ldapauth/ldapauth.php

   1 <?php
   2
   3 /**
   4  * Name: LDAP Authenticate
   5  * Description: Authenticate a user against an LDAP directory
   6  * Version: 1.1
   7  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   8  * Author: aymhce
   9  */
  10
  11 /**
  12  * Friendica addon
  13  *
  14  * Module: LDAP Authenticate
  15  *
  16  * Authenticate a user against an LDAP directory
  17  * Useful for Windows Active Directory and other LDAP-based organisations
  18  * to maintain a single password across the organisation.
  19  *
  20  * Optionally authenticates only if a member of a given group in the directory.
  21  *
  22  * By default, the person must have registered with Friendica using the normal registration
  23  * procedures in order to have a Friendica user record, contact, and profile.
  24  * However, it's possible with an option to automate the creation of a Friendica basic account.
  25  *
  26  * Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
  27  * ldap.conf file to the signing cert for your LDAP server.
  28  *
  29  * The configuration options for this module may be set in the .htconfig.php file
  30  * e.g.:
  31  *
  32  * // ldap hostname server - required
  33  * $a->config['ldapauth']['ldap_server'] = 'host.example.com';
  34  * // dn to search users - required
  35  * $a->config['ldapauth']['ldap_searchdn'] = 'ou=users,dc=example,dc=com';
  36  * // attribute to find username - required
  37  * $a->config['ldapauth']['ldap_userattr'] = 'uid';
  38  *
  39  * // admin dn - optional - only if ldap server dont have anonymous access
  40  * $a->config['ldapauth']['ldap_binddn'] = 'cn=admin,dc=example,dc=com';
  41  * // admin password - optional - only if ldap server dont have anonymous access
  42  * $a->config['ldapauth']['ldap_bindpw'] = 'password';
  43  *
  44  * // for create Friendica account if user exist in ldap
  45  * //     required an email and a simple (beautiful) nickname on user ldap object
  46  * //   active account creation - optional - default none
  47  * $a->config['ldapauth']['ldap_autocreateaccount'] = 'true';
  48  * //   attribute to get email - optional - default : 'mail'
  49  * $a->config['ldapauth']['ldap_autocreateaccount_emailattribute'] = 'mail';
  50  * //   attribute to get nickname - optional - default : 'givenName'
  51  * $a->config['ldapauth']['ldap_autocreateaccount_nameattribute'] = 'cn';
  52  *
  53  * ...etc.
  54  */
  55 use Friendica\Core\Addon;
  56 use Friendica\Core\Config;
  57 use Friendica\Model\User;
  58
  59 function ldapauth_install()
  60 {
  61         Addon::registerHook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  62 }
  63
  64 function ldapauth_uninstall()
  65 {
  66         Addon::unregisterHook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  67 }
  68
  69 function ldapauth_hook_authenticate($a, &$b)
  70 {
  71         if (ldapauth_authenticate($b['username'], $b['password'])) {
  72                 $results = get_existing_account($b['username']);
  73                 if (!empty($results)) {
  74                         $b['user_record'] = $results[0];
  75                         $b['authenticated'] = 1;
  76                 }
  77         }
  78         return;
  79 }
  80
  81 function ldapauth_authenticate($username, $password)
  82 {
  83         $ldap_server   = Config::get('ldapauth', 'ldap_server');
  84         $ldap_binddn   = Config::get('ldapauth', 'ldap_binddn');
  85         $ldap_bindpw   = Config::get('ldapauth', 'ldap_bindpw');
  86         $ldap_searchdn = Config::get('ldapauth', 'ldap_searchdn');
  87         $ldap_userattr = Config::get('ldapauth', 'ldap_userattr');
  88         $ldap_group    = Config::get('ldapauth', 'ldap_group');
  89         $ldap_autocreateaccount = Config::get('ldapauth', 'ldap_autocreateaccount');
  90         $ldap_autocreateaccount_emailattribute = Config::get('ldapauth', 'ldap_autocreateaccount_emailattribute');
  91         $ldap_autocreateaccount_nameattribute  = Config::get('ldapauth', 'ldap_autocreateaccount_nameattribute');
  92
  93         if (!(strlen($password) && function_exists('ldap_connect') && strlen($ldap_server))) {
  94                 logger("ldapauth: not configured or missing php-ldap module");
  95                 return false;
  96         }
  97
  98         $connect = @ldap_connect($ldap_server);
  99
 100         if ($connect === false) {
 101                 logger("ldapauth: could not connect to $ldap_server");
 102                 return false;
 103         }
 104
 105         @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
 106         @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0);
 107         if ((@ldap_bind($connect, $ldap_binddn, $ldap_bindpw)) === false) {
 108                 logger("ldapauth: could not bind $ldap_server as $ldap_binddn");
 109                 return false;
 110         }
 111
 112         $res = @ldap_search($connect, $ldap_searchdn, $ldap_userattr . '=' . $username);
 113
 114         if (!$res) {
 115                 logger("ldapauth: $ldap_userattr=$username,$ldap_searchdn not found");
 116                 return false;
 117         }
 118
 119         $id = @ldap_first_entry($connect, $res);
 120
 121         if (!$id) {
 122                 return false;
 123         }
 124
 125         $dn = @ldap_get_dn($connect, $id);
 126
 127         if (!@ldap_bind($connect, $dn, $password)) {
 128                 return false;
 129         }
 130
 131         $emailarray = [];
 132         $namearray = [];
 133         if ($ldap_autocreateaccount == "true") {
 134                 if (!strlen($ldap_autocreateaccount_emailattribute)) {
 135                         $ldap_autocreateaccount_emailattribute = "mail";
 136                 }
 137                 if (!strlen($ldap_autocreateaccount_nameattribute)) {
 138                         $ldap_autocreateaccount_nameattribute = "givenName";
 139                 }
 140                 $emailarray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute);
 141                 $namearray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute);
 142         }
 143
 144         if (!strlen($ldap_group)) {
 145                 ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
 146                 return true;
 147         }
 148
 149         $r = @ldap_compare($connect, $ldap_group, 'member', $dn);
 150         if ($r === -1) {
 151                 $err = @ldap_error($connect);
 152                 $eno = @ldap_errno($connect);
 153                 @ldap_close($connect);
 154
 155                 if ($eno === 32) {
 156                         logger("ldapauth: access control group Does Not Exist");
 157                         return false;
 158                 } elseif ($eno === 16) {
 159                         logger('ldapauth: membership attribute does not exist in access control group');
 160                         return false;
 161                 } else {
 162                         logger('ldapauth: error: ' . $err);
 163                         return false;
 164                 }
 165         } elseif ($r === false) {
 166                 @ldap_close($connect);
 167                 return false;
 168         }
 169
 170         ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
 171         return true;
 172 }
 173
 174 function ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $email, $name)
 175 {
 176         if ($ldap_autocreateaccount == "true") {
 177                 $results = get_existing_account($username);
 178                 if (empty($results)) {
 179                         if (strlen($email) > 0 && strlen($name) > 0) {
 180                                 $arr = ['username' => $name, 'nickname' => $username, 'email' => $email, 'password' => $password, 'verified' => 1];
 181
 182                                 try {
 183                                         User::create($arr);
 184                                         logger("ldapauth: account " . $username . " created");
 185                                 } catch (Exception $ex) {
 186                                         logger("ldapauth: account " . $username . " was not created ! : " . $ex->getMessage());
 187                                 }
 188                         } else {
 189                                 logger("ldapauth: unable to create account, no email or nickname found");
 190                         }
 191                 }
 192         }
 193 }
 194
 195 function get_existing_account($username)
 196 {
 197         return q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1", $username);
 198 }