lib.php 23 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();

29 30
require('session.php');

Nigel McNie's avatar
Nigel McNie committed
31 32 33
/**
 * Unknown user exception
 */
34 35 36 37 38 39 40 41 42 43 44
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
45 46
     * @todo Later, needs to deal with institution
     *
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
     * @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
     */
64
    public static abstract function get_user_info($username);
65 66

    /**
Nigel McNie's avatar
Nigel McNie committed
67 68 69 70 71
     * 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.
72
     *
Nigel McNie's avatar
Nigel McNie committed
73 74 75 76 77 78 79 80 81 82 83 84 85
     * 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
86
     */
87 88 89
    public static function get_configuration_form() {
    }

Nigel McNie's avatar
Nigel McNie committed
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 118 119
    /**
     * 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.
     */
120
    public static function is_username_valid($username) {
Nigel McNie's avatar
Nigel McNie committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
        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.
     */
137
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
        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) {
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
        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;
168 169 170 171 172 173
    }

}


/**
Nigel McNie's avatar
Nigel McNie committed
174
 * Handles authentication by setting up a session for a user if they are logged in.
175 176 177 178 179 180 181 182
 *
 * 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
183 184 185 186 187 188 189 190 191
 *
 * 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.
192 193
 */
function auth_setup () {
194
    global $SESSION, $USER;
195 196 197 198

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
199
        $SESSION->logout();
Nigel McNie's avatar
Nigel McNie committed
200
        log_debug('system not installed, letting user through');
201 202 203 204 205 206
        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');
207
    if ($sessionlogouttime > time()) {
208
        if (isset($_GET['logout'])) {
Nigel McNie's avatar
Nigel McNie committed
209
            log_debug('logging user ' . $SESSION->get('username') . ' out');
210
            $SESSION->logout();
Nigel McNie's avatar
Nigel McNie committed
211
            $SESSION->add_ok_msg(get_string('loggedoutok'));
212
            redirect(get_config('wwwroot'));
213 214
        }
        // The session is still active, so continue it.
Nigel McNie's avatar
Nigel McNie committed
215
        log_debug('session still active from previous time');
216
        $USER = $SESSION->renew();
217
        auth_check_password_change($USER);
218
        return $USER;
219 220 221
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
Nigel McNie's avatar
Nigel McNie committed
222
        log_debug('session timed out');
223
        $SESSION->logout();
224 225 226 227 228
        auth_draw_login_page(get_string('sessiontimedout'));
        // The auth_draw_login_page function may authenticate a user if a login
        // request was sent at the same time that the "timed out" message is to
        // be displayed.
        return $USER;
229 230 231
    }
    else {
        // There is no session, so we check to see if one needs to be started.
232
        
233
        // Build login form. If the form is submitted it will be handled here,
234 235
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
236 237 238
        require_once('form.php');
        $form = new Form(auth_get_login_form());
        if ($USER) {
Nigel McNie's avatar
Nigel McNie committed
239
            log_debug('user logged in just fine');
240 241 242 243 244
            return $USER;
        }
        
        // Check if the page is public or the site is configured to be public.
        if (defined('PUBLIC')) {
245
            return;
246
        }
247
        
Martyn Smith's avatar
Martyn Smith committed
248
        log_debug('no session or old session, and page is private');
249
        auth_draw_login_page(null, $form);
250
        exit;
251 252 253 254 255 256 257 258 259 260 261 262 263 264
    }
}

/**
 * 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';
}

265 266 267 268 269 270 271 272
/**
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
 *
 * This only applies for the internal authentication plugin. Other plugins
 * will, in theory, have different data stores, making changing the password
 * via the internal form difficult.
 */
273
function auth_check_password_change($user) {
274 275
    log_debug('checking if the user needs to change their password');
    if (auth_get_authtype_for_institution($user->institution) == 'internal' && $user->passwordchange) {
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
        log_debug('user DOES need to change their password');
        require_once('form.php');
        $form = array(
            'name' => 'change_password',
            'method' => 'post',
            'elements' => array(
                'password1' => array(
                    'type' => 'password',
                    'title' => 'New Password:',
                    'description' => 'Your new password',
                    'rules' => array(
                        'required' => true
                    )
                ),
                'password2' => array(
                    'type' => 'password',
                    'title' => 'Confirm Password:',
                    'description' => 'Your new password again',
                    'rules' => array(
                        'required' => true
                    )
                ),
                'submit' => array(
                    'type' => 'submit',
                    'value' => 'Change Password'
                )
            )
        );

        $smarty = smarty();
        $smarty->assign('change_password_form', form($form));
        $smarty->display('change_password.tpl');
        exit;
    }
}

312 313
/**
 * Check if the given user's account has expired
314 315 316 317
 *
 * @param object $user The user to check for the expired password.
 * @todo maybe later, just use $USER because that's all we are actually checking...
 * @private
318 319 320 321
 */
function auth_check_user_expired($user) {
    log_debug('Checking to see if the user has expired');
    if ($user->expiry > 0 && time() > $user->expiry) {
322 323
        // Trash the $USER object, used for checking if the user is logged in.
        // Smarty uses it otherwise...
324 325
        global $USER;
        $USER = null;
326
        die_info(get_string('accountexpired'));
327 328 329
    }
}

330 331 332 333 334 335 336
/**
 * Check if the given user's account has been suspended
 *
 * @param object $user The user to check for the suspended account.
 * @private
 */
function auth_check_user_suspended($user) {
337 338
    global $USER;
    log_debug('Checking to see if the user is suspended');
339
    $suspend = get_record('usr_suspension', 'usr', $user->id);
340 341 342
    if ($suspend) {
        global $USER;
        $USER = null;
343
        die_info(get_string('accountsuspended', 'mahara', $suspend->ctime, $suspend->reason));
344 345 346
    }
}

347 348 349 350 351
/**
 * Validates the form for changing the password for a user.
 *
 * This only applies to the internal authentication plugin.
 *
Nigel McNie's avatar
Nigel McNie committed
352 353 354 355 356 357
 * @todo As far as I can tell, the change password and registration forms will 
 * only be used for internal authentication. And so, by proxy, will the 
 * username/password valid methods for the Auth class. I think this means they 
 * can be removed from the Auth class, and instead just be part of AuthInternal
 * since they don't need to be specified for other types.
 *
358 359 360 361
 * Furthermore, I think that the change_password stuff (as well as suspended
 * and expired) are also quite possibly related to internal only. This will
 * require a lot of thought about how to best structure it.
 *
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
 * @param Form  $form   The form to check
 * @param array $values The values to check
 */
function change_password_validate(Form $form, $values) {
    global $SESSION;

    // Get the authentication type for the user (based on the institution), and
    // use the information to validate the password
    $authtype = auth_get_authtype_for_institution($SESSION->get('institution'));
    if ($authtype == 'internal') {
        safe_require('auth', $authtype, 'lib.php', 'require_once');

        // Check that the password is in valid form
        if (!$form->get_error('password1')
            && !call_static_method('AuthInternal', 'is_password_valid', $values['password1'])) {
377
            $form->set_error('password1', get_string('passwordinvalidform', 'auth.internal'));
378 379 380 381 382 383 384
        }

        // The password must not be too easy :)
        $suckypasswords = array(
            'mahara', 'password', $SESSION->get('username')
        );
        if (!$form->get_error('password1') && in_array($values['password1'], $suckypasswords)) {
385
            $form->set_error('password1', get_string('passwordtooeasy', 'auth.internal'));
386 387 388
        }

        // The password cannot be the same as the old one
389 390
        if (!$form->get_error('password1') && $values['password1'] == $USER->password) {
            $form->set_error('password1', get_string('passwordnotchanged', 'auth.internal'));
391 392 393 394
        }

        // The passwords must match
        if (!$form->get_error('password1') && !$form->get_error('password2') && $values['password1'] != $values['password2']) {
395
            $form->set_error('password2', get_string('passwordsdonotmatch', 'auth.internal'));
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
        }
    }
    else {
        throw new Exception('The user "' . $USER->username . '" is trying to'
            . ' change their password, but they do not use the internal'
            . ' authentication method');
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * This only applies to the internal authentication plugin.
 *
 * @param array $values The submitted form values
 */
function change_password_submit($values) {
    global $SESSION;
    log_debug('changing password to ' . $values['password1']);

    $authtype = auth_get_authtype_for_institution($SESSION->get('institution'));
    if ($authtype == 'internal') {
        // Create a salted password and set it for the user
        safe_require('auth', $authtype, 'lib.php', 'require_once');
        $user = new StdClass;
        $user->salt = substr(md5(rand(1000000, 9999999)), 2, 8);
        $user->password = call_static_method('AuthInternal', 'encrypt_password', $values['password1'], $user->salt);
        $user->passwordchange = 0;
        $where = new StdClass;
        $where->username = $SESSION->get('username');
        update_record('usr', $user, $where);

        $SESSION->set('passwordchange', 0);
429
        $SESSION->add_ok_msg(get_string('passwordsaved', 'auth.internal'));
430 431 432 433 434 435 436 437 438 439
        redirect(get_config('wwwroot'));
        exit;
    }
    else {
        throw new Exception('The user "' . $USER->username . '" is trying to'
            . ' change their password, but they do not use the internal'
            . ' authentication method');
    }
}

440
/**
Nigel McNie's avatar
Nigel McNie committed
441
 * Creates and displays the transient login page.
442
 *
Nigel McNie's avatar
Nigel McNie committed
443 444 445 446
 * 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.
 *
447 448 449
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
Nigel McNie's avatar
Nigel McNie committed
450 451 452 453
 * @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
454
 */
455 456
function auth_draw_login_page($message=null, Form $form=null) {
    global $USER, $SESSION;
457 458 459 460 461 462
    if ($form != null) {
        $loginform = $form->build();
    }
    else {
        require_once('form.php');
        $loginform = form(auth_get_login_form());
463 464 465 466 467 468 469 470 471 472 473
        // If this is true, the form was submitted even before being built.
        // This happens when a user's session times out and they resend post
        // data. The request should just continue if so.
        if ($USER) {
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
474
    }
475
    $smarty = smarty();
476 477 478 479
    $smarty->assign('login_form', $loginform);
    $smarty->display('login.tpl');
    exit;
}
480

481
/**
Nigel McNie's avatar
Nigel McNie committed
482
 * Returns the definition of the login form.
483
 *
Nigel McNie's avatar
Nigel McNie committed
484 485
 * @return array   The login form definition array.
 * @access private
486 487
 */
function auth_get_login_form() {
488 489 490
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
491
            'legend' => get_string('login'),
492 493 494
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
495 496 497
                    'title'       => get_string('username'),
                    'description' => get_string('usernamedesc'),
                    'help'        => get_string('usernamehelp'),
498 499 500
                    'rules' => array(
                        'required'    => true
                    )
501 502 503
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
504 505 506
                    'title'       => get_string('password'),
                    'description' => get_string('passworddesc'),
                    'help'        => get_string('passwordhelp'),
507 508 509 510
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
511 512 513 514 515 516
                )
            )
        ),

        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
517
            'value' => get_string('login')
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
        )
    );

    // 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(
554 555 556
        'name'     => 'login',
        'method'   => 'post',
        'action'   => $action,
557 558
        'elements' => $elements,
        'iscancellable' => false
559 560
    );

561
    return $form;
562 563
}

564

565
/**
566 567
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
568
 *
569
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
570
 * @access private
571
 */
572
function login_submit($values) {
573 574
    global $SESSION, $USER;

Nigel McNie's avatar
Nigel McNie committed
575
    log_debug('auth details supplied, attempting to log user in');
576 577 578 579 580 581
    $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');
582
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
583

584 585
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
Nigel McNie's avatar
Nigel McNie committed
586
            log_debug('user ' . $username . ' logged in OK');
587
            $USER = call_static_method($authclass, 'get_user_info', $username);
588 589
            auth_check_user_expired($USER);
            auth_check_user_suspended($USER);
590 591
            $SESSION->login($USER);
            $USER->logout_time = $SESSION->get('logout_time');
592
            auth_check_password_change($USER);
593 594 595
        }
        else {
            // Login attempt failed
Nigel McNie's avatar
Nigel McNie committed
596 597
            log_debug('login attempt FAILED');
            $SESSION->add_err_msg(get_string('loginfailed'));
598 599 600
        }
    }
    catch (AuthUnknownUserException $e) {
Nigel McNie's avatar
Nigel McNie committed
601 602
        log_debug('unknown user ' . $username);
        $SESSION->add_err_msg(get_string('loginfailed'));
603
    }
604 605
}

Nigel McNie's avatar
Nigel McNie committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
/**
 * 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
 */
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
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));
645 646 647
}

?>