fa7c2c515444fd1499de1f03157c943b48408066
[moodle.git] / auth / ldap / auth.php
1 <?php
3 /**
4  * @author Martin Dougiamas
5  * @author I´┐Żaki Arenaza
6  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
7  * @package moodle multiauth
8  *
9  * Authentication Plugin: LDAP Authentication
10  *
11  * Authentication using LDAP (Lightweight Directory Access Protocol).
12  *
13  * 2006-08-28  File created.
14  */
16 if (!defined('MOODLE_INTERNAL')) {
17     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
18 }
20 // See http://support.microsoft.com/kb/305144 to interprete these values.
21 if (!defined('AUTH_AD_ACCOUNTDISABLE')) {
22     define('AUTH_AD_ACCOUNTDISABLE', 0x0002);
23 }
24 if (!defined('AUTH_AD_NORMAL_ACCOUNT')) {
25     define('AUTH_AD_NORMAL_ACCOUNT', 0x0200);
26 }
27 if (!defined('AUTH_NTLMTIMEOUT')) {  // timewindow for the NTLM SSO process, in secs...
28     define('AUTH_NTLMTIMEOUT', 10);
29 }
31 // UF_DONT_EXPIRE_PASSWD value taken from MSDN directly
32 if (!defined('UF_DONT_EXPIRE_PASSWD')) {
33     define ('UF_DONT_EXPIRE_PASSWD', 0x00010000);
34 }
36 // The Posix uid and gid of the 'nobody' account and 'nogroup' group.
37 if (!defined('AUTH_UID_NOBODY')) {
38     define('AUTH_UID_NOBODY', -2);
39 }
40 if (!defined('AUTH_GID_NOGROUP')) {
41     define('AUTH_GID_NOGROUP', -2);
42 }
44 require_once($CFG->libdir.'/authlib.php');
45 require_once($CFG->libdir.'/ldaplib.php');
47 /**
48  * LDAP authentication plugin.
49  */
50 class auth_plugin_ldap extends auth_plugin_base {
52     /**
53      * Init plugin config from database settings depending on the plugin auth type.
54      */
55     function init_plugin($authtype) {
56         $this->pluginconfig = 'auth/'.$authtype;
57         $this->config = get_config($this->pluginconfig);
58         if (empty($this->config->ldapencoding)) {
59             $this->config->ldapencoding = 'utf-8';
60         }
61         if (empty($this->config->user_type)) {
62             $this->config->user_type = 'default';
63         }
65         $ldap_usertypes = ldap_supported_usertypes();
66         $this->config->user_type_name = $ldap_usertypes[$this->config->user_type];
67         unset($ldap_usertypes);
69         $default = ldap_getdefaults();
71         // Use defaults if values not given
72         foreach ($default as $key => $value) {
73             // watch out - 0, false are correct values too
74             if (!isset($this->config->{$key}) or $this->config->{$key} == '') {
75                 $this->config->{$key} = $value[$this->config->user_type];
76             }
77         }
79         // Hack prefix to objectclass
80         if (empty($this->config->objectclass)) {
81             // Can't send empty filter
82             $this->config->objectclass = '(objectClass=*)';
83         } else if (stripos($this->config->objectclass, 'objectClass=') === 0) {
84             // Value is 'objectClass=some-string-here', so just add ()
85             // around the value (filter _must_ have them).
86             $this->config->objectclass = '('.$this->config->objectclass.')';
87         } else if (strpos($this->config->objectclass, '(') !== 0) {
88             // Value is 'some-string-not-starting-with-left-parentheses',
89             // which is assumed to be the objectClass matching value.
90             // So build a valid filter with it.
91             $this->config->objectclass = '(objectClass='.$this->config->objectclass.')';
92         } else {
93             // There is an additional possible value
94             // '(some-string-here)', that can be used to specify any
95             // valid filter string, to select subsets of users based
96             // on any criteria. For example, we could select the users
97             // whose objectClass is 'user' and have the
98             // 'enabledMoodleUser' attribute, with something like:
99             //
100             //   (&(objectClass=user)(enabledMoodleUser=1))
101             //
102             // In this particular case we don't need to do anything,
103             // so leave $this->config->objectclass as is.
104         }
105     }
107     /**
108      * Constructor with initialisation.
109      */
110     function auth_plugin_ldap() {
111         $this->authtype = 'ldap';
112         $this->roleauth = 'auth_ldap';
113         $this->errorlogtag = '[AUTH LDAP] ';
114         $this->init_plugin($this->authtype);
115     }
117     /**
118      * Returns true if the username and password work and false if they are
119      * wrong or don't exist.
120      *
121      * @param string $username The username (without system magic quotes)
122      * @param string $password The password (without system magic quotes)
123      *
124      * @return bool Authentication success or failure.
125      */
126     function user_login($username, $password) {
127         if (! function_exists('ldap_bind')) {
128             print_error('auth_ldapnotinstalled', 'auth_ldap');
129             return false;
130         }
132         if (!$username or !$password) {    // Don't allow blank usernames or passwords
133             return false;
134         }
136         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
137         $extpassword = textlib::convert($password, 'utf-8', $this->config->ldapencoding);
139         // Before we connect to LDAP, check if this is an AD SSO login
140         // if we succeed in this block, we'll return success early.
141         //
142         $key = sesskey();
143         if (!empty($this->config->ntlmsso_enabled) && $key === $password) {
144             $cf = get_cache_flags($this->pluginconfig.'/ntlmsess');
145             // We only get the cache flag if we retrieve it before
146             // it expires (AUTH_NTLMTIMEOUT seconds).
147             if (!isset($cf[$key]) || $cf[$key] === '') {
148                 return false;
149             }
151             $sessusername = $cf[$key];
152             if ($username === $sessusername) {
153                 unset($sessusername);
154                 unset($cf);
156                 // Check that the user is inside one of the configured LDAP contexts
157                 $validuser = false;
158                 $ldapconnection = $this->ldap_connect();
159                 // if the user is not inside the configured contexts,
160                 // ldap_find_userdn returns false.
161                 if ($this->ldap_find_userdn($ldapconnection, $extusername)) {
162                     $validuser = true;
163                 }
164                 $this->ldap_close();
166                 // Shortcut here - SSO confirmed
167                 return $validuser;
168             }
169         } // End SSO processing
170         unset($key);
172         $ldapconnection = $this->ldap_connect();
173         $ldap_user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
175         // If ldap_user_dn is empty, user does not exist
176         if (!$ldap_user_dn) {
177             $this->ldap_close();
178             return false;
179         }
181         // Try to bind with current username and password
182         $ldap_login = @ldap_bind($ldapconnection, $ldap_user_dn, $extpassword);
183         $this->ldap_close();
184         if ($ldap_login) {
185             return true;
186         }
187         return false;
188     }
190     /**
191      * Reads user information from ldap and returns it in array()
192      *
193      * Function should return all information available. If you are saving
194      * this information to moodle user-table you should honor syncronization flags
195      *
196      * @param string $username username
197      *
198      * @return mixed array with no magic quotes or false on error
199      */
200     function get_userinfo($username) {
201         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
203         $ldapconnection = $this->ldap_connect();
204         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extusername))) {
205             return false;
206         }
208         $search_attribs = array();
209         $attrmap = $this->ldap_attributes();
210         foreach ($attrmap as $key => $values) {
211             if (!is_array($values)) {
212                 $values = array($values);
213             }
214             foreach ($values as $value) {
215                 if (!in_array($value, $search_attribs)) {
216                     array_push($search_attribs, $value);
217                 }
218             }
219         }
221         if (!$user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs)) {
222             return false; // error!
223         }
225         $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
226         if (empty($user_entry)) {
227             return false; // entry not found
228         }
230         $result = array();
231         foreach ($attrmap as $key => $values) {
232             if (!is_array($values)) {
233                 $values = array($values);
234             }
235             $ldapval = NULL;
236             foreach ($values as $value) {
237                 $entry = array_change_key_case($user_entry[0], CASE_LOWER);
238                 if (($value == 'dn') || ($value == 'distinguishedname')) {
239                     $result[$key] = $user_dn;
240                     continue;
241                 }
242                 if (!array_key_exists($value, $entry)) {
243                     continue; // wrong data mapping!
244                 }
245                 if (is_array($entry[$value])) {
246                     $newval = textlib::convert($entry[$value][0], $this->config->ldapencoding, 'utf-8');
247                 } else {
248                     $newval = textlib::convert($entry[$value], $this->config->ldapencoding, 'utf-8');
249                 }
250                 if (!empty($newval)) { // favour ldap entries that are set
251                     $ldapval = $newval;
252                 }
253             }
254             if (!is_null($ldapval)) {
255                 $result[$key] = $ldapval;
256             }
257         }
259         $this->ldap_close();
260         return $result;
261     }
263     /**
264      * Reads user information from ldap and returns it in an object
265      *
266      * @param string $username username (with system magic quotes)
267      * @return mixed object or false on error
268      */
269     function get_userinfo_asobj($username) {
270         $user_array = $this->get_userinfo($username);
271         if ($user_array == false) {
272             return false; //error or not found
273         }
274         $user_array = truncate_userinfo($user_array);
275         $user = new stdClass();
276         foreach ($user_array as $key=>$value) {
277             $user->{$key} = $value;
278         }
279         return $user;
280     }
282     /**
283      * Returns all usernames from LDAP
284      *
285      * get_userlist returns all usernames from LDAP
286      *
287      * @return array
288      */
289     function get_userlist() {
290         return $this->ldap_get_userlist("({$this->config->user_attribute}=*)");
291     }
293     /**
294      * Checks if user exists on LDAP
295      *
296      * @param string $username
297      */
298     function user_exists($username) {
299         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
301         // Returns true if given username exists on ldap
302         $users = $this->ldap_get_userlist('('.$this->config->user_attribute.'='.ldap_filter_addslashes($extusername).')');
303         return count($users);
304     }
306     /**
307      * Creates a new user on LDAP.
308      * By using information in userobject
309      * Use user_exists to prevent duplicate usernames
310      *
311      * @param mixed $userobject  Moodle userobject
312      * @param mixed $plainpass   Plaintext password
313      */
314     function user_create($userobject, $plainpass) {
315         $extusername = textlib::convert($userobject->username, 'utf-8', $this->config->ldapencoding);
316         $extpassword = textlib::convert($plainpass, 'utf-8', $this->config->ldapencoding);
318         switch ($this->config->passtype) {
319             case 'md5':
320                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
321                 break;
322             case 'sha1':
323                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
324                 break;
325             case 'plaintext':
326             default:
327                 break; // plaintext
328         }
330         $ldapconnection = $this->ldap_connect();
331         $attrmap = $this->ldap_attributes();
333         $newuser = array();
335         foreach ($attrmap as $key => $values) {
336             if (!is_array($values)) {
337                 $values = array($values);
338             }
339             foreach ($values as $value) {
340                 if (!empty($userobject->$key) ) {
341                     $newuser[$value] = textlib::convert($userobject->$key, 'utf-8', $this->config->ldapencoding);
342                 }
343             }
344         }
346         //Following sets all mandatory and other forced attribute values
347         //User should be creted as login disabled untill email confirmation is processed
348         //Feel free to add your user type and send patches to paca@sci.fi to add them
349         //Moodle distribution
351         switch ($this->config->user_type)  {
352             case 'edir':
353                 $newuser['objectClass']   = array('inetOrgPerson', 'organizationalPerson', 'person', 'top');
354                 $newuser['uniqueId']      = $extusername;
355                 $newuser['logindisabled'] = 'TRUE';
356                 $newuser['userpassword']  = $extpassword;
357                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
358                 break;
359             case 'rfc2307':
360             case 'rfc2307bis':
361                 // posixAccount object class forces us to specify a uidNumber
362                 // and a gidNumber. That is quite complicated to generate from
363                 // Moodle without colliding with existing numbers and without
364                 // race conditions. As this user is supposed to be only used
365                 // with Moodle (otherwise the user would exist beforehand) and
366                 // doesn't need to login into a operating system, we assign the
367                 // user the uid of user 'nobody' and gid of group 'nogroup'. In
368                 // addition to that, we need to specify a home directory. We
369                 // use the root directory ('/') as the home directory, as this
370                 // is the only one can always be sure exists. Finally, even if
371                 // it's not mandatory, we specify '/bin/false' as the login
372                 // shell, to prevent the user from login in at the operating
373                 // system level (Moodle ignores this).
375                 $newuser['objectClass']   = array('posixAccount', 'inetOrgPerson', 'organizationalPerson', 'person', 'top');
376                 $newuser['cn']            = $extusername;
377                 $newuser['uid']           = $extusername;
378                 $newuser['uidNumber']     = AUTH_UID_NOBODY;
379                 $newuser['gidNumber']     = AUTH_GID_NOGROUP;
380                 $newuser['homeDirectory'] = '/';
381                 $newuser['loginShell']    = '/bin/false';
383                 // IMPORTANT:
384                 // We have to create the account locked, but posixAccount has
385                 // no attribute to achive this reliably. So we are going to
386                 // modify the password in a reversable way that we can later
387                 // revert in user_activate().
388                 //
389                 // Beware that this can be defeated by the user if we are not
390                 // using MD5 or SHA-1 passwords. After all, the source code of
391                 // Moodle is available, and the user can see the kind of
392                 // modification we are doing and 'undo' it by hand (but only
393                 // if we are using plain text passwords).
394                 //
395                 // Also bear in mind that you need to use a binding user that
396                 // can create accounts and has read/write privileges on the
397                 // 'userPassword' attribute for this to work.
399                 $newuser['userPassword']  = '*'.$extpassword;
400                 $uadd = ldap_add($ldapconnection, $this->config->user_attribute.'='.ldap_addslashes($extusername).','.$this->config->create_context, $newuser);
401                 break;
402             case 'ad':
403                 // User account creation is a two step process with AD. First you
404                 // create the user object, then you set the password. If you try
405                 // to set the password while creating the user, the operation
406                 // fails.
408                 // Passwords in Active Directory must be encoded as Unicode
409                 // strings (UCS-2 Little Endian format) and surrounded with
410                 // double quotes. See http://support.microsoft.com/?kbid=269190
411                 if (!function_exists('mb_convert_encoding')) {
412                     print_error('auth_ldap_no_mbstring', 'auth_ldap');
413                 }
415                 // Check for invalid sAMAccountName characters.
416                 if (preg_match('#[/\\[\]:;|=,+*?<>@"]#', $extusername)) {
417                     print_error ('auth_ldap_ad_invalidchars', 'auth_ldap');
418                 }
420                 // First create the user account, and mark it as disabled.
421                 $newuser['objectClass'] = array('top', 'person', 'user', 'organizationalPerson');
422                 $newuser['sAMAccountName'] = $extusername;
423                 $newuser['userAccountControl'] = AUTH_AD_NORMAL_ACCOUNT |
424                                                  AUTH_AD_ACCOUNTDISABLE;
425                 $userdn = 'cn='.ldap_addslashes($extusername).','.$this->config->create_context;
426                 if (!ldap_add($ldapconnection, $userdn, $newuser)) {
427                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
428                 }
430                 // Now set the password
431                 unset($newuser);
432                 $newuser['unicodePwd'] = mb_convert_encoding('"' . $extpassword . '"',
433                                                              'UCS-2LE', 'UTF-8');
434                 if(!ldap_modify($ldapconnection, $userdn, $newuser)) {
435                     // Something went wrong: delete the user account and error out
436                     ldap_delete ($ldapconnection, $userdn);
437                     print_error('auth_ldap_ad_create_req', 'auth_ldap');
438                 }
439                 $uadd = true;
440                 break;
441             default:
442                print_error('auth_ldap_unsupportedusertype', 'auth_ldap', '', $this->config->user_type_name);
443         }
444         $this->ldap_close();
445         return $uadd;
446     }
448     /**
449      * Returns true if plugin allows resetting of password from moodle.
450      *
451      * @return bool
452      */
453     function can_reset_password() {
454         return !empty($this->config->stdchangepassword);
455     }
457     /**
458      * Returns true if plugin allows signup and user creation.
459      *
460      * @return bool
461      */
462     function can_signup() {
463         return (!empty($this->config->auth_user_create) and !empty($this->config->create_context));
464     }
466     /**
467      * Sign up a new user ready for confirmation.
468      * Password is passed in plaintext.
469      *
470      * @param object $user new user object
471      * @param boolean $notify print notice with link and terminate
472      */
473     function user_signup($user, $notify=true) {
474         global $CFG, $DB, $PAGE, $OUTPUT;
476         require_once($CFG->dirroot.'/user/profile/lib.php');
478         if ($this->user_exists($user->username)) {
479             print_error('auth_ldap_user_exists', 'auth_ldap');
480         }
482         $plainslashedpassword = $user->password;
483         unset($user->password);
485         if (! $this->user_create($user, $plainslashedpassword)) {
486             print_error('auth_ldap_create_error', 'auth_ldap');
487         }
489         $user->id = $DB->insert_record('user', $user);
491         // Save any custom profile field information
492         profile_save_data($user);
494         $this->update_user_record($user->username);
495         update_internal_user_password($user, $plainslashedpassword);
497         $user = $DB->get_record('user', array('id'=>$user->id));
498         events_trigger('user_created', $user);
500         if (! send_confirmation_email($user)) {
501             print_error('noemail', 'auth_ldap');
502         }
504         if ($notify) {
505             $emailconfirm = get_string('emailconfirm');
506             $PAGE->set_url('/auth/ldap/auth.php');
507             $PAGE->navbar->add($emailconfirm);
508             $PAGE->set_title($emailconfirm);
509             $PAGE->set_heading($emailconfirm);
510             echo $OUTPUT->header();
511             notice(get_string('emailconfirmsent', '', $user->email), "{$CFG->wwwroot}/index.php");
512         } else {
513             return true;
514         }
515     }
517     /**
518      * Returns true if plugin allows confirming of new users.
519      *
520      * @return bool
521      */
522     function can_confirm() {
523         return $this->can_signup();
524     }
526     /**
527      * Confirm the new user as registered.
528      *
529      * @param string $username
530      * @param string $confirmsecret
531      */
532     function user_confirm($username, $confirmsecret) {
533         global $DB;
535         $user = get_complete_user_data('username', $username);
537         if (!empty($user)) {
538             if ($user->confirmed) {
539                 return AUTH_CONFIRM_ALREADY;
541             } else if ($user->auth != $this->authtype) {
542                 return AUTH_CONFIRM_ERROR;
544             } else if ($user->secret == $confirmsecret) {   // They have provided the secret key to get in
545                 if (!$this->user_activate($username)) {
546                     return AUTH_CONFIRM_FAIL;
547                 }
548                 $DB->set_field('user', 'confirmed', 1, array('id'=>$user->id));
549                 if ($user->firstaccess == 0) {
550                     $DB->set_field('user', 'firstaccess', time(), array('id'=>$user->id));
551                 }
552                 $euser = $DB->get_record('user', array('id' => $user->id));
553                 events_trigger('user_updated', $euser);
554                 return AUTH_CONFIRM_OK;
555             }
556         } else {
557             return AUTH_CONFIRM_ERROR;
558         }
559     }
561     /**
562      * Return number of days to user password expires
563      *
564      * If userpassword does not expire it should return 0. If password is already expired
565      * it should return negative value.
566      *
567      * @param mixed $username username
568      * @return integer
569      */
570     function password_expire($username) {
571         $result = 0;
573         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
575         $ldapconnection = $this->ldap_connect();
576         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
577         $search_attribs = array($this->config->expireattr);
578         $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
579         if ($sr)  {
580             $info = ldap_get_entries_moodle($ldapconnection, $sr);
581             if (!empty ($info)) {
582                 $info = array_change_key_case($info[0], CASE_LOWER);
583                 if (!empty($info[$this->config->expireattr][0])) {
584                     $expiretime = $this->ldap_expirationtime2unix($info[$this->config->expireattr][0], $ldapconnection, $user_dn);
585                     if ($expiretime != 0) {
586                         $now = time();
587                         if ($expiretime > $now) {
588                             $result = ceil(($expiretime - $now) / DAYSECS);
589                         } else {
590                             $result = floor(($expiretime - $now) / DAYSECS);
591                         }
592                     }
593                 }
594             }
595         } else {
596             error_log($this->errorlogtag.get_string('didtfindexpiretime', 'auth_ldap'));
597         }
599         return $result;
600     }
602     /**
603      * Syncronizes user fron external LDAP server to moodle user table
604      *
605      * Sync is now using username attribute.
606      *
607      * Syncing users removes or suspends users that dont exists anymore in external LDAP.
608      * Creates new users and updates coursecreator status of users.
609      *
610      * @param bool $do_updates will do pull in data updates from LDAP if relevant
611      */
612     function sync_users($do_updates=true) {
613         global $CFG, $DB;
615         print_string('connectingldap', 'auth_ldap');
616         $ldapconnection = $this->ldap_connect();
618         $dbman = $DB->get_manager();
620     /// Define table user to be created
621         $table = new xmldb_table('tmp_extuser');
622         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
623         $table->add_field('username', XMLDB_TYPE_CHAR, '100', null, XMLDB_NOTNULL, null, null);
624         $table->add_field('mnethostid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null);
625         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
626         $table->add_index('username', XMLDB_INDEX_UNIQUE, array('mnethostid', 'username'));
628         print_string('creatingtemptable', 'auth_ldap', 'tmp_extuser');
629         $dbman->create_temp_table($table);
631         ////
632         //// get user's list from ldap to sql in a scalable fashion
633         ////
634         // prepare some data we'll need
635         $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
637         $contexts = explode(';', $this->config->contexts);
639         if (!empty($this->config->create_context)) {
640               array_push($contexts, $this->config->create_context);
641         }
643         $fresult = array();
644         foreach ($contexts as $context) {
645             $context = trim($context);
646             if (empty($context)) {
647                 continue;
648             }
649             if ($this->config->search_sub) {
650                 //use ldap_search to find first user from subtree
651                 $ldap_result = ldap_search($ldapconnection, $context,
652                                            $filter,
653                                            array($this->config->user_attribute));
654             } else {
655                 //search only in this context
656                 $ldap_result = ldap_list($ldapconnection, $context,
657                                          $filter,
658                                          array($this->config->user_attribute));
659             }
661             if(!$ldap_result) {
662                 continue;
663             }
665             if ($entry = @ldap_first_entry($ldapconnection, $ldap_result)) {
666                 do {
667                     $value = ldap_get_values_len($ldapconnection, $entry, $this->config->user_attribute);
668                     $value = textlib::convert($value[0], $this->config->ldapencoding, 'utf-8');
669                     $this->ldap_bulk_insert($value);
670                 } while ($entry = ldap_next_entry($ldapconnection, $entry));
671             }
672             unset($ldap_result); // free mem
673         }
675         /// preserve our user database
676         /// if the temp table is empty, it probably means that something went wrong, exit
677         /// so as to avoid mass deletion of users; which is hard to undo
678         $count = $DB->count_records_sql('SELECT COUNT(username) AS count, 1 FROM {tmp_extuser}');
679         if ($count < 1) {
680             print_string('didntgetusersfromldap', 'auth_ldap');
681             exit;
682         } else {
683             print_string('gotcountrecordsfromldap', 'auth_ldap', $count);
684         }
687 /// User removal
688         // Find users in DB that aren't in ldap -- to be removed!
689         // this is still not as scalable (but how often do we mass delete?)
690         if ($this->config->removeuser != AUTH_REMOVEUSER_KEEP) {
691             $sql = 'SELECT u.*
692                       FROM {user} u
693                       LEFT JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
694                      WHERE u.auth = ?
695                            AND u.deleted = 0
696                            AND e.username IS NULL';
697             $remove_users = $DB->get_records_sql($sql, array($this->authtype));
699             if (!empty($remove_users)) {
700                 print_string('userentriestoremove', 'auth_ldap', count($remove_users));
702                 foreach ($remove_users as $user) {
703                     if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
704                         if (delete_user($user)) {
705                             echo "\t"; print_string('auth_dbdeleteuser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
706                         } else {
707                             echo "\t"; print_string('auth_dbdeleteusererror', 'auth_db', $user->username); echo "\n";
708                         }
709                     } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
710                         $updateuser = new stdClass();
711                         $updateuser->id = $user->id;
712                         $updateuser->auth = 'nologin';
713                         $DB->update_record('user', $updateuser);
714                         echo "\t"; print_string('auth_dbsuspenduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
715                         $euser = $DB->get_record('user', array('id' => $user->id));
716                         events_trigger('user_updated', $euser);
717                     }
718                 }
719             } else {
720                 print_string('nouserentriestoremove', 'auth_ldap');
721             }
722             unset($remove_users); // free mem!
723         }
725 /// Revive suspended users
726         if (!empty($this->config->removeuser) and $this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
727             $sql = "SELECT u.id, u.username
728                       FROM {user} u
729                       JOIN {tmp_extuser} e ON (u.username = e.username AND u.mnethostid = e.mnethostid)
730                      WHERE u.auth = 'nologin' AND u.deleted = 0";
731             $revive_users = $DB->get_records_sql($sql);
733             if (!empty($revive_users)) {
734                 print_string('userentriestorevive', 'auth_ldap', count($revive_users));
736                 foreach ($revive_users as $user) {
737                     $updateuser = new stdClass();
738                     $updateuser->id = $user->id;
739                     $updateuser->auth = $this->authtype;
740                     $DB->update_record('user', $updateuser);
741                     echo "\t"; print_string('auth_dbreviveduser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id)); echo "\n";
742                     $euser = $DB->get_record('user', array('id' => $user->id));
743                     events_trigger('user_updated', $euser);
744                 }
745             } else {
746                 print_string('nouserentriestorevive', 'auth_ldap');
747             }
749             unset($revive_users);
750         }
753 /// User Updates - time-consuming (optional)
754         if ($do_updates) {
755             // Narrow down what fields we need to update
756             $all_keys = array_keys(get_object_vars($this->config));
757             $updatekeys = array();
758             foreach ($all_keys as $key) {
759                 if (preg_match('/^field_updatelocal_(.+)$/', $key, $match)) {
760                     // If we have a field to update it from
761                     // and it must be updated 'onlogin' we
762                     // update it on cron
763                     if (!empty($this->config->{'field_map_'.$match[1]})
764                          and $this->config->{$match[0]} === 'onlogin') {
765                         array_push($updatekeys, $match[1]); // the actual key name
766                     }
767                 }
768             }
769             unset($all_keys); unset($key);
771         } else {
772             print_string('noupdatestobedone', 'auth_ldap');
773         }
774         if ($do_updates and !empty($updatekeys)) { // run updates only if relevant
775             $users = $DB->get_records_sql('SELECT u.username, u.id
776                                              FROM {user} u
777                                             WHERE u.deleted = 0 AND u.auth = ? AND u.mnethostid = ?',
778                                           array($this->authtype, $CFG->mnet_localhost_id));
779             if (!empty($users)) {
780                 print_string('userentriestoupdate', 'auth_ldap', count($users));
782                 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
783                 if (!empty($this->config->creators) and !empty($this->config->memberattribute)
784                   and $roles = get_archetype_roles('coursecreator')) {
785                     $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
786                 } else {
787                     $creatorrole = false;
788                 }
790                 $transaction = $DB->start_delegated_transaction();
791                 $xcount = 0;
792                 $maxxcount = 100;
794                 foreach ($users as $user) {
795                     echo "\t"; print_string('auth_dbupdatinguser', 'auth_db', array('name'=>$user->username, 'id'=>$user->id));
796                     if (!$this->update_user_record($user->username, $updatekeys)) {
797                         echo ' - '.get_string('skipped');
798                     }
799                     echo "\n";
800                     $xcount++;
802                     // Update course creators if needed
803                     if ($creatorrole !== false) {
804                         if ($this->iscreator($user->username)) {
805                             role_assign($creatorrole->id, $user->id, $sitecontext->id, $this->roleauth);
806                         } else {
807                             role_unassign($creatorrole->id, $user->id, $sitecontext->id, $this->roleauth);
808                         }
809                     }
810                 }
811                 $transaction->allow_commit();
812                 unset($users); // free mem
813             }
814         } else { // end do updates
815             print_string('noupdatestobedone', 'auth_ldap');
816         }
818 /// User Additions
819         // Find users missing in DB that are in LDAP
820         // and gives me a nifty object I don't want.
821         // note: we do not care about deleted accounts anymore, this feature was replaced by suspending to nologin auth plugin
822         $sql = 'SELECT e.id, e.username
823                   FROM {tmp_extuser} e
824                   LEFT JOIN {user} u ON (e.username = u.username AND e.mnethostid = u.mnethostid)
825                  WHERE u.id IS NULL';
826         $add_users = $DB->get_records_sql($sql);
828         if (!empty($add_users)) {
829             print_string('userentriestoadd', 'auth_ldap', count($add_users));
831             $sitecontext = get_context_instance(CONTEXT_SYSTEM);
832             if (!empty($this->config->creators) and !empty($this->config->memberattribute)
833               and $roles = get_archetype_roles('coursecreator')) {
834                 $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
835             } else {
836                 $creatorrole = false;
837             }
839             $transaction = $DB->start_delegated_transaction();
840             foreach ($add_users as $user) {
841                 $user = $this->get_userinfo_asobj($user->username);
843                 // Prep a few params
844                 $user->modified   = time();
845                 $user->confirmed  = 1;
846                 $user->auth       = $this->authtype;
847                 $user->mnethostid = $CFG->mnet_localhost_id;
848                 // get_userinfo_asobj() might have replaced $user->username with the value
849                 // from the LDAP server (which can be mixed-case). Make sure it's lowercase
850                 $user->username = trim(textlib::strtolower($user->username));
851                 if (empty($user->lang)) {
852                     $user->lang = $CFG->lang;
853                 }
855                 $id = $DB->insert_record('user', $user);
856                 echo "\t"; print_string('auth_dbinsertuser', 'auth_db', array('name'=>$user->username, 'id'=>$id)); echo "\n";
857                 $euser = $DB->get_record('user', array('id' => $user->id));
858                 events_trigger('user_created', $euser);
859                 if (!empty($this->config->forcechangepassword)) {
860                     set_user_preference('auth_forcepasswordchange', 1, $id);
861                 }
863                 // Add course creators if needed
864                 if ($creatorrole !== false and $this->iscreator($user->username)) {
865                     role_assign($creatorrole->id, $id, $sitecontext->id, $this->roleauth);
866                 }
868             }
869             $transaction->allow_commit();
870             unset($add_users); // free mem
871         } else {
872             print_string('nouserstobeadded', 'auth_ldap');
873         }
875         $dbman->drop_table($table);
876         $this->ldap_close();
878         return true;
879     }
881     /**
882      * Update a local user record from an external source.
883      * This is a lighter version of the one in moodlelib -- won't do
884      * expensive ops such as enrolment.
885      *
886      * If you don't pass $updatekeys, there is a performance hit and
887      * values removed from LDAP won't be removed from moodle.
888      *
889      * @param string $username username
890      * @param boolean $updatekeys true to update the local record with the external LDAP values.
891      */
892     function update_user_record($username, $updatekeys = false) {
893         global $CFG, $DB;
895         // Just in case check text case
896         $username = trim(textlib::strtolower($username));
898         // Get the current user record
899         $user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id));
900         if (empty($user)) { // trouble
901             error_log($this->errorlogtag.get_string('auth_dbusernotexist', 'auth_db', '', $username));
902             print_error('auth_dbusernotexist', 'auth_db', '', $username);
903             die;
904         }
906         // Protect the userid from being overwritten
907         $userid = $user->id;
909         if ($newinfo = $this->get_userinfo($username)) {
910             $newinfo = truncate_userinfo($newinfo);
912             if (empty($updatekeys)) { // all keys? this does not support removing values
913                 $updatekeys = array_keys($newinfo);
914             }
916             foreach ($updatekeys as $key) {
917                 if (isset($newinfo[$key])) {
918                     $value = $newinfo[$key];
919                 } else {
920                     $value = '';
921                 }
923                 if (!empty($this->config->{'field_updatelocal_' . $key})) {
924                     if ($user->{$key} != $value) { // only update if it's changed
925                         $DB->set_field('user', $key, $value, array('id'=>$userid));
926                     }
927                 }
928             }
929             if (!empty($updatekeys)) {
930                 $euser = $DB->get_record('user', array('id' => $userid));
931                 events_trigger('user_updated', $euser);
932             }
933         } else {
934             return false;
935         }
936         return $DB->get_record('user', array('id'=>$userid, 'deleted'=>0));
937     }
939     /**
940      * Bulk insert in SQL's temp table
941      */
942     function ldap_bulk_insert($username) {
943         global $DB, $CFG;
945         $username = textlib::strtolower($username); // usernames are __always__ lowercase.
946         $DB->insert_record_raw('tmp_extuser', array('username'=>$username,
947                                                     'mnethostid'=>$CFG->mnet_localhost_id), false, true);
948         echo '.';
949     }
951     /**
952      * Activates (enables) user in external LDAP so user can login
953      *
954      * @param mixed $username
955      * @return boolean result
956      */
957     function user_activate($username) {
958         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
960         $ldapconnection = $this->ldap_connect();
962         $userdn = $this->ldap_find_userdn($ldapconnection, $extusername);
963         switch ($this->config->user_type)  {
964             case 'edir':
965                 $newinfo['loginDisabled'] = 'FALSE';
966                 break;
967             case 'rfc2307':
968             case 'rfc2307bis':
969                 // Remember that we add a '*' character in front of the
970                 // external password string to 'disable' the account. We just
971                 // need to remove it.
972                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
973                                 array('userPassword'));
974                 $info = ldap_get_entries($ldapconnection, $sr);
975                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
976                 $newinfo['userPassword'] = ltrim($info[0]['userpassword'][0], '*');
977                 break;
978             case 'ad':
979                 // We need to unset the ACCOUNTDISABLE bit in the
980                 // userAccountControl attribute ( see
981                 // http://support.microsoft.com/kb/305144 )
982                 $sr = ldap_read($ldapconnection, $userdn, '(objectClass=*)',
983                                 array('userAccountControl'));
984                 $info = ldap_get_entries($ldapconnection, $sr);
985                 $info[0] = array_change_key_case($info[0], CASE_LOWER);
986                 $newinfo['userAccountControl'] = $info[0]['useraccountcontrol'][0]
987                                                  & (~AUTH_AD_ACCOUNTDISABLE);
988                 break;
989             default:
990                 print_error('user_activatenotsupportusertype', 'auth_ldap', '', $this->config->user_type_name);
991         }
992         $result = ldap_modify($ldapconnection, $userdn, $newinfo);
993         $this->ldap_close();
994         return $result;
995     }
997     /**
998      * Returns true if user should be coursecreator.
999      *
1000      * @param mixed $username    username (without system magic quotes)
1001      * @return mixed result      null if course creators is not configured, boolean otherwise.
1002      */
1003     function iscreator($username) {
1004         if (empty($this->config->creators) or empty($this->config->memberattribute)) {
1005             return null;
1006         }
1008         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
1010         $ldapconnection = $this->ldap_connect();
1012         if ($this->config->memberattribute_isdn) {
1013             if(!($userid = $this->ldap_find_userdn($ldapconnection, $extusername))) {
1014                 return false;
1015             }
1016         } else {
1017             $userid = $extusername;
1018         }
1020         $group_dns = explode(';', $this->config->creators);
1021         $creator = ldap_isgroupmember($ldapconnection, $userid, $group_dns, $this->config->memberattribute);
1023         $this->ldap_close();
1025         return $creator;
1026     }
1028     /**
1029      * Called when the user record is updated.
1030      *
1031      * Modifies user in external LDAP server. It takes olduser (before
1032      * changes) and newuser (after changes) compares information and
1033      * saves modified information to external LDAP server.
1034      *
1035      * @param mixed $olduser     Userobject before modifications    (without system magic quotes)
1036      * @param mixed $newuser     Userobject new modified userobject (without system magic quotes)
1037      * @return boolean result
1038      *
1039      */
1040     function user_update($olduser, $newuser) {
1041         global $USER;
1043         if (isset($olduser->username) and isset($newuser->username) and $olduser->username != $newuser->username) {
1044             error_log($this->errorlogtag.get_string('renamingnotallowed', 'auth_ldap'));
1045             return false;
1046         }
1048         if (isset($olduser->auth) and $olduser->auth != $this->authtype) {
1049             return true; // just change auth and skip update
1050         }
1052         $attrmap = $this->ldap_attributes();
1053         // Before doing anything else, make sure we really need to update anything
1054         // in the external LDAP server.
1055         $update_external = false;
1056         foreach ($attrmap as $key => $ldapkeys) {
1057             if (!empty($this->config->{'field_updateremote_'.$key})) {
1058                 $update_external = true;
1059                 break;
1060             }
1061         }
1062         if (!$update_external) {
1063             return true;
1064         }
1066         $extoldusername = textlib::convert($olduser->username, 'utf-8', $this->config->ldapencoding);
1068         $ldapconnection = $this->ldap_connect();
1070         $search_attribs = array();
1071         foreach ($attrmap as $key => $values) {
1072             if (!is_array($values)) {
1073                 $values = array($values);
1074             }
1075             foreach ($values as $value) {
1076                 if (!in_array($value, $search_attribs)) {
1077                     array_push($search_attribs, $value);
1078                 }
1079             }
1080         }
1082         if(!($user_dn = $this->ldap_find_userdn($ldapconnection, $extoldusername))) {
1083             return false;
1084         }
1086         $user_info_result = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1087         if ($user_info_result) {
1088             $user_entry = ldap_get_entries_moodle($ldapconnection, $user_info_result);
1089             if (empty($user_entry)) {
1090                 $attribs = join (', ', $search_attribs);
1091                 error_log($this->errorlogtag.get_string('updateusernotfound', 'auth_ldap',
1092                                                           array('userdn'=>$user_dn,
1093                                                                 'attribs'=>$attribs)));
1094                 return false; // old user not found!
1095             } else if (count($user_entry) > 1) {
1096                 error_log($this->errorlogtag.get_string('morethanoneuser', 'auth_ldap'));
1097                 return false;
1098             }
1100             $user_entry = array_change_key_case($user_entry[0], CASE_LOWER);
1102             foreach ($attrmap as $key => $ldapkeys) {
1103                 // Only process if the moodle field ($key) has changed and we
1104                 // are set to update LDAP with it
1105                 if (isset($olduser->$key) and isset($newuser->$key)
1106                   and $olduser->$key !== $newuser->$key
1107                   and !empty($this->config->{'field_updateremote_'. $key})) {
1108                     // For ldap values that could be in more than one
1109                     // ldap key, we will do our best to match
1110                     // where they came from
1111                     $ambiguous = true;
1112                     $changed   = false;
1113                     if (!is_array($ldapkeys)) {
1114                         $ldapkeys = array($ldapkeys);
1115                     }
1116                     if (count($ldapkeys) < 2) {
1117                         $ambiguous = false;
1118                     }
1120                     $nuvalue = textlib::convert($newuser->$key, 'utf-8', $this->config->ldapencoding);
1121                     empty($nuvalue) ? $nuvalue = array() : $nuvalue;
1122                     $ouvalue = textlib::convert($olduser->$key, 'utf-8', $this->config->ldapencoding);
1124                     foreach ($ldapkeys as $ldapkey) {
1125                         $ldapkey   = $ldapkey;
1126                         $ldapvalue = $user_entry[$ldapkey][0];
1127                         if (!$ambiguous) {
1128                             // Skip update if the values already match
1129                             if ($nuvalue !== $ldapvalue) {
1130                                 // This might fail due to schema validation
1131                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1132                                     continue;
1133                                 } else {
1134                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1135                                                                              array('errno'=>ldap_errno($ldapconnection),
1136                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1137                                                                                    'key'=>$key,
1138                                                                                    'ouvalue'=>$ouvalue,
1139                                                                                    'nuvalue'=>$nuvalue)));
1140                                     continue;
1141                                 }
1142                             }
1143                         } else {
1144                             // Ambiguous. Value empty before in Moodle (and LDAP) - use
1145                             // 1st ldap candidate field, no need to guess
1146                             if ($ouvalue === '') { // value empty before - use 1st ldap candidate
1147                                 // This might fail due to schema validation
1148                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1149                                     $changed = true;
1150                                     continue;
1151                                 } else {
1152                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1153                                                                              array('errno'=>ldap_errno($ldapconnection),
1154                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1155                                                                                    'key'=>$key,
1156                                                                                    'ouvalue'=>$ouvalue,
1157                                                                                    'nuvalue'=>$nuvalue)));
1158                                     continue;
1159                                 }
1160                             }
1162                             // We found which ldap key to update!
1163                             if ($ouvalue !== '' and $ouvalue === $ldapvalue ) {
1164                                 // This might fail due to schema validation
1165                                 if (@ldap_modify($ldapconnection, $user_dn, array($ldapkey => $nuvalue))) {
1166                                     $changed = true;
1167                                     continue;
1168                                 } else {
1169                                     error_log($this->errorlogtag.get_string ('updateremfail', 'auth_ldap',
1170                                                                              array('errno'=>ldap_errno($ldapconnection),
1171                                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)),
1172                                                                                    'key'=>$key,
1173                                                                                    'ouvalue'=>$ouvalue,
1174                                                                                    'nuvalue'=>$nuvalue)));
1175                                     continue;
1176                                 }
1177                             }
1178                         }
1179                     }
1181                     if ($ambiguous and !$changed) {
1182                         error_log($this->errorlogtag.get_string ('updateremfailamb', 'auth_ldap',
1183                                                                  array('key'=>$key,
1184                                                                        'ouvalue'=>$ouvalue,
1185                                                                        'nuvalue'=>$nuvalue)));
1186                     }
1187                 }
1188             }
1189         } else {
1190             error_log($this->errorlogtag.get_string ('usernotfound', 'auth_ldap'));
1191             $this->ldap_close();
1192             return false;
1193         }
1195         $this->ldap_close();
1196         return true;
1198     }
1200     /**
1201      * Changes userpassword in LDAP
1202      *
1203      * Called when the user password is updated. It assumes it is
1204      * called by an admin or that you've otherwise checked the user's
1205      * credentials
1206      *
1207      * @param  object  $user        User table object
1208      * @param  string  $newpassword Plaintext password (not crypted/md5'ed)
1209      * @return boolean result
1210      *
1211      */
1212     function user_update_password($user, $newpassword) {
1213         global $USER;
1215         $result = false;
1216         $username = $user->username;
1218         $extusername = textlib::convert($username, 'utf-8', $this->config->ldapencoding);
1219         $extpassword = textlib::convert($newpassword, 'utf-8', $this->config->ldapencoding);
1221         switch ($this->config->passtype) {
1222             case 'md5':
1223                 $extpassword = '{MD5}' . base64_encode(pack('H*', md5($extpassword)));
1224                 break;
1225             case 'sha1':
1226                 $extpassword = '{SHA}' . base64_encode(pack('H*', sha1($extpassword)));
1227                 break;
1228             case 'plaintext':
1229             default:
1230                 break; // plaintext
1231         }
1233         $ldapconnection = $this->ldap_connect();
1235         $user_dn = $this->ldap_find_userdn($ldapconnection, $extusername);
1237         if (!$user_dn) {
1238             error_log($this->errorlogtag.get_string ('nodnforusername', 'auth_ldap', $user->username));
1239             return false;
1240         }
1242         switch ($this->config->user_type) {
1243             case 'edir':
1244                 // Change password
1245                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1246                 if (!$result) {
1247                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1248                                                                array('errno'=>ldap_errno($ldapconnection),
1249                                                                      'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1250                 }
1251                 // Update password expiration time, grace logins count
1252                 $search_attribs = array($this->config->expireattr, 'passwordExpirationInterval', 'loginGraceLimit');
1253                 $sr = ldap_read($ldapconnection, $user_dn, '(objectClass=*)', $search_attribs);
1254                 if ($sr) {
1255                     $entry = ldap_get_entries_moodle($ldapconnection, $sr);
1256                     $info = array_change_key_case($entry[0], CASE_LOWER);
1257                     $newattrs = array();
1258                     if (!empty($info[$this->config->expireattr][0])) {
1259                         // Set expiration time only if passwordExpirationInterval is defined
1260                         if (!empty($info['passwordexpirationinterval'][0])) {
1261                            $expirationtime = time() + $info['passwordexpirationinterval'][0];
1262                            $ldapexpirationtime = $this->ldap_unix2expirationtime($expirationtime);
1263                            $newattrs['passwordExpirationTime'] = $ldapexpirationtime;
1264                         }
1266                         // Set gracelogin count
1267                         if (!empty($info['logingracelimit'][0])) {
1268                            $newattrs['loginGraceRemaining']= $info['logingracelimit'][0];
1269                         }
1271                         // Store attribute changes in LDAP
1272                         $result = ldap_modify($ldapconnection, $user_dn, $newattrs);
1273                         if (!$result) {
1274                             error_log($this->errorlogtag.get_string ('updatepasserrorexpiregrace', 'auth_ldap',
1275                                                                        array('errno'=>ldap_errno($ldapconnection),
1276                                                                              'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1277                         }
1278                     }
1279                 }
1280                 else {
1281                     error_log($this->errorlogtag.get_string ('updatepasserrorexpire', 'auth_ldap',
1282                                                              array('errno'=>ldap_errno($ldapconnection),
1283                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1284                 }
1285                 break;
1287             case 'ad':
1288                 // Passwords in Active Directory must be encoded as Unicode
1289                 // strings (UCS-2 Little Endian format) and surrounded with
1290                 // double quotes. See http://support.microsoft.com/?kbid=269190
1291                 if (!function_exists('mb_convert_encoding')) {
1292                     error_log($this->errorlogtag.get_string ('needmbstring', 'auth_ldap'));
1293                     return false;
1294                 }
1295                 $extpassword = mb_convert_encoding('"'.$extpassword.'"', "UCS-2LE", $this->config->ldapencoding);
1296                 $result = ldap_modify($ldapconnection, $user_dn, array('unicodePwd' => $extpassword));
1297                 if (!$result) {
1298                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1299                                                              array('errno'=>ldap_errno($ldapconnection),
1300                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1301                 }
1302                 break;
1304             default:
1305                 // Send LDAP the password in cleartext, it will md5 it itself
1306                 $result = ldap_modify($ldapconnection, $user_dn, array('userPassword' => $extpassword));
1307                 if (!$result) {
1308                     error_log($this->errorlogtag.get_string ('updatepasserror', 'auth_ldap',
1309                                                              array('errno'=>ldap_errno($ldapconnection),
1310                                                                    'errstring'=>ldap_err2str(ldap_errno($ldapconnection)))));
1311                 }
1313         }
1315         $this->ldap_close();
1316         return $result;
1317     }
1319     /**
1320      * Take expirationtime and return it as unix timestamp in seconds
1321      *
1322      * Takes expiration timestamp as read from LDAP and returns it as unix timestamp in seconds
1323      * Depends on $this->config->user_type variable
1324      *
1325      * @param mixed time   Time stamp read from LDAP as it is.
1326      * @param string $ldapconnection Only needed for Active Directory.
1327      * @param string $user_dn User distinguished name for the user we are checking password expiration (only needed for Active Directory).
1328      * @return timestamp
1329      */
1330     function ldap_expirationtime2unix ($time, $ldapconnection, $user_dn) {
1331         $result = false;
1332         switch ($this->config->user_type) {
1333             case 'edir':
1334                 $yr=substr($time, 0, 4);
1335                 $mo=substr($time, 4, 2);
1336                 $dt=substr($time, 6, 2);
1337                 $hr=substr($time, 8, 2);
1338                 $min=substr($time, 10, 2);
1339                 $sec=substr($time, 12, 2);
1340                 $result = mktime($hr, $min, $sec, $mo, $dt, $yr);
1341                 break;
1342             case 'rfc2307':
1343             case 'rfc2307bis':
1344                 $result = $time * DAYSECS; // The shadowExpire contains the number of DAYS between 01/01/1970 and the actual expiration date
1345                 break;
1346             case 'ad':
1347                 $result = $this->ldap_get_ad_pwdexpire($time, $ldapconnection, $user_dn);
1348                 break;
1349             default:
1350                 print_error('auth_ldap_usertypeundefined', 'auth_ldap');
1351         }
1352         return $result;
1353     }
1355     /**
1356      * Takes unix timestamp and returns it formated for storing in LDAP
1357      *
1358      * @param integer unix time stamp
1359      */
1360     function ldap_unix2expirationtime($time) {
1361         $result = false;
1362         switch ($this->config->user_type) {
1363             case 'edir':
1364                 $result=date('YmdHis', $time).'Z';
1365                 break;
1366             case 'rfc2307':
1367             case 'rfc2307bis':
1368                 $result = $time ; // Already in correct format
1369                 break;
1370             default:
1371                 print_error('auth_ldap_usertypeundefined2', 'auth_ldap');
1372         }
1373         return $result;
1375     }
1377     /**
1378      * Returns user attribute mappings between moodle and LDAP
1379      *
1380      * @return array
1381      */
1383     function ldap_attributes () {
1384         $moodleattributes = array();
1385         foreach ($this->userfields as $field) {
1386             if (!empty($this->config->{"field_map_$field"})) {
1387                 $moodleattributes[$field] = textlib::strtolower(trim($this->config->{"field_map_$field"}));
1388                 if (preg_match('/,/', $moodleattributes[$field])) {
1389                     $moodleattributes[$field] = explode(',', $moodleattributes[$field]); // split ?
1390                 }
1391             }
1392         }
1393         $moodleattributes['username'] = textlib::strtolower(trim($this->config->user_attribute));
1394         return $moodleattributes;
1395     }
1397     /**
1398      * Returns all usernames from LDAP
1399      *
1400      * @param $filter An LDAP search filter to select desired users
1401      * @return array of LDAP user names converted to UTF-8
1402      */
1403     function ldap_get_userlist($filter='*') {
1404         $fresult = array();
1406         $ldapconnection = $this->ldap_connect();
1408         if ($filter == '*') {
1409            $filter = '(&('.$this->config->user_attribute.'=*)'.$this->config->objectclass.')';
1410         }
1412         $contexts = explode(';', $this->config->contexts);
1413         if (!empty($this->config->create_context)) {
1414               array_push($contexts, $this->config->create_context);
1415         }
1417         foreach ($contexts as $context) {
1418             $context = trim($context);
1419             if (empty($context)) {
1420                 continue;
1421             }
1423             if ($this->config->search_sub) {
1424                 // Use ldap_search to find first user from subtree
1425                 $ldap_result = ldap_search($ldapconnection, $context,
1426                                            $filter,
1427                                            array($this->config->user_attribute));
1428             } else {
1429                 // Search only in this context
1430                 $ldap_result = ldap_list($ldapconnection, $context,
1431                                          $filter,
1432                                          array($this->config->user_attribute));
1433             }
1435             if(!$ldap_result) {
1436                 continue;
1437             }
1439             $users = ldap_get_entries_moodle($ldapconnection, $ldap_result);
1441             // Add found users to list
1442             for ($i = 0; $i < count($users); $i++) {
1443                 $extuser = textlib::convert($users[$i][$this->config->user_attribute][0],
1444                                              $this->config->ldapencoding, 'utf-8');
1445                 array_push($fresult, $extuser);
1446             }
1447         }
1449         $this->ldap_close();
1450         return $fresult;
1451     }
1453     /**
1454      * Indicates if password hashes should be stored in local moodle database.
1455      *
1456      * @return bool true means flag 'not_cached' stored instead of password hash
1457      */
1458     function prevent_local_passwords() {
1459         return !empty($this->config->preventpassindb);
1460     }
1462     /**
1463      * Returns true if this authentication plugin is 'internal'.
1464      *
1465      * @return bool
1466      */
1467     function is_internal() {
1468         return false;
1469     }
1471     /**
1472      * Returns true if this authentication plugin can change the user's
1473      * password.
1474      *
1475      * @return bool
1476      */
1477     function can_change_password() {
1478         return !empty($this->config->stdchangepassword) or !empty($this->config->changepasswordurl);
1479     }
1481     /**
1482      * Returns the URL for changing the user's password, or empty if the default can
1483      * be used.
1484      *
1485      * @return moodle_url
1486      */
1487     function change_password_url() {
1488         if (empty($this->config->stdchangepassword)) {
1489             return new moodle_url($this->config->changepasswordurl);
1490         } else {
1491             return null;
1492         }
1493     }
1495     /**
1496      * Will get called before the login page is shownr. Ff NTLM SSO
1497      * is enabled, and the user is in the right network, we'll redirect
1498      * to the magic NTLM page for SSO...
1499      *
1500      */
1501     function loginpage_hook() {
1502         global $CFG, $SESSION;
1504         // HTTPS is potentially required
1505         //httpsrequired(); - this must be used before setting the URL, it is already done on the login/index.php
1507         if (($_SERVER['REQUEST_METHOD'] === 'GET'         // Only on initial GET of loginpage
1508              || ($_SERVER['REQUEST_METHOD'] === 'POST'
1509                  && (get_referer() != strip_querystring(qualified_me()))))
1510                                                           // Or when POSTed from another place
1511                                                           // See MDL-14071
1512             && !empty($this->config->ntlmsso_enabled)     // SSO enabled
1513             && !empty($this->config->ntlmsso_subnet)      // have a subnet to test for
1514             && empty($_GET['authldap_skipntlmsso'])       // haven't failed it yet
1515             && (isguestuser() || !isloggedin())           // guestuser or not-logged-in users
1516             && address_in_subnet(getremoteaddr(), $this->config->ntlmsso_subnet)) {
1518             // First, let's remember where we were trying to get to before we got here
1519             if (empty($SESSION->wantsurl)) {
1520                 $SESSION->wantsurl = (array_key_exists('HTTP_REFERER', $_SERVER) &&
1521                                       $_SERVER['HTTP_REFERER'] != $CFG->wwwroot &&
1522                                       $_SERVER['HTTP_REFERER'] != $CFG->wwwroot.'/' &&
1523                                       $_SERVER['HTTP_REFERER'] != $CFG->httpswwwroot.'/login/' &&
1524                                       $_SERVER['HTTP_REFERER'] != $CFG->httpswwwroot.'/login/index.php')
1525                     ? $_SERVER['HTTP_REFERER'] : NULL;
1526             }
1528             // Now start the whole NTLM machinery.
1529             if(!empty($this->config->ntlmsso_ie_fastpath)) {
1530                 // Shortcut for IE browsers: skip the attempt page
1531                 if(check_browser_version('MSIE')) {
1532                     $sesskey = sesskey();
1533                     redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_magic.php?sesskey='.$sesskey);
1534                 } else {
1535                     redirect($CFG->httpswwwroot.'/login/index.php?authldap_skipntlmsso=1');
1536                 }
1537             } else {
1538                 redirect($CFG->wwwroot.'/auth/ldap/ntlmsso_attempt.php');
1539             }
1540         }
1542         // No NTLM SSO, Use the normal login page instead.
1544         // If $SESSION->wantsurl is empty and we have a 'Referer:' header, the login
1545         // page insists on redirecting us to that page after user validation. If
1546         // we clicked on the redirect link at the ntlmsso_finish.php page (instead
1547         // of waiting for the redirection to happen) then we have a 'Referer:' header
1548         // we don't want to use at all. As we can't get rid of it, just point
1549         // $SESSION->wantsurl to $CFG->wwwroot (after all, we came from there).
1550         if (empty($SESSION->wantsurl)
1551             && (get_referer() == $CFG->httpswwwroot.'/auth/ldap/ntlmsso_finish.php')) {
1553             $SESSION->wantsurl = $CFG->wwwroot;
1554         }
1555     }
1557     /**
1558      * To be called from a page running under NTLM's
1559      * "Integrated Windows Authentication".
1560      *
1561      * If successful, it will set a special "cookie" (not an HTTP cookie!)
1562      * in cache_flags under the $this->pluginconfig/ntlmsess "plugin" and return true.
1563      * The "cookie" will be picked up by ntlmsso_finish() to complete the
1564      * process.
1565      *
1566      * On failure it will return false for the caller to display an appropriate
1567      * error message (probably saying that Integrated Windows Auth isn't enabled!)
1568      *
1569      * NOTE that this code will execute under the OS user credentials,
1570      * so we MUST avoid dealing with files -- such as session files.
1571      * (The caller should define('NO_MOODLE_COOKIES', true) before including config.php)
1572      *
1573      */
1574     function ntlmsso_magic($sesskey) {
1575         if (isset($_SERVER['REMOTE_USER']) && !empty($_SERVER['REMOTE_USER'])) {
1577             // HTTP __headers__ seem to be sent in ISO-8859-1 encoding
1578             // (according to my reading of RFC-1945, RFC-2616 and RFC-2617 and
1579             // my local tests), so we need to convert the REMOTE_USER value
1580             // (i.e., what we got from the HTTP WWW-Authenticate header) into UTF-8
1581             $username = textlib::convert($_SERVER['REMOTE_USER'], 'iso-8859-1', 'utf-8');
1583             switch ($this->config->ntlmsso_type) {
1584                 case 'ntlm':
1585                     // Format is DOMAIN\username
1586                     $username = substr(strrchr($username, '\\'), 1);
1587                     break;
1588                 case 'kerberos':
1589                     // Format is username@DOMAIN
1590                     $username = substr($username, 0, strpos($username, '@'));
1591                     break;
1592                 default:
1593                     error_log($this->errorlogtag.get_string ('ntlmsso_unknowntype', 'auth_ldap'));
1594                     return false; // Should never happen!
1595             }
1597             $username = textlib::strtolower($username); // Compatibility hack
1598             set_cache_flag($this->pluginconfig.'/ntlmsess', $sesskey, $username, AUTH_NTLMTIMEOUT);
1599             return true;
1600         }
1601         return false;
1602     }
1604     /**
1605      * Find the session set by ntlmsso_magic(), validate it and
1606      * call authenticate_user_login() to authenticate the user through
1607      * the auth machinery.
1608      *
1609      * It is complemented by a similar check in user_login().
1610      *
1611      * If it succeeds, it never returns.
1612      *
1613      */
1614     function ntlmsso_finish() {
1615         global $CFG, $USER, $SESSION;
1617         $key = sesskey();
1618         $cf = get_cache_flags($this->pluginconfig.'/ntlmsess');
1619         if (!isset($cf[$key]) || $cf[$key] === '') {
1620             return false;
1621         }
1622         $username   = $cf[$key];
1623         // Here we want to trigger the whole authentication machinery
1624         // to make sure no step is bypassed...
1625         $user = authenticate_user_login($username, $key);
1626         if ($user) {
1627             add_to_log(SITEID, 'user', 'login', "view.php?id=$USER->id&course=".SITEID,
1628                        $user->id, 0, $user->id);
1629             complete_user_login($user);
1631             // Cleanup the key to prevent reuse...
1632             // and to allow re-logins with normal credentials
1633             unset_cache_flag($this->pluginconfig.'/ntlmsess', $key);
1635             // Redirection
1636             if (user_not_fully_set_up($USER)) {
1637                 $urltogo = $CFG->wwwroot.'/user/edit.php';
1638                 // We don't delete $SESSION->wantsurl yet, so we get there later
1639             } else if (isset($SESSION->wantsurl) and (strpos($SESSION->wantsurl, $CFG->wwwroot) === 0)) {
1640                 $urltogo = $SESSION->wantsurl;    // Because it's an address in this site
1641                 unset($SESSION->wantsurl);
1642             } else {
1643                 // No wantsurl stored or external - go to homepage
1644                 $urltogo = $CFG->wwwroot.'/';
1645                 unset($SESSION->wantsurl);
1646             }
1647             redirect($urltogo);
1648         }
1649         // Should never reach here.
1650         return false;
1651     }
1653     /**
1654      * Sync roles for this user
1655      *
1656      * @param $user object user object (without system magic quotes)
1657      */
1658     function sync_roles($user) {
1659         $iscreator = $this->iscreator($user->username);
1660         if ($iscreator === null) {
1661             return; // Nothing to sync - creators not configured
1662         }
1664         if ($roles = get_archetype_roles('coursecreator')) {
1665             $creatorrole = array_shift($roles);      // We can only use one, let's use the first one
1666             $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1668             if ($iscreator) { // Following calls will not create duplicates
1669                 role_assign($creatorrole->id, $user->id, $systemcontext->id, $this->roleauth);
1670             } else {
1671                 // Unassign only if previously assigned by this plugin!
1672                 role_unassign($creatorrole->id, $user->id, $systemcontext->id, $this->roleauth);
1673             }
1674         }
1675     }
1677     /**
1678      * Prints a form for configuring this authentication plugin.
1679      *
1680      * This function is called from admin/auth.php, and outputs a full page with
1681      * a form for configuring this plugin.
1682      *
1683      * @param array $page An object containing all the data for this page.
1684      */
1685     function config_form($config, $err, $user_fields) {
1686         global $CFG, $OUTPUT;
1688         if (!function_exists('ldap_connect')) { // Is php-ldap really there?
1689             echo $OUTPUT->notification(get_string('auth_ldap_noextension', 'auth_ldap'));
1690             return;
1691         }
1693         include($CFG->dirroot.'/auth/ldap/config.html');
1694     }
1696     /**
1697      * Processes and stores configuration data for this authentication plugin.
1698      */
1699     function process_config($config) {
1700         // Set to defaults if undefined
1701         if (!isset($config->host_url)) {
1702              $config->host_url = '';
1703         }
1704         if (empty($config->ldapencoding)) {
1705          $config->ldapencoding = 'utf-8';
1706         }
1707         if (!isset($config->contexts)) {
1708              $config->contexts = '';
1709         }
1710         if (!isset($config->user_type)) {
1711              $config->user_type = 'default';
1712         }
1713         if (!isset($config->user_attribute)) {
1714              $config->user_attribute = '';
1715         }
1716         if (!isset($config->search_sub)) {
1717              $config->search_sub = '';
1718         }
1719         if (!isset($config->opt_deref)) {
1720              $config->opt_deref = LDAP_DEREF_NEVER;
1721         }
1722         if (!isset($config->preventpassindb)) {
1723              $config->preventpassindb = 0;
1724         }
1725         if (!isset($config->bind_dn)) {
1726             $config->bind_dn = '';
1727         }
1728         if (!isset($config->bind_pw)) {
1729             $config->bind_pw = '';
1730         }
1731         if (!isset($config->ldap_version)) {
1732             $config->ldap_version = '3';
1733         }
1734         if (!isset($config->objectclass)) {
1735             $config->objectclass = '';
1736         }
1737         if (!isset($config->memberattribute)) {
1738             $config->memberattribute = '';
1739         }
1740         if (!isset($config->memberattribute_isdn)) {
1741             $config->memberattribute_isdn = '';
1742         }
1743         if (!isset($config->creators)) {
1744             $config->creators = '';
1745         }
1746         if (!isset($config->create_context)) {
1747             $config->create_context = '';
1748         }
1749         if (!isset($config->expiration)) {
1750             $config->expiration = '';
1751         }
1752         if (!isset($config->expiration_warning)) {
1753             $config->expiration_warning = '10';
1754         }
1755         if (!isset($config->expireattr)) {
1756             $config->expireattr = '';
1757         }
1758         if (!isset($config->gracelogins)) {
1759             $config->gracelogins = '';
1760         }
1761         if (!isset($config->graceattr)) {
1762             $config->graceattr = '';
1763         }
1764         if (!isset($config->auth_user_create)) {
1765             $config->auth_user_create = '';
1766         }
1767         if (!isset($config->forcechangepassword)) {
1768             $config->forcechangepassword = 0;
1769         }
1770         if (!isset($config->stdchangepassword)) {
1771             $config->stdchangepassword = 0;
1772         }
1773         if (!isset($config->passtype)) {
1774             $config->passtype = 'plaintext';
1775         }
1776         if (!isset($config->changepasswordurl)) {
1777             $config->changepasswordurl = '';
1778         }
1779         if (!isset($config->removeuser)) {
1780             $config->removeuser = AUTH_REMOVEUSER_KEEP;
1781         }
1782         if (!isset($config->ntlmsso_enabled)) {
1783             $config->ntlmsso_enabled = 0;
1784         }
1785         if (!isset($config->ntlmsso_subnet)) {
1786             $config->ntlmsso_subnet = '';
1787         }
1788         if (!isset($config->ntlmsso_ie_fastpath)) {
1789             $config->ntlmsso_ie_fastpath = 0;
1790         }
1791         if (!isset($config->ntlmsso_type)) {
1792             $config->ntlmsso_type = 'ntlm';
1793         }
1795         // Try to remove duplicates before storing the contexts (to avoid problems in sync_users()).
1796         $config->contexts = explode(';', $config->contexts);
1797         $config->contexts = array_map(create_function('$x', 'return textlib::strtolower(trim($x));'),
1798                                       $config->contexts);
1799         $config->contexts = implode(';', array_unique($config->contexts));
1801         // Save settings
1802         set_config('host_url', trim($config->host_url), $this->pluginconfig);
1803         set_config('ldapencoding', trim($config->ldapencoding), $this->pluginconfig);
1804         set_config('contexts', $config->contexts, $this->pluginconfig);
1805         set_config('user_type', textlib::strtolower(trim($config->user_type)), $this->pluginconfig);
1806         set_config('user_attribute', textlib::strtolower(trim($config->user_attribute)), $this->pluginconfig);
1807         set_config('search_sub', $config->search_sub, $this->pluginconfig);
1808         set_config('opt_deref', $config->opt_deref, $this->pluginconfig);
1809         set_config('preventpassindb', $config->preventpassindb, $this->pluginconfig);
1810         set_config('bind_dn', trim($config->bind_dn), $this->pluginconfig);
1811         set_config('bind_pw', $config->bind_pw, $this->pluginconfig);
1812         set_config('ldap_version', $config->ldap_version, $this->pluginconfig);
1813         set_config('objectclass', trim($config->objectclass), $this->pluginconfig);
1814         set_config('memberattribute', textlib::strtolower(trim($config->memberattribute)), $this->pluginconfig);
1815         set_config('memberattribute_isdn', $config->memberattribute_isdn, $this->pluginconfig);
1816         set_config('creators', trim($config->creators), $this->pluginconfig);
1817         set_config('create_context', trim($config->create_context), $this->pluginconfig);
1818         set_config('expiration', $config->expiration, $this->pluginconfig);
1819         set_config('expiration_warning', trim($config->expiration_warning), $this->pluginconfig);
1820         set_config('expireattr', textlib::strtolower(trim($config->expireattr)), $this->pluginconfig);
1821         set_config('gracelogins', $config->gracelogins, $this->pluginconfig);
1822         set_config('graceattr', textlib::strtolower(trim($config->graceattr)), $this->pluginconfig);
1823         set_config('auth_user_create', $config->auth_user_create, $this->pluginconfig);
1824         set_config('forcechangepassword', $config->forcechangepassword, $this->pluginconfig);
1825         set_config('stdchangepassword', $config->stdchangepassword, $this->pluginconfig);
1826         set_config('passtype', $config->passtype, $this->pluginconfig);
1827         set_config('changepasswordurl', trim($config->changepasswordurl), $this->pluginconfig);
1828         set_config('removeuser', $config->removeuser, $this->pluginconfig);
1829         set_config('ntlmsso_enabled', (int)$config->ntlmsso_enabled, $this->pluginconfig);
1830         set_config('ntlmsso_subnet', trim($config->ntlmsso_subnet), $this->pluginconfig);
1831         set_config('ntlmsso_ie_fastpath', (int)$config->ntlmsso_ie_fastpath, $this->pluginconfig);
1832         set_config('ntlmsso_type', $config->ntlmsso_type, 'auth/ldap');
1834         return true;
1835     }
1837     /**
1838      * Get password expiration time for a given user from Active Directory
1839      *
1840      * @param string $pwdlastset The time last time we changed the password.
1841      * @param resource $lcapconn The open LDAP connection.
1842      * @param string $user_dn The distinguished name of the user we are checking.
1843      *
1844      * @return string $unixtime
1845      */
1846     function ldap_get_ad_pwdexpire($pwdlastset, $ldapconn, $user_dn){
1847         global $CFG;
1849         if (!function_exists('bcsub')) {
1850             error_log($this->errorlogtag.get_string ('needbcmath', 'auth_ldap'));
1851             return 0;
1852         }
1854         // If UF_DONT_EXPIRE_PASSWD flag is set in user's
1855         // userAccountControl attribute, the password doesn't expire.
1856         $sr = ldap_read($ldapconn, $user_dn, '(objectClass=*)',
1857                         array('userAccountControl'));
1858         if (!$sr) {
1859             error_log($this->errorlogtag.get_string ('useracctctrlerror', 'auth_ldap', $user_dn));
1860             // Don't expire password, as we are not sure if it has to be
1861             // expired or not.
1862             return 0;
1863         }
1865         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1866         $info = array_change_key_case($entry[0], CASE_LOWER);
1867         $useraccountcontrol = $info['useraccountcontrol'][0];
1868         if ($useraccountcontrol & UF_DONT_EXPIRE_PASSWD) {
1869             // Password doesn't expire.
1870             return 0;
1871         }
1873         // If pwdLastSet is zero, the user must change his/her password now
1874         // (unless UF_DONT_EXPIRE_PASSWD flag is set, but we already
1875         // tested this above)
1876         if ($pwdlastset === '0') {
1877             // Password has expired
1878             return -1;
1879         }
1881         // ----------------------------------------------------------------
1882         // Password expiration time in Active Directory is the composition of
1883         // two values:
1884         //
1885         //   - User's pwdLastSet attribute, that stores the last time
1886         //     the password was changed.
1887         //
1888         //   - Domain's maxPwdAge attribute, that sets how long
1889         //     passwords last in this domain.
1890         //
1891         // We already have the first value (passed in as a parameter). We
1892         // need to get the second one. As we don't know the domain DN, we
1893         // have to query rootDSE's defaultNamingContext attribute to get
1894         // it. Then we have to query that DN's maxPwdAge attribute to get
1895         // the real value.
1896         //
1897         // Once we have both values, we just need to combine them. But MS
1898         // chose to use a different base and unit for time measurements.
1899         // So we need to convert the values to Unix timestamps (see
1900         // details below).
1901         // ----------------------------------------------------------------
1903         $sr = ldap_read($ldapconn, ROOTDSE, '(objectClass=*)',
1904                         array('defaultNamingContext'));
1905         if (!$sr) {
1906             error_log($this->errorlogtag.get_string ('rootdseerror', 'auth_ldap'));
1907             return 0;
1908         }
1910         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1911         $info = array_change_key_case($entry[0], CASE_LOWER);
1912         $domaindn = $info['defaultnamingcontext'][0];
1914         $sr = ldap_read ($ldapconn, $domaindn, '(objectClass=*)',
1915                          array('maxPwdAge'));
1916         $entry = ldap_get_entries_moodle($ldapconn, $sr);
1917         $info = array_change_key_case($entry[0], CASE_LOWER);
1918         $maxpwdage = $info['maxpwdage'][0];
1920         // ----------------------------------------------------------------
1921         // MSDN says that "pwdLastSet contains the number of 100 nanosecond
1922         // intervals since January 1, 1601 (UTC), stored in a 64 bit integer".
1923         //
1924         // According to Perl's Date::Manip, the number of seconds between
1925         // this date and Unix epoch is 11644473600. So we have to
1926         // substract this value to calculate a Unix time, once we have
1927         // scaled pwdLastSet to seconds. This is the script used to
1928         // calculate the value shown above:
1929         //
1930         //    #!/usr/bin/perl -w
1931         //
1932         //    use Date::Manip;
1933         //
1934         //    $date1 = ParseDate ("160101010000 UTC");
1935         //    $date2 = ParseDate ("197001010000 UTC");
1936         //    $delta = DateCalc($date1, $date2, \$err);
1937         //    $secs = Delta_Format($delta, 0, "%st");
1938         //    print "$secs \n";
1939         //
1940         // MSDN also says that "maxPwdAge is stored as a large integer that
1941         // represents the number of 100 nanosecond intervals from the time
1942         // the password was set before the password expires." We also need
1943         // to scale this to seconds. Bear in mind that this value is stored
1944         // as a _negative_ quantity (at least in my AD domain).
1945         //
1946         // As a last remark, if the low 32 bits of maxPwdAge are equal to 0,
1947         // the maximum password age in the domain is set to 0, which means
1948         // passwords do not expire (see
1949         // http://msdn2.microsoft.com/en-us/library/ms974598.aspx)
1950         //
1951         // As the quantities involved are too big for PHP integers, we
1952         // need to use BCMath functions to work with arbitrary precision
1953         // numbers.
1954         // ----------------------------------------------------------------
1956         // If the low order 32 bits are 0, then passwords do not expire in
1957         // the domain. Just do '$maxpwdage mod 2^32' and check the result
1958         // (2^32 = 4294967296)
1959         if (bcmod ($maxpwdage, 4294967296) === '0') {
1960             return 0;
1961         }
1963         // Add up pwdLastSet and maxPwdAge to get password expiration
1964         // time, in MS time units. Remember maxPwdAge is stored as a
1965         // _negative_ quantity, so we need to substract it in fact.
1966         $pwdexpire = bcsub ($pwdlastset, $maxpwdage);
1968         // Scale the result to convert it to Unix time units and return
1969         // that value.
1970         return bcsub( bcdiv($pwdexpire, '10000000'), '11644473600');
1971     }
1973     /**
1974      * Connect to the LDAP server, using the plugin configured
1975      * settings. It's actually a wrapper around ldap_connect_moodle()
1976      *
1977      * @return resource A valid LDAP connection (or dies if it can't connect)
1978      */
1979     function ldap_connect() {
1980         // Cache ldap connections. They are expensive to set up
1981         // and can drain the TCP/IP ressources on the server if we
1982         // are syncing a lot of users (as we try to open a new connection
1983         // to get the user details). This is the least invasive way
1984         // to reuse existing connections without greater code surgery.
1985         if(!empty($this->ldapconnection)) {
1986             $this->ldapconns++;
1987             return $this->ldapconnection;
1988         }
1990         if($ldapconnection = ldap_connect_moodle($this->config->host_url, $this->config->ldap_version,
1991                                                  $this->config->user_type, $this->config->bind_dn,
1992                                                  $this->config->bind_pw, $this->config->opt_deref,
1993                                                  $debuginfo)) {
1994             $this->ldapconns = 1;
1995             $this->ldapconnection = $ldapconnection;
1996             return $ldapconnection;
1997         }
1999         print_error('auth_ldap_noconnect_all', 'auth_ldap', '', $debuginfo);
2000     }
2002     /**
2003      * Disconnects from a LDAP server
2004      *
2005      */
2006     function ldap_close() {
2007         $this->ldapconns--;
2008         if($this->ldapconns == 0) {
2009             @ldap_close($this->ldapconnection);
2010             unset($this->ldapconnection);
2011         }
2012     }
2014     /**
2015      * Search specified contexts for username and return the user dn
2016      * like: cn=username,ou=suborg,o=org. It's actually a wrapper
2017      * around ldap_find_userdn().
2018      *
2019      * @param resource $ldapconnection a valid LDAP connection
2020      * @param string $extusername the username to search (in external LDAP encoding, no db slashes)
2021      * @return mixed the user dn (external LDAP encoding) or false
2022      */
2023     function ldap_find_userdn($ldapconnection, $extusername) {
2024         $ldap_contexts = explode(';', $this->config->contexts);
2025         if (!empty($this->config->create_context)) {
2026             array_push($ldap_contexts, $this->config->create_context);
2027         }
2029         return ldap_find_userdn($ldapconnection, $extusername, $ldap_contexts, $this->config->objectclass,
2030                                 $this->config->user_attribute, $this->config->search_sub);
2031     }
2033 } // End of the class