Merge branch 'MDL-64071-master' of https://github.com/UniGe/moodle
[moodle.git] / auth / ldap / auth.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Authentication Plugin: LDAP Authentication
19  * Authentication using LDAP (Lightweight Directory Access Protocol).
20  *
21  * @package auth_ldap
22  * @author Martin Dougiamas
23  * @author IƱaki Arenaza
24  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
25  */
27 defined('MOODLE_INTERNAL') || die();
29 // See http://support.microsoft.com/kb/305144 to interprete these values.
30 if (!defined('AUTH_AD_ACCOUNTDISABLE')) {
31     define('AUTH_AD_ACCOUNTDISABLE', 0x0002);
32 }
33 if (!defined('AUTH_AD_NORMAL_ACCOUNT')) {
34     define('AUTH_AD_NORMAL_ACCOUNT', 0x0200);
35 }
36 if (!defined('AUTH_NTLMTIMEOUT')) {  // timewindow for the NTLM SSO process, in secs...
37     define('AUTH_NTLMTIMEOUT', 10);
38 }
40 // UF_DONT_EXPIRE_PASSWD value taken from MSDN directly
41 if (!defined('UF_DONT_EXPIRE_PASSWD')) {
42     define ('UF_DONT_EXPIRE_PASSWD', 0x00010000);
43 }
45 // The Posix uid and gid of the 'nobody' account and 'nogroup' group.
46 if (!defined('AUTH_UID_NOBODY')) {
47     define('AUTH_UID_NOBODY', -2);
48 }
49 if (!defined('AUTH_GID_NOGROUP')) {
50     define('AUTH_GID_NOGROUP', -2);
51 }
53 // Regular expressions for a valid NTLM username and domain name.
54 if (!defined('AUTH_NTLM_VALID_USERNAME')) {
55     define('AUTH_NTLM_VALID_USERNAME', '[^/\\\\\\\\\[\]:;|=,+*?<>@"]+');
56 }
57 if (!defined('AUTH_NTLM_VALID_DOMAINNAME')) {
58     define('AUTH_NTLM_VALID_DOMAINNAME', '[^\\\\\\\\\/:*?"<>|]+');
59 }
60 // Default format for remote users if using NTLM SSO
61 if (!defined('AUTH_NTLM_DEFAULT_FORMAT')) {
62     define('AUTH_NTLM_DEFAULT_FORMAT', '%domain%\\%username%');
63 }
64 if (!defined('AUTH_NTLM_FASTPATH_ATTEMPT')) {
65     define('AUTH_NTLM_FASTPATH_ATTEMPT', 0);
66 }
67 if (!defined('AUTH_NTLM_FASTPATH_YESFORM')) {
68     define('AUTH_NTLM_FASTPATH_YESFORM', 1);
69 }
70 if (!defined('AUTH_NTLM_FASTPATH_YESATTEMPT')) {
71     define('AUTH_NTLM_FASTPATH_YESATTEMPT', 2);
72 }
74 // Allows us to retrieve a diagnostic message in case of LDAP operation error
75 if (!defined('LDAP_OPT_DIAGNOSTIC_MESSAGE')) {
76     define('LDAP_OPT_DIAGNOSTIC_MESSAGE', 0x0032);
77 }
79 require_once($CFG->libdir.'/authlib.php');
80 require_once($CFG->libdir.'/ldaplib.php');
81 require_once($CFG->dirroot.'/user/lib.php');
82 require_once($CFG->dirroot.'/auth/ldap/locallib.php');
84 /**
85  * LDAP authentication plugin.
86  */
87 class auth_plugin_ldap extends auth_plugin_base {
89     /**
90      * Init plugin config from database settings depending on the plugin auth type.
91      */
92     function init_plugin($authtype) {
93         $this->pluginconfig = 'auth_'.$authtype;
94         $this->config = get_config($this->pluginconfig);
95         if (empty($this->config->ldapencoding)) {
96             $this->config->ldapencoding = 'utf-8';
97         }
98         if (empty($this->config->user_type)) {
99             $this->config->user_type = 'default';
100         }
102         $ldap_usertypes = ldap_supported_usertypes();
103         $this->config->user_type_name = $ldap_usertypes[$this->config->user_type];
104         unset($ldap_usertypes);
106         $default = ldap_getdefaults();
108         // Use defaults if values not given
109         foreach ($default as $key => $value) {
110             // watch out - 0, false are correct values too
111             if (!isset($this->config->{$key}) or $this->config->{$key} == '') {
112                 $this->config->{$key} = $value[$this->config->user_type];
113             }
114         }
116         // Hack prefix to objectclass
117         $this->config->objectclass = ldap_normalise_objectclass($this->config->objectclass);
118     }
120     /**
121      * Constructor with initialisation.
122      */
123     public function __construct() {
124         $this->authtype = 'ldap';
125         $this->roleauth = 'auth_ldap';
126         $this->errorlogtag = '[AUTH LDAP] ';
127         $this->init_plugin($this->authtype);
128     }
130     /**
131      * Old syntax of class constructor. Deprecated in PHP7.
132      *
133      * @deprecated since Moodle 3.1
134      */
135     public function auth_plugin_ldap() {
136         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
137         self::__construct();
138     }
140     /**
141      * Returns true if the username and password work and false if they are
142      * wrong or don't exist.
143      *
144      * @param string $username The username (without system magic quotes)
145      * @param string $password The password (without system magic quotes)
146      *
147      * @return bool Authentication success or failure.
148      */
149     function user_login($username, $password) {
150         if (! function_exists('ldap_bind')) {
151             print_error('auth_ldapnotinstalled', 'auth_ldap');
152             return false;
153         }
155         if (!$username or !$password) {    // Don't allow blank usernames or passwords
156             return false;
157         }
159         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
160         $extpassword = core_text::convert($password, 'utf-8', $this->config->ldapencoding);
162         // Before we connect to LDAP, check if this is an AD SSO login
163         // if we succeed in this block, we'll return success early.
164         //
165         $key = sesskey();
166         if (!empty($this->config->ntlmsso_enabled) && $key === $password) {
167             $sessusername = get_cache_flag($this->pluginconfig.'/ntlmsess', $key);
168             // We only get the cache flag if we retrieve it before
169             // it expires (AUTH_NTLMTIMEOUT seconds).
170             if (empty($sessusername)) {
171                 return false;
172             }
174             if ($username === $sessusername) {
175                 unset($sessusername);
177                 // Check that the user is inside one of the configured LDAP contexts
178                 $validuser = false;
179                 $ldapconnection = $this->ldap_connect();
180                 // if the user is not inside the configured contexts,
181                 // ldap_find_userdn returns false.
182                 if ($this->ldap_find_userdn($ldapconnection, $extusername)) {
183                     $validuser = true;
184                 }
185                 $this->ldap_close();
187                 // Shortcut here - SSO confirmed
188                 return $validuser;
189             }
190         } // End SSO processing
191         unset($key);
193         $ldapconnection = $this->ldap_connect();
194         $ldap_user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
196         // If ldap_user_dn is empty, user does not exist
197         if (!$ldap_user_dn) {
198             $this->ldap_close();
199             return false;
200         }
202         // Try to bind with current username and password
203         $ldap_login = @ldap_bind($ldapconnection, $ldap_user_dn, $extpassword);
205         // If login fails and we are using MS Active Directory, retrieve the diagnostic
206         // message to see if this is due to an expired password, or that the user is forced to
207         // change the password on first login. If it is, only proceed if we can change
208         // password from Moodle (otherwise we'll get stuck later in the login process).
209         if (!$ldap_login && ($this->config->user_type == 'ad')
210             && $this->can_change_password()
211             && (!empty($this->config->expiration) and ($this->config->expiration == 1))) {
213             // We need to get the diagnostic message right after the call to ldap_bind(),
214             // before any other LDAP operation.
215             ldap_get_option($ldapconnection, LDAP_OPT_DIAGNOSTIC_MESSAGE, $diagmsg);
217             if ($this->ldap_ad_pwdexpired_from_diagmsg($diagmsg)) {
218                 // If login failed because user must change the password now or the
219                 // password has expired, let the user in. We'll catch this later in the
220                 // login process when we explicitly check for expired passwords.
221                 $ldap_login = true;
222             }
223         }
224         $this->ldap_close();
225         return $ldap_login;
226     }
228     /**
229      * Reads user information from ldap and returns it in array()
230      *
231      * Function should return all information available. If you are saving
232      * this information to moodle user-table you should honor syncronization flags
233      *
234      * @param string $username username
235      *
236      * @return mixed array with no magic quotes or false on error
237      */
238     function get_userinfo($username) {
239         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
241         $ldapconnection = $this->ldap_connect();
242         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extusername))) {
243             $this->ldap_close();
244             return false;
245         }
247         $search_attribs = array();
248         $attrmap = $this->ldap_attributes();
249         foreach ($attrmap as $key => $values) {
250             if (!is_array($values)) {
251                 $values = array($values);
252             }
253             foreach ($values as $value) {
254                 if (!in_array($value, $search_attribs)) {
255                     array_push($search_attribs, $value);
256                 }
257             }
258         }
260         if (!$user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs)) {
261             $this->ldap_close();
262             return false; // error!
263         }
265         $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
266         if (empty($user_entry)) {
267             $this->ldap_close();
268             return false; // entry not found
269         }
271         $result = array();
272         foreach ($attrmap as $key => $values) {
273             if (!is_array($values)) {
274                 $values = array($values);
275             }
276             $ldapval = NULL;
277             foreach ($values as $value) {
278                 $entry = $user_entry[0];
279                 if (($value == 'dn') || ($value == 'distinguishedname')) {
280                     $result[$key] = $user_dn;
281                     continue;
282                 }
283                 if (!array_key_exists($value, $entry)) {
284                     continue; // wrong data mapping!
285                 }
286                 if (is_array($entry[$value])) {
287                     $newval = core_text::convert($entry[$value][0], $this->config->ldapencoding, 'utf-8');
288                 } else {
289                     $newval = core_text::convert($entry[$value], $this->config->ldapencoding, 'utf-8');
290                 }
291                 if (!empty($newval)) { // favour ldap entries that are set
292                     $ldapval = $newval;
293                 }
294             }
295             if (!is_null($ldapval)) {
296                 $result[$key] = $ldapval;
297             }
298         }
300         $this->ldap_close();
301         return $result;
302     }
304     /**
305      * Reads user information from ldap and returns it in an object
306      *
307      * @param string $username username (with system magic quotes)
308      * @return mixed object or false on error
309      */
310     function get_userinfo_asobj($username) {
311         $user_array = $this->get_userinfo($username);
312         if ($user_array == false) {
313             return false; //error or not found
314         }
315         $user_array = truncate_userinfo($user_array);
316         $user = new stdClass();
317         foreach ($user_array as $key=>$value) {
318             $user->{$key} = $value;
319         }
320         return $user;
321     }
323     /**
324      * Returns all usernames from LDAP
325      *
326      * get_userlist returns all usernames from LDAP
327      *
328      * @return array
329      */
330     function get_userlist() {
331         return $this->ldap_get_userlist("({$this->config->user_attribute}=*)");
332     }
334     /**
335      * Checks if user exists on LDAP
336      *
337      * @param string $username
338      */
339     function user_exists($username) {
340         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
342         // Returns true if given username exists on ldap
343         $users = $this->ldap_get_userlist('('.$this->config->user_attribute.'='.ldap_filter_addslashes($extusername).')');
344         return count($users);
345     }
347     /**
348      * Creates a new user on LDAP.
349      * By using information in userobject
350      * Use user_exists to prevent duplicate usernames
351      *
352      * @param mixed $userobject  Moodle userobject
353      * @param mixed $plainpass   Plaintext password
354      */
355     function user_create($userobject, $plainpass) {
356         $extusername = core_text::convert($userobject->username, 'utf-8', $this->config->ldapencoding);
357         $extpassword = core_text::convert($plainpass, 'utf-8', $this->config->ldapencoding);
359         switch ($this->config->passtype) {
360             case 'md5':
361                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
362                 break;
363             case 'sha1':
364                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
365                 break;
366             case 'plaintext':
367             default:
368                 break; // plaintext
369         }
371         $ldapconnection = $this->ldap_connect();
372         $attrmap = $this->ldap_attributes();
374         $newuser = array();
376         foreach ($attrmap as $key => $values) {
377             if (!is_array($values)) {
378                 $values = array($values);
379             }
380             foreach ($values as $value) {
381                 if (!empty($userobject->$key) ) {
382                     $newuser[$value] = core_text::convert($userobject->$key, 'utf-8', $this->config->ldapencoding);
383                 }
384             }
385         }
387         //Following sets all mandatory and other forced attribute values
388         //User should be creted as login disabled untill email confirmation is processed
389         //Feel free to add your user type and send patches to paca@sci.fi to add them
390         //Moodle distribution
392         switch ($this->config->user_type)  {
393             case 'edir':
394                 $newuser['objectClass']   = array('inetOrgPerson', 'organizationalPerson', 'person', 'top');
395                 $newuser['uniqueId']      = $extusername;
396                 $newuser['logindisabled'] = 'TRUE';
397                 $newuser['userpassword']  = $extpassword;
398                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
399                 break;
400             case 'rfc2307':
401             case 'rfc2307bis':
402                 // posixAccount object class forces us to specify a uidNumber
403                 // and a gidNumber. That is quite complicated to generate from
404                 // Moodle without colliding with existing numbers and without
405                 // race conditions. As this user is supposed to be only used
406                 // with Moodle (otherwise the user would exist beforehand) and
407                 // doesn't need to login into a operating system, we assign the
408                 // user the uid of user 'nobody' and gid of group 'nogroup'. In
409                 // addition to that, we need to specify a home directory. We
410                 // use the root directory ('/') as the home directory, as this
411                 // is the only one can always be sure exists. Finally, even if
412                 // it's not mandatory, we specify '/bin/false' as the login
413                 // shell, to prevent the user from login in at the operating
414                 // system level (Moodle ignores this).
416                 $newuser['objectClass']   = array('posixAccount', 'inetOrgPerson', 'organizationalPerson', 'person', 'top');
417                 $newuser['cn']            = $extusername;
418                 $newuser['uid']           = $extusername;
419                 $newuser['uidNumber']     = AUTH_UID_NOBODY;
420                 $newuser['gidNumber']     = AUTH_GID_NOGROUP;
421                 $newuser['homeDirectory'] = '/';
422                 $newuser['loginShell']    = '/bin/false';
424                 // IMPORTANT:
425                 // We have to create the account locked, but posixAccount has
426                 // no attribute to achive this reliably. So we are going to
427                 // modify the password in a reversable way that we can later
428                 // revert in user_activate().
429                 //
430                 // Beware that this can be defeated by the user if we are not
431                 // using MD5 or SHA-1 passwords. After all, the source code of
432                 // Moodle is available, and the user can see the kind of
433                 // modification we are doing and 'undo' it by hand (but only
434                 // if we are using plain text passwords).
435                 //
436                 // Also bear in mind that you need to use a binding user that
437                 // can create accounts and has read/write privileges on the
438                 // 'userPassword' attribute for this to work.
440                 $newuser['userPassword']  = '*'.$extpassword;
441                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
442                 break;
443             case 'ad':
444                 // User account creation is a two step process with AD. First you
445                 // create the user object, then you set the password. If you try
446                 // to set the password while creating the user, the operation
447                 // fails.
449                 // Passwords in Active Directory must be encoded as Unicode
450                 // strings (UCS-2 Little Endian format) and surrounded with
451                 // double quotes. See http://support.microsoft.com/?kbid=269190
452                 if (!function_exists('mb_convert_encoding')) {
453                     print_error('auth_ldap_no_mbstring', 'auth_ldap');
454                 }
456                 // Check for invalid sAMAccountName characters.
457                 if (preg_match('#[/\\[\]:;|=,+*?<>@"]#', $extusername)) {
458                     print_error ('auth_ldap_ad_invalidchars', 'auth_ldap');
459                 }
461                 // First create the user account, and mark it as disabled.
462                 $newuser['objectClass'] = array('top', 'person', 'user', 'organizationalPerson');
463                 $newuser['sAMAccountName'] = $extusername;
464                 $newuser['userAccountControl'] = AUTH_AD_NORMAL_ACCOUNT |
465                                                  AUTH_AD_ACCOUNTDISABLE;
466                 $userdn = 'cn='.ldap_addslashes($extusername).','.$this->config->create_context;
467                 if (!ldap_add($ldapconnection, $userdn, $newuser)) {
468                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
469                 }
471                 // Now set the password
472                 unset($newuser);
473                 $newuser['unicodePwd'] = mb_convert_encoding('"' . $extpassword . '"',
474                                                              'UCS-2LE', 'UTF-8');
475                 if(!ldap_modify($ldapconnection, $userdn, $newuser)) {
476                     // Something went wrong: delete the user account and error out
477                     ldap_delete ($ldapconnection, $userdn);
478                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
479                 }
480                 $uadd = true;
481                 break;
482             default:
483                print_error('auth_ldap_unsupportedusertype', 'auth_ldap', '', $this->config->user_type_name);
484         }
485         $this->ldap_close();
486         return $uadd;
487     }
489     /**
490      * Returns true if plugin allows resetting of password from moodle.
491      *
492      * @return bool
493      */
494     function can_reset_password() {
495         return !empty($this->config->stdchangepassword);
496     }
498     /**
499      * Returns true if plugin can be manually set.
500      *
501      * @return bool
502      */
503     function can_be_manually_set() {
504         return true;
505     }
507     /**
508      * Returns true if plugin allows signup and user creation.
509      *
510      * @return bool
511      */
512     function can_signup() {
513         return (!empty($this->config->auth_user_create) and !empty($this->config->create_context));
514     }
516     /**
517      * Sign up a new user ready for confirmation.
518      * Password is passed in plaintext.
519      *
520      * @param object $user new user object
521      * @param boolean $notify print notice with link and terminate
522      * @return boolean success
523      */
524     function user_signup($user, $notify=true) {
525         global $CFG, $DB, $PAGE, $OUTPUT;
527         require_once($CFG->dirroot.'/user/profile/lib.php');
528         require_once($CFG->dirroot.'/user/lib.php');
530         if ($this->user_exists($user->username)) {
531             print_error('auth_ldap_user_exists', 'auth_ldap');
532         }
534         $plainslashedpassword = $user->password;
535         unset($user->password);
537         if (! $this->user_create($user, $plainslashedpassword)) {
538             print_error('auth_ldap_create_error', 'auth_ldap');
539         }
541         $user->id = user_create_user($user, false, false);
543         user_add_password_history($user->id, $plainslashedpassword);
545         // Save any custom profile field information
546         profile_save_data($user);
548         $userinfo = $this->get_userinfo($user->username);
549         $this->update_user_record($user->username, false, false, $this->is_user_suspended((object) $userinfo));
551         // This will also update the stored hash to the latest algorithm
552         // if the existing hash is using an out-of-date algorithm (or the
553         // legacy md5 algorithm).
554         update_internal_user_password($user, $plainslashedpassword);
556         $user = $DB->get_record('user', array('id'=>$user->id));
558         \core\event\user_created::create_from_userid($user->id)->trigger();
560         if (! send_confirmation_email($user)) {
561             print_error('noemail', 'auth_ldap');
562         }
564         if ($notify) {
565             $emailconfirm = get_string('emailconfirm');
566             $PAGE->set_url('/auth/ldap/auth.php');
567             $PAGE->navbar->add($emailconfirm);
568             $PAGE->set_title($emailconfirm);
569             $PAGE->set_heading($emailconfirm);
570             echo $OUTPUT->header();
571             notice(get_string('emailconfirmsent', '', $user->email), "{$CFG->wwwroot}/index.php");
572         } else {
573             return true;
574         }
575     }
577     /**
578      * Returns true if plugin allows confirming of new users.
579      *
580      * @return bool
581      */
582     function can_confirm() {
583         return $this->can_signup();
584     }
586     /**
587      * Confirm the new user as registered.
588      *
589      * @param string $username
590      * @param string $confirmsecret
591      */
592     function user_confirm($username, $confirmsecret) {
593         global $DB;
595         $user = get_complete_user_data('username', $username);
597         if (!empty($user)) {
598             if ($user->auth != $this->authtype) {
599                 return AUTH_CONFIRM_ERROR;
601             } else if ($user->secret == $confirmsecret && $user->confirmed) {
602                 return AUTH_CONFIRM_ALREADY;
604             } else if ($user->secret == $confirmsecret) {   // They have provided the secret key to get in
605                 if (!$this->user_activate($username)) {
606                     return AUTH_CONFIRM_FAIL;
607                 }
608                 $user->confirmed = 1;
609                 user_update_user($user, false);
610                 return AUTH_CONFIRM_OK;
611             }
612         } else {
613             return AUTH_CONFIRM_ERROR;
614         }
615     }
617     /**
618      * Return number of days to user password expires
619      *
620      * If userpassword does not expire it should return 0. If password is already expired
621      * it should return negative value.
622      *
623      * @param mixed $username username
624      * @return integer
625      */
626     function password_expire($username) {
627         $result = 0;
629         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
631         $ldapconnection = $this->ldap_connect();
632         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
633         $search_attribs = array($this->config->expireattr);
634         $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
635         if ($sr)  {
636             $info = ldap_get_entries_moodle($ldapconnection, $sr);
637             if (!empty ($info)) {
638                 $info = $info[0];
639                 if (isset($info[$this->config->expireattr][0])) {
640                     $expiretime = $this->ldap_expirationtime2unix($info[$this->config->expireattr][0], $ldapconnection, $user_dn);
641                     if ($expiretime != 0) {
642                         $now = time();
643                         if ($expiretime > $now) {
644                             $result = ceil(($expiretime - $now) / DAYSECS);
645                         } else {
646                             $result = floor(($expiretime - $now) / DAYSECS);
647                         }
648                     }
649                 }
650             }
651         } else {
652             error_log($this->errorlogtag.get_string('didtfindexpiretime', 'auth_ldap'));
653         }
655         return $result;
656     }
658     /**
659      * Syncronizes user fron external LDAP server to moodle user table
660      *
661      * Sync is now using username attribute.
662      *
663      * Syncing users removes or suspends users that dont exists anymore in external LDAP.
664      * Creates new users and updates coursecreator status of users.
665      *
666      * @param bool $do_updates will do pull in data updates from LDAP if relevant
667      */
668     function sync_users($do_updates=true) {
669         global $CFG, $DB;
671         require_once($CFG->dirroot . '/user/profile/lib.php');
673         print_string('connectingldap', 'auth_ldap');
674         $ldapconnection = $this->ldap_connect();
676         $dbman = $DB->get_manager();
678     /// Define table user to be created
679         $table = new xmldb_table('tmp_extuser');
680         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
681         $table->add_field('username', XMLDB_TYPE_CHAR, '100', null, XMLDB_NOTNULL, null, null);
682         $table->add_field('mnethostid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null);
683         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
684         $table->add_index('username', XMLDB_INDEX_UNIQUE, array('mnethostid', 'username'));
686         print_string('creatingtemptable', 'auth_ldap', 'tmp_extuser');
687         $dbman->create_temp_table($table);
689         ////
690         //// get user's list from ldap to sql in a scalable fashion
691         ////
692         // prepare some data we'll need
693         $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
695         $contexts = explode(';', $this->config->contexts);
697         if (!empty($this->config->create_context)) {
698             array_push($contexts, $this->config->create_context);
699         }
701         $ldappagedresults = ldap_paged_results_supported($this->config->ldap_version, $ldapconnection);
702         $ldapcookie = '';
703         foreach ($contexts as $context) {
704             $context = trim($context);
705             if (empty($context)) {
706                 continue;
707             }
709             do {
710                 if ($ldappagedresults) {
711                     ldap_control_paged_result($ldapconnection, $this->config->pagesize, true, $ldapcookie);
712                 }
713                 if ($this->config->search_sub) {
714                     // Use ldap_search to find first user from subtree.
715                     $ldapresult = ldap_search($ldapconnection, $context, $filter, array($this->config->user_attribute));
716                 } else {
717                     // Search only in this context.
718                     $ldapresult = ldap_list($ldapconnection, $context, $filter, array($this->config->user_attribute));
719                 }
720                 if (!$ldapresult) {
721                     continue;
722                 }
723                 if ($ldappagedresults) {
724                     $pagedresp = ldap_control_paged_result_response($ldapconnection, $ldapresult, $ldapcookie);
725                     // Function ldap_control_paged_result_response() does not overwrite $ldapcookie if it fails, by
726                     // setting this to null we avoid an infinite loop.
727                     if ($pagedresp === false) {
728                         $ldapcookie = null;
729                     }
730                 }
731                 if ($entry = @ldap_first_entry($ldapconnection, $ldapresult)) {
732                     do {
733                         $value = ldap_get_values_len($ldapconnection, $entry, $this->config->user_attribute);
734                         $value = core_text::convert($value[0], $this->config->ldapencoding, 'utf-8');
735                         $value = trim($value);
736                         $this->ldap_bulk_insert($value);
737                     } while ($entry = ldap_next_entry($ldapconnection, $entry));
738                 }
739                 unset($ldapresult); // Free mem.
740             } while ($ldappagedresults && $ldapcookie !== null && $ldapcookie != '');
741         }
743         // If LDAP paged results were used, the current connection must be completely
744         // closed and a new one created, to work without paged results from here on.
745         if ($ldappagedresults) {
746             $this->ldap_close(true);
747             $ldapconnection = $this->ldap_connect();
748         }
750         /// preserve our user database
751         /// if the temp table is empty, it probably means that something went wrong, exit
752         /// so as to avoid mass deletion of users; which is hard to undo
753         $count = $DB->count_records_sql('SELECT COUNT(username) AS count, 1 FROM {tmp_extuser}');
754         if ($count < 1) {
755             print_string('didntgetusersfromldap', 'auth_ldap');
756             $dbman->drop_table($table);
757             $this->ldap_close();
758             return false;
759         } else {
760             print_string('gotcountrecordsfromldap', 'auth_ldap', $count);
761         }
764 /// User removal
765         // Find users in DB that aren't in ldap -- to be removed!
766         // this is still not as scalable (but how often do we mass delete?)
768         if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
769             $sql = "SELECT u.*
770                       FROM {user} u
771                  LEFT JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
772                      WHERE u.auth = :auth
773                            AND u.deleted = 0
774                            AND e.username IS NULL";
775             $remove_users = $DB->get_records_sql($sql, array('auth'=>$this->authtype));
777             if (!empty($remove_users)) {
778                 print_string('userentriestoremove', 'auth_ldap', count($remove_users));
779                 foreach ($remove_users as $user) {
780                     if (delete_user($user)) {
781                         echo "\t"; print_string('auth_dbdeleteuser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
782                     } else {
783                         echo "\t"; print_string('auth_dbdeleteusererror', 'auth_db', $user->username); echo "\n";
784                     }
785                 }
786             } else {
787                 print_string('nouserentriestoremove', 'auth_ldap');
788             }
789             unset($remove_users); // Free mem!
791         } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
792             $sql = "SELECT u.*
793                       FROM {user} u
794                  LEFT JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
795                      WHERE u.auth = :auth
796                            AND u.deleted = 0
797                            AND u.suspended = 0
798                            AND e.username IS NULL";
799             $remove_users = $DB->get_records_sql($sql, array('auth'=>$this->authtype));
801             if (!empty($remove_users)) {
802                 print_string('userentriestoremove', 'auth_ldap', count($remove_users));
804                 foreach ($remove_users as $user) {
805                     $updateuser = new stdClass();
806                     $updateuser->id = $user->id;
807                     $updateuser->suspended = 1;
808                     user_update_user($updateuser, false);
809                     echo "\t"; print_string('auth_dbsuspenduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
810                     \core\session\manager::kill_user_sessions($user->id);
811                 }
812             } else {
813                 print_string('nouserentriestoremove', 'auth_ldap');
814             }
815             unset($remove_users); // Free mem!
816         }
818 /// Revive suspended users
819         if (!empty($this->config->removeuser) and $this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
820             $sql = "SELECT u.id, u.username
821                       FROM {user} u
822                       JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
823                      WHERE (u.auth = 'nologin' OR (u.auth = ? AND u.suspended = 1)) AND u.deleted = 0";
824             // Note: 'nologin' is there for backwards compatibility.
825             $revive_users = $DB->get_records_sql($sql, array($this->authtype));
827             if (!empty($revive_users)) {
828                 print_string('userentriestorevive', 'auth_ldap', count($revive_users));
830                 foreach ($revive_users as $user) {
831                     $updateuser = new stdClass();
832                     $updateuser->id = $user->id;
833                     $updateuser->auth = $this->authtype;
834                     $updateuser->suspended = 0;
835                     user_update_user($updateuser, false);
836                     echo "\t"; print_string('auth_dbreviveduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
837                 }
838             } else {
839                 print_string('nouserentriestorevive', 'auth_ldap');
840             }
842             unset($revive_users);
843         }
846 /// User Updates - time-consuming (optional)
847         if ($do_updates) {
848             // Narrow down what fields we need to update
849             $updatekeys = $this->get_profile_keys();
851         } else {
852             print_string('noupdatestobedone', 'auth_ldap');
853         }
854         if ($do_updates and !empty($updatekeys)) { // run updates only if relevant
855             $users = $DB->get_records_sql('SELECT u.username, u.id
856                                              FROM {user} u
857                                             WHERE u.deleted = 0 AND u.auth = ? AND u.mnethostid = ?',
858                                           array($this->authtype, $CFG->mnet_localhost_id));
859             if (!empty($users)) {
860                 print_string('userentriestoupdate', 'auth_ldap', count($users));
862                 $transaction = $DB->start_delegated_transaction();
863                 $xcount = 0;
864                 $maxxcount = 100;
866                 foreach ($users as $user) {
867                     echo "\t"; print_string('auth_dbupdatinguser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id));
868                     $userinfo = $this->get_userinfo($user->username);
869                     if (!$this->update_user_record($user->username, $updatekeys, true,
870                             $this->is_user_suspended((object) $userinfo))) {
871                         echo ' - '.get_string('skipped');
872                     }
873                     echo "\n";
874                     $xcount++;
876                     // Update system roles, if needed.
877                     $this->sync_roles($user);
878                 }
879                 $transaction->allow_commit();
880                 unset($users); // free mem
881             }
882         } else { // end do updates
883             print_string('noupdatestobedone', 'auth_ldap');
884         }
886 /// User Additions
887         // Find users missing in DB that are in LDAP
888         // and gives me a nifty object I don't want.
889         // note: we do not care about deleted accounts anymore, this feature was replaced by suspending to nologin auth plugin
890         $sql = 'SELECT e.id, e.username
891                   FROM {tmp_extuser} e
892                   LEFT JOIN {user} u ON (e.username = u.username AND e.mnethostid = u.mnethostid)
893                  WHERE u.id IS NULL';
894         $add_users = $DB->get_records_sql($sql);
896         if (!empty($add_users)) {
897             print_string('userentriestoadd', 'auth_ldap', count($add_users));
899             $transaction = $DB->start_delegated_transaction();
900             foreach ($add_users as $user) {
901                 $user = $this->get_userinfo_asobj($user->username);
903                 // Prep a few params
904                 $user->modified   = time();
905                 $user->confirmed  = 1;
906                 $user->auth       = $this->authtype;
907                 $user->mnethostid = $CFG->mnet_localhost_id;
908                 // get_userinfo_asobj() might have replaced $user->username with the value
909                 // from the LDAP server (which can be mixed-case). Make sure it's lowercase
910                 $user->username = trim(core_text::strtolower($user->username));
911                 // It isn't possible to just rely on the configured suspension attribute since
912                 // things like active directory use bit masks, other things using LDAP might
913                 // do different stuff as well.
914                 //
915                 // The cast to int is a workaround for MDL-53959.
916                 $user->suspended = (int)$this->is_user_suspended($user);
917                 if (empty($user->lang)) {
918                     $user->lang = $CFG->lang;
919                 }
920                 if (empty($user->calendartype)) {
921                     $user->calendartype = $CFG->calendartype;
922                 }
924                 $id = user_create_user($user, false);
925                 echo "\t"; print_string('auth_dbinsertuser', 'auth_db', array('name'=>$user->username, 'id'=>$id)); echo "\n";
926                 $euser = $DB->get_record('user', array('id' => $id));
928                 if (!empty($this->config->forcechangepassword)) {
929                     set_user_preference('auth_forcepasswordchange', 1, $id);
930                 }
932                 // Save custom profile fields.
933                 $this->update_user_record($user->username, $this->get_profile_keys(true), false);
935                 // Add roles if needed.
936                 $this->sync_roles($euser);
938             }
939             $transaction->allow_commit();
940             unset($add_users); // free mem
941         } else {
942             print_string('nouserstobeadded', 'auth_ldap');
943         }
945         $dbman->drop_table($table);
946         $this->ldap_close();
948         return true;
949     }
951     /**
952      * Bulk insert in SQL's temp table
953      */
954     function ldap_bulk_insert($username) {
955         global $DB, $CFG;
957         $username = core_text::strtolower($username); // usernames are __always__ lowercase.
958         $DB->insert_record_raw('tmp_extuser', array('username'=>$username,
959                                                     'mnethostid'=>$CFG->mnet_localhost_id), false, true);
960         echo '.';
961     }
963     /**
964      * Activates (enables) user in external LDAP so user can login
965      *
966      * @param mixed $username
967      * @return boolean result
968      */
969     function user_activate($username) {
970         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
972         $ldapconnection = $this->ldap_connect();
974         $userdn = $this->ldap_find_userdn($ldapconnection, $extusername);
975         switch ($this->config->user_type)  {
976             case 'edir':
977                 $newinfo['loginDisabled'] = 'FALSE';
978                 break;
979             case 'rfc2307':
980             case 'rfc2307bis':
981                 // Remember that we add a '*' character in front of the
982                 // external password string to 'disable' the account. We just
983                 // need to remove it.
984                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
985                                 array('userPassword'));
986                 $info = ldap_get_entries($ldapconnection, $sr);
987                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
988                 $newinfo['userPassword'] = ltrim($info[0]['userpassword'][0], '*');
989                 break;
990             case 'ad':
991                 // We need to unset the ACCOUNTDISABLE bit in the
992                 // userAccountControl attribute ( see
993                 // http://support.microsoft.com/kb/305144 )
994                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
995                                 array('userAccountControl'));
996                 $info = ldap_get_entries($ldapconnection, $sr);
997                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
998                 $newinfo['userAccountControl'] = $info[0]['useraccountcontrol'][0]
999                                                  & (~AUTH_AD_ACCOUNTDISABLE);
1000                 break;
1001             default:
1002                 print_error('user_activatenotsupportusertype', 'auth_ldap', '', $this->config->user_type_name);
1003         }
1004         $result = ldap_modify($ldapconnection, $userdn, $newinfo);
1005         $this->ldap_close();
1006         return $result;
1007     }
1009     /**
1010      * Returns true if user should be coursecreator.
1011      *
1012      * @param mixed $username    username (without system magic quotes)
1013      * @return mixed result      null if course creators is not configured, boolean otherwise.
1014      *
1015      * @deprecated since Moodle 3.4 MDL-30634 - please do not use this function any more.
1016      */
1017     function iscreator($username) {
1018         debugging('iscreator() is deprecated. Please use auth_plugin_ldap::is_role() instead.', DEBUG_DEVELOPER);
1020         if (empty($this->config->creators) or empty($this->config->memberattribute)) {
1021             return null;
1022         }
1024         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1026         $ldapconnection = $this->ldap_connect();
1028         if ($this->config->memberattribute_isdn) {
1029             if(!($userid = $this->ldap_find_userdn($ldapconnection, $extusername))) {
1030                 return false;
1031             }
1032         } else {
1033             $userid = $extusername;
1034         }
1036         $group_dns = explode(';', $this->config->creators);
1037         $creator = ldap_isgroupmember($ldapconnection, $userid, $group_dns, $this->config->memberattribute);
1039         $this->ldap_close();
1041         return $creator;
1042     }
1044     /**
1045      * Check if user has LDAP group membership.
1046      *
1047      * Returns true if user should be assigned role.
1048      *
1049      * @param mixed $username username (without system magic quotes).
1050      * @param array $role Array of role's shortname, localname, and settingname for the config value.
1051      * @return mixed result null if role/LDAP context is not configured, boolean otherwise.
1052      */
1053     private function is_role($username, $role) {
1054         if (empty($this->config->{$role['settingname']}) or empty($this->config->memberattribute)) {
1055             return null;
1056         }
1058         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1060         $ldapconnection = $this->ldap_connect();
1062         if ($this->config->memberattribute_isdn) {
1063             if (!($userid = $this->ldap_find_userdn($ldapconnection, $extusername))) {
1064                 return false;
1065             }
1066         } else {
1067             $userid = $extusername;
1068         }
1070         $groupdns = explode(';', $this->config->{$role['settingname']});
1071         $isrole = ldap_isgroupmember($ldapconnection, $userid, $groupdns, $this->config->memberattribute);
1073         $this->ldap_close();
1075         return $isrole;
1076     }
1078     /**
1079      * Called when the user record is updated.
1080      *
1081      * Modifies user in external LDAP server. It takes olduser (before
1082      * changes) and newuser (after changes) compares information and
1083      * saves modified information to external LDAP server.
1084      *
1085      * @param mixed $olduser     Userobject before modifications    (without system magic quotes)
1086      * @param mixed $newuser     Userobject new modified userobject (without system magic quotes)
1087      * @return boolean result
1088      *
1089      */
1090     function user_update($olduser, $newuser) {
1091         global $CFG;
1093         require_once($CFG->dirroot . '/user/profile/lib.php');
1095         if (isset($olduser->username) and isset($newuser->username) and $olduser->username != $newuser->username) {
1096             error_log($this->errorlogtag.get_string('renamingnotallowed', 'auth_ldap'));
1097             return false;
1098         }
1100         if (isset($olduser->auth) and $olduser->auth != $this->authtype) {
1101             return true; // just change auth and skip update
1102         }
1104         $attrmap = $this->ldap_attributes();
1105         // Before doing anything else, make sure we really need to update anything
1106         // in the external LDAP server.
1107         $update_external = false;
1108         foreach ($attrmap as $key => $ldapkeys) {
1109             if (!empty($this->config->{'field_updateremote_'.$key})) {
1110                 $update_external = true;
1111                 break;
1112             }
1113         }
1114         if (!$update_external) {
1115             return true;
1116         }
1118         $extoldusername = core_text::convert($olduser->username, 'utf-8', $this->config->ldapencoding);
1120         $ldapconnection = $this->ldap_connect();
1122         $search_attribs = array();
1123         foreach ($attrmap as $key => $values) {
1124             if (!is_array($values)) {
1125                 $values = array($values);
1126             }
1127             foreach ($values as $value) {
1128                 if (!in_array($value, $search_attribs)) {
1129                     array_push($search_attribs, $value);
1130                 }
1131             }
1132         }
1134         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extoldusername))) {
1135             return false;
1136         }
1138         // Load old custom fields.
1139         $olduserprofilefields = (array) profile_user_record($olduser->id, false);
1141         $fields = array();
1142         foreach (profile_get_custom_fields(false) as $field) {
1143             $fields[$field->shortname] = $field;
1144         }
1146         $success = true;
1147         $user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1148         if ($user_info_result) {
1149             $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
1150             if (empty($user_entry)) {
1151                 $attribs = join (', ', $search_attribs);
1152                 error_log($this->errorlogtag.get_string('updateusernotfound', 'auth_ldap',
1153                                                           array('userdn'=>$user_dn,
1154                                                                 'attribs'=>$attribs)));
1155                 return false; // old user not found!
1156             } else if (count($user_entry) > 1) {
1157                 error_log($this->errorlogtag.get_string('morethanoneuser', 'auth_ldap'));
1158                 return false;
1159             }
1161             $user_entry = $user_entry[0];
1163             foreach ($attrmap as $key => $ldapkeys) {
1164                 if (preg_match('/^profile_field_(.*)$/', $key, $match)) {
1165                     // Custom field.
1166                     $fieldname = $match[1];
1167                     if (isset($fields[$fieldname])) {
1168                         $class = 'profile_field_' . $fields[$fieldname]->datatype;
1169                         $formfield = new $class($fields[$fieldname]->id, $olduser->id);
1170                         $oldvalue = isset($olduserprofilefields[$fieldname]) ? $olduserprofilefields[$fieldname] : null;
1171                     } else {
1172                         $oldvalue = null;
1173                     }
1174                     $newvalue = $formfield->edit_save_data_preprocess($newuser->{$formfield->inputname}, new stdClass);
1175                 } else {
1176                     // Standard field.
1177                     $oldvalue = isset($olduser->$key) ? $olduser->$key : null;
1178                     $newvalue = isset($newuser->$key) ? $newuser->$key : null;
1179                 }
1181                 if ($newvalue !== null and $newvalue !== $oldvalue and !empty($this->config->{'field_updateremote_' . $key})) {
1182                     // For ldap values that could be in more than one
1183                     // ldap key, we will do our best to match
1184                     // where they came from
1185                     $ambiguous = true;
1186                     $changed   = false;
1187                     if (!is_array($ldapkeys)) {
1188                         $ldapkeys = array($ldapkeys);
1189                     }
1190                     if (count($ldapkeys) < 2) {
1191                         $ambiguous = false;
1192                     }
1194                     $nuvalue = core_text::convert($newvalue, 'utf-8', $this->config->ldapencoding);
1195                     empty($nuvalue) ? $nuvalue = array() : $nuvalue;
1196                     $ouvalue = core_text::convert($oldvalue, 'utf-8', $this->config->ldapencoding);
1197                     foreach ($ldapkeys as $ldapkey) {
1198                         // Skip update if $ldapkey does not exist in LDAP.
1199                         if (!isset($user_entry[$ldapkey][0])) {
1200                             $success = false;
1201                             error_log($this->errorlogtag.get_string('updateremfailfield', 'auth_ldap',
1202                                                                      array('ldapkey' => $ldapkey,
1203                                                                             'key' => $key,
1204                                                                             'ouvalue' => $ouvalue,
1205                                                                             'nuvalue' => $nuvalue)));
1206                             continue;
1207                         }
1209                         $ldapvalue = $user_entry[$ldapkey][0];
1210                         if (!$ambiguous) {
1211                             // Skip update if the values already match
1212                             if ($nuvalue !== $ldapvalue) {
1213                                 // This might fail due to schema validation
1214                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1215                                     $changed = true;
1216                                     continue;
1217                                 } else {
1218                                     $success = false;
1219                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1220                                                                              array('errno'=>ldap_errno($ldapconnection),
1221                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1222                                                                                    'key'=>$key,
1223                                                                                    'ouvalue'=>$ouvalue,
1224                                                                                    'nuvalue'=>$nuvalue)));
1225                                     continue;
1226                                 }
1227                             }
1228                         } else {
1229                             // Ambiguous. Value empty before in Moodle (and LDAP) - use
1230                             // 1st ldap candidate field, no need to guess
1231                             if ($ouvalue === '') { // value empty before - use 1st ldap candidate
1232                                 // This might fail due to schema validation
1233                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1234                                     $changed = true;
1235                                     continue;
1236                                 } else {
1237                                     $success = false;
1238                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1239                                                                              array('errno'=>ldap_errno($ldapconnection),
1240                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1241                                                                                    'key'=>$key,
1242                                                                                    'ouvalue'=>$ouvalue,
1243                                                                                    'nuvalue'=>$nuvalue)));
1244                                     continue;
1245                                 }
1246                             }
1248                             // We found which ldap key to update!
1249                             if ($ouvalue !== '' and $ouvalue === $ldapvalue ) {
1250                                 // This might fail due to schema validation
1251                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1252                                     $changed = true;
1253                                     continue;
1254                                 } else {
1255                                     $success = false;
1256                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1257                                                                              array('errno'=>ldap_errno($ldapconnection),
1258                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1259                                                                                    'key'=>$key,
1260                                                                                    'ouvalue'=>$ouvalue,
1261                                                                                    'nuvalue'=>$nuvalue)));
1262                                     continue;
1263                                 }
1264                             }
1265                         }
1266                     }
1268                     if ($ambiguous and !$changed) {
1269                         $success = false;
1270                         error_log($this->errorlogtag.get_string ('updateremfailamb', 'auth_ldap',
1271                                                                  array('key'=>$key,
1272                                                                        'ouvalue'=>$ouvalue,
1273                                                                        'nuvalue'=>$nuvalue)));
1274                     }
1275                 }
1276             }
1277         } else {
1278             error_log($this->errorlogtag.get_string ('usernotfound', 'auth_ldap'));
1279             $success = false;
1280         }
1282         $this->ldap_close();
1283         return $success;
1285     }
1287     /**
1288      * Changes userpassword in LDAP
1289      *
1290      * Called when the user password is updated. It assumes it is
1291      * called by an admin or that you've otherwise checked the user's
1292      * credentials
1293      *
1294      * @param  object  $user        User table object
1295      * @param  string  $newpassword Plaintext password (not crypted/md5'ed)
1296      * @return boolean result
1297      *
1298      */
1299     function user_update_password($user, $newpassword) {
1300         global $USER;
1302         $result = false;
1303         $username = $user->username;
1305         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1306         $extpassword = core_text::convert($newpassword, 'utf-8', $this->config->ldapencoding);
1308         switch ($this->config->passtype) {
1309             case 'md5':
1310                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
1311                 break;
1312             case 'sha1':
1313                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
1314                 break;
1315             case 'plaintext':
1316             default:
1317                 break; // plaintext
1318         }
1320         $ldapconnection = $this->ldap_connect();
1322         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
1324         if (!$user_dn) {
1325             error_log($this->errorlogtag.get_string ('nodnforusername', 'auth_ldap', $user->username));
1326             return false;
1327         }
1329         switch ($this->config->user_type) {
1330             case 'edir':
1331                 // Change password
1332                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1333                 if (!$result) {
1334                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1335                                                                array('errno'=>ldap_errno($ldapconnection),
1336                                                                      'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1337                 }
1338                 // Update password expiration time, grace logins count
1339                 $search_attribs = array($this->config->expireattr, 'passwordExpirationInterval', 'loginGraceLimit');
1340                 $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1341                 if ($sr) {
1342                     $entry = ldap_get_entries_moodle($ldapconnection, $sr);
1343                     $info = $entry[0];
1344                     $newattrs = array();
1345                     if (!empty($info[$this->config->expireattr][0])) {
1346                         // Set expiration time only if passwordExpirationInterval is defined
1347                         if (!empty($info['passwordexpirationinterval'][0])) {
1348                            $expirationtime = time() + $info['passwordexpirationinterval'][0];
1349                            $ldapexpirationtime = $this->ldap_unix2expirationtime($expirationtime);
1350                            $newattrs['passwordExpirationTime'] = $ldapexpirationtime;
1351                         }
1353                         // Set gracelogin count
1354                         if (!empty($info['logingracelimit'][0])) {
1355                            $newattrs['loginGraceRemaining']= $info['logingracelimit'][0];
1356                         }
1358                         // Store attribute changes in LDAP
1359                         $result = ldap_modify($ldapconnection, $user_dn, $newattrs);
1360                         if (!$result) {
1361                             error_log($this->errorlogtag.get_string ('updatepasserrorexpiregrace', 'auth_ldap',
1362                                                                        array('errno'=>ldap_errno($ldapconnection),
1363                                                                              'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1364                         }
1365                     }
1366                 }
1367                 else {
1368                     error_log($this->errorlogtag.get_string ('updatepasserrorexpire', 'auth_ldap',
1369                                                              array('errno'=>ldap_errno($ldapconnection),
1370                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1371                 }
1372                 break;
1374             case 'ad':
1375                 // Passwords in Active Directory must be encoded as Unicode
1376                 // strings (UCS-2 Little Endian format) and surrounded with
1377                 // double quotes. See http://support.microsoft.com/?kbid=269190
1378                 if (!function_exists('mb_convert_encoding')) {
1379                     error_log($this->errorlogtag.get_string ('needmbstring', 'auth_ldap'));
1380                     return false;
1381                 }
1382                 $extpassword = mb_convert_encoding('"'.$extpassword.'"', "UCS-2LE", $this->config->ldapencoding);
1383                 $result = ldap_modify($ldapconnection, $user_dn, array('unicodePwd' => $extpassword));
1384                 if (!$result) {
1385                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1386                                                              array('errno'=>ldap_errno($ldapconnection),
1387                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1388                 }
1389                 break;
1391             default:
1392                 // Send LDAP the password in cleartext, it will md5 it itself
1393                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1394                 if (!$result) {
1395                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1396                                                              array('errno'=>ldap_errno($ldapconnection),
1397                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1398                 }
1400         }
1402         $this->ldap_close();
1403         return $result;
1404     }
1406     /**
1407      * Take expirationtime and return it as unix timestamp in seconds
1408      *
1409      * Takes expiration timestamp as read from LDAP and returns it as unix timestamp in seconds
1410      * Depends on $this->config->user_type variable
1411      *
1412      * @param mixed time   Time stamp read from LDAP as it is.
1413      * @param string $ldapconnection Only needed for Active Directory.
1414      * @param string $user_dn User distinguished name for the user we are checking password expiration (only needed for Active Directory).
1415      * @return timestamp
1416      */
1417     function ldap_expirationtime2unix ($time, $ldapconnection, $user_dn) {
1418         $result = false;
1419         switch ($this->config->user_type) {
1420             case 'edir':
1421                 $yr=substr($time, 0, 4);
1422                 $mo=substr($time, 4, 2);
1423                 $dt=substr($time, 6, 2);
1424                 $hr=substr($time, 8, 2);
1425                 $min=substr($time, 10, 2);
1426                 $sec=substr($time, 12, 2);
1427                 $result = mktime($hr, $min, $sec, $mo, $dt, $yr);
1428                 break;
1429             case 'rfc2307':
1430             case 'rfc2307bis':
1431                 $result = $time * DAYSECS; // The shadowExpire contains the number of DAYS between 01/01/1970 and the actual expiration date
1432                 break;
1433             case 'ad':
1434                 $result = $this->ldap_get_ad_pwdexpire($time, $ldapconnection, $user_dn);
1435                 break;
1436             default:
1437                 print_error('auth_ldap_usertypeundefined', 'auth_ldap');
1438         }
1439         return $result;
1440     }
1442     /**
1443      * Takes unix timestamp and returns it formated for storing in LDAP
1444      *
1445      * @param integer unix time stamp
1446      */
1447     function ldap_unix2expirationtime($time) {
1448         $result = false;
1449         switch ($this->config->user_type) {
1450             case 'edir':
1451                 $result=date('YmdHis', $time).'Z';
1452                 break;
1453             case 'rfc2307':
1454             case 'rfc2307bis':
1455                 $result = $time ; // Already in correct format
1456                 break;
1457             default:
1458                 print_error('auth_ldap_usertypeundefined2', 'auth_ldap');
1459         }
1460         return $result;
1462     }
1464     /**
1465      * Returns user attribute mappings between moodle and LDAP
1466      *
1467      * @return array
1468      */
1470     function ldap_attributes () {
1471         $moodleattributes = array();
1472         // If we have custom fields then merge them with user fields.
1473         $customfields = $this->get_custom_user_profile_fields();
1474         if (!empty($customfields) && !empty($this->userfields)) {
1475             $userfields = array_merge($this->userfields, $customfields);
1476         } else {
1477             $userfields = $this->userfields;
1478         }
1480         foreach ($userfields as $field) {
1481             if (!empty($this->config->{"field_map_$field"})) {
1482                 $moodleattributes[$field] = core_text::strtolower(trim($this->config->{"field_map_$field"}));
1483                 if (preg_match('/,/', $moodleattributes[$field])) {
1484                     $moodleattributes[$field] = explode(',', $moodleattributes[$field]); // split ?
1485                 }
1486             }
1487         }
1488         $moodleattributes['username'] = core_text::strtolower(trim($this->config->user_attribute));
1489         $moodleattributes['suspended'] = core_text::strtolower(trim($this->config->suspended_attribute));
1490         return $moodleattributes;
1491     }
1493     /**
1494      * Returns all usernames from LDAP
1495      *
1496      * @param $filter An LDAP search filter to select desired users
1497      * @return array of LDAP user names converted to UTF-8
1498      */
1499     function ldap_get_userlist($filter='*') {
1500         $fresult = array();
1502         $ldapconnection = $this->ldap_connect();
1504         if ($filter == '*') {
1505            $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
1506         }
1508         $contexts = explode(';', $this->config->contexts);
1509         if (!empty($this->config->create_context)) {
1510             array_push($contexts, $this->config->create_context);
1511         }
1513         $ldap_cookie = '';
1514         $ldap_pagedresults = ldap_paged_results_supported($this->config->ldap_version, $ldapconnection);
1515         foreach ($contexts as $context) {
1516             $context = trim($context);
1517             if (empty($context)) {
1518                 continue;
1519             }
1521             do {
1522                 if ($ldap_pagedresults) {
1523                     ldap_control_paged_result($ldapconnection, $this->config->pagesize, true, $ldap_cookie);
1524                 }
1525                 if ($this->config->search_sub) {
1526                     // Use ldap_search to find first user from subtree.
1527                     $ldap_result = ldap_search($ldapconnection, $context, $filter, array($this->config->user_attribute));
1528                 } else {
1529                     // Search only in this context.
1530                     $ldap_result = ldap_list($ldapconnection, $context, $filter, array($this->config->user_attribute));
1531                 }
1532                 if(!$ldap_result) {
1533                     continue;
1534                 }
1535                 if ($ldap_pagedresults) {
1536                     ldap_control_paged_result_response($ldapconnection, $ldap_result, $ldap_cookie);
1537                 }
1538                 $users = ldap_get_entries_moodle($ldapconnection, $ldap_result);
1539                 // Add found users to list.
1540                 for ($i = 0; $i < count($users); $i++) {
1541                     $extuser = core_text::convert($users[$i][$this->config->user_attribute][0],
1542                                                 $this->config->ldapencoding, 'utf-8');
1543                     array_push($fresult, $extuser);
1544                 }
1545                 unset($ldap_result); // Free mem.
1546             } while ($ldap_pagedresults && !empty($ldap_cookie));
1547         }
1549         // If paged results were used, make sure the current connection is completely closed
1550         $this->ldap_close($ldap_pagedresults);
1551         return $fresult;
1552     }
1554     /**
1555      * Indicates if password hashes should be stored in local moodle database.
1556      *
1557      * @return bool true means flag 'not_cached' stored instead of password hash
1558      */
1559     function prevent_local_passwords() {
1560         return !empty($this->config->preventpassindb);
1561     }
1563     /**
1564      * Returns true if this authentication plugin is 'internal'.
1565      *
1566      * @return bool
1567      */
1568     function is_internal() {
1569         return false;
1570     }
1572     /**
1573      * Returns true if this authentication plugin can change the user's
1574      * password.
1575      *
1576      * @return bool
1577      */
1578     function can_change_password() {
1579         return !empty($this->config->stdchangepassword) or !empty($this->config->changepasswordurl);
1580     }
1582     /**
1583      * Returns the URL for changing the user's password, or empty if the default can
1584      * be used.
1585      *
1586      * @return moodle_url
1587      */
1588     function change_password_url() {
1589         if (empty($this->config->stdchangepassword)) {
1590             if (!empty($this->config->changepasswordurl)) {
1591                 return new moodle_url($this->config->changepasswordurl);
1592             } else {
1593                 return null;
1594             }
1595         } else {
1596             return null;
1597         }
1598     }
1600     /**
1601      * Will get called before the login page is shownr. Ff NTLM SSO
1602      * is enabled, and the user is in the right network, we'll redirect
1603      * to the magic NTLM page for SSO...
1604      *
1605      */
1606     function loginpage_hook() {
1607         global $CFG, $SESSION;
1609         // HTTPS is potentially required
1610         //httpsrequired(); - this must be used before setting the URL, it is already done on the login/index.php
1612         if (($_SERVER['REQUEST_METHOD'] === 'GET'         // Only on initial GET of loginpage
1613              || ($_SERVER['REQUEST_METHOD'] === 'POST'
1614                  && (get_local_referer() != strip_querystring(qualified_me()))))
1615                                                           // Or when POSTed from another place
1616                                                           // See MDL-14071
1617             && !empty($this->config->ntlmsso_enabled)     // SSO enabled
1618             && !empty($this->config->ntlmsso_subnet)      // have a subnet to test for
1619             && empty($_GET['authldap_skipntlmsso'])       // haven't failed it yet
1620             && (isguestuser() || !isloggedin())           // guestuser or not-logged-in users
1621             && address_in_subnet(getremoteaddr(), $this->config->ntlmsso_subnet)) {
1623             // First, let's remember where we were trying to get to before we got here
1624             if (empty($SESSION->wantsurl)) {
1625                 $SESSION->wantsurl = null;
1626                 $referer = get_local_referer(false);
1627                 if ($referer &&
1628                         $referer != $CFG->wwwroot &&
1629                         $referer != $CFG->wwwroot . '/' &&
1630                         $referer != $CFG->wwwroot . '/login/' &&
1631                         $referer != $CFG->wwwroot . '/login/index.php') {
1632                     $SESSION->wantsurl = $referer;
1633                 }
1634             }
1636             // Now start the whole NTLM machinery.
1637             if($this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESATTEMPT ||
1638                 $this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESFORM) {
1639                 if (core_useragent::is_ie()) {
1640                     $sesskey = sesskey();
1641                     redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_magic.php?sesskey='.$sesskey);
1642                 } else if ($this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESFORM) {
1643                     redirect($CFG->wwwroot.'/login/index.php?authldap_skipntlmsso=1');
1644                 }
1645             }
1646             redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_attempt.php');
1647         }
1649         // No NTLM SSO, Use the normal login page instead.
1651         // If $SESSION->wantsurl is empty and we have a 'Referer:' header, the login
1652         // page insists on redirecting us to that page after user validation. If
1653         // we clicked on the redirect link at the ntlmsso_finish.php page (instead
1654         // of waiting for the redirection to happen) then we have a 'Referer:' header
1655         // we don't want to use at all. As we can't get rid of it, just point
1656         // $SESSION->wantsurl to $CFG->wwwroot (after all, we came from there).
1657         if (empty($SESSION->wantsurl)
1658             && (get_local_referer() == $CFG->wwwroot.'/auth/ldap/ntlmsso_finish.php')) {
1660             $SESSION->wantsurl = $CFG->wwwroot;
1661         }
1662     }
1664     /**
1665      * To be called from a page running under NTLM's
1666      * "Integrated Windows Authentication".
1667      *
1668      * If successful, it will set a special "cookie" (not an HTTP cookie!)
1669      * in cache_flags under the $this->pluginconfig/ntlmsess "plugin" and return true.
1670      * The "cookie" will be picked up by ntlmsso_finish() to complete the
1671      * process.
1672      *
1673      * On failure it will return false for the caller to display an appropriate
1674      * error message (probably saying that Integrated Windows Auth isn't enabled!)
1675      *
1676      * NOTE that this code will execute under the OS user credentials,
1677      * so we MUST avoid dealing with files -- such as session files.
1678      * (The caller should define('NO_MOODLE_COOKIES', true) before including config.php)
1679      *
1680      */
1681     function ntlmsso_magic($sesskey) {
1682         if (isset($_SERVER['REMOTE_USER']) && !empty($_SERVER['REMOTE_USER'])) {
1684             // HTTP __headers__ seem to be sent in ISO-8859-1 encoding
1685             // (according to my reading of RFC-1945, RFC-2616 and RFC-2617 and
1686             // my local tests), so we need to convert the REMOTE_USER value
1687             // (i.e., what we got from the HTTP WWW-Authenticate header) into UTF-8
1688             $username = core_text::convert($_SERVER['REMOTE_USER'], 'iso-8859-1', 'utf-8');
1690             switch ($this->config->ntlmsso_type) {
1691                 case 'ntlm':
1692                     // The format is now configurable, so try to extract the username
1693                     $username = $this->get_ntlm_remote_user($username);
1694                     if (empty($username)) {
1695                         return false;
1696                     }
1697                     break;
1698                 case 'kerberos':
1699                     // Format is username@DOMAIN
1700                     $username = substr($username, 0, strpos($username, '@'));
1701                     break;
1702                 default:
1703                     error_log($this->errorlogtag.get_string ('ntlmsso_unknowntype', 'auth_ldap'));
1704                     return false; // Should never happen!
1705             }
1707             $username = core_text::strtolower($username); // Compatibility hack
1708             set_cache_flag($this->pluginconfig.'/ntlmsess', $sesskey, $username, AUTH_NTLMTIMEOUT);
1709             return true;
1710         }
1711         return false;
1712     }
1714     /**
1715      * Find the session set by ntlmsso_magic(), validate it and
1716      * call authenticate_user_login() to authenticate the user through
1717      * the auth machinery.
1718      *
1719      * It is complemented by a similar check in user_login().
1720      *
1721      * If it succeeds, it never returns.
1722      *
1723      */
1724     function ntlmsso_finish() {
1725         global $CFG, $USER, $SESSION;
1727         $key = sesskey();
1728         $username = get_cache_flag($this->pluginconfig.'/ntlmsess', $key);
1729         if (empty($username)) {
1730             return false;
1731         }
1733         // Here we want to trigger the whole authentication machinery
1734         // to make sure no step is bypassed...
1735         $reason = null;
1736         $user = authenticate_user_login($username, $key, false, $reason, false);
1737         if ($user) {
1738             complete_user_login($user);
1740             // Cleanup the key to prevent reuse...
1741             // and to allow re-logins with normal credentials
1742             unset_cache_flag($this->pluginconfig.'/ntlmsess', $key);
1744             // Redirection
1745             if (user_not_fully_set_up($USER, true)) {
1746                 $urltogo = $CFG->wwwroot.'/user/edit.php';
1747                 // We don't delete $SESSION->wantsurl yet, so we get there later
1748             } else if (isset($SESSION->wantsurl) and (strpos($SESSION->wantsurl, $CFG->wwwroot) === 0)) {
1749                 $urltogo = $SESSION->wantsurl;    // Because it's an address in this site
1750                 unset($SESSION->wantsurl);
1751             } else {
1752                 // No wantsurl stored or external - go to homepage
1753                 $urltogo = $CFG->wwwroot.'/';
1754                 unset($SESSION->wantsurl);
1755             }
1756             // We do not want to redirect if we are in a PHPUnit test.
1757             if (!PHPUNIT_TEST) {
1758                 redirect($urltogo);
1759             }
1760         }
1761         // Should never reach here.
1762         return false;
1763     }
1765     /**
1766      * Sync roles for this user.
1767      *
1768      * @param object $user The user to sync (without system magic quotes).
1769      */
1770     function sync_roles($user) {
1771         global $DB;
1773         $roles = get_ldap_assignable_role_names(2); // Admin user.
1775         foreach ($roles as $role) {
1776             $isrole = $this->is_role($user->username, $role);
1777             if ($isrole === null) {
1778                 continue; // Nothing to sync - role/LDAP contexts not configured.
1779             }
1781             // Sync user.
1782             $systemcontext = context_system::instance();
1783             if ($isrole) {
1784                 // Following calls will not create duplicates.
1785                 role_assign($role['id'], $user->id, $systemcontext->id, $this->roleauth);
1786             } else {
1787                 // Unassign only if previously assigned by this plugin.
1788                 role_unassign($role['id'], $user->id, $systemcontext->id, $this->roleauth);
1789             }
1790         }
1791     }
1793     /**
1794      * Get password expiration time for a given user from Active Directory
1795      *
1796      * @param string $pwdlastset The time last time we changed the password.
1797      * @param resource $lcapconn The open LDAP connection.
1798      * @param string $user_dn The distinguished name of the user we are checking.
1799      *
1800      * @return string $unixtime
1801      */
1802     function ldap_get_ad_pwdexpire($pwdlastset, $ldapconn, $user_dn){
1803         global $CFG;
1805         if (!function_exists('bcsub')) {
1806             error_log($this->errorlogtag.get_string ('needbcmath', 'auth_ldap'));
1807             return 0;
1808         }
1810         // If UF_DONT_EXPIRE_PASSWD flag is set in user's
1811         // userAccountControl attribute, the password doesn't expire.
1812         $sr = ldap_read($ldapconn, $user_dn, '(objectClass=*)',
1813                         array('userAccountControl'));
1814         if (!$sr) {
1815             error_log($this->errorlogtag.get_string ('useracctctrlerror', 'auth_ldap', $user_dn));
1816             // Don't expire password, as we are not sure if it has to be
1817             // expired or not.
1818             return 0;
1819         }
1821         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1822         $info = $entry[0];
1823         $useraccountcontrol = $info['useraccountcontrol'][0];
1824         if ($useraccountcontrol & UF_DONT_EXPIRE_PASSWD) {
1825             // Password doesn't expire.
1826             return 0;
1827         }
1829         // If pwdLastSet is zero, the user must change his/her password now
1830         // (unless UF_DONT_EXPIRE_PASSWD flag is set, but we already
1831         // tested this above)
1832         if ($pwdlastset === '0') {
1833             // Password has expired
1834             return -1;
1835         }
1837         // ----------------------------------------------------------------
1838         // Password expiration time in Active Directory is the composition of
1839         // two values:
1840         //
1841         //   - User's pwdLastSet attribute, that stores the last time
1842         //     the password was changed.
1843         //
1844         //   - Domain's maxPwdAge attribute, that sets how long
1845         //     passwords last in this domain.
1846         //
1847         // We already have the first value (passed in as a parameter). We
1848         // need to get the second one. As we don't know the domain DN, we
1849         // have to query rootDSE's defaultNamingContext attribute to get
1850         // it. Then we have to query that DN's maxPwdAge attribute to get
1851         // the real value.
1852         //
1853         // Once we have both values, we just need to combine them. But MS
1854         // chose to use a different base and unit for time measurements.
1855         // So we need to convert the values to Unix timestamps (see
1856         // details below).
1857         // ----------------------------------------------------------------
1859         $sr = ldap_read($ldapconn, ROOTDSE, '(objectClass=*)',
1860                         array('defaultNamingContext'));
1861         if (!$sr) {
1862             error_log($this->errorlogtag.get_string ('rootdseerror', 'auth_ldap'));
1863             return 0;
1864         }
1866         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1867         $info = $entry[0];
1868         $domaindn = $info['defaultnamingcontext'][0];
1870         $sr = ldap_read ($ldapconn, $domaindn, '(objectClass=*)',
1871                          array('maxPwdAge'));
1872         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1873         $info = $entry[0];
1874         $maxpwdage = $info['maxpwdage'][0];
1875         if ($sr = ldap_read($ldapconn, $user_dn, '(objectClass=*)', array('msDS-ResultantPSO'))) {
1876             if ($entry = ldap_get_entries_moodle($ldapconn, $sr)) {
1877                 $info = $entry[0];
1878                 $userpso = $info['msds-resultantpso'][0];
1880                 // If a PSO exists, FGPP is being utilized.
1881                 // Grab the new maxpwdage from the msDS-MaximumPasswordAge attribute of the PSO.
1882                 if (!empty($userpso)) {
1883                     $sr = ldap_read($ldapconn, $userpso, '(objectClass=*)', array('msDS-MaximumPasswordAge'));
1884                     if ($entry = ldap_get_entries_moodle($ldapconn, $sr)) {
1885                         $info = $entry[0];
1886                         // Default value of msds-maximumpasswordage is 42 and is always set.
1887                         $maxpwdage = $info['msds-maximumpasswordage'][0];
1888                     }
1889                 }
1890             }
1891         }
1892         // ----------------------------------------------------------------
1893         // MSDN says that "pwdLastSet contains the number of 100 nanosecond
1894         // intervals since January 1, 1601 (UTC), stored in a 64 bit integer".
1895         //
1896         // According to Perl's Date::Manip, the number of seconds between
1897         // this date and Unix epoch is 11644473600. So we have to
1898         // substract this value to calculate a Unix time, once we have
1899         // scaled pwdLastSet to seconds. This is the script used to
1900         // calculate the value shown above:
1901         //
1902         //    #!/usr/bin/perl -w
1903         //
1904         //    use Date::Manip;
1905         //
1906         //    $date1 = ParseDate ("160101010000 UTC");
1907         //    $date2 = ParseDate ("197001010000 UTC");
1908         //    $delta = DateCalc($date1, $date2, \$err);
1909         //    $secs = Delta_Format($delta, 0, "%st");
1910         //    print "$secs \n";
1911         //
1912         // MSDN also says that "maxPwdAge is stored as a large integer that
1913         // represents the number of 100 nanosecond intervals from the time
1914         // the password was set before the password expires." We also need
1915         // to scale this to seconds. Bear in mind that this value is stored
1916         // as a _negative_ quantity (at least in my AD domain).
1917         //
1918         // As a last remark, if the low 32 bits of maxPwdAge are equal to 0,
1919         // the maximum password age in the domain is set to 0, which means
1920         // passwords do not expire (see
1921         // http://msdn2.microsoft.com/en-us/library/ms974598.aspx)
1922         //
1923         // As the quantities involved are too big for PHP integers, we
1924         // need to use BCMath functions to work with arbitrary precision
1925         // numbers.
1926         // ----------------------------------------------------------------
1928         // If the low order 32 bits are 0, then passwords do not expire in
1929         // the domain. Just do '$maxpwdage mod 2^32' and check the result
1930         // (2^32 = 4294967296)
1931         if (bcmod ($maxpwdage, 4294967296) === '0') {
1932             return 0;
1933         }
1935         // Add up pwdLastSet and maxPwdAge to get password expiration
1936         // time, in MS time units. Remember maxPwdAge is stored as a
1937         // _negative_ quantity, so we need to substract it in fact.
1938         $pwdexpire = bcsub ($pwdlastset, $maxpwdage);
1940         // Scale the result to convert it to Unix time units and return
1941         // that value.
1942         return bcsub( bcdiv($pwdexpire, '10000000'), '11644473600');
1943     }
1945     /**
1946      * Connect to the LDAP server, using the plugin configured
1947      * settings. It's actually a wrapper around ldap_connect_moodle()
1948      *
1949      * @return resource A valid LDAP connection (or dies if it can't connect)
1950      */
1951     function ldap_connect() {
1952         // Cache ldap connections. They are expensive to set up
1953         // and can drain the TCP/IP ressources on the server if we
1954         // are syncing a lot of users (as we try to open a new connection
1955         // to get the user details). This is the least invasive way
1956         // to reuse existing connections without greater code surgery.
1957         if(!empty($this->ldapconnection)) {
1958             $this->ldapconns++;
1959             return $this->ldapconnection;
1960         }
1962         if($ldapconnection = ldap_connect_moodle($this->config->host_url, $this->config->ldap_version,
1963                                                  $this->config->user_type, $this->config->bind_dn,
1964                                                  $this->config->bind_pw, $this->config->opt_deref,
1965                                                  $debuginfo, $this->config->start_tls)) {
1966             $this->ldapconns = 1;
1967             $this->ldapconnection = $ldapconnection;
1968             return $ldapconnection;
1969         }
1971         print_error('auth_ldap_noconnect_all', 'auth_ldap', '', $debuginfo);
1972     }
1974     /**
1975      * Disconnects from a LDAP server
1976      *
1977      * @param force boolean Forces closing the real connection to the LDAP server, ignoring any
1978      *                      cached connections. This is needed when we've used paged results
1979      *                      and want to use normal results again.
1980      */
1981     function ldap_close($force=false) {
1982         $this->ldapconns--;
1983         if (($this->ldapconns == 0) || ($force)) {
1984             $this->ldapconns = 0;
1985             @ldap_close($this->ldapconnection);
1986             unset($this->ldapconnection);
1987         }
1988     }
1990     /**
1991      * Search specified contexts for username and return the user dn
1992      * like: cn=username,ou=suborg,o=org. It's actually a wrapper
1993      * around ldap_find_userdn().
1994      *
1995      * @param resource $ldapconnection a valid LDAP connection
1996      * @param string $extusername the username to search (in external LDAP encoding, no db slashes)
1997      * @return mixed the user dn (external LDAP encoding) or false
1998      */
1999     function ldap_find_userdn($ldapconnection, $extusername) {
2000         $ldap_contexts = explode(';', $this->config->contexts);
2001         if (!empty($this->config->create_context)) {
2002             array_push($ldap_contexts, $this->config->create_context);
2003         }
2005         return ldap_find_userdn($ldapconnection, $extusername, $ldap_contexts, $this->config->objectclass,
2006                                 $this->config->user_attribute, $this->config->search_sub);
2007     }
2009     /**
2010      * When using NTLM SSO, the format of the remote username we get in
2011      * $_SERVER['REMOTE_USER'] may vary, depending on where from and how the web
2012      * server gets the data. So we let the admin configure the format using two
2013      * place holders (%domain% and %username%). This function tries to extract
2014      * the username (stripping the domain part and any separators if they are
2015      * present) from the value present in $_SERVER['REMOTE_USER'], using the
2016      * configured format.
2017      *
2018      * @param string $remoteuser The value from $_SERVER['REMOTE_USER'] (converted to UTF-8)
2019      *
2020      * @return string The remote username (without domain part or
2021      *                separators). Empty string if we can't extract the username.
2022      */
2023     protected function get_ntlm_remote_user($remoteuser) {
2024         if (empty($this->config->ntlmsso_remoteuserformat)) {
2025             $format = AUTH_NTLM_DEFAULT_FORMAT;
2026         } else {
2027             $format = $this->config->ntlmsso_remoteuserformat;
2028         }
2030         $format = preg_quote($format);
2031         $formatregex = preg_replace(array('#%domain%#', '#%username%#'),
2032                                     array('('.AUTH_NTLM_VALID_DOMAINNAME.')', '('.AUTH_NTLM_VALID_USERNAME.')'),
2033                                     $format);
2034         if (preg_match('#^'.$formatregex.'$#', $remoteuser, $matches)) {
2035             $user = end($matches);
2036             return $user;
2037         }
2039         /* We are unable to extract the username with the configured format. Probably
2040          * the format specified is wrong, so log a warning for the admin and return
2041          * an empty username.
2042          */
2043         error_log($this->errorlogtag.get_string ('auth_ntlmsso_maybeinvalidformat', 'auth_ldap'));
2044         return '';
2045     }
2047     /**
2048      * Check if the diagnostic message for the LDAP login error tells us that the
2049      * login is denied because the user password has expired or the password needs
2050      * to be changed on first login (using interactive SMB/Windows logins, not
2051      * LDAP logins).
2052      *
2053      * @param string the diagnostic message for the LDAP login error
2054      * @return bool true if the password has expired or the password must be changed on first login
2055      */
2056     protected function ldap_ad_pwdexpired_from_diagmsg($diagmsg) {
2057         // The format of the diagnostic message is (actual examples from W2003 and W2008):
2058         // "80090308: LdapErr: DSID-0C090334, comment: AcceptSecurityContext error, data 52e, vece"  (W2003)
2059         // "80090308: LdapErr: DSID-0C090334, comment: AcceptSecurityContext error, data 773, vece"  (W2003)
2060         // "80090308: LdapErr: DSID-0C0903AA, comment: AcceptSecurityContext error, data 52e, v1771" (W2008)
2061         // "80090308: LdapErr: DSID-0C0903AA, comment: AcceptSecurityContext error, data 773, v1771" (W2008)
2062         // We are interested in the 'data nnn' part.
2063         //   if nnn == 773 then user must change password on first login
2064         //   if nnn == 532 then user password has expired
2065         $diagmsg = explode(',', $diagmsg);
2066         if (preg_match('/data (773|532)/i', trim($diagmsg[2]))) {
2067             return true;
2068         }
2069         return false;
2070     }
2072     /**
2073      * Check if a user is suspended. This function is intended to be used after calling
2074      * get_userinfo_asobj. This is needed because LDAP doesn't have a notion of disabled
2075      * users, however things like MS Active Directory support it and expose information
2076      * through a field.
2077      *
2078      * @param object $user the user object returned by get_userinfo_asobj
2079      * @return boolean
2080      */
2081     protected function is_user_suspended($user) {
2082         if (!$this->config->suspended_attribute || !isset($user->suspended)) {
2083             return false;
2084         }
2085         if ($this->config->suspended_attribute == 'useraccountcontrol' && $this->config->user_type == 'ad') {
2086             return (bool)($user->suspended & AUTH_AD_ACCOUNTDISABLE);
2087         }
2089         return (bool)$user->suspended;
2090     }
2092     /**
2093      * Test a DN
2094      *
2095      * @param resource $ldapconn
2096      * @param string $dn The DN to check for existence
2097      * @param string $message The identifier of a string as in get_string()
2098      * @param string|object|array $a An object, string or number that can be used
2099      *      within translation strings as in get_string()
2100      * @return true or a message in case of error
2101      */
2102     private function test_dn($ldapconn, $dn, $message, $a = null) {
2103         $ldapresult = @ldap_read($ldapconn, $dn, '(objectClass=*)', array());
2104         if (!$ldapresult) {
2105             if (ldap_errno($ldapconn) == 32) {
2106                 // No such object.
2107                 return get_string($message, 'auth_ldap', $a);
2108             }
2110             $a = array('code' => ldap_errno($ldapconn), 'subject' => $a, 'message' => ldap_error($ldapconn));
2111             return get_string('diag_genericerror', 'auth_ldap', $a);
2112         }
2114         return true;
2115     }
2117     /**
2118      * Test if settings are correct, print info to output.
2119      */
2120     public function test_settings() {
2121         global $OUTPUT;
2123         if (!function_exists('ldap_connect')) { // Is php-ldap really there?
2124             echo $OUTPUT->notification(get_string('auth_ldap_noextension', 'auth_ldap'), \core\output\notification::NOTIFY_ERROR);
2125             return;
2126         }
2128         // Check to see if this is actually configured.
2129         if (empty($this->config->host_url)) {
2130             // LDAP is not even configured.
2131             echo $OUTPUT->notification(get_string('ldapnotconfigured', 'auth_ldap'), \core\output\notification::NOTIFY_ERROR);
2132             return;
2133         }
2135         if ($this->config->ldap_version != 3) {
2136             echo $OUTPUT->notification(get_string('diag_toooldversion', 'auth_ldap'), \core\output\notification::NOTIFY_WARNING);
2137         }
2139         try {
2140             $ldapconn = $this->ldap_connect();
2141         } catch (Exception $e) {
2142             echo $OUTPUT->notification($e->getMessage(), \core\output\notification::NOTIFY_ERROR);
2143             return;
2144         }
2146         // Display paged file results.
2147         if (!ldap_paged_results_supported($this->config->ldap_version, $ldapconn)) {
2148             echo $OUTPUT->notification(get_string('pagedresultsnotsupp', 'auth_ldap'), \core\output\notification::NOTIFY_INFO);
2149         }
2151         // Check contexts.
2152         foreach (explode(';', $this->config->contexts) as $context) {
2153             $context = trim($context);
2154             if (empty($context)) {
2155                 echo $OUTPUT->notification(get_string('diag_emptycontext', 'auth_ldap'), \core\output\notification::NOTIFY_WARNING);
2156                 continue;
2157             }
2159             $message = $this->test_dn($ldapconn, $context, 'diag_contextnotfound', $context);
2160             if ($message !== true) {
2161                 echo $OUTPUT->notification($message, \core\output\notification::NOTIFY_WARNING);
2162             }
2163         }
2165         // Create system role mapping field for each assignable system role.
2166         $roles = get_ldap_assignable_role_names();
2167         foreach ($roles as $role) {
2168             foreach (explode(';', $this->config->{$role['settingname']}) as $groupdn) {
2169                 if (empty($groupdn)) {
2170                     continue;
2171                 }
2173                 $role['group'] = $groupdn;
2174                 $message = $this->test_dn($ldapconn, $groupdn, 'diag_rolegroupnotfound', $role);
2175                 if ($message !== true) {
2176                     echo $OUTPUT->notification($message, \core\output\notification::NOTIFY_WARNING);
2177                 }
2178             }
2179         }
2181         $this->ldap_close(true);
2182         // We were able to connect successfuly.
2183         echo $OUTPUT->notification(get_string('connectingldapsuccess', 'auth_ldap'), \core\output\notification::NOTIFY_SUCCESS);
2184     }
2186     /**
2187      * Get the list of profile fields.
2188      *
2189      * @param   bool    $fetchall   Fetch all, not just those for update.
2190      * @return  array
2191      */
2192     protected function get_profile_keys($fetchall = false) {
2193         $keys = array_keys(get_object_vars($this->config));
2194         $updatekeys = [];
2195         foreach ($keys as $key) {
2196             if (preg_match('/^field_updatelocal_(.+)$/', $key, $match)) {
2197                 // If we have a field to update it from and it must be updated 'onlogin' we update it on cron.
2198                 if (!empty($this->config->{'field_map_'.$match[1]})) {
2199                     if ($fetchall || $this->config->{$match[0]} === 'onlogin') {
2200                         array_push($updatekeys, $match[1]); // the actual key name
2201                     }
2202                 }
2203             }
2204         }
2206         if ($this->config->suspended_attribute && $this->config->sync_suspended) {
2207             $updatekeys[] = 'suspended';
2208         }
2210         return $updatekeys;
2211     }