lib.php 22.7 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
require('session.php');
30
require(get_config('docroot') . 'auth/user.php');
31

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

/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
40
41
42
43
44
45
 *
 * @todo for authentication:
 *   - inactivity: each institution has inactivity timeout times, this needs
 *     to be supported
 *     - this means the lastlogin field needs to be updated on the usr table
 *     - warnings are handled by cron
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 */
abstract class Auth {

    /**
     * Given a username, password and institution, attempts to log the use in.
     *
     * @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
     */
69
    public static abstract function get_user_info($username);
70

Nigel McNie's avatar
Nigel McNie committed
71
72
73
74
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
75
76
77
78
79
     * This only needs to be defined by subclasses if:
     *  - They implement the change_password method, which means that the
     *    system can use the <kbd>passwordchange</kbd> flag on the <kbd>usr</kbd>
     *    table to control whether the user's password needs changing.
     *  - The password that a user can set must be in a certain format.
Nigel McNie's avatar
Nigel McNie committed
80
81
82
83
     *
     * 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!
     *
84
85
86
     * This method is defined to be empty, so that authentication methods do 
     * not have to specify a format if they do not need to.
     *
Nigel McNie's avatar
Nigel McNie committed
87
88
89
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
90
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
91
92
93
        return true;
    }

94
95
96
97
}


/**
Nigel McNie's avatar
Nigel McNie committed
98
 * Handles authentication by setting up a session for a user if they are logged in.
99
100
101
102
103
104
105
106
 *
 * 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
107
108
109
110
111
112
113
 *
 * 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.
 *
114
115
 */
function auth_setup () {
116
    global $SESSION, $USER;
117
118
119

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
120
    log_debug('auth_setup()');
121
    if (!get_config('installed')) {
122
123
        log_debug('system not installed, letting user through');
        $USER->logout();
124
125
126
127
128
        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.
129
130
    $sessionlogouttime = $USER->get('logout_time');
    log_debug("logout time: $sessionlogouttime");
Nigel McNie's avatar
Nigel McNie committed
131
    if ($sessionlogouttime && isset($_GET['logout'])) {
132
133
134
135
        log_debug("logging user out");
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
        redirect(get_config('wwwroot'));
Nigel McNie's avatar
Nigel McNie committed
136
137
    }
    if ($sessionlogouttime > time()) {
138
        log_debug("session still active");
139
        // The session is still active, so continue it.
140
141
142
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
143
144
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->get('id'));
            if (!$USER->get('admin') && $userreallyadmin) {
145
                // The user has been made into an admin
146
147
                log_debug("user has been made an admin");
                $USER->set('admin', 1);
148
            }
149
            else if ($USER->get('admin') && !$userreallyadmin) {
150
                // The user's admin rights have been taken away
151
152
                log_debug("users admin rights have been revoked!");
                $USER->set('admin', 0);
153
154
155
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }
156
            elseif (!$USER->get('admin')) {
157
                // The user never was an admin
158
                log_debug("denying user access to administration");
159
160
161
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }
162
        }
163
164
        log_debug("renewing user's session");
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
165
        auth_check_password_change();
166
        //return $USER;
167
168
169
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
170
171
        log_debug('session timed out');
        $USER->logout();
172
173
174
175
176
177
178

        // If the page the user is viewing is public, inform them that they can
        // log in again
        if (defined('PUBLIC')) {
            // @todo this links to ?login - later it should do magic to make
            // sure that whatever GET string is made it includes the old data
            // correctly
179
            log_debug('timed out on public page');
180
181
182
183
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic'), false);
            return;
        }

184
185
186
187
        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.
188
        //return $USER;
189
190
191
    }
    else {
        // There is no session, so we check to see if one needs to be started.
192
        log_debug('no session');
193
        // Build login form. If the form is submitted it will be handled here,
194
195
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
196
197
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
198
199
        if ($USER->is_logged_in()) {
            return;
200
201
202
        }
        
        // Check if the page is public or the site is configured to be public.
203
        if (defined('PUBLIC') && !isset($_GET['login'])) {
204
            log_debug('user viewing public page');
205
            return;
206
        }
207
        
208
        auth_draw_login_page(null, $form);
209
        exit;
210
211
212
213
214
215
216
217
218
    }
}

/**
 * Given an institution, returns the authentication method used by it.
 *
 * @return string
 */
function auth_get_authtype_for_institution($institution) {
Nigel McNie's avatar
Nigel McNie committed
219
220
221
222
223
    static $cache = array();
    if (isset($cache[$institution])) {
        return $cache[$institution];
    }
    return $cache[$institution] = get_field('institution', 'authplugin', 'name', $institution);
224
225
}

226
227
228
229
230
231
232
233
/**
 * 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.
 */
Nigel McNie's avatar
Nigel McNie committed
234
235
function auth_check_password_change() {
    global $USER;
236
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
237
238
239
        return;
    }

240
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
241
242
    $authclass = 'Auth' . ucfirst($authtype);
    $url       = '';
243
    safe_require('auth', $authtype);
Nigel McNie's avatar
Nigel McNie committed
244
245
246
247
248
249
250
251
252
253
    
    // @todo auth preference for a password change screen for all auth methods other than internal
    if (
        ($url = get_config_plugin('auth', $authtype, 'changepasswordurl'))
        || (method_exists($authclass, 'change_password'))) {
        if ($url) {
            redirect($url);
            exit;
        }

254
        require_once('pieforms/pieform.php');
255
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
256
257
258
259
260
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
Nigel McNie's avatar
Nigel McNie committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
                'passwords' => array(
                    'type' => 'fieldset',
                    'legend' => get_string('newpassword'),
                    'elements' => array(
                        'password1' => array(
                            'type'        => 'password',
                            'title'       => get_string('newpassword') . ':',
                            'description' => get_string('yournewpassword'),
                            'rules'       => array(
                                'required' => true
                            )
                        ),
                        'password2' => array(
                            'type'        => 'password',
                            'title'       => get_string('confirmpassword') . ':',
                            'description' => get_string('yournewpasswordagain'),
                            'rules'       => array(
                                'required' => true
                            )
                        )
281
282
283
                    )
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
284
285
                    'type'  => 'submit',
                    'value' => get_string('changepassword')
286
287
288
289
290
                )
            )
        );

        $smarty = smarty();
291
        $smarty->assign('change_password_form', pieform($form));
292
293
294
295
296
297
298
299
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
300
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
301
 *
302
303
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
304
 */
305
function change_password_validate(Pieform $form, $values) {
306
    global $USER;
307
308
309

    // Get the authentication type for the user (based on the institution), and
    // use the information to validate the password
310
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
311
312
    $authclass = 'Auth' . ucfirst($authtype);
    $authlang  = 'auth.' . $authtype;
313
    safe_require('auth', $authtype);
314

Nigel McNie's avatar
Nigel McNie committed
315
316
    // @todo this could be done by a custom form rule... 'password' => $user
    password_validate($form, $values, $USER);
317

Nigel McNie's avatar
Nigel McNie committed
318
    // The password cannot be the same as the old one
319
    if (!$form->get_error('password1')
320
        && call_static_method($authclass, 'authenticate_user_account', $USER->get('username'), $values['password1'], $USER->get('institution'))) {
Nigel McNie's avatar
Nigel McNie committed
321
        $form->set_error('password1', get_string('passwordnotchanged'));
322
323
324
325
326
327
328
329
330
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
function change_password_submit($values) {
331
332
    global $USER, $SESSION;
    $authtype = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
333
334
335
336
    $authclass = 'Auth' . ucfirst($authtype);

    // This method should exists, because if it did not then the change
    // password form would not have been shown.
337
    if ($password = call_static_method($authclass, 'change_password', $USER->get('username'), $values['password1'])) {
338
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
339
        $user->password = $password;
340
341
        $user->passwordchange = 0;
        $where = new StdClass;
342
        $where->username = $USER->get('username');
343
        update_record('usr', $user, $where);
344
345
        $USER->set('password', $password);
        $USER->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
346
        $SESSION->add_ok_msg(get_string('passwordsaved'));
347
348
349
        redirect(get_config('wwwroot'));
        exit;
    }
Nigel McNie's avatar
Nigel McNie committed
350

351
352
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
353
354
}

355
/**
Nigel McNie's avatar
Nigel McNie committed
356
 * Creates and displays the transient login page.
357
 *
Nigel McNie's avatar
Nigel McNie committed
358
359
360
361
 * 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.
 *
362
363
364
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
365
366
367
 * @param Pieform $form If specified, just build this form to get the HTML
 *                      required. Otherwise, this function will build and
 *                      validate the form itself.
Nigel McNie's avatar
Nigel McNie committed
368
 * @access private
369
 */
370
function auth_draw_login_page($message=null, Pieform $form=null) {
371
    global $USER, $SESSION;
372
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
373
        $loginform = get_login_form_js($form->build());
374
375
    }
    else {
376
        require_once('pieforms/pieform.php');
377
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
378
379
380
381
382
        /*
         * If $USER is set, 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.
         */
383
        if ($USER->is_logged_in()) {
384
385
386
387
388
389
390
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
391
    }
392
    $smarty = smarty();
393
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
394
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
395
396
397
    $smarty->display('login.tpl');
    exit;
}
398

399
/**
Nigel McNie's avatar
Nigel McNie committed
400
 * Returns the definition of the login form.
401
 *
Nigel McNie's avatar
Nigel McNie committed
402
403
 * @return array   The login form definition array.
 * @access private
404
405
 */
function auth_get_login_form() {
406
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
407
408
409
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
410
            'legend' => get_string('login'),
411
412
413
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
414
                    'title'       => get_string('username'),
415
                    'description' => get_string('usernamedescription'),
416
417
418
                    'rules' => array(
                        'required'    => true
                    )
419
420
421
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
422
                    'title'       => get_string('password'),
423
                    'description' => get_string('passworddescription'),
424
425
426
427
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
428
429
430
431
432
433
434
435
436
437
                ),
                'login_institution' => array(
                    'type' => 'select',
                    'title' => get_string('institution'),
                    'defaultvalue' => get_cookie('institution'),
                    'options' => $institutions,
                    'rules' => array(
                        'required' => true
                    ),
                    'ignore' => count($institutions) == 1
438
439
440
441
442
443
                )
            )
        ),

        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
444
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
445
        ),
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
    );

    // 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(
Nigel McNie's avatar
Nigel McNie committed
481
482
483
484
485
486
        'name'          => 'login',
        'method'        => 'post',
        'action'        => $action,
        'plugintype'    => 'auth',
        'pluginname'    => 'internal',
        'elements'      => $elements,
487
        'iscancellable' => false
488
489
    );

490
    return $form;
491
492
}

Nigel McNie's avatar
Nigel McNie committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
/**
 * Returns javascript to assist with the rendering of the login forms. The
 * javascript is used to detect whether cookies are enabled, and not show the
 * login form if they are not.
 *
 * @param string $form A rendered login form
 * @return string      The form with extra javascript added for cookie detection
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
    $strcookiesnotenabled    = get_string('cookiesnotenabled');
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
var loginbox = $('loginbox');
Nigel McNie's avatar
Nigel McNie committed
509
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
510
511
if (document.cookie) {
    loginbox.innerHTML = '$form';
512
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
513
514
}
else {
515
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
516
517
518
519
}
</script>
EOF;
}
520

521
/**
522
523
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
524
 *
525
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
526
 * @access private
527
 */
528
function login_submit($values) {
529
    global $SESSION, $USER;
530
    log_debug('login_submit()');
531
532
533

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
534
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
535
536
            
    $authtype = auth_get_authtype_for_institution($institution);
537
    safe_require('auth', $authtype);
538
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
539

540
541
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
542
543
            // User logged in! Set a cookie to remember their institution
            set_cookie('institution', $institution);
544
            log_debug('user authenticated successfully');
Nigel McNie's avatar
Nigel McNie committed
545
546
547
548
549
550

            if (!record_exists('usr', 'username', $username)) {
                // We don't know about this user. But if the authentication
                // method says they're fine, then we must insert data for them
                // into the usr table.
                // @todo document what needs to be returned by get_user_info
551
552
                $userdata = call_static_method($authclass, 'get_user_info', $username);
                insert_record('usr', $userdata);
Nigel McNie's avatar
Nigel McNie committed
553
554
555
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
556
                $userdata = call_static_method($authclass, 'get_user_info', $username);
Nigel McNie's avatar
Nigel McNie committed
557
558
559
560
561
562
563
                $where = new StdClass;
                $where->username = $username;
                $where->institution = $institution;
                // @todo as per the above todo about what needs to be returned by get_user_info,
                // that needs to be validated somewhere. Because here we do an insert into the
                // usr table, that needs to work. and provide enough information for future
                // authentication attempts
564
                update_record('usr', $userdata, $where);
Nigel McNie's avatar
Nigel McNie committed
565
566
            }
            else {
567
                $userdata = get_record('usr', 'username', $username, null, null, null, null, '*, ' . db_format_tsfield('expiry'));
Nigel McNie's avatar
Nigel McNie committed
568
569
            }

570
            // Only admins in the admin section!
571
572
            if (defined('ADMIN') && !$userdata->admin) {
                log_debug('user not allowed in admin section');
573
574
575
576
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }

Nigel McNie's avatar
Nigel McNie committed
577
            // Check if the user's account has expired
578
579
            // @todo TEST THIS
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
580
581
582
583
                die_info(get_string('accountexpired'));
            }

            // Check if the user's account has been suspended
584
585
586
            // Note: only the internal authentication method can say if a user is suspended for now.
            // There are problems with how searching excluding suspended users will work that would
            // need to be resolved before this could be implemented for all methods
587
588
            // @todo TEST THIS
            if ($suspend = get_record('usr_suspension', 'usr', $userdata->id)) {
Nigel McNie's avatar
Nigel McNie committed
589
590
591
592
                die_info(get_string('accountsuspended', 'mahara', $suspend->ctime, $suspend->reason));
            }

            // User is allowed to log in
593
            $USER->login($userdata);
Nigel McNie's avatar
Nigel McNie committed
594
            auth_check_password_change();
595
596
597
        }
        else {
            // Login attempt failed
Nigel McNie's avatar
Nigel McNie committed
598
            $SESSION->add_err_msg(get_string('loginfailed'));
599
600
601
        }
    }
    catch (AuthUnknownUserException $e) {
Nigel McNie's avatar
Nigel McNie committed
602
        $SESSION->add_err_msg(get_string('loginfailed'));
603
    }
604
605
}

606
?>