lib/authlib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Multiple plugin authentication Support library
  20  *
  21  * 2006-08-28  File created, AUTH return values defined.
  22  *
  23  * @package    core
  24  * @subpackage auth
  25  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29 defined('MOODLE_INTERNAL') || die();
  30
  31 /**
  32  * Returned when the login was successful.
  33  */
  34 define('AUTH_OK',     0);
  35
  36 /**
  37  * Returned when the login was unsuccessful.
  38  */
  39 define('AUTH_FAIL',   1);
  40
  41 /**
  42  * Returned when the login was denied (a reason for AUTH_FAIL).
  43  */
  44 define('AUTH_DENIED', 2);
  45
  46 /**
  47  * Returned when some error occurred (a reason for AUTH_FAIL).
  48  */
  49 define('AUTH_ERROR',  4);
  50
  51 /**
  52  * Authentication - error codes for user confirm
  53  */
  54 define('AUTH_CONFIRM_FAIL', 0);
  55 define('AUTH_CONFIRM_OK', 1);
  56 define('AUTH_CONFIRM_ALREADY', 2);
  57 define('AUTH_CONFIRM_ERROR', 3);
  58
  59 # MDL-14055
  60 define('AUTH_REMOVEUSER_KEEP', 0);
  61 define('AUTH_REMOVEUSER_SUSPEND', 1);
  62 define('AUTH_REMOVEUSER_FULLDELETE', 2);
  63
  64 /** Login attempt successful. */
  65 define('AUTH_LOGIN_OK', 0);
  66
  67 /** Can not login because user does not exist. */
  68 define('AUTH_LOGIN_NOUSER', 1);
  69
  70 /** Can not login because user is suspended. */
  71 define('AUTH_LOGIN_SUSPENDED', 2);
  72
  73 /** Can not login, most probably password did not match. */
  74 define('AUTH_LOGIN_FAILED', 3);
  75
  76 /** Can not login because user is locked out. */
  77 define('AUTH_LOGIN_LOCKOUT', 4);
  78
  79 /** Can not login becauser user is not authorised. */
  80 define('AUTH_LOGIN_UNAUTHORISED', 5);
  81
  82 /**
  83  * Abstract authentication plugin.
  84  *
  85  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  86  * @package moodlecore
  87  */
  88 class auth_plugin_base {
  89
  90     /**
  91      * The configuration details for the plugin.
  92      * @var object
  93      */
  94     var $config;
  95
  96     /**
  97      * Authentication plugin type - the same as db field.
  98      * @var string
  99      */
 100     var $authtype;
 101     /*
 102      * The fields we can lock and update from/to external authentication backends
 103      * @var array
 104      */
 105     var $userfields = array(
 106         'firstname',
 107         'lastname',
 108         'email',
 109         'city',
 110         'country',
 111         'lang',
 112         'description',
 113         'url',
 114         'idnumber',
 115         'institution',
 116         'department',
 117         'phone1',
 118         'phone2',
 119         'address',
 120         'firstnamephonetic',
 121         'lastnamephonetic',
 122         'middlename',
 123         'alternatename'
 124     );
 125
 126     /**
 127      * Moodle custom fields to sync with.
 128      * @var array()
 129      */
 130     var $customfields = null;
 131
 132     /**
 133      * This is the primary method that is used by the authenticate_user_login()
 134      * function in moodlelib.php.
 135      *
 136      * This method should return a boolean indicating
 137      * whether or not the username and password authenticate successfully.
 138      *
 139      * Returns true if the username and password work and false if they are
 140      * wrong or don't exist.
 141      *
 142      * @param string $username The username (with system magic quotes)
 143      * @param string $password The password (with system magic quotes)
 144      *
 145      * @return bool Authentication success or failure.
 146      */
 147     function user_login($username, $password) {
 148         print_error('mustbeoveride', 'debug', '', 'user_login()' );
 149     }
 150
 151     /**
 152      * Returns true if this authentication plugin can change the users'
 153      * password.
 154      *
 155      * @return bool
 156      */
 157     function can_change_password() {
 158         //override if needed
 159         return false;
 160     }
 161
 162     /**
 163      * Returns the URL for changing the users' passwords, or empty if the default
 164      * URL can be used.
 165      *
 166      * This method is used if can_change_password() returns true.
 167      * This method is called only when user is logged in, it may use global $USER.
 168      * If you are using a plugin config variable in this method, please make sure it is set before using it,
 169      * as this method can be called even if the plugin is disabled, in which case the config values won't be set.
 170      *
 171      * @return moodle_url url of the profile page or null if standard used
 172      */
 173     function change_password_url() {
 174         //override if needed
 175         return null;
 176     }
 177
 178     /**
 179      * Returns true if this authentication plugin can edit the users'
 180      * profile.
 181      *
 182      * @return bool
 183      */
 184     function can_edit_profile() {
 185         //override if needed
 186         return true;
 187     }
 188
 189     /**
 190      * Returns the URL for editing the users' profile, or empty if the default
 191      * URL can be used.
 192      *
 193      * This method is used if can_edit_profile() returns true.
 194      * This method is called only when user is logged in, it may use global $USER.
 195      *
 196      * @return moodle_url url of the profile page or null if standard used
 197      */
 198     function edit_profile_url() {
 199         //override if needed
 200         return null;
 201     }
 202
 203     /**
 204      * Returns true if this authentication plugin is "internal".
 205      *
 206      * Internal plugins use password hashes from Moodle user table for authentication.
 207      *
 208      * @return bool
 209      */
 210     function is_internal() {
 211         //override if needed
 212         return true;
 213     }
 214
 215     /**
 216      * Returns false if this plugin is enabled but not configured.
 217      *
 218      * @return bool
 219      */
 220     public function is_configured() {
 221         return false;
 222     }
 223
 224     /**
 225      * Indicates if password hashes should be stored in local moodle database.
 226      * @return bool true means md5 password hash stored in user table, false means flag 'not_cached' stored there instead
 227      */
 228     function prevent_local_passwords() {
 229         return !$this->is_internal();
 230     }
 231
 232     /**
 233      * Indicates if moodle should automatically update internal user
 234      * records with data from external sources using the information
 235      * from get_userinfo() method.
 236      *
 237      * @return bool true means automatically copy data from ext to user table
 238      */
 239     function is_synchronised_with_external() {
 240         return !$this->is_internal();
 241     }
 242
 243     /**
 244      * Updates the user's password.
 245      *
 246      * In previous versions of Moodle, the function
 247      * auth_user_update_password accepted a username as the first parameter. The
 248      * revised function expects a user object.
 249      *
 250      * @param  object  $user        User table object
 251      * @param  string  $newpassword Plaintext password
 252      *
 253      * @return bool                  True on success
 254      */
 255     function user_update_password($user, $newpassword) {
 256         //override if needed
 257         return true;
 258     }
 259
 260     /**
 261      * Called when the user record is updated.
 262      * Modifies user in external database. It takes olduser (before changes) and newuser (after changes)
 263      * compares information saved modified information to external db.
 264      *
 265      * @param mixed $olduser     Userobject before modifications    (without system magic quotes)
 266      * @param mixed $newuser     Userobject new modified userobject (without system magic quotes)
 267      * @return boolean true if updated or update ignored; false if error
 268      *
 269      */
 270     function user_update($olduser, $newuser) {
 271         //override if needed
 272         return true;
 273     }
 274
 275     /**
 276      * User delete requested - internal user record is mared as deleted already, username not present anymore.
 277      *
 278      * Do any action in external database.
 279      *
 280      * @param object $user       Userobject before delete    (without system magic quotes)
 281      * @return void
 282      */
 283     function user_delete($olduser) {
 284         //override if needed
 285         return;
 286     }
 287
 288     /**
 289      * Returns true if plugin allows resetting of internal password.
 290      *
 291      * @return bool
 292      */
 293     function can_reset_password() {
 294         //override if needed
 295         return false;
 296     }
 297
 298     /**
 299      * Returns true if plugin allows resetting of internal password.
 300      *
 301      * @return bool
 302      */
 303     function can_signup() {
 304         //override if needed
 305         return false;
 306     }
 307
 308     /**
 309      * Sign up a new user ready for confirmation.
 310      * Password is passed in plaintext.
 311      *
 312      * @param object $user new user object
 313      * @param boolean $notify print notice with link and terminate
 314      */
 315     function user_signup($user, $notify=true) {
 316         //override when can signup
 317         print_error('mustbeoveride', 'debug', '', 'user_signup()' );
 318     }
 319
 320     /**
 321      * Return a form to capture user details for account creation.
 322      * This is used in /login/signup.php.
 323      * @return moodle_form A form which edits a record from the user table.
 324      */
 325     function signup_form() {
 326         global $CFG;
 327
 328         require_once($CFG->dirroot.'/login/signup_form.php');
 329         return new login_signup_form(null, null, 'post', '', array('autocomplete'=>'on'));
 330     }
 331
 332     /**
 333      * Returns true if plugin allows confirming of new users.
 334      *
 335      * @return bool
 336      */
 337     function can_confirm() {
 338         //override if needed
 339         return false;
 340     }
 341
 342     /**
 343      * Confirm the new user as registered.
 344      *
 345      * @param string $username
 346      * @param string $confirmsecret
 347      */
 348     function user_confirm($username, $confirmsecret) {
 349         //override when can confirm
 350         print_error('mustbeoveride', 'debug', '', 'user_confirm()' );
 351     }
 352
 353     /**
 354      * Checks if user exists in external db
 355      *
 356      * @param string $username (with system magic quotes)
 357      * @return bool
 358      */
 359     function user_exists($username) {
 360         //override if needed
 361         return false;
 362     }
 363
 364     /**
 365      * return number of days to user password expires
 366      *
 367      * If userpassword does not expire it should return 0. If password is already expired
 368      * it should return negative value.
 369      *
 370      * @param mixed $username username (with system magic quotes)
 371      * @return integer
 372      */
 373     function password_expire($username) {
 374         return 0;
 375     }
 376     /**
 377      * Sync roles for this user - usually creator
 378      *
 379      * @param $user object user object (without system magic quotes)
 380      */
 381     function sync_roles($user) {
 382         //override if needed
 383     }
 384
 385     /**
 386      * Read user information from external database and returns it as array().
 387      * Function should return all information available. If you are saving
 388      * this information to moodle user-table you should honour synchronisation flags
 389      *
 390      * @param string $username username
 391      *
 392      * @return mixed array with no magic quotes or false on error
 393      */
 394     function get_userinfo($username) {
 395         //override if needed
 396         return array();
 397     }
 398
 399     /**
 400      * Prints a form for configuring this authentication plugin.
 401      *
 402      * This function is called from admin/auth.php, and outputs a full page with
 403      * a form for configuring this plugin.
 404      *
 405      * @param object $config
 406      * @param object $err
 407      * @param array $user_fields
 408      */
 409     function config_form($config, $err, $user_fields) {
 410         //override if needed
 411     }
 412
 413     /**
 414      * A chance to validate form data, and last chance to
 415      * do stuff before it is inserted in config_plugin
 416      * @param object object with submitted configuration settings (without system magic quotes)
 417      * @param array $err array of error messages
 418      */
 419      function validate_form($form, &$err) {
 420         //override if needed
 421     }
 422
 423     /**
 424      * Processes and stores configuration data for this authentication plugin.
 425      *
 426      * @param object object with submitted configuration settings (without system magic quotes)
 427      */
 428     function process_config($config) {
 429         //override if needed
 430         return true;
 431     }
 432
 433     /**
 434      * Hook for overriding behaviour of login page.
 435      * This method is called from login/index.php page for all enabled auth plugins.
 436      *
 437      * @global object
 438      * @global object
 439      */
 440     function loginpage_hook() {
 441         global $frm;  // can be used to override submitted login form
 442         global $user; // can be used to replace authenticate_user_login()
 443
 444         //override if needed
 445     }
 446
 447     /**
 448      * Post authentication hook.
 449      * This method is called from authenticate_user_login() for all enabled auth plugins.
 450      *
 451      * @param object $user user object, later used for $USER
 452      * @param string $username (with system magic quotes)
 453      * @param string $password plain text password (with system magic quotes)
 454      */
 455     function user_authenticated_hook(&$user, $username, $password) {
 456         //override if needed
 457     }
 458
 459     /**
 460      * Pre logout hook.
 461      * This method is called from require_logout() for all enabled auth plugins,
 462      *
 463      * @global object
 464      */
 465     function prelogout_hook() {
 466         global $USER; // use $USER->auth to find the plugin used for login
 467
 468         //override if needed
 469     }
 470
 471     /**
 472      * Hook for overriding behaviour of logout page.
 473      * This method is called from login/logout.php page for all enabled auth plugins.
 474      *
 475      * @global object
 476      * @global string
 477      */
 478     function logoutpage_hook() {
 479         global $USER;     // use $USER->auth to find the plugin used for login
 480         global $redirect; // can be used to override redirect after logout
 481
 482         //override if needed
 483     }
 484
 485     /**
 486      * Hook called before timing out of database session.
 487      * This is useful for SSO and MNET.
 488      *
 489      * @param object $user
 490      * @param string $sid session id
 491      * @param int $timecreated start of session
 492      * @param int $timemodified user last seen
 493      * @return bool true means do not timeout session yet
 494      */
 495     function ignore_timeout_hook($user, $sid, $timecreated, $timemodified) {
 496         return false;
 497     }
 498
 499     /**
 500      * Return the properly translated human-friendly title of this auth plugin
 501      *
 502      * @todo Document this function
 503      */
 504     function get_title() {
 505         return get_string('pluginname', "auth_{$this->authtype}");
 506     }
 507
 508     /**
 509      * Get the auth description (from core or own auth lang files)
 510      *
 511      * @return string The description
 512      */
 513     function get_description() {
 514         $authdescription = get_string("auth_{$this->authtype}description", "auth_{$this->authtype}");
 515         return $authdescription;
 516     }
 517
 518     /**
 519      * Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.
 520      *
 521      * @abstract Implement in child classes
 522      * @return bool
 523      */
 524     function is_captcha_enabled() {
 525         return false;
 526     }
 527
 528     /**
 529      * Returns whether or not this authentication plugin can be manually set
 530      * for users, for example, when bulk uploading users.
 531      *
 532      * This should be overriden by authentication plugins where setting the
 533      * authentication method manually is allowed.
 534      *
 535      * @return bool
 536      * @since Moodle 2.6
 537      */
 538     function can_be_manually_set() {
 539         // Override if needed.
 540         return false;
 541     }
 542
 543     /**
 544      * Returns a list of potential IdPs that this authentication plugin supports.
 545      * This is used to provide links on the login page.
 546      *
 547      * @param string $wantsurl the relative url fragment the user wants to get to.  You can use this to compose a returnurl, for example
 548      *
 549      * @return array like:
 550      *              array(
 551      *                  array(
 552      *                      'url' => 'http://someurl',
 553      *                      'icon' => new pix_icon(...),
 554      *                      'name' => get_string('somename', 'auth_yourplugin'),
 555      *                 ),
 556      *             )
 557      */
 558     function loginpage_idp_list($wantsurl) {
 559         return array();
 560     }
 561
 562     /**
 563      * Return custom user profile fields.
 564      *
 565      * @return array list of custom fields.
 566      */
 567     public function get_custom_user_profile_fields() {
 568         global $DB;
 569         // If already retrieved then return.
 570         if (!is_null($this->customfields)) {
 571             return $this->customfields;
 572         }
 573
 574         $this->customfields = array();
 575         if ($proffields = $DB->get_records('user_info_field')) {
 576             foreach ($proffields as $proffield) {
 577                 $this->customfields[] = 'profile_field_'.$proffield->shortname;
 578             }
 579         }
 580         unset($proffields);
 581
 582         return $this->customfields;
 583     }
 584
 585     /**
 586      * Post logout hook.
 587      *
 588      * This method is used after moodle logout by auth classes to execute server logout.
 589      *
 590      * @param stdClass $user clone of USER object before the user session was terminated
 591      */
 592     public function postlogout_hook($user) {
 593     }
 594 }
 595
 596 /**
 597  * Verify if user is locked out.
 598  *
 599  * @param stdClass $user
 600  * @return bool true if user locked out
 601  */
 602 function login_is_lockedout($user) {
 603     global $CFG;
 604
 605     if ($user->mnethostid != $CFG->mnet_localhost_id) {
 606         return false;
 607     }
 608     if (isguestuser($user)) {
 609         return false;
 610     }
 611
 612     if (empty($CFG->lockoutthreshold)) {
 613         // Lockout not enabled.
 614         return false;
 615     }
 616
 617     if (get_user_preferences('login_lockout_ignored', 0, $user)) {
 618         // This preference may be used for accounts that must not be locked out.
 619         return false;
 620     }
 621
 622     $locked = get_user_preferences('login_lockout', 0, $user);
 623     if (!$locked) {
 624         return false;
 625     }
 626
 627     if (empty($CFG->lockoutduration)) {
 628         // Locked out forever.
 629         return true;
 630     }
 631
 632     if (time() - $locked < $CFG->lockoutduration) {
 633         return true;
 634     }
 635
 636     login_unlock_account($user);
 637
 638     return false;
 639 }
 640
 641 /**
 642  * To be called after valid user login.
 643  * @param stdClass $user
 644  */
 645 function login_attempt_valid($user) {
 646     global $CFG;
 647
 648     // Note: user_loggedin event is triggered in complete_user_login().
 649
 650     if ($user->mnethostid != $CFG->mnet_localhost_id) {
 651         return;
 652     }
 653     if (isguestuser($user)) {
 654         return;
 655     }
 656
 657     // Always unlock here, there might be some race conditions or leftovers when switching threshold.
 658     login_unlock_account($user);
 659 }
 660
 661 /**
 662  * To be called after failed user login.
 663  * @param stdClass $user
 664  */
 665 function login_attempt_failed($user) {
 666     global $CFG;
 667
 668     if ($user->mnethostid != $CFG->mnet_localhost_id) {
 669         return;
 670     }
 671     if (isguestuser($user)) {
 672         return;
 673     }
 674
 675     $count = get_user_preferences('login_failed_count', 0, $user);
 676     $last = get_user_preferences('login_failed_last', 0, $user);
 677     $sincescuccess = get_user_preferences('login_failed_count_since_success', $count, $user);
 678     $sincescuccess = $sincescuccess + 1;
 679     set_user_preference('login_failed_count_since_success', $sincescuccess, $user);
 680
 681     if (empty($CFG->lockoutthreshold)) {
 682         // No threshold means no lockout.
 683         // Always unlock here, there might be some race conditions or leftovers when switching threshold.
 684         login_unlock_account($user);
 685         return;
 686     }
 687
 688     if (!empty($CFG->lockoutwindow) and time() - $last > $CFG->lockoutwindow) {
 689         $count = 0;
 690     }
 691
 692     $count = $count+1;
 693
 694     set_user_preference('login_failed_count', $count, $user);
 695     set_user_preference('login_failed_last', time(), $user);
 696
 697     if ($count >= $CFG->lockoutthreshold) {
 698         login_lock_account($user);
 699     }
 700 }
 701
 702 /**
 703  * Lockout user and send notification email.
 704  *
 705  * @param stdClass $user
 706  */
 707 function login_lock_account($user) {
 708     global $CFG;
 709
 710     if ($user->mnethostid != $CFG->mnet_localhost_id) {
 711         return;
 712     }
 713     if (isguestuser($user)) {
 714         return;
 715     }
 716
 717     if (get_user_preferences('login_lockout_ignored', 0, $user)) {
 718         // This user can not be locked out.
 719         return;
 720     }
 721
 722     $alreadylockedout = get_user_preferences('login_lockout', 0, $user);
 723
 724     set_user_preference('login_lockout', time(), $user);
 725
 726     if ($alreadylockedout == 0) {
 727         $secret = random_string(15);
 728         set_user_preference('login_lockout_secret', $secret, $user);
 729
 730         $oldforcelang = force_current_language($user->lang);
 731
 732         $site = get_site();
 733         $supportuser = core_user::get_support_user();
 734
 735         $data = new stdClass();
 736         $data->firstname = $user->firstname;
 737         $data->lastname  = $user->lastname;
 738         $data->username  = $user->username;
 739         $data->sitename  = format_string($site->fullname);
 740         $data->link      = $CFG->wwwroot.'/login/unlock_account.php?u='.$user->id.'&s='.$secret;
 741         $data->admin     = generate_email_signoff();
 742
 743         $message = get_string('lockoutemailbody', 'admin', $data);
 744         $subject = get_string('lockoutemailsubject', 'admin', format_string($site->fullname));
 745
 746         if ($message) {
 747             // Directly email rather than using the messaging system to ensure its not routed to a popup or jabber.
 748             email_to_user($user, $supportuser, $subject, $message);
 749         }
 750
 751         force_current_language($oldforcelang);
 752     }
 753 }
 754
 755 /**
 756  * Unlock user account and reset timers.
 757  *
 758  * @param stdClass $user
 759  */
 760 function login_unlock_account($user) {
 761     unset_user_preference('login_lockout', $user);
 762     unset_user_preference('login_failed_count', $user);
 763     unset_user_preference('login_failed_last', $user);
 764
 765     // Note: do not clear the lockout secret because user might click on the link repeatedly.
 766 }