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 config/addon.config.php file
  30  * e.g.:
  31  *
  32  * [ldapauth]
  33  * ; ldap hostname server - required
  34  * ldap_server = host.example.com
  35  * ; dn to search users - required
  36  * ldap_searchdn = ou=users,dc=example,dc=com
  37  * ; attribute to find username - required
  38  * ldap_userattr = uid
  39  *
  40  * ; admin dn - optional - only if ldap server dont have anonymous access
  41  * ldap_binddn = cn=admin,dc=example,dc=com
  42  * ; admin password - optional - only if ldap server dont have anonymous access
  43  * ldap_bindpw = password
  44  *
  45  * ; for create Friendica account if user exist in ldap
  46  * ;     required an email and a simple (beautiful) nickname on user ldap object
  47  * ;   active account creation - optional - default none
  48  * ldap_autocreateaccount = true
  49  * ;   attribute to get email - optional - default : 'mail'
  50  * ldap_autocreateaccount_emailattribute = mail
  51  * ;   attribute to get nickname - optional - default : 'givenName'
  52  * ldap_autocreateaccount_nameattribute = cn
  53  *
  54  * ...etc.
  55  */
  56
  57 use Friendica\Core\Config;
  58 use Friendica\Core\Hook;
  59 use Friendica\Core\Logger;
  60 use Friendica\Model\User;
  61 use Friendica\Util\Config\ConfigFileLoader;
  62
  63 function ldapauth_install()
  64 {
  65         Hook::register('load_config',  'addon/ldapauth/ldapauth.php', 'ldapauth_load_config');
  66         Hook::register('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  67 }
  68
  69 function ldapauth_uninstall()
  70 {
  71         Hook::unregister('load_config',  'addon/ldapauth/ldapauth.php', 'ldapauth_load_config');
  72         Hook::unregister('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  73 }
  74
  75 function ldapauth_load_config(\Friendica\App $a, ConfigFileLoader $loader)
  76 {
  77         $a->getConfigCache()->load($loader->loadAddonConfig('ldapauth'));
  78 }
  79
  80 function ldapauth_hook_authenticate($a, &$b)
  81 {
  82         if (ldapauth_authenticate($b['username'], $b['password'])) {
  83                 $results = get_existing_account($b['username']);
  84                 if (!empty($results)) {
  85                         $b['user_record'] = $results[0];
  86                         $b['authenticated'] = 1;
  87                 }
  88         }
  89         return;
  90 }
  91
  92 function ldapauth_authenticate($username, $password)
  93 {
  94         $ldap_server   = Config::get('ldapauth', 'ldap_server');
  95         $ldap_binddn   = Config::get('ldapauth', 'ldap_binddn');
  96         $ldap_bindpw   = Config::get('ldapauth', 'ldap_bindpw');
  97         $ldap_searchdn = Config::get('ldapauth', 'ldap_searchdn');
  98         $ldap_userattr = Config::get('ldapauth', 'ldap_userattr');
  99         $ldap_group    = Config::get('ldapauth', 'ldap_group');
 100         $ldap_autocreateaccount = Config::get('ldapauth', 'ldap_autocreateaccount');
 101         $ldap_autocreateaccount_emailattribute = Config::get('ldapauth', 'ldap_autocreateaccount_emailattribute');
 102         $ldap_autocreateaccount_nameattribute  = Config::get('ldapauth', 'ldap_autocreateaccount_nameattribute');
 103
 104         if (!(strlen($password) && function_exists('ldap_connect') && strlen($ldap_server))) {
 105                 Logger::log("ldapauth: not configured or missing php-ldap module");
 106                 return false;
 107         }
 108
 109         $connect = @ldap_connect($ldap_server);
 110
 111         if ($connect === false) {
 112                 Logger::log("ldapauth: could not connect to $ldap_server");
 113                 return false;
 114         }
 115
 116         @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
 117         @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0);
 118         if ((@ldap_bind($connect, $ldap_binddn, $ldap_bindpw)) === false) {
 119                 Logger::log("ldapauth: could not bind $ldap_server as $ldap_binddn");
 120                 return false;
 121         }
 122
 123         $res = @ldap_search($connect, $ldap_searchdn, $ldap_userattr . '=' . $username);
 124
 125         if (!$res) {
 126                 Logger::log("ldapauth: $ldap_userattr=$username,$ldap_searchdn not found");
 127                 return false;
 128         }
 129
 130         $id = @ldap_first_entry($connect, $res);
 131
 132         if (!$id) {
 133                 return false;
 134         }
 135
 136         $dn = @ldap_get_dn($connect, $id);
 137
 138         if (!@ldap_bind($connect, $dn, $password)) {
 139                 return false;
 140         }
 141
 142         $emailarray = [];
 143         $namearray = [];
 144         if ($ldap_autocreateaccount == "true") {
 145                 if (!strlen($ldap_autocreateaccount_emailattribute)) {
 146                         $ldap_autocreateaccount_emailattribute = "mail";
 147                 }
 148                 if (!strlen($ldap_autocreateaccount_nameattribute)) {
 149                         $ldap_autocreateaccount_nameattribute = "givenName";
 150                 }
 151                 $emailarray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute);
 152                 $namearray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute);
 153         }
 154
 155         if (!strlen($ldap_group)) {
 156                 ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
 157                 return true;
 158         }
 159
 160         $r = @ldap_compare($connect, $ldap_group, 'member', $dn);
 161         if ($r === -1) {
 162                 $err = @ldap_error($connect);
 163                 $eno = @ldap_errno($connect);
 164                 @ldap_close($connect);
 165
 166                 if ($eno === 32) {
 167                         Logger::log("ldapauth: access control group Does Not Exist");
 168                         return false;
 169                 } elseif ($eno === 16) {
 170                         Logger::log('ldapauth: membership attribute does not exist in access control group');
 171                         return false;
 172                 } else {
 173                         Logger::log('ldapauth: error: ' . $err);
 174                         return false;
 175                 }
 176         } elseif ($r === false) {
 177                 @ldap_close($connect);
 178                 return false;
 179         }
 180
 181         ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
 182         return true;
 183 }
 184
 185 function ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $email, $name)
 186 {
 187         if ($ldap_autocreateaccount == "true") {
 188                 $results = get_existing_account($username);
 189                 if (empty($results)) {
 190                         if (strlen($email) > 0 && strlen($name) > 0) {
 191                                 $arr = ['username' => $name, 'nickname' => $username, 'email' => $email, 'password' => $password, 'verified' => 1];
 192
 193                                 try {
 194                                         User::create($arr);
 195                                         Logger::log("ldapauth: account " . $username . " created");
 196                                 } catch (Exception $ex) {
 197                                         Logger::log("ldapauth: account " . $username . " was not created ! : " . $ex->getMessage());
 198                                 }
 199                         } else {
 200                                 Logger::log("ldapauth: unable to create account, no email or nickname found");
 201                         }
 202                 }
 203         }
 204 }
 205
 206 function get_existing_account($username)
 207 {
 208         return q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1", $username);
 209 }