Merge branch 'MDL-52387-master' of git://github.com/lameze/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');
83 /**
84  * LDAP authentication plugin.
85  */
86 class auth_plugin_ldap extends auth_plugin_base {
88     /**
89      * Init plugin config from database settings depending on the plugin auth type.
90      */
91     function init_plugin($authtype) {
92         $this->pluginconfig = 'auth/'.$authtype;
93         $this->config = get_config($this->pluginconfig);
94         if (empty($this->config->ldapencoding)) {
95             $this->config->ldapencoding = 'utf-8';
96         }
97         if (empty($this->config->user_type)) {
98             $this->config->user_type = 'default';
99         }
101         $ldap_usertypes = ldap_supported_usertypes();
102         $this->config->user_type_name = $ldap_usertypes[$this->config->user_type];
103         unset($ldap_usertypes);
105         $default = ldap_getdefaults();
107         // Use defaults if values not given
108         foreach ($default as $key => $value) {
109             // watch out - 0, false are correct values too
110             if (!isset($this->config->{$key}) or $this->config->{$key} == '') {
111                 $this->config->{$key} = $value[$this->config->user_type];
112             }
113         }
115         // Hack prefix to objectclass
116         $this->config->objectclass = ldap_normalise_objectclass($this->config->objectclass);
117     }
119     /**
120      * Constructor with initialisation.
121      */
122     public function __construct() {
123         $this->authtype = 'ldap';
124         $this->roleauth = 'auth_ldap';
125         $this->errorlogtag = '[AUTH LDAP] ';
126         $this->init_plugin($this->authtype);
127     }
129     /**
130      * Old syntax of class constructor. Deprecated in PHP7.
131      *
132      * @deprecated since Moodle 3.1
133      */
134     public function auth_plugin_ldap() {
135         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
136         self::__construct();
137     }
139     /**
140      * Returns true if the username and password work and false if they are
141      * wrong or don't exist.
142      *
143      * @param string $username The username (without system magic quotes)
144      * @param string $password The password (without system magic quotes)
145      *
146      * @return bool Authentication success or failure.
147      */
148     function user_login($username, $password) {
149         if (! function_exists('ldap_bind')) {
150             print_error('auth_ldapnotinstalled', 'auth_ldap');
151             return false;
152         }
154         if (!$username or !$password) {    // Don't allow blank usernames or passwords
155             return false;
156         }
158         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
159         $extpassword = core_text::convert($password, 'utf-8', $this->config->ldapencoding);
161         // Before we connect to LDAP, check if this is an AD SSO login
162         // if we succeed in this block, we'll return success early.
163         //
164         $key = sesskey();
165         if (!empty($this->config->ntlmsso_enabled) && $key === $password) {
166             $cf = get_cache_flags($this->pluginconfig.'/ntlmsess');
167             // We only get the cache flag if we retrieve it before
168             // it expires (AUTH_NTLMTIMEOUT seconds).
169             if (!isset($cf[$key]) || $cf[$key] === '') {
170                 return false;
171             }
173             $sessusername = $cf[$key];
174             if ($username === $sessusername) {
175                 unset($sessusername);
176                 unset($cf);
178                 // Check that the user is inside one of the configured LDAP contexts
179                 $validuser = false;
180                 $ldapconnection = $this->ldap_connect();
181                 // if the user is not inside the configured contexts,
182                 // ldap_find_userdn returns false.
183                 if ($this->ldap_find_userdn($ldapconnection, $extusername)) {
184                     $validuser = true;
185                 }
186                 $this->ldap_close();
188                 // Shortcut here - SSO confirmed
189                 return $validuser;
190             }
191         } // End SSO processing
192         unset($key);
194         $ldapconnection = $this->ldap_connect();
195         $ldap_user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
197         // If ldap_user_dn is empty, user does not exist
198         if (!$ldap_user_dn) {
199             $this->ldap_close();
200             return false;
201         }
203         // Try to bind with current username and password
204         $ldap_login = @ldap_bind($ldapconnection, $ldap_user_dn, $extpassword);
206         // If login fails and we are using MS Active Directory, retrieve the diagnostic
207         // message to see if this is due to an expired password, or that the user is forced to
208         // change the password on first login. If it is, only proceed if we can change
209         // password from Moodle (otherwise we'll get stuck later in the login process).
210         if (!$ldap_login && ($this->config->user_type == 'ad')
211             && $this->can_change_password()
212             && (!empty($this->config->expiration) and ($this->config->expiration == 1))) {
214             // We need to get the diagnostic message right after the call to ldap_bind(),
215             // before any other LDAP operation.
216             ldap_get_option($ldapconnection, LDAP_OPT_DIAGNOSTIC_MESSAGE, $diagmsg);
218             if ($this->ldap_ad_pwdexpired_from_diagmsg($diagmsg)) {
219                 // If login failed because user must change the password now or the
220                 // password has expired, let the user in. We'll catch this later in the
221                 // login process when we explicitly check for expired passwords.
222                 $ldap_login = true;
223             }
224         }
225         $this->ldap_close();
226         return $ldap_login;
227     }
229     /**
230      * Reads user information from ldap and returns it in array()
231      *
232      * Function should return all information available. If you are saving
233      * this information to moodle user-table you should honor syncronization flags
234      *
235      * @param string $username username
236      *
237      * @return mixed array with no magic quotes or false on error
238      */
239     function get_userinfo($username) {
240         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
242         $ldapconnection = $this->ldap_connect();
243         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extusername))) {
244             $this->ldap_close();
245             return false;
246         }
248         $search_attribs = array();
249         $attrmap = $this->ldap_attributes();
250         foreach ($attrmap as $key => $values) {
251             if (!is_array($values)) {
252                 $values = array($values);
253             }
254             foreach ($values as $value) {
255                 if (!in_array($value, $search_attribs)) {
256                     array_push($search_attribs, $value);
257                 }
258             }
259         }
261         if (!$user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs)) {
262             $this->ldap_close();
263             return false; // error!
264         }
266         $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
267         if (empty($user_entry)) {
268             $this->ldap_close();
269             return false; // entry not found
270         }
272         $result = array();
273         foreach ($attrmap as $key => $values) {
274             if (!is_array($values)) {
275                 $values = array($values);
276             }
277             $ldapval = NULL;
278             foreach ($values as $value) {
279                 $entry = array_change_key_case($user_entry[0], CASE_LOWER);
280                 if (($value == 'dn') || ($value == 'distinguishedname')) {
281                     $result[$key] = $user_dn;
282                     continue;
283                 }
284                 if (!array_key_exists($value, $entry)) {
285                     continue; // wrong data mapping!
286                 }
287                 if (is_array($entry[$value])) {
288                     $newval = core_text::convert($entry[$value][0], $this->config->ldapencoding, 'utf-8');
289                 } else {
290                     $newval = core_text::convert($entry[$value], $this->config->ldapencoding, 'utf-8');
291                 }
292                 if (!empty($newval)) { // favour ldap entries that are set
293                     $ldapval = $newval;
294                 }
295             }
296             if (!is_null($ldapval)) {
297                 $result[$key] = $ldapval;
298             }
299         }
301         $this->ldap_close();
302         return $result;
303     }
305     /**
306      * Reads user information from ldap and returns it in an object
307      *
308      * @param string $username username (with system magic quotes)
309      * @return mixed object or false on error
310      */
311     function get_userinfo_asobj($username) {
312         $user_array = $this->get_userinfo($username);
313         if ($user_array == false) {
314             return false; //error or not found
315         }
316         $user_array = truncate_userinfo($user_array);
317         $user = new stdClass();
318         foreach ($user_array as $key=>$value) {
319             $user->{$key} = $value;
320         }
321         return $user;
322     }
324     /**
325      * Returns all usernames from LDAP
326      *
327      * get_userlist returns all usernames from LDAP
328      *
329      * @return array
330      */
331     function get_userlist() {
332         return $this->ldap_get_userlist("({$this->config->user_attribute}=*)");
333     }
335     /**
336      * Checks if user exists on LDAP
337      *
338      * @param string $username
339      */
340     function user_exists($username) {
341         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
343         // Returns true if given username exists on ldap
344         $users = $this->ldap_get_userlist('('.$this->config->user_attribute.'='.ldap_filter_addslashes($extusername).')');
345         return count($users);
346     }
348     /**
349      * Creates a new user on LDAP.
350      * By using information in userobject
351      * Use user_exists to prevent duplicate usernames
352      *
353      * @param mixed $userobject  Moodle userobject
354      * @param mixed $plainpass   Plaintext password
355      */
356     function user_create($userobject, $plainpass) {
357         $extusername = core_text::convert($userobject->username, 'utf-8', $this->config->ldapencoding);
358         $extpassword = core_text::convert($plainpass, 'utf-8', $this->config->ldapencoding);
360         switch ($this->config->passtype) {
361             case 'md5':
362                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
363                 break;
364             case 'sha1':
365                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
366                 break;
367             case 'plaintext':
368             default:
369                 break; // plaintext
370         }
372         $ldapconnection = $this->ldap_connect();
373         $attrmap = $this->ldap_attributes();
375         $newuser = array();
377         foreach ($attrmap as $key => $values) {
378             if (!is_array($values)) {
379                 $values = array($values);
380             }
381             foreach ($values as $value) {
382                 if (!empty($userobject->$key) ) {
383                     $newuser[$value] = core_text::convert($userobject->$key, 'utf-8', $this->config->ldapencoding);
384                 }
385             }
386         }
388         //Following sets all mandatory and other forced attribute values
389         //User should be creted as login disabled untill email confirmation is processed
390         //Feel free to add your user type and send patches to paca@sci.fi to add them
391         //Moodle distribution
393         switch ($this->config->user_type)  {
394             case 'edir':
395                 $newuser['objectClass']   = array('inetOrgPerson', 'organizationalPerson', 'person', 'top');
396                 $newuser['uniqueId']      = $extusername;
397                 $newuser['logindisabled'] = 'TRUE';
398                 $newuser['userpassword']  = $extpassword;
399                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
400                 break;
401             case 'rfc2307':
402             case 'rfc2307bis':
403                 // posixAccount object class forces us to specify a uidNumber
404                 // and a gidNumber. That is quite complicated to generate from
405                 // Moodle without colliding with existing numbers and without
406                 // race conditions. As this user is supposed to be only used
407                 // with Moodle (otherwise the user would exist beforehand) and
408                 // doesn't need to login into a operating system, we assign the
409                 // user the uid of user 'nobody' and gid of group 'nogroup'. In
410                 // addition to that, we need to specify a home directory. We
411                 // use the root directory ('/') as the home directory, as this
412                 // is the only one can always be sure exists. Finally, even if
413                 // it's not mandatory, we specify '/bin/false' as the login
414                 // shell, to prevent the user from login in at the operating
415                 // system level (Moodle ignores this).
417                 $newuser['objectClass']   = array('posixAccount', 'inetOrgPerson', 'organizationalPerson', 'person', 'top');
418                 $newuser['cn']            = $extusername;
419                 $newuser['uid']           = $extusername;
420                 $newuser['uidNumber']     = AUTH_UID_NOBODY;
421                 $newuser['gidNumber']     = AUTH_GID_NOGROUP;
422                 $newuser['homeDirectory'] = '/';
423                 $newuser['loginShell']    = '/bin/false';
425                 // IMPORTANT:
426                 // We have to create the account locked, but posixAccount has
427                 // no attribute to achive this reliably. So we are going to
428                 // modify the password in a reversable way that we can later
429                 // revert in user_activate().
430                 //
431                 // Beware that this can be defeated by the user if we are not
432                 // using MD5 or SHA-1 passwords. After all, the source code of
433                 // Moodle is available, and the user can see the kind of
434                 // modification we are doing and 'undo' it by hand (but only
435                 // if we are using plain text passwords).
436                 //
437                 // Also bear in mind that you need to use a binding user that
438                 // can create accounts and has read/write privileges on the
439                 // 'userPassword' attribute for this to work.
441                 $newuser['userPassword']  = '*'.$extpassword;
442                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
443                 break;
444             case 'ad':
445                 // User account creation is a two step process with AD. First you
446                 // create the user object, then you set the password. If you try
447                 // to set the password while creating the user, the operation
448                 // fails.
450                 // Passwords in Active Directory must be encoded as Unicode
451                 // strings (UCS-2 Little Endian format) and surrounded with
452                 // double quotes. See http://support.microsoft.com/?kbid=269190
453                 if (!function_exists('mb_convert_encoding')) {
454                     print_error('auth_ldap_no_mbstring', 'auth_ldap');
455                 }
457                 // Check for invalid sAMAccountName characters.
458                 if (preg_match('#[/\\[\]:;|=,+*?<>@"]#', $extusername)) {
459                     print_error ('auth_ldap_ad_invalidchars', 'auth_ldap');
460                 }
462                 // First create the user account, and mark it as disabled.
463                 $newuser['objectClass'] = array('top', 'person', 'user', 'organizationalPerson');
464                 $newuser['sAMAccountName'] = $extusername;
465                 $newuser['userAccountControl'] = AUTH_AD_NORMAL_ACCOUNT |
466                                                  AUTH_AD_ACCOUNTDISABLE;
467                 $userdn = 'cn='.ldap_addslashes($extusername).','.$this->config->create_context;
468                 if (!ldap_add($ldapconnection, $userdn, $newuser)) {
469                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
470                 }
472                 // Now set the password
473                 unset($newuser);
474                 $newuser['unicodePwd'] = mb_convert_encoding('"' . $extpassword . '"',
475                                                              'UCS-2LE', 'UTF-8');
476                 if(!ldap_modify($ldapconnection, $userdn, $newuser)) {
477                     // Something went wrong: delete the user account and error out
478                     ldap_delete ($ldapconnection, $userdn);
479                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
480                 }
481                 $uadd = true;
482                 break;
483             default:
484                print_error('auth_ldap_unsupportedusertype', 'auth_ldap', '', $this->config->user_type_name);
485         }
486         $this->ldap_close();
487         return $uadd;
488     }
490     /**
491      * Returns true if plugin allows resetting of password from moodle.
492      *
493      * @return bool
494      */
495     function can_reset_password() {
496         return !empty($this->config->stdchangepassword);
497     }
499     /**
500      * Returns true if plugin can be manually set.
501      *
502      * @return bool
503      */
504     function can_be_manually_set() {
505         return true;
506     }
508     /**
509      * Returns true if plugin allows signup and user creation.
510      *
511      * @return bool
512      */
513     function can_signup() {
514         return (!empty($this->config->auth_user_create) and !empty($this->config->create_context));
515     }
517     /**
518      * Sign up a new user ready for confirmation.
519      * Password is passed in plaintext.
520      *
521      * @param object $user new user object
522      * @param boolean $notify print notice with link and terminate
523      * @return boolean success
524      */
525     function user_signup($user, $notify=true) {
526         global $CFG, $DB, $PAGE, $OUTPUT;
528         require_once($CFG->dirroot.'/user/profile/lib.php');
529         require_once($CFG->dirroot.'/user/lib.php');
531         if ($this->user_exists($user->username)) {
532             print_error('auth_ldap_user_exists', 'auth_ldap');
533         }
535         $plainslashedpassword = $user->password;
536         unset($user->password);
538         if (! $this->user_create($user, $plainslashedpassword)) {
539             print_error('auth_ldap_create_error', 'auth_ldap');
540         }
542         $user->id = user_create_user($user, false, false);
544         user_add_password_history($user->id, $plainslashedpassword);
546         // Save any custom profile field information
547         profile_save_data($user);
549         $this->update_user_record($user->username);
550         // This will also update the stored hash to the latest algorithm
551         // if the existing hash is using an out-of-date algorithm (or the
552         // legacy md5 algorithm).
553         update_internal_user_password($user, $plainslashedpassword);
555         $user = $DB->get_record('user', array('id'=>$user->id));
557         \core\event\user_created::create_from_userid($user->id)->trigger();
559         if (! send_confirmation_email($user)) {
560             print_error('noemail', 'auth_ldap');
561         }
563         if ($notify) {
564             $emailconfirm = get_string('emailconfirm');
565             $PAGE->set_url('/auth/ldap/auth.php');
566             $PAGE->navbar->add($emailconfirm);
567             $PAGE->set_title($emailconfirm);
568             $PAGE->set_heading($emailconfirm);
569             echo $OUTPUT->header();
570             notice(get_string('emailconfirmsent', '', $user->email), "{$CFG->wwwroot}/index.php");
571         } else {
572             return true;
573         }
574     }
576     /**
577      * Returns true if plugin allows confirming of new users.
578      *
579      * @return bool
580      */
581     function can_confirm() {
582         return $this->can_signup();
583     }
585     /**
586      * Confirm the new user as registered.
587      *
588      * @param string $username
589      * @param string $confirmsecret
590      */
591     function user_confirm($username, $confirmsecret) {
592         global $DB;
594         $user = get_complete_user_data('username', $username);
596         if (!empty($user)) {
597             if ($user->auth != $this->authtype) {
598                 return AUTH_CONFIRM_ERROR;
600             } else if ($user->secret == $confirmsecret && $user->confirmed) {
601                 return AUTH_CONFIRM_ALREADY;
603             } else if ($user->secret == $confirmsecret) {   // They have provided the secret key to get in
604                 if (!$this->user_activate($username)) {
605                     return AUTH_CONFIRM_FAIL;
606                 }
607                 $user->confirmed = 1;
608                 user_update_user($user, false);
609                 return AUTH_CONFIRM_OK;
610             }
611         } else {
612             return AUTH_CONFIRM_ERROR;
613         }
614     }
616     /**
617      * Return number of days to user password expires
618      *
619      * If userpassword does not expire it should return 0. If password is already expired
620      * it should return negative value.
621      *
622      * @param mixed $username username
623      * @return integer
624      */
625     function password_expire($username) {
626         $result = 0;
628         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
630         $ldapconnection = $this->ldap_connect();
631         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
632         $search_attribs = array($this->config->expireattr);
633         $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
634         if ($sr)  {
635             $info = ldap_get_entries_moodle($ldapconnection, $sr);
636             if (!empty ($info)) {
637                 $info = array_change_key_case($info[0], CASE_LOWER);
638                 if (isset($info[$this->config->expireattr][0])) {
639                     $expiretime = $this->ldap_expirationtime2unix($info[$this->config->expireattr][0], $ldapconnection, $user_dn);
640                     if ($expiretime != 0) {
641                         $now = time();
642                         if ($expiretime > $now) {
643                             $result = ceil(($expiretime - $now) / DAYSECS);
644                         } else {
645                             $result = floor(($expiretime - $now) / DAYSECS);
646                         }
647                     }
648                 }
649             }
650         } else {
651             error_log($this->errorlogtag.get_string('didtfindexpiretime', 'auth_ldap'));
652         }
654         return $result;
655     }
657     /**
658      * Syncronizes user fron external LDAP server to moodle user table
659      *
660      * Sync is now using username attribute.
661      *
662      * Syncing users removes or suspends users that dont exists anymore in external LDAP.
663      * Creates new users and updates coursecreator status of users.
664      *
665      * @param bool $do_updates will do pull in data updates from LDAP if relevant
666      */
667     function sync_users($do_updates=true) {
668         global $CFG, $DB;
670         print_string('connectingldap', 'auth_ldap');
671         $ldapconnection = $this->ldap_connect();
673         $dbman = $DB->get_manager();
675     /// Define table user to be created
676         $table = new xmldb_table('tmp_extuser');
677         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
678         $table->add_field('username', XMLDB_TYPE_CHAR, '100', null, XMLDB_NOTNULL, null, null);
679         $table->add_field('mnethostid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null);
680         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
681         $table->add_index('username', XMLDB_INDEX_UNIQUE, array('mnethostid', 'username'));
683         print_string('creatingtemptable', 'auth_ldap', 'tmp_extuser');
684         $dbman->create_temp_table($table);
686         ////
687         //// get user's list from ldap to sql in a scalable fashion
688         ////
689         // prepare some data we'll need
690         $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
692         $contexts = explode(';', $this->config->contexts);
694         if (!empty($this->config->create_context)) {
695             array_push($contexts, $this->config->create_context);
696         }
698         $ldap_pagedresults = ldap_paged_results_supported($this->config->ldap_version);
699         $ldap_cookie = '';
700         foreach ($contexts as $context) {
701             $context = trim($context);
702             if (empty($context)) {
703                 continue;
704             }
706             do {
707                 if ($ldap_pagedresults) {
708                     ldap_control_paged_result($ldapconnection, $this->config->pagesize, true, $ldap_cookie);
709                 }
710                 if ($this->config->search_sub) {
711                     // Use ldap_search to find first user from subtree.
712                     $ldap_result = ldap_search($ldapconnection, $context, $filter, array($this->config->user_attribute));
713                 } else {
714                     // Search only in this context.
715                     $ldap_result = ldap_list($ldapconnection, $context, $filter, array($this->config->user_attribute));
716                 }
717                 if(!$ldap_result) {
718                     continue;
719                 }
720                 if ($ldap_pagedresults) {
721                     ldap_control_paged_result_response($ldapconnection, $ldap_result, $ldap_cookie);
722                 }
723                 if ($entry = @ldap_first_entry($ldapconnection, $ldap_result)) {
724                     do {
725                         $value = ldap_get_values_len($ldapconnection, $entry, $this->config->user_attribute);
726                         $value = core_text::convert($value[0], $this->config->ldapencoding, 'utf-8');
727                         $value = trim($value);
728                         $this->ldap_bulk_insert($value);
729                     } while ($entry = ldap_next_entry($ldapconnection, $entry));
730                 }
731                 unset($ldap_result); // Free mem.
732             } while ($ldap_pagedresults && $ldap_cookie !== null && $ldap_cookie != '');
733         }
735         // If LDAP paged results were used, the current connection must be completely
736         // closed and a new one created, to work without paged results from here on.
737         if ($ldap_pagedresults) {
738             $this->ldap_close(true);
739             $ldapconnection = $this->ldap_connect();
740         }
742         /// preserve our user database
743         /// if the temp table is empty, it probably means that something went wrong, exit
744         /// so as to avoid mass deletion of users; which is hard to undo
745         $count = $DB->count_records_sql('SELECT COUNT(username) AS count, 1 FROM {tmp_extuser}');
746         if ($count < 1) {
747             print_string('didntgetusersfromldap', 'auth_ldap');
748             exit;
749         } else {
750             print_string('gotcountrecordsfromldap', 'auth_ldap', $count);
751         }
754 /// User removal
755         // Find users in DB that aren't in ldap -- to be removed!
756         // this is still not as scalable (but how often do we mass delete?)
758         if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
759             $sql = "SELECT u.*
760                       FROM {user} u
761                  LEFT JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
762                      WHERE u.auth = :auth
763                            AND u.deleted = 0
764                            AND e.username IS NULL";
765             $remove_users = $DB->get_records_sql($sql, array('auth'=>$this->authtype));
767             if (!empty($remove_users)) {
768                 print_string('userentriestoremove', 'auth_ldap', count($remove_users));
769                 foreach ($remove_users as $user) {
770                     if (delete_user($user)) {
771                         echo "\t"; print_string('auth_dbdeleteuser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
772                     } else {
773                         echo "\t"; print_string('auth_dbdeleteusererror', 'auth_db', $user->username); echo "\n";
774                     }
775                 }
776             } else {
777                 print_string('nouserentriestoremove', 'auth_ldap');
778             }
779             unset($remove_users); // Free mem!
781         } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
782             $sql = "SELECT u.*
783                       FROM {user} u
784                  LEFT JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
785                      WHERE u.auth = :auth
786                            AND u.deleted = 0
787                            AND u.suspended = 0
788                            AND e.username IS NULL";
789             $remove_users = $DB->get_records_sql($sql, array('auth'=>$this->authtype));
791             if (!empty($remove_users)) {
792                 print_string('userentriestoremove', 'auth_ldap', count($remove_users));
794                 foreach ($remove_users as $user) {
795                     $updateuser = new stdClass();
796                     $updateuser->id = $user->id;
797                     $updateuser->suspended = 1;
798                     user_update_user($updateuser, false);
799                     echo "\t"; print_string('auth_dbsuspenduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
800                     \core\session\manager::kill_user_sessions($user->id);
801                 }
802             } else {
803                 print_string('nouserentriestoremove', 'auth_ldap');
804             }
805             unset($remove_users); // Free mem!
806         }
808 /// Revive suspended users
809         if (!empty($this->config->removeuser) and $this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
810             $sql = "SELECT u.id, u.username
811                       FROM {user} u
812                       JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
813                      WHERE (u.auth = 'nologin' OR (u.auth = ? AND u.suspended = 1)) AND u.deleted = 0";
814             // Note: 'nologin' is there for backwards compatibility.
815             $revive_users = $DB->get_records_sql($sql, array($this->authtype));
817             if (!empty($revive_users)) {
818                 print_string('userentriestorevive', 'auth_ldap', count($revive_users));
820                 foreach ($revive_users as $user) {
821                     $updateuser = new stdClass();
822                     $updateuser->id = $user->id;
823                     $updateuser->auth = $this->authtype;
824                     $updateuser->suspended = 0;
825                     user_update_user($updateuser, false);
826                     echo "\t"; print_string('auth_dbreviveduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
827                 }
828             } else {
829                 print_string('nouserentriestorevive', 'auth_ldap');
830             }
832             unset($revive_users);
833         }
836 /// User Updates - time-consuming (optional)
837         if ($do_updates) {
838             // Narrow down what fields we need to update
839             $all_keys = array_keys(get_object_vars($this->config));
840             $updatekeys = array();
841             foreach ($all_keys as $key) {
842                 if (preg_match('/^field_updatelocal_(.+)$/', $key, $match)) {
843                     // If we have a field to update it from
844                     // and it must be updated 'onlogin' we
845                     // update it on cron
846                     if (!empty($this->config->{'field_map_'.$match[1]})
847                          and $this->config->{$match[0]} === 'onlogin') {
848                         array_push($updatekeys, $match[1]); // the actual key name
849                     }
850                 }
851             }
852             unset($all_keys); unset($key);
854         } else {
855             print_string('noupdatestobedone', 'auth_ldap');
856         }
857         if ($do_updates and !empty($updatekeys)) { // run updates only if relevant
858             $users = $DB->get_records_sql('SELECT u.username, u.id
859                                              FROM {user} u
860                                             WHERE u.deleted = 0 AND u.auth = ? AND u.mnethostid = ?',
861                                           array($this->authtype, $CFG->mnet_localhost_id));
862             if (!empty($users)) {
863                 print_string('userentriestoupdate', 'auth_ldap', count($users));
865                 $sitecontext = context_system::instance();
866                 if (!empty($this->config->creators) and !empty($this->config->memberattribute)
867                   and $roles = get_archetype_roles('coursecreator')) {
868                     $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
869                 } else {
870                     $creatorrole = false;
871                 }
873                 $transaction = $DB->start_delegated_transaction();
874                 $xcount = 0;
875                 $maxxcount = 100;
877                 foreach ($users as $user) {
878                     echo "\t"; print_string('auth_dbupdatinguser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id));
879                     if (!$this->update_user_record($user->username, $updatekeys, true)) {
880                         echo ' - '.get_string('skipped');
881                     }
882                     echo "\n";
883                     $xcount++;
885                     // Update course creators if needed
886                     if ($creatorrole !== false) {
887                         if ($this->iscreator($user->username)) {
888                             role_assign($creatorrole->id, $user->id, $sitecontext->id, $this->roleauth);
889                         } else {
890                             role_unassign($creatorrole->id, $user->id, $sitecontext->id, $this->roleauth);
891                         }
892                     }
893                 }
894                 $transaction->allow_commit();
895                 unset($users); // free mem
896             }
897         } else { // end do updates
898             print_string('noupdatestobedone', 'auth_ldap');
899         }
901 /// User Additions
902         // Find users missing in DB that are in LDAP
903         // and gives me a nifty object I don't want.
904         // note: we do not care about deleted accounts anymore, this feature was replaced by suspending to nologin auth plugin
905         $sql = 'SELECT e.id, e.username
906                   FROM {tmp_extuser} e
907                   LEFT JOIN {user} u ON (e.username = u.username AND e.mnethostid = u.mnethostid)
908                  WHERE u.id IS NULL';
909         $add_users = $DB->get_records_sql($sql);
911         if (!empty($add_users)) {
912             print_string('userentriestoadd', 'auth_ldap', count($add_users));
914             $sitecontext = context_system::instance();
915             if (!empty($this->config->creators) and !empty($this->config->memberattribute)
916               and $roles = get_archetype_roles('coursecreator')) {
917                 $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
918             } else {
919                 $creatorrole = false;
920             }
922             $transaction = $DB->start_delegated_transaction();
923             foreach ($add_users as $user) {
924                 $user = $this->get_userinfo_asobj($user->username);
926                 // Prep a few params
927                 $user->modified   = time();
928                 $user->confirmed  = 1;
929                 $user->auth       = $this->authtype;
930                 $user->mnethostid = $CFG->mnet_localhost_id;
931                 // get_userinfo_asobj() might have replaced $user->username with the value
932                 // from the LDAP server (which can be mixed-case). Make sure it's lowercase
933                 $user->username = trim(core_text::strtolower($user->username));
934                 if (empty($user->lang)) {
935                     $user->lang = $CFG->lang;
936                 }
937                 if (empty($user->calendartype)) {
938                     $user->calendartype = $CFG->calendartype;
939                 }
941                 $id = user_create_user($user, false);
942                 echo "\t"; print_string('auth_dbinsertuser', 'auth_db', array('name'=>$user->username, 'id'=>$id)); echo "\n";
943                 $euser = $DB->get_record('user', array('id' => $id));
945                 if (!empty($this->config->forcechangepassword)) {
946                     set_user_preference('auth_forcepasswordchange', 1, $id);
947                 }
949                 // Add course creators if needed
950                 if ($creatorrole !== false and $this->iscreator($user->username)) {
951                     role_assign($creatorrole->id, $id, $sitecontext->id, $this->roleauth);
952                 }
954             }
955             $transaction->allow_commit();
956             unset($add_users); // free mem
957         } else {
958             print_string('nouserstobeadded', 'auth_ldap');
959         }
961         $dbman->drop_table($table);
962         $this->ldap_close();
964         return true;
965     }
967     /**
968      * Update a local user record from an external source.
969      * This is a lighter version of the one in moodlelib -- won't do
970      * expensive ops such as enrolment.
971      *
972      * If you don't pass $updatekeys, there is a performance hit and
973      * values removed from LDAP won't be removed from moodle.
974      *
975      * @param string $username username
976      * @param boolean $updatekeys true to update the local record with the external LDAP values.
977      * @param bool $triggerevent set false if user_updated event should not be triggered.
978      *             This will not affect user_password_updated event triggering.
979      * @return stdClass|bool updated user record or false if there is no new info to update.
980      */
981     function update_user_record($username, $updatekeys = false, $triggerevent = false) {
982         global $CFG, $DB;
984         // Just in case check text case
985         $username = trim(core_text::strtolower($username));
987         // Get the current user record
988         $user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id));
989         if (empty($user)) { // trouble
990             error_log($this->errorlogtag.get_string('auth_dbusernotexist', 'auth_db', '', $username));
991             print_error('auth_dbusernotexist', 'auth_db', '', $username);
992             die;
993         }
995         // Protect the userid from being overwritten
996         $userid = $user->id;
998         if ($newinfo = $this->get_userinfo($username)) {
999             $newinfo = truncate_userinfo($newinfo);
1001             if (empty($updatekeys)) { // all keys? this does not support removing values
1002                 $updatekeys = array_keys($newinfo);
1003             }
1005             if (!empty($updatekeys)) {
1006                 $newuser = new stdClass();
1007                 $newuser->id = $userid;
1009                 foreach ($updatekeys as $key) {
1010                     if (isset($newinfo[$key])) {
1011                         $value = $newinfo[$key];
1012                     } else {
1013                         $value = '';
1014                     }
1016                     if (!empty($this->config->{'field_updatelocal_' . $key})) {
1017                         // Only update if it's changed.
1018                         if ($user->{$key} != $value) {
1019                             $newuser->$key = $value;
1020                         }
1021                     }
1022                 }
1023                 user_update_user($newuser, false, $triggerevent);
1024             }
1025         } else {
1026             return false;
1027         }
1028         return $DB->get_record('user', array('id'=>$userid, 'deleted'=>0));
1029     }
1031     /**
1032      * Bulk insert in SQL's temp table
1033      */
1034     function ldap_bulk_insert($username) {
1035         global $DB, $CFG;
1037         $username = core_text::strtolower($username); // usernames are __always__ lowercase.
1038         $DB->insert_record_raw('tmp_extuser', array('username'=>$username,
1039                                                     'mnethostid'=>$CFG->mnet_localhost_id), false, true);
1040         echo '.';
1041     }
1043     /**
1044      * Activates (enables) user in external LDAP so user can login
1045      *
1046      * @param mixed $username
1047      * @return boolean result
1048      */
1049     function user_activate($username) {
1050         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1052         $ldapconnection = $this->ldap_connect();
1054         $userdn = $this->ldap_find_userdn($ldapconnection, $extusername);
1055         switch ($this->config->user_type)  {
1056             case 'edir':
1057                 $newinfo['loginDisabled'] = 'FALSE';
1058                 break;
1059             case 'rfc2307':
1060             case 'rfc2307bis':
1061                 // Remember that we add a '*' character in front of the
1062                 // external password string to 'disable' the account. We just
1063                 // need to remove it.
1064                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
1065                                 array('userPassword'));
1066                 $info = ldap_get_entries($ldapconnection, $sr);
1067                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
1068                 $newinfo['userPassword'] = ltrim($info[0]['userpassword'][0], '*');
1069                 break;
1070             case 'ad':
1071                 // We need to unset the ACCOUNTDISABLE bit in the
1072                 // userAccountControl attribute ( see
1073                 // http://support.microsoft.com/kb/305144 )
1074                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
1075                                 array('userAccountControl'));
1076                 $info = ldap_get_entries($ldapconnection, $sr);
1077                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
1078                 $newinfo['userAccountControl'] = $info[0]['useraccountcontrol'][0]
1079                                                  & (~AUTH_AD_ACCOUNTDISABLE);
1080                 break;
1081             default:
1082                 print_error('user_activatenotsupportusertype', 'auth_ldap', '', $this->config->user_type_name);
1083         }
1084         $result = ldap_modify($ldapconnection, $userdn, $newinfo);
1085         $this->ldap_close();
1086         return $result;
1087     }
1089     /**
1090      * Returns true if user should be coursecreator.
1091      *
1092      * @param mixed $username    username (without system magic quotes)
1093      * @return mixed result      null if course creators is not configured, boolean otherwise.
1094      */
1095     function iscreator($username) {
1096         if (empty($this->config->creators) or empty($this->config->memberattribute)) {
1097             return null;
1098         }
1100         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1102         $ldapconnection = $this->ldap_connect();
1104         if ($this->config->memberattribute_isdn) {
1105             if(!($userid = $this->ldap_find_userdn($ldapconnection, $extusername))) {
1106                 return false;
1107             }
1108         } else {
1109             $userid = $extusername;
1110         }
1112         $group_dns = explode(';', $this->config->creators);
1113         $creator = ldap_isgroupmember($ldapconnection, $userid, $group_dns, $this->config->memberattribute);
1115         $this->ldap_close();
1117         return $creator;
1118     }
1120     /**
1121      * Called when the user record is updated.
1122      *
1123      * Modifies user in external LDAP server. It takes olduser (before
1124      * changes) and newuser (after changes) compares information and
1125      * saves modified information to external LDAP server.
1126      *
1127      * @param mixed $olduser     Userobject before modifications    (without system magic quotes)
1128      * @param mixed $newuser     Userobject new modified userobject (without system magic quotes)
1129      * @return boolean result
1130      *
1131      */
1132     function user_update($olduser, $newuser) {
1133         global $USER;
1135         if (isset($olduser->username) and isset($newuser->username) and $olduser->username != $newuser->username) {
1136             error_log($this->errorlogtag.get_string('renamingnotallowed', 'auth_ldap'));
1137             return false;
1138         }
1140         if (isset($olduser->auth) and $olduser->auth != $this->authtype) {
1141             return true; // just change auth and skip update
1142         }
1144         $attrmap = $this->ldap_attributes();
1145         // Before doing anything else, make sure we really need to update anything
1146         // in the external LDAP server.
1147         $update_external = false;
1148         foreach ($attrmap as $key => $ldapkeys) {
1149             if (!empty($this->config->{'field_updateremote_'.$key})) {
1150                 $update_external = true;
1151                 break;
1152             }
1153         }
1154         if (!$update_external) {
1155             return true;
1156         }
1158         $extoldusername = core_text::convert($olduser->username, 'utf-8', $this->config->ldapencoding);
1160         $ldapconnection = $this->ldap_connect();
1162         $search_attribs = array();
1163         foreach ($attrmap as $key => $values) {
1164             if (!is_array($values)) {
1165                 $values = array($values);
1166             }
1167             foreach ($values as $value) {
1168                 if (!in_array($value, $search_attribs)) {
1169                     array_push($search_attribs, $value);
1170                 }
1171             }
1172         }
1174         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extoldusername))) {
1175             return false;
1176         }
1178         $success = true;
1179         $user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1180         if ($user_info_result) {
1181             $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
1182             if (empty($user_entry)) {
1183                 $attribs = join (', ', $search_attribs);
1184                 error_log($this->errorlogtag.get_string('updateusernotfound', 'auth_ldap',
1185                                                           array('userdn'=>$user_dn,
1186                                                                 'attribs'=>$attribs)));
1187                 return false; // old user not found!
1188             } else if (count($user_entry) > 1) {
1189                 error_log($this->errorlogtag.get_string('morethanoneuser', 'auth_ldap'));
1190                 return false;
1191             }
1193             $user_entry = array_change_key_case($user_entry[0], CASE_LOWER);
1195             foreach ($attrmap as $key => $ldapkeys) {
1196                 $profilefield = '';
1197                 // Only process if the moodle field ($key) has changed and we
1198                 // are set to update LDAP with it
1199                 $customprofilefield = 'profile_field_' . $key;
1200                 if (isset($olduser->$key) and isset($newuser->$key)
1201                     and ($olduser->$key !== $newuser->$key)) {
1202                     $profilefield = $key;
1203                 } else if (isset($olduser->$customprofilefield) && isset($newuser->$customprofilefield)
1204                     && $olduser->$customprofilefield !== $newuser->$customprofilefield) {
1205                     $profilefield = $customprofilefield;
1206                 }
1208                 if (!empty($profilefield) && !empty($this->config->{'field_updateremote_' . $key})) {
1209                     // For ldap values that could be in more than one
1210                     // ldap key, we will do our best to match
1211                     // where they came from
1212                     $ambiguous = true;
1213                     $changed   = false;
1214                     if (!is_array($ldapkeys)) {
1215                         $ldapkeys = array($ldapkeys);
1216                     }
1217                     if (count($ldapkeys) < 2) {
1218                         $ambiguous = false;
1219                     }
1221                     $nuvalue = core_text::convert($newuser->$profilefield, 'utf-8', $this->config->ldapencoding);
1222                     empty($nuvalue) ? $nuvalue = array() : $nuvalue;
1223                     $ouvalue = core_text::convert($olduser->$profilefield, 'utf-8', $this->config->ldapencoding);
1225                     foreach ($ldapkeys as $ldapkey) {
1226                         $ldapkey   = $ldapkey;
1227                         $ldapvalue = $user_entry[$ldapkey][0];
1228                         if (!$ambiguous) {
1229                             // Skip update if the values already match
1230                             if ($nuvalue !== $ldapvalue) {
1231                                 // This might fail due to schema validation
1232                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1233                                     $changed = true;
1234                                     continue;
1235                                 } else {
1236                                     $success = false;
1237                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1238                                                                              array('errno'=>ldap_errno($ldapconnection),
1239                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1240                                                                                    'key'=>$key,
1241                                                                                    'ouvalue'=>$ouvalue,
1242                                                                                    'nuvalue'=>$nuvalue)));
1243                                     continue;
1244                                 }
1245                             }
1246                         } else {
1247                             // Ambiguous. Value empty before in Moodle (and LDAP) - use
1248                             // 1st ldap candidate field, no need to guess
1249                             if ($ouvalue === '') { // value empty before - use 1st ldap candidate
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                             }
1266                             // We found which ldap key to update!
1267                             if ($ouvalue !== '' and $ouvalue === $ldapvalue ) {
1268                                 // This might fail due to schema validation
1269                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1270                                     $changed = true;
1271                                     continue;
1272                                 } else {
1273                                     $success = false;
1274                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1275                                                                              array('errno'=>ldap_errno($ldapconnection),
1276                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1277                                                                                    'key'=>$key,
1278                                                                                    'ouvalue'=>$ouvalue,
1279                                                                                    'nuvalue'=>$nuvalue)));
1280                                     continue;
1281                                 }
1282                             }
1283                         }
1284                     }
1286                     if ($ambiguous and !$changed) {
1287                         $success = false;
1288                         error_log($this->errorlogtag.get_string ('updateremfailamb', 'auth_ldap',
1289                                                                  array('key'=>$key,
1290                                                                        'ouvalue'=>$ouvalue,
1291                                                                        'nuvalue'=>$nuvalue)));
1292                     }
1293                 }
1294             }
1295         } else {
1296             error_log($this->errorlogtag.get_string ('usernotfound', 'auth_ldap'));
1297             $success = false;
1298         }
1300         $this->ldap_close();
1301         return $success;
1303     }
1305     /**
1306      * Changes userpassword in LDAP
1307      *
1308      * Called when the user password is updated. It assumes it is
1309      * called by an admin or that you've otherwise checked the user's
1310      * credentials
1311      *
1312      * @param  object  $user        User table object
1313      * @param  string  $newpassword Plaintext password (not crypted/md5'ed)
1314      * @return boolean result
1315      *
1316      */
1317     function user_update_password($user, $newpassword) {
1318         global $USER;
1320         $result = false;
1321         $username = $user->username;
1323         $extusername = core_text::convert($username, 'utf-8', $this->config->ldapencoding);
1324         $extpassword = core_text::convert($newpassword, 'utf-8', $this->config->ldapencoding);
1326         switch ($this->config->passtype) {
1327             case 'md5':
1328                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
1329                 break;
1330             case 'sha1':
1331                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
1332                 break;
1333             case 'plaintext':
1334             default:
1335                 break; // plaintext
1336         }
1338         $ldapconnection = $this->ldap_connect();
1340         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
1342         if (!$user_dn) {
1343             error_log($this->errorlogtag.get_string ('nodnforusername', 'auth_ldap', $user->username));
1344             return false;
1345         }
1347         switch ($this->config->user_type) {
1348             case 'edir':
1349                 // Change password
1350                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1351                 if (!$result) {
1352                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1353                                                                array('errno'=>ldap_errno($ldapconnection),
1354                                                                      'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1355                 }
1356                 // Update password expiration time, grace logins count
1357                 $search_attribs = array($this->config->expireattr, 'passwordExpirationInterval', 'loginGraceLimit');
1358                 $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1359                 if ($sr) {
1360                     $entry = ldap_get_entries_moodle($ldapconnection, $sr);
1361                     $info = array_change_key_case($entry[0], CASE_LOWER);
1362                     $newattrs = array();
1363                     if (!empty($info[$this->config->expireattr][0])) {
1364                         // Set expiration time only if passwordExpirationInterval is defined
1365                         if (!empty($info['passwordexpirationinterval'][0])) {
1366                            $expirationtime = time() + $info['passwordexpirationinterval'][0];
1367                            $ldapexpirationtime = $this->ldap_unix2expirationtime($expirationtime);
1368                            $newattrs['passwordExpirationTime'] = $ldapexpirationtime;
1369                         }
1371                         // Set gracelogin count
1372                         if (!empty($info['logingracelimit'][0])) {
1373                            $newattrs['loginGraceRemaining']= $info['logingracelimit'][0];
1374                         }
1376                         // Store attribute changes in LDAP
1377                         $result = ldap_modify($ldapconnection, $user_dn, $newattrs);
1378                         if (!$result) {
1379                             error_log($this->errorlogtag.get_string ('updatepasserrorexpiregrace', 'auth_ldap',
1380                                                                        array('errno'=>ldap_errno($ldapconnection),
1381                                                                              'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1382                         }
1383                     }
1384                 }
1385                 else {
1386                     error_log($this->errorlogtag.get_string ('updatepasserrorexpire', 'auth_ldap',
1387                                                              array('errno'=>ldap_errno($ldapconnection),
1388                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1389                 }
1390                 break;
1392             case 'ad':
1393                 // Passwords in Active Directory must be encoded as Unicode
1394                 // strings (UCS-2 Little Endian format) and surrounded with
1395                 // double quotes. See http://support.microsoft.com/?kbid=269190
1396                 if (!function_exists('mb_convert_encoding')) {
1397                     error_log($this->errorlogtag.get_string ('needmbstring', 'auth_ldap'));
1398                     return false;
1399                 }
1400                 $extpassword = mb_convert_encoding('"'.$extpassword.'"', "UCS-2LE", $this->config->ldapencoding);
1401                 $result = ldap_modify($ldapconnection, $user_dn, array('unicodePwd' => $extpassword));
1402                 if (!$result) {
1403                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1404                                                              array('errno'=>ldap_errno($ldapconnection),
1405                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1406                 }
1407                 break;
1409             default:
1410                 // Send LDAP the password in cleartext, it will md5 it itself
1411                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1412                 if (!$result) {
1413                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1414                                                              array('errno'=>ldap_errno($ldapconnection),
1415                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1416                 }
1418         }
1420         $this->ldap_close();
1421         return $result;
1422     }
1424     /**
1425      * Take expirationtime and return it as unix timestamp in seconds
1426      *
1427      * Takes expiration timestamp as read from LDAP and returns it as unix timestamp in seconds
1428      * Depends on $this->config->user_type variable
1429      *
1430      * @param mixed time   Time stamp read from LDAP as it is.
1431      * @param string $ldapconnection Only needed for Active Directory.
1432      * @param string $user_dn User distinguished name for the user we are checking password expiration (only needed for Active Directory).
1433      * @return timestamp
1434      */
1435     function ldap_expirationtime2unix ($time, $ldapconnection, $user_dn) {
1436         $result = false;
1437         switch ($this->config->user_type) {
1438             case 'edir':
1439                 $yr=substr($time, 0, 4);
1440                 $mo=substr($time, 4, 2);
1441                 $dt=substr($time, 6, 2);
1442                 $hr=substr($time, 8, 2);
1443                 $min=substr($time, 10, 2);
1444                 $sec=substr($time, 12, 2);
1445                 $result = mktime($hr, $min, $sec, $mo, $dt, $yr);
1446                 break;
1447             case 'rfc2307':
1448             case 'rfc2307bis':
1449                 $result = $time * DAYSECS; // The shadowExpire contains the number of DAYS between 01/01/1970 and the actual expiration date
1450                 break;
1451             case 'ad':
1452                 $result = $this->ldap_get_ad_pwdexpire($time, $ldapconnection, $user_dn);
1453                 break;
1454             default:
1455                 print_error('auth_ldap_usertypeundefined', 'auth_ldap');
1456         }
1457         return $result;
1458     }
1460     /**
1461      * Takes unix timestamp and returns it formated for storing in LDAP
1462      *
1463      * @param integer unix time stamp
1464      */
1465     function ldap_unix2expirationtime($time) {
1466         $result = false;
1467         switch ($this->config->user_type) {
1468             case 'edir':
1469                 $result=date('YmdHis', $time).'Z';
1470                 break;
1471             case 'rfc2307':
1472             case 'rfc2307bis':
1473                 $result = $time ; // Already in correct format
1474                 break;
1475             default:
1476                 print_error('auth_ldap_usertypeundefined2', 'auth_ldap');
1477         }
1478         return $result;
1480     }
1482     /**
1483      * Returns user attribute mappings between moodle and LDAP
1484      *
1485      * @return array
1486      */
1488     function ldap_attributes () {
1489         $moodleattributes = array();
1490         // If we have custom fields then merge them with user fields.
1491         $customfields = $this->get_custom_user_profile_fields();
1492         if (!empty($customfields) && !empty($this->userfields)) {
1493             $userfields = array_merge($this->userfields, $customfields);
1494         } else {
1495             $userfields = $this->userfields;
1496         }
1498         foreach ($userfields as $field) {
1499             if (!empty($this->config->{"field_map_$field"})) {
1500                 $moodleattributes[$field] = core_text::strtolower(trim($this->config->{"field_map_$field"}));
1501                 if (preg_match('/,/', $moodleattributes[$field])) {
1502                     $moodleattributes[$field] = explode(',', $moodleattributes[$field]); // split ?
1503                 }
1504             }
1505         }
1506         $moodleattributes['username'] = core_text::strtolower(trim($this->config->user_attribute));
1507         return $moodleattributes;
1508     }
1510     /**
1511      * Returns all usernames from LDAP
1512      *
1513      * @param $filter An LDAP search filter to select desired users
1514      * @return array of LDAP user names converted to UTF-8
1515      */
1516     function ldap_get_userlist($filter='*') {
1517         $fresult = array();
1519         $ldapconnection = $this->ldap_connect();
1521         if ($filter == '*') {
1522            $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
1523         }
1525         $contexts = explode(';', $this->config->contexts);
1526         if (!empty($this->config->create_context)) {
1527             array_push($contexts, $this->config->create_context);
1528         }
1530         $ldap_cookie = '';
1531         $ldap_pagedresults = ldap_paged_results_supported($this->config->ldap_version);
1532         foreach ($contexts as $context) {
1533             $context = trim($context);
1534             if (empty($context)) {
1535                 continue;
1536             }
1538             do {
1539                 if ($ldap_pagedresults) {
1540                     ldap_control_paged_result($ldapconnection, $this->config->pagesize, true, $ldap_cookie);
1541                 }
1542                 if ($this->config->search_sub) {
1543                     // Use ldap_search to find first user from subtree.
1544                     $ldap_result = ldap_search($ldapconnection, $context, $filter, array($this->config->user_attribute));
1545                 } else {
1546                     // Search only in this context.
1547                     $ldap_result = ldap_list($ldapconnection, $context, $filter, array($this->config->user_attribute));
1548                 }
1549                 if(!$ldap_result) {
1550                     continue;
1551                 }
1552                 if ($ldap_pagedresults) {
1553                     ldap_control_paged_result_response($ldapconnection, $ldap_result, $ldap_cookie);
1554                 }
1555                 $users = ldap_get_entries_moodle($ldapconnection, $ldap_result);
1556                 // Add found users to list.
1557                 for ($i = 0; $i < count($users); $i++) {
1558                     $extuser = core_text::convert($users[$i][$this->config->user_attribute][0],
1559                                                 $this->config->ldapencoding, 'utf-8');
1560                     array_push($fresult, $extuser);
1561                 }
1562                 unset($ldap_result); // Free mem.
1563             } while ($ldap_pagedresults && !empty($ldap_cookie));
1564         }
1566         // If paged results were used, make sure the current connection is completely closed
1567         $this->ldap_close($ldap_pagedresults);
1568         return $fresult;
1569     }
1571     /**
1572      * Indicates if password hashes should be stored in local moodle database.
1573      *
1574      * @return bool true means flag 'not_cached' stored instead of password hash
1575      */
1576     function prevent_local_passwords() {
1577         return !empty($this->config->preventpassindb);
1578     }
1580     /**
1581      * Returns true if this authentication plugin is 'internal'.
1582      *
1583      * @return bool
1584      */
1585     function is_internal() {
1586         return false;
1587     }
1589     /**
1590      * Returns true if this authentication plugin can change the user's
1591      * password.
1592      *
1593      * @return bool
1594      */
1595     function can_change_password() {
1596         return !empty($this->config->stdchangepassword) or !empty($this->config->changepasswordurl);
1597     }
1599     /**
1600      * Returns the URL for changing the user's password, or empty if the default can
1601      * be used.
1602      *
1603      * @return moodle_url
1604      */
1605     function change_password_url() {
1606         if (empty($this->config->stdchangepassword)) {
1607             if (!empty($this->config->changepasswordurl)) {
1608                 return new moodle_url($this->config->changepasswordurl);
1609             } else {
1610                 return null;
1611             }
1612         } else {
1613             return null;
1614         }
1615     }
1617     /**
1618      * Will get called before the login page is shownr. Ff NTLM SSO
1619      * is enabled, and the user is in the right network, we'll redirect
1620      * to the magic NTLM page for SSO...
1621      *
1622      */
1623     function loginpage_hook() {
1624         global $CFG, $SESSION;
1626         // HTTPS is potentially required
1627         //httpsrequired(); - this must be used before setting the URL, it is already done on the login/index.php
1629         if (($_SERVER['REQUEST_METHOD'] === 'GET'         // Only on initial GET of loginpage
1630              || ($_SERVER['REQUEST_METHOD'] === 'POST'
1631                  && (get_local_referer() != strip_querystring(qualified_me()))))
1632                                                           // Or when POSTed from another place
1633                                                           // See MDL-14071
1634             && !empty($this->config->ntlmsso_enabled)     // SSO enabled
1635             && !empty($this->config->ntlmsso_subnet)      // have a subnet to test for
1636             && empty($_GET['authldap_skipntlmsso'])       // haven't failed it yet
1637             && (isguestuser() || !isloggedin())           // guestuser or not-logged-in users
1638             && address_in_subnet(getremoteaddr(), $this->config->ntlmsso_subnet)) {
1640             // First, let's remember where we were trying to get to before we got here
1641             if (empty($SESSION->wantsurl)) {
1642                 $SESSION->wantsurl = null;
1643                 $referer = get_local_referer(false);
1644                 if ($referer &&
1645                         $referer != $CFG->wwwroot &&
1646                         $referer != $CFG->wwwroot . '/' &&
1647                         $referer != $CFG->httpswwwroot . '/login/' &&
1648                         $referer != $CFG->httpswwwroot . '/login/index.php') {
1649                     $SESSION->wantsurl = $referer;
1650                 }
1651             }
1653             // Now start the whole NTLM machinery.
1654             if($this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESATTEMPT ||
1655                 $this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESFORM) {
1656                 if (core_useragent::is_ie()) {
1657                     $sesskey = sesskey();
1658                     redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_magic.php?sesskey='.$sesskey);
1659                 } else if ($this->config->ntlmsso_ie_fastpath == AUTH_NTLM_FASTPATH_YESFORM) {
1660                     redirect($CFG->httpswwwroot.'/login/index.php?authldap_skipntlmsso=1');
1661                 }
1662             }
1663             redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_attempt.php');
1664         }
1666         // No NTLM SSO, Use the normal login page instead.
1668         // If $SESSION->wantsurl is empty and we have a 'Referer:' header, the login
1669         // page insists on redirecting us to that page after user validation. If
1670         // we clicked on the redirect link at the ntlmsso_finish.php page (instead
1671         // of waiting for the redirection to happen) then we have a 'Referer:' header
1672         // we don't want to use at all. As we can't get rid of it, just point
1673         // $SESSION->wantsurl to $CFG->wwwroot (after all, we came from there).
1674         if (empty($SESSION->wantsurl)
1675             && (get_local_referer() == $CFG->httpswwwroot.'/auth/ldap/ntlmsso_finish.php')) {
1677             $SESSION->wantsurl = $CFG->wwwroot;
1678         }
1679     }
1681     /**
1682      * To be called from a page running under NTLM's
1683      * "Integrated Windows Authentication".
1684      *
1685      * If successful, it will set a special "cookie" (not an HTTP cookie!)
1686      * in cache_flags under the $this->pluginconfig/ntlmsess "plugin" and return true.
1687      * The "cookie" will be picked up by ntlmsso_finish() to complete the
1688      * process.
1689      *
1690      * On failure it will return false for the caller to display an appropriate
1691      * error message (probably saying that Integrated Windows Auth isn't enabled!)
1692      *
1693      * NOTE that this code will execute under the OS user credentials,
1694      * so we MUST avoid dealing with files -- such as session files.
1695      * (The caller should define('NO_MOODLE_COOKIES', true) before including config.php)
1696      *
1697      */
1698     function ntlmsso_magic($sesskey) {
1699         if (isset($_SERVER['REMOTE_USER']) && !empty($_SERVER['REMOTE_USER'])) {
1701             // HTTP __headers__ seem to be sent in ISO-8859-1 encoding
1702             // (according to my reading of RFC-1945, RFC-2616 and RFC-2617 and
1703             // my local tests), so we need to convert the REMOTE_USER value
1704             // (i.e., what we got from the HTTP WWW-Authenticate header) into UTF-8
1705             $username = core_text::convert($_SERVER['REMOTE_USER'], 'iso-8859-1', 'utf-8');
1707             switch ($this->config->ntlmsso_type) {
1708                 case 'ntlm':
1709                     // The format is now configurable, so try to extract the username
1710                     $username = $this->get_ntlm_remote_user($username);
1711                     if (empty($username)) {
1712                         return false;
1713                     }
1714                     break;
1715                 case 'kerberos':
1716                     // Format is username@DOMAIN
1717                     $username = substr($username, 0, strpos($username, '@'));
1718                     break;
1719                 default:
1720                     error_log($this->errorlogtag.get_string ('ntlmsso_unknowntype', 'auth_ldap'));
1721                     return false; // Should never happen!
1722             }
1724             $username = core_text::strtolower($username); // Compatibility hack
1725             set_cache_flag($this->pluginconfig.'/ntlmsess', $sesskey, $username, AUTH_NTLMTIMEOUT);
1726             return true;
1727         }
1728         return false;
1729     }
1731     /**
1732      * Find the session set by ntlmsso_magic(), validate it and
1733      * call authenticate_user_login() to authenticate the user through
1734      * the auth machinery.
1735      *
1736      * It is complemented by a similar check in user_login().
1737      *
1738      * If it succeeds, it never returns.
1739      *
1740      */
1741     function ntlmsso_finish() {
1742         global $CFG, $USER, $SESSION;
1744         $key = sesskey();
1745         $cf = get_cache_flags($this->pluginconfig.'/ntlmsess');
1746         if (!isset($cf[$key]) || $cf[$key] === '') {
1747             return false;
1748         }
1749         $username   = $cf[$key];
1751         // Here we want to trigger the whole authentication machinery
1752         // to make sure no step is bypassed...
1753         $user = authenticate_user_login($username, $key);
1754         if ($user) {
1755             complete_user_login($user);
1757             // Cleanup the key to prevent reuse...
1758             // and to allow re-logins with normal credentials
1759             unset_cache_flag($this->pluginconfig.'/ntlmsess', $key);
1761             // Redirection
1762             if (user_not_fully_set_up($USER)) {
1763                 $urltogo = $CFG->wwwroot.'/user/edit.php';
1764                 // We don't delete $SESSION->wantsurl yet, so we get there later
1765             } else if (isset($SESSION->wantsurl) and (strpos($SESSION->wantsurl, $CFG->wwwroot) === 0)) {
1766                 $urltogo = $SESSION->wantsurl;    // Because it's an address in this site
1767                 unset($SESSION->wantsurl);
1768             } else {
1769                 // No wantsurl stored or external - go to homepage
1770                 $urltogo = $CFG->wwwroot.'/';
1771                 unset($SESSION->wantsurl);
1772             }
1773             // We do not want to redirect if we are in a PHPUnit test.
1774             if (!PHPUNIT_TEST) {
1775                 redirect($urltogo);
1776             }
1777         }
1778         // Should never reach here.
1779         return false;
1780     }
1782     /**
1783      * Sync roles for this user
1784      *
1785      * @param $user object user object (without system magic quotes)
1786      */
1787     function sync_roles($user) {
1788         $iscreator = $this->iscreator($user->username);
1789         if ($iscreator === null) {
1790             return; // Nothing to sync - creators not configured
1791         }
1793         if ($roles = get_archetype_roles('coursecreator')) {
1794             $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
1795             $systemcontext = context_system::instance();
1797             if ($iscreator) { // Following calls will not create duplicates
1798                 role_assign($creatorrole->id, $user->id, $systemcontext->id, $this->roleauth);
1799             } else {
1800                 // Unassign only if previously assigned by this plugin!
1801                 role_unassign($creatorrole->id, $user->id, $systemcontext->id, $this->roleauth);
1802             }
1803         }
1804     }
1806     /**
1807      * Prints a form for configuring this authentication plugin.
1808      *
1809      * This function is called from admin/auth.php, and outputs a full page with
1810      * a form for configuring this plugin.
1811      *
1812      * @param array $page An object containing all the data for this page.
1813      */
1814     function config_form($config, $err, $user_fields) {
1815         global $CFG, $OUTPUT;
1817         if (!function_exists('ldap_connect')) { // Is php-ldap really there?
1818             echo $OUTPUT->notification(get_string('auth_ldap_noextension', 'auth_ldap'));
1819             return;
1820         }
1822         include($CFG->dirroot.'/auth/ldap/config.html');
1823     }
1825     /**
1826      * Processes and stores configuration data for this authentication plugin.
1827      */
1828     function process_config($config) {
1829         // Set to defaults if undefined
1830         if (!isset($config->host_url)) {
1831              $config->host_url = '';
1832         }
1833         if (!isset($config->start_tls)) {
1834              $config->start_tls = false;
1835         }
1836         if (empty($config->ldapencoding)) {
1837          $config->ldapencoding = 'utf-8';
1838         }
1839         if (!isset($config->pagesize)) {
1840             $config->pagesize = LDAP_DEFAULT_PAGESIZE;
1841         }
1842         if (!isset($config->contexts)) {
1843              $config->contexts = '';
1844         }
1845         if (!isset($config->user_type)) {
1846              $config->user_type = 'default';
1847         }
1848         if (!isset($config->user_attribute)) {
1849              $config->user_attribute = '';
1850         }
1851         if (!isset($config->search_sub)) {
1852              $config->search_sub = '';
1853         }
1854         if (!isset($config->opt_deref)) {
1855              $config->opt_deref = LDAP_DEREF_NEVER;
1856         }
1857         if (!isset($config->preventpassindb)) {
1858              $config->preventpassindb = 0;
1859         }
1860         if (!isset($config->bind_dn)) {
1861             $config->bind_dn = '';
1862         }
1863         if (!isset($config->bind_pw)) {
1864             $config->bind_pw = '';
1865         }
1866         if (!isset($config->ldap_version)) {
1867             $config->ldap_version = '3';
1868         }
1869         if (!isset($config->objectclass)) {
1870             $config->objectclass = '';
1871         }
1872         if (!isset($config->memberattribute)) {
1873             $config->memberattribute = '';
1874         }
1875         if (!isset($config->memberattribute_isdn)) {
1876             $config->memberattribute_isdn = '';
1877         }
1878         if (!isset($config->creators)) {
1879             $config->creators = '';
1880         }
1881         if (!isset($config->create_context)) {
1882             $config->create_context = '';
1883         }
1884         if (!isset($config->expiration)) {
1885             $config->expiration = '';
1886         }
1887         if (!isset($config->expiration_warning)) {
1888             $config->expiration_warning = '10';
1889         }
1890         if (!isset($config->expireattr)) {
1891             $config->expireattr = '';
1892         }
1893         if (!isset($config->gracelogins)) {
1894             $config->gracelogins = '';
1895         }
1896         if (!isset($config->graceattr)) {
1897             $config->graceattr = '';
1898         }
1899         if (!isset($config->auth_user_create)) {
1900             $config->auth_user_create = '';
1901         }
1902         if (!isset($config->forcechangepassword)) {
1903             $config->forcechangepassword = 0;
1904         }
1905         if (!isset($config->stdchangepassword)) {
1906             $config->stdchangepassword = 0;
1907         }
1908         if (!isset($config->passtype)) {
1909             $config->passtype = 'plaintext';
1910         }
1911         if (!isset($config->changepasswordurl)) {
1912             $config->changepasswordurl = '';
1913         }
1914         if (!isset($config->removeuser)) {
1915             $config->removeuser = AUTH_REMOVEUSER_KEEP;
1916         }
1917         if (!isset($config->ntlmsso_enabled)) {
1918             $config->ntlmsso_enabled = 0;
1919         }
1920         if (!isset($config->ntlmsso_subnet)) {
1921             $config->ntlmsso_subnet = '';
1922         }
1923         if (!isset($config->ntlmsso_ie_fastpath)) {
1924             $config->ntlmsso_ie_fastpath = 0;
1925         }
1926         if (!isset($config->ntlmsso_type)) {
1927             $config->ntlmsso_type = 'ntlm';
1928         }
1929         if (!isset($config->ntlmsso_remoteuserformat)) {
1930             $config->ntlmsso_remoteuserformat = '';
1931         }
1933         // Try to remove duplicates before storing the contexts (to avoid problems in sync_users()).
1934         $config->contexts = explode(';', $config->contexts);
1935         $config->contexts = array_map(create_function('$x', 'return core_text::strtolower(trim($x));'),
1936                                       $config->contexts);
1937         $config->contexts = implode(';', array_unique($config->contexts));
1939         // Save settings
1940         set_config('host_url', trim($config->host_url), $this->pluginconfig);
1941         set_config('start_tls', $config->start_tls, $this->pluginconfig);
1942         set_config('ldapencoding', trim($config->ldapencoding), $this->pluginconfig);
1943         set_config('pagesize', (int)trim($config->pagesize), $this->pluginconfig);
1944         set_config('contexts', $config->contexts, $this->pluginconfig);
1945         set_config('user_type', core_text::strtolower(trim($config->user_type)), $this->pluginconfig);
1946         set_config('user_attribute', core_text::strtolower(trim($config->user_attribute)), $this->pluginconfig);
1947         set_config('search_sub', $config->search_sub, $this->pluginconfig);
1948         set_config('opt_deref', $config->opt_deref, $this->pluginconfig);
1949         set_config('preventpassindb', $config->preventpassindb, $this->pluginconfig);
1950         set_config('bind_dn', trim($config->bind_dn), $this->pluginconfig);
1951         set_config('bind_pw', $config->bind_pw, $this->pluginconfig);
1952         set_config('ldap_version', $config->ldap_version, $this->pluginconfig);
1953         set_config('objectclass', trim($config->objectclass), $this->pluginconfig);
1954         set_config('memberattribute', core_text::strtolower(trim($config->memberattribute)), $this->pluginconfig);
1955         set_config('memberattribute_isdn', $config->memberattribute_isdn, $this->pluginconfig);
1956         set_config('creators', trim($config->creators), $this->pluginconfig);
1957         set_config('create_context', trim($config->create_context), $this->pluginconfig);
1958         set_config('expiration', $config->expiration, $this->pluginconfig);
1959         set_config('expiration_warning', trim($config->expiration_warning), $this->pluginconfig);
1960         set_config('expireattr', core_text::strtolower(trim($config->expireattr)), $this->pluginconfig);
1961         set_config('gracelogins', $config->gracelogins, $this->pluginconfig);
1962         set_config('graceattr', core_text::strtolower(trim($config->graceattr)), $this->pluginconfig);
1963         set_config('auth_user_create', $config->auth_user_create, $this->pluginconfig);
1964         set_config('forcechangepassword', $config->forcechangepassword, $this->pluginconfig);
1965         set_config('stdchangepassword', $config->stdchangepassword, $this->pluginconfig);
1966         set_config('passtype', $config->passtype, $this->pluginconfig);
1967         set_config('changepasswordurl', trim($config->changepasswordurl), $this->pluginconfig);
1968         set_config('removeuser', $config->removeuser, $this->pluginconfig);
1969         set_config('ntlmsso_enabled', (int)$config->ntlmsso_enabled, $this->pluginconfig);
1970         set_config('ntlmsso_subnet', trim($config->ntlmsso_subnet), $this->pluginconfig);
1971         set_config('ntlmsso_ie_fastpath', (int)$config->ntlmsso_ie_fastpath, $this->pluginconfig);
1972         set_config('ntlmsso_type', $config->ntlmsso_type, 'auth/ldap');
1973         set_config('ntlmsso_remoteuserformat', trim($config->ntlmsso_remoteuserformat), 'auth/ldap');
1975         return true;
1976     }
1978     /**
1979      * Get password expiration time for a given user from Active Directory
1980      *
1981      * @param string $pwdlastset The time last time we changed the password.
1982      * @param resource $lcapconn The open LDAP connection.
1983      * @param string $user_dn The distinguished name of the user we are checking.
1984      *
1985      * @return string $unixtime
1986      */
1987     function ldap_get_ad_pwdexpire($pwdlastset, $ldapconn, $user_dn){
1988         global $CFG;
1990         if (!function_exists('bcsub')) {
1991             error_log($this->errorlogtag.get_string ('needbcmath', 'auth_ldap'));
1992             return 0;
1993         }
1995         // If UF_DONT_EXPIRE_PASSWD flag is set in user's
1996         // userAccountControl attribute, the password doesn't expire.
1997         $sr = ldap_read($ldapconn, $user_dn, '(objectClass=*)',
1998                         array('userAccountControl'));
1999         if (!$sr) {
2000             error_log($this->errorlogtag.get_string ('useracctctrlerror', 'auth_ldap', $user_dn));
2001             // Don't expire password, as we are not sure if it has to be
2002             // expired or not.
2003             return 0;
2004         }
2006         $entry = ldap_get_entries_moodle($ldapconn, $sr);
2007         $info = array_change_key_case($entry[0], CASE_LOWER);
2008         $useraccountcontrol = $info['useraccountcontrol'][0];
2009         if ($useraccountcontrol & UF_DONT_EXPIRE_PASSWD) {
2010             // Password doesn't expire.
2011             return 0;
2012         }
2014         // If pwdLastSet is zero, the user must change his/her password now
2015         // (unless UF_DONT_EXPIRE_PASSWD flag is set, but we already
2016         // tested this above)
2017         if ($pwdlastset === '0') {
2018             // Password has expired
2019             return -1;
2020         }
2022         // ----------------------------------------------------------------
2023         // Password expiration time in Active Directory is the composition of
2024         // two values:
2025         //
2026         //   - User's pwdLastSet attribute, that stores the last time
2027         //     the password was changed.
2028         //
2029         //   - Domain's maxPwdAge attribute, that sets how long
2030         //     passwords last in this domain.
2031         //
2032         // We already have the first value (passed in as a parameter). We
2033         // need to get the second one. As we don't know the domain DN, we
2034         // have to query rootDSE's defaultNamingContext attribute to get
2035         // it. Then we have to query that DN's maxPwdAge attribute to get
2036         // the real value.
2037         //
2038         // Once we have both values, we just need to combine them. But MS
2039         // chose to use a different base and unit for time measurements.
2040         // So we need to convert the values to Unix timestamps (see
2041         // details below).
2042         // ----------------------------------------------------------------
2044         $sr = ldap_read($ldapconn, ROOTDSE, '(objectClass=*)',
2045                         array('defaultNamingContext'));
2046         if (!$sr) {
2047             error_log($this->errorlogtag.get_string ('rootdseerror', 'auth_ldap'));
2048             return 0;
2049         }
2051         $entry = ldap_get_entries_moodle($ldapconn, $sr);
2052         $info = array_change_key_case($entry[0], CASE_LOWER);
2053         $domaindn = $info['defaultnamingcontext'][0];
2055         $sr = ldap_read ($ldapconn, $domaindn, '(objectClass=*)',
2056                          array('maxPwdAge'));
2057         $entry = ldap_get_entries_moodle($ldapconn, $sr);
2058         $info = array_change_key_case($entry[0], CASE_LOWER);
2059         $maxpwdage = $info['maxpwdage'][0];
2060         if ($sr = ldap_read($ldapconn, $user_dn, '(objectClass=*)', array('msDS-ResultantPSO', 'msDS-MaximumPasswordAge'))) {
2061             if ($entry = ldap_get_entries_moodle($ldapconn, $sr)) {
2062                 $info = array_change_key_case($entry[0], CASE_LOWER);
2063                 $userpso = $info['msds-resultantpso'][0];
2065                 // If a PSO exists, FGPP is being utilized.
2066                 // Grab the new maxpwdage from the msDS-MaximumPasswordAge attribute of the PSO.
2067                 if (!empty($userpso)) {
2068                     if ($entry = ldap_get_entries_moodle($ldapconn, $sr)) {
2069                         $info = array_change_key_case($entry[0], CASE_LOWER);
2070                         $maxpwdage = $info['msds-maximumpasswordage'][0];
2071                     }
2072                 }
2073             }
2074         }
2075         // ----------------------------------------------------------------
2076         // MSDN says that "pwdLastSet contains the number of 100 nanosecond
2077         // intervals since January 1, 1601 (UTC), stored in a 64 bit integer".
2078         //
2079         // According to Perl's Date::Manip, the number of seconds between
2080         // this date and Unix epoch is 11644473600. So we have to
2081         // substract this value to calculate a Unix time, once we have
2082         // scaled pwdLastSet to seconds. This is the script used to
2083         // calculate the value shown above:
2084         //
2085         //    #!/usr/bin/perl -w
2086         //
2087         //    use Date::Manip;
2088         //
2089         //    $date1 = ParseDate ("160101010000 UTC");
2090         //    $date2 = ParseDate ("197001010000 UTC");
2091         //    $delta = DateCalc($date1, $date2, \$err);
2092         //    $secs = Delta_Format($delta, 0, "%st");
2093         //    print "$secs \n";
2094         //
2095         // MSDN also says that "maxPwdAge is stored as a large integer that
2096         // represents the number of 100 nanosecond intervals from the time
2097         // the password was set before the password expires." We also need
2098         // to scale this to seconds. Bear in mind that this value is stored
2099         // as a _negative_ quantity (at least in my AD domain).
2100         //
2101         // As a last remark, if the low 32 bits of maxPwdAge are equal to 0,
2102         // the maximum password age in the domain is set to 0, which means
2103         // passwords do not expire (see
2104         // http://msdn2.microsoft.com/en-us/library/ms974598.aspx)
2105         //
2106         // As the quantities involved are too big for PHP integers, we
2107         // need to use BCMath functions to work with arbitrary precision
2108         // numbers.
2109         // ----------------------------------------------------------------
2111         // If the low order 32 bits are 0, then passwords do not expire in
2112         // the domain. Just do '$maxpwdage mod 2^32' and check the result
2113         // (2^32 = 4294967296)
2114         if (bcmod ($maxpwdage, 4294967296) === '0') {
2115             return 0;
2116         }
2118         // Add up pwdLastSet and maxPwdAge to get password expiration
2119         // time, in MS time units. Remember maxPwdAge is stored as a
2120         // _negative_ quantity, so we need to substract it in fact.
2121         $pwdexpire = bcsub ($pwdlastset, $maxpwdage);
2123         // Scale the result to convert it to Unix time units and return
2124         // that value.
2125         return bcsub( bcdiv($pwdexpire, '10000000'), '11644473600');
2126     }
2128     /**
2129      * Connect to the LDAP server, using the plugin configured
2130      * settings. It's actually a wrapper around ldap_connect_moodle()
2131      *
2132      * @return resource A valid LDAP connection (or dies if it can't connect)
2133      */
2134     function ldap_connect() {
2135         // Cache ldap connections. They are expensive to set up
2136         // and can drain the TCP/IP ressources on the server if we
2137         // are syncing a lot of users (as we try to open a new connection
2138         // to get the user details). This is the least invasive way
2139         // to reuse existing connections without greater code surgery.
2140         if(!empty($this->ldapconnection)) {
2141             $this->ldapconns++;
2142             return $this->ldapconnection;
2143         }
2145         if($ldapconnection = ldap_connect_moodle($this->config->host_url, $this->config->ldap_version,
2146                                                  $this->config->user_type, $this->config->bind_dn,
2147                                                  $this->config->bind_pw, $this->config->opt_deref,
2148                                                  $debuginfo, $this->config->start_tls)) {
2149             $this->ldapconns = 1;
2150             $this->ldapconnection = $ldapconnection;
2151             return $ldapconnection;
2152         }
2154         print_error('auth_ldap_noconnect_all', 'auth_ldap', '', $debuginfo);
2155     }
2157     /**
2158      * Disconnects from a LDAP server
2159      *
2160      * @param force boolean Forces closing the real connection to the LDAP server, ignoring any
2161      *                      cached connections. This is needed when we've used paged results
2162      *                      and want to use normal results again.
2163      */
2164     function ldap_close($force=false) {
2165         $this->ldapconns--;
2166         if (($this->ldapconns == 0) || ($force)) {
2167             $this->ldapconns = 0;
2168             @ldap_close($this->ldapconnection);
2169             unset($this->ldapconnection);
2170         }
2171     }
2173     /**
2174      * Search specified contexts for username and return the user dn
2175      * like: cn=username,ou=suborg,o=org. It's actually a wrapper
2176      * around ldap_find_userdn().
2177      *
2178      * @param resource $ldapconnection a valid LDAP connection
2179      * @param string $extusername the username to search (in external LDAP encoding, no db slashes)
2180      * @return mixed the user dn (external LDAP encoding) or false
2181      */
2182     function ldap_find_userdn($ldapconnection, $extusername) {
2183         $ldap_contexts = explode(';', $this->config->contexts);
2184         if (!empty($this->config->create_context)) {
2185             array_push($ldap_contexts, $this->config->create_context);
2186         }
2188         return ldap_find_userdn($ldapconnection, $extusername, $ldap_contexts, $this->config->objectclass,
2189                                 $this->config->user_attribute, $this->config->search_sub);
2190     }
2193     /**
2194      * A chance to validate form data, and last chance to do stuff
2195      * before it is inserted in config_plugin
2196      *
2197      * @param object object with submitted configuration settings (without system magic quotes)
2198      * @param array $err array of error messages (passed by reference)
2199      */
2200     function validate_form($form, &$err) {
2201         if ($form->ntlmsso_type == 'ntlm') {
2202             $format = trim($form->ntlmsso_remoteuserformat);
2203             if (!empty($format) && !preg_match('/%username%/i', $format)) {
2204                 $err['ntlmsso_remoteuserformat'] = get_string('auth_ntlmsso_missing_username', 'auth_ldap');
2205             }
2206         }
2207     }
2210     /**
2211      * When using NTLM SSO, the format of the remote username we get in
2212      * $_SERVER['REMOTE_USER'] may vary, depending on where from and how the web
2213      * server gets the data. So we let the admin configure the format using two
2214      * place holders (%domain% and %username%). This function tries to extract
2215      * the username (stripping the domain part and any separators if they are
2216      * present) from the value present in $_SERVER['REMOTE_USER'], using the
2217      * configured format.
2218      *
2219      * @param string $remoteuser The value from $_SERVER['REMOTE_USER'] (converted to UTF-8)
2220      *
2221      * @return string The remote username (without domain part or
2222      *                separators). Empty string if we can't extract the username.
2223      */
2224     protected function get_ntlm_remote_user($remoteuser) {
2225         if (empty($this->config->ntlmsso_remoteuserformat)) {
2226             $format = AUTH_NTLM_DEFAULT_FORMAT;
2227         } else {
2228             $format = $this->config->ntlmsso_remoteuserformat;
2229         }
2231         $format = preg_quote($format);
2232         $formatregex = preg_replace(array('#%domain%#', '#%username%#'),
2233                                     array('('.AUTH_NTLM_VALID_DOMAINNAME.')', '('.AUTH_NTLM_VALID_USERNAME.')'),
2234                                     $format);
2235         if (preg_match('#^'.$formatregex.'$#', $remoteuser, $matches)) {
2236             $user = end($matches);
2237             return $user;
2238         }
2240         /* We are unable to extract the username with the configured format. Probably
2241          * the format specified is wrong, so log a warning for the admin and return
2242          * an empty username.
2243          */
2244         error_log($this->errorlogtag.get_string ('auth_ntlmsso_maybeinvalidformat', 'auth_ldap'));
2245         return '';
2246     }
2248     /**
2249      * Check if the diagnostic message for the LDAP login error tells us that the
2250      * login is denied because the user password has expired or the password needs
2251      * to be changed on first login (using interactive SMB/Windows logins, not
2252      * LDAP logins).
2253      *
2254      * @param string the diagnostic message for the LDAP login error
2255      * @return bool true if the password has expired or the password must be changed on first login
2256      */
2257     protected function ldap_ad_pwdexpired_from_diagmsg($diagmsg) {
2258         // The format of the diagnostic message is (actual examples from W2003 and W2008):
2259         // "80090308: LdapErr: DSID-0C090334, comment: AcceptSecurityContext error, data 52e, vece"  (W2003)
2260         // "80090308: LdapErr: DSID-0C090334, comment: AcceptSecurityContext error, data 773, vece"  (W2003)
2261         // "80090308: LdapErr: DSID-0C0903AA, comment: AcceptSecurityContext error, data 52e, v1771" (W2008)
2262         // "80090308: LdapErr: DSID-0C0903AA, comment: AcceptSecurityContext error, data 773, v1771" (W2008)
2263         // We are interested in the 'data nnn' part.
2264         //   if nnn == 773 then user must change password on first login
2265         //   if nnn == 532 then user password has expired
2266         $diagmsg = explode(',', $diagmsg);
2267         if (preg_match('/data (773|532)/i', trim($diagmsg[2]))) {
2268             return true;
2269         }
2270         return false;
2271     }
2273 } // End of the class