lib.php 15.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php
/**
 * This program is part of Mahara
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
20
 * @subpackage auth
21 22 23 24 25 26 27 28
 * @author     Nigel McNie <nigel@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

defined('INTERNAL') || die();

Nigel McNie's avatar
Nigel McNie committed
29 30 31
/**
 * Unknown user exception
 */
32 33 34 35 36 37 38 39 40 41 42
class AuthUnknownUserException extends Exception {}

/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
 */
abstract class Auth {

    /**
     * Given a username, password and institution, attempts to log the use in.
     *
Nigel McNie's avatar
Nigel McNie committed
43 44
     * @todo Later, needs to deal with institution
     *
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
     * @param string $username  The username to attempt to authenticate
     * @param string $password  The password to use for the attempt
     * @param string $institute The institution the user belongs to
     * @return bool             Whether the authentication was successful
     * @throws AuthUnknownUserException  If the user is unknown to the
     *                                   authentication method
     */
    public static abstract function authenticate_user_account($username, $password, $institute);

    /**
     * Given a username, returns a hash of information about a user.
     *
     * @param string $username The username to look up information for
     * @return array           The information for the user
     * @throws AuthUnknownUserException If the user is unknown to the
     *                                  authentication method
     */
62
    public static abstract function get_user_info($username);
63 64

    /**
Nigel McNie's avatar
Nigel McNie committed
65 66 67 68 69
     * Returns a hash of information that will be rendered into a form when
     * configuring authentication.
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify a form if they do not need to.
70
     *
Nigel McNie's avatar
Nigel McNie committed
71 72 73 74 75 76 77 78 79 80 81 82 83
     * If an authentication method is to return any elements, the return result
     * <b>must</b> be wrapped in a call to {@link build_form}.
     *
     * For example:
     *
     * <pre>
     * $elements = array(
     *     // ... describe elements here ...
     * );
     * return Auth::build_form($elements);
     * </pre>
     *
     * @return array The form for configuring the authentication method
84
     */
85 86 87
    public static function get_configuration_form() {
    }

Nigel McNie's avatar
Nigel McNie committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    /**
     * Given a submission from the configuration form, validates it
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify any validation rules if they do not need to.
     *
     * @param array $values The submitted values for the form
     * @param Form $form    The form being validated
     */
    public static function validate_configuration_form(Form $form, $values) {
    }

    /**
     * Given a username, returns whether it is in a valid format for this
     * authentication method.
     *
     * Note: This does <b>not</b> check that the username is an existing user
     * that this authentication method could log in given the correct password.
     * It only checks that the format that the username is in is allowed - i.e.
     * that it matches a specific regular expression for example.
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify a format if they do not need to.
     *
     * The default behaviour is to assume that the username is in a valid form,
     * so make sure to implement this method if this is not the case!
     *
     * @param string $username The username to check
     * @return bool            Whether the username is in valid form.
     */
118
    public static function is_username_valid($username) {
Nigel McNie's avatar
Nigel McNie committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
        return true;
    }

    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify a format if they do not need to.
     *
     * The default behaviour is to assume that the password is in a valid form,
     * so make sure to implement this method if this is not the case!
     *
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
135
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
        return true;
    }

    /**
     * If a validation form is to be used, the result of 
     * {@link get_configuration_form} should be passed through this method
     * before being returned. This method builds the rest of the form.
     *
     * @param string $method  The name of the authentication method (for
     *                        example 'internal'). Lowercase please.
     * @param array $elements The elements in the form.
     * @return array          The form definition. <kbd>false</kbd> if there
     *                        is no form for the authentication method.
     */
    protected static final function build_form($method, $elements) {
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
        if (count($elements)) {
            $elements['submit'] = array(
                'type' => 'submit',
                'value' => 'Update'
            );
            $elements['method'] = array(
                'type' => 'hidden',
                'value' => $method 
            );
            return array(
                'name' => 'auth',
                'elements' => $elements
            );
        }
        return false;
166 167 168 169 170 171
    }

}


/**
Nigel McNie's avatar
Nigel McNie committed
172
 * Handles authentication by setting up a session for a user if they are logged in.
173 174 175 176 177 178 179 180
 *
 * This function combined with the Session class is smart - if the user is not
 * logged in then they do not get a session, which prevents simple curl hits
 * or search engine crawls to a page from getting sessions they won't use.
 *
 * Once the user has a session, they keep it even if the log out, so it can
 * be reused. The session does expire, but the expiry time is typically a week
 * or more.
Nigel McNie's avatar
Nigel McNie committed
181 182 183 184 185 186 187 188 189
 *
 * If the user is not authenticated for this page, then this function will
 * exit, printing the login page. Therefore, after including init.php, you can
 * be sure that the user is logged in, or has a valid guest key. However, no
 * testing is done to make sure the user has the required permissions to see
 * the page.
 *
 * @return object The $USER object, if the user is logged in and continuing
 *                their session.
190 191
 */
function auth_setup () {
192
    global $SESSION, $USER;
193 194 195 196

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
Nigel McNie's avatar
Nigel McNie committed
197
        log_debug('system not installed, letting user through');
198 199 200 201 202 203
        return;
    }

    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
    $sessionlogouttime = $SESSION->get('logout_time');
204
    if ($sessionlogouttime > time()) {
205
        if (isset($_GET['logout'])) {
Nigel McNie's avatar
Nigel McNie committed
206
            log_debug('logging user ' . $SESSION->get('username') . ' out');
207
            $SESSION->logout();
Nigel McNie's avatar
Nigel McNie committed
208
            $SESSION->add_ok_msg(get_string('loggedoutok'));
209
            redirect(get_config('wwwroot'));
210 211
        }
        // The session is still active, so continue it.
Nigel McNie's avatar
Nigel McNie committed
212
        log_debug('session still active from previous time');
213 214 215 216
        return $SESSION->renew();
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
Nigel McNie's avatar
Nigel McNie committed
217
        log_debug('session timed out');
218
        $SESSION->logout();
Nigel McNie's avatar
Nigel McNie committed
219
        $SESSION->add_info_msg(get_string('sessiontimedout'));
220 221 222 223 224 225 226
        // @todo<nigel>: if page is public, no need to show the login page again
        auth_draw_login_page();
        exit;
    }
    else {
        // There is no session, so we check to see if one needs to be started.
        // First, check if the page is public or the site is configured to be public.
227
        if (defined('PUBLIC')) {
228 229 230
            return;
        }

231 232 233 234 235
        // Build login form. If the form is submitted it will be handled here,
        // and set $USER for us.
        require_once('form.php');
        $form = new Form(auth_get_login_form());
        if ($USER) {
Nigel McNie's avatar
Nigel McNie committed
236
            log_debug('user logged in just fine');
237
            return;
238
        }
239
        
Nigel McNie's avatar
Nigel McNie committed
240
        log_debug('no session or old session, and page is private hello');
241 242
        auth_draw_login_page($form);
        exit;
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    }
}

/**
 * Given an institution, returns the authentication method used by it.
 *
 * @return string
 * @todo<nigel>: Currently, the system doesn't have a concept of institution
 * at the database level, so the internal authentication method is assumed.
 */
function auth_get_authtype_for_institution($institution) {
    return 'internal';
}

/**
Nigel McNie's avatar
Nigel McNie committed
258
 * Creates and displays the transient login page.
259
 *
Nigel McNie's avatar
Nigel McNie committed
260 261 262 263 264 265 266 267
 * This login page remembers all GET/POST data and passes it on. This way,
 * users can have their sessions time out, and then can log in again without
 * losing any of their data.
 *
 * @param Form $form If specified, just build this form to get the HTML
 *                   required. Otherwise, this function will build and
 *                   validate the form itself.
 * @access private
268
 */
Nigel McNie's avatar
Nigel McNie committed
269
function auth_draw_login_page(Form $form=null) {
270 271 272 273 274 275 276
    if ($form != null) {
        $loginform = $form->build();
    }
    else {
        require_once('form.php');
        $loginform = form(auth_get_login_form());
    }
277
    $smarty = smarty();
278 279 280 281
    $smarty->assign('login_form', $loginform);
    $smarty->display('login.tpl');
    exit;
}
282

283
/**
Nigel McNie's avatar
Nigel McNie committed
284
 * Returns the definition of the login form.
285
 *
Nigel McNie's avatar
Nigel McNie committed
286 287
 * @return array   The login form definition array.
 * @access private
288 289
 */
function auth_get_login_form() {
290 291 292
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
293
            'legend' => get_string('login'),
294 295 296
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
297 298 299
                    'title'       => get_string('username'),
                    'description' => get_string('usernamedesc'),
                    'help'        => get_string('usernamehelp'),
300 301 302
                    'rules' => array(
                        'required'    => true
                    )
303 304 305
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
306 307 308
                    'title'       => get_string('password'),
                    'description' => get_string('passworddesc'),
                    'help'        => get_string('passwordhelp'),
309 310 311 312
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
313 314 315 316 317 318
                )
            )
        ),

        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
319
            'value' => get_string('login')
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
        )
    );

    // The login page is completely transient, and it is smart because it
    // remembers the GET and POST data sent to it and resends that on
    // afterwards. 
    $action = '';
    if ($_GET) {
        if (isset($_GET['logout'])) {
            // You can log the user out on any particular page by appending
            // ?logout to the URL. In this case, we don't want the "action"
            // of the url to include that, or be blank, else the next time
            // the user logs in they will be logged out again.
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
        } else {
            $action = '?';
            foreach ($_GET as $key => $value) {
                if ($key != 'logout') {
                    $action .= hsc($key) . '=' . hsc($value) . '&amp;';
                }
            }
            $action = substr($action, 0, -5);
        }
    }
    if ($_POST) {
        foreach ($_POST as $key => $value) {
            if (!isset($elements[$key]) && !isset($elements['login']['elements'][$key])) {
                $elements[$key] = array(
                    'type'  => 'hidden',
                    'value' => $value
                );
            }
        }
    }

    $form = array(
356 357 358
        'name'     => 'login',
        'method'   => 'post',
        'action'   => $action,
359 360
        'elements' => $elements,
        'iscancellable' => false
361 362
    );

363
    return $form;
364 365
}

366

367
/**
368 369
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
370
 *
371
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
372
 * @access private
373
 */
374
function login_submit($values) {
375 376
    global $SESSION, $USER;

Nigel McNie's avatar
Nigel McNie committed
377
    log_debug('auth details supplied, attempting to log user in');
378 379 380 381 382 383
    $username    = $values['login_username'];
    $password    = $values['login_password'];
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 0;
            
    $authtype = auth_get_authtype_for_institution($institution);
    safe_require('auth', $authtype, 'lib.php', 'require_once');
384
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
385

386 387
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
Nigel McNie's avatar
Nigel McNie committed
388
            log_debug('user ' . $username . ' logged in OK');
389 390 391 392 393 394
            $USER = call_static_method($authclass, 'get_user_info', $username);
            $SESSION->login($USER);
            $USER->logout_time = $SESSION->get('logout_time');
        }
        else {
            // Login attempt failed
Nigel McNie's avatar
Nigel McNie committed
395 396
            log_debug('login attempt FAILED');
            $SESSION->add_err_msg(get_string('loginfailed'));
397 398 399
        }
    }
    catch (AuthUnknownUserException $e) {
Nigel McNie's avatar
Nigel McNie committed
400 401
        log_debug('unknown user ' . $username);
        $SESSION->add_err_msg(get_string('loginfailed'));
402
    }
403 404
}

Nigel McNie's avatar
Nigel McNie committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * Passes the form data through to the validation method of the appropriate
 * authentication plugin, for it to validate if necessary.
 *
 * This is for validation of the configuration form that each authentication
 * method exports
 *
 * @param Form  $form   The form to validate
 * @param array $values The values submitted to check
 * @access private
 */
function auth_validate(Form $form, $values) {
    $class = 'Auth' . $values['method'];
    safe_require('auth', $values['method'], 'lib.php', 'require_once');
    call_static_method($class, 'validate_configuration_form', $form, $values);
}

/**
 * Handles submission of the configuration form for an authentication method.
 * Sets each configuration value in the database.
 *
 * @param array $values The submitted values, successfully validated
 * @access private
 */
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
function auth_submit($values) {
    global $SESSION, $db;
    $db->StartTrans();

    foreach ($values as $key => $value) {
        if (!in_array($key, array('submit', 'method'))) {
            set_config_plugin('auth', $values['method'], $key, $value);
        }
    }
    if ($db->HasFailedTrans()) {
        $db->CompleteTrans();
        throw new Exception('Could not update the configuration options for the auth method');
    }
    $db->CompleteTrans();
    $SESSION->add_ok_msg(get_string('authconfigurationoptionssaved') . ' ' . get_config_plugin('auth', $values['method'], $key));
444 445 446
}

?>