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\Hook;
  58 use Friendica\Core\Logger;
  59 use Friendica\Database\DBA;
  60 use Friendica\DI;
  61 use Friendica\Model\User;
  62 use Friendica\Util\ConfigFileLoader;
  63
  64 function ldapauth_install()
  65 {
  66         Hook::register('load_config',  'addon/ldapauth/ldapauth.php', 'ldapauth_load_config');
  67         Hook::register('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  68 }
  69
  70 function ldapauth_load_config(\Friendica\App $a, ConfigFileLoader $loader)
  71 {
  72         $a->getConfigCache()->load($loader->loadAddonConfig('ldapauth'));
  73 }
  74
  75 function ldapauth_hook_authenticate($a, &$b)
  76 {
  77         $user = ldapauth_authenticate($b['username'], $b['password']);
  78         if (!empty($user['uid'])) {
  79                 $b['user_record'] = User::getById($user['uid']);
  80                 $b['authenticated'] = 1;
  81         }
  82 }
  83
  84 function ldapauth_authenticate($username, $password)
  85 {
  86         $ldap_server   = DI::config()->get('ldapauth', 'ldap_server');
  87         $ldap_binddn   = DI::config()->get('ldapauth', 'ldap_binddn');
  88         $ldap_bindpw   = DI::config()->get('ldapauth', 'ldap_bindpw');
  89         $ldap_searchdn = DI::config()->get('ldapauth', 'ldap_searchdn');
  90         $ldap_userattr = DI::config()->get('ldapauth', 'ldap_userattr');
  91         $ldap_group    = DI::config()->get('ldapauth', 'ldap_group');
  92         $ldap_autocreateaccount = DI::config()->get('ldapauth', 'ldap_autocreateaccount');
  93         $ldap_autocreateaccount_emailattribute = DI::config()->get('ldapauth', 'ldap_autocreateaccount_emailattribute');
  94         $ldap_autocreateaccount_nameattribute  = DI::config()->get('ldapauth', 'ldap_autocreateaccount_nameattribute');
  95
  96         if (!extension_loaded('ldap') || !strlen($ldap_server)) {
  97                 Logger::error('Addon not configured or missing php-ldap extension', ['extension_loaded' => extension_loaded('ldap'), 'server' => $ldap_server]);
  98                 return false;
  99         }
 100
 101         if (!strlen($password)) {
 102                 Logger::error('Empty password disallowed', ['provided_password_length' => strlen($password)]);
 103                 return false;
 104         }
 105
 106         $connect = @ldap_connect($ldap_server);
 107         if ($connect === false) {
 108                 Logger::warning('Could not connect to LDAP server', ['server' => $ldap_server]);
 109                 return false;
 110         }
 111
 112         @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
 113         @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0);
 114         if ((@ldap_bind($connect, $ldap_binddn, $ldap_bindpw)) === false) {
 115                 Logger::warning('Could not bind to LDAP server', ['server' => $ldap_server, 'binddn' => $ldap_binddn, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]);
 116                 return false;
 117         }
 118
 119         $res = @ldap_search($connect, $ldap_searchdn, $ldap_userattr . '=' . $username);
 120         if (!$res) {
 121                 Logger::notice('LDAP user not found.', ['searchdn' => $ldap_searchdn, 'userattr' => $ldap_userattr, 'username' => $username, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]);
 122                 return false;
 123         }
 124
 125         $id = @ldap_first_entry($connect, $res);
 126         if (!$id) {
 127                 Logger::notice('Could not retrieve first LDAP entry.', ['searchdn' => $ldap_searchdn, 'userattr' => $ldap_userattr, 'username' => $username, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]);
 128                 return false;
 129         }
 130
 131         $dn = @ldap_get_dn($connect, $id);
 132         if (!@ldap_bind($connect, $dn, $password)) {
 133                 Logger::notice('Could not authenticate LDAP user with provided password', ['errno' => ldap_errno($connect), 'error' => ldap_error($connect)]);
 134                 return false;
 135         }
 136
 137         if (strlen($ldap_group) && @ldap_compare($connect, $ldap_group, 'member', $dn) !== true) {
 138                 $errno = @ldap_errno($connect);
 139                 if ($errno === 32) {
 140                         Logger::notice('LDAP Access Control Group does not exist', ['errno' => $errno, 'error' => ldap_error($connect)]);
 141                 } elseif ($errno === 16) {
 142                         Logger::notice('LDAP membership attribute does not exist in access control group', ['errno' => $errno, 'error' => ldap_error($connect)]);
 143                 } else {
 144                         Logger::notice('LDAP user isn\'t part of the authorized group', ['dn' => $dn]);
 145                 }
 146
 147                 @ldap_close($connect);
 148                 return false;
 149         }
 150
 151         if ($ldap_autocreateaccount == 'true' && !DBA::exists('user', ['nickname' => $username])) {
 152                 if (!strlen($ldap_autocreateaccount_emailattribute)) {
 153                         $ldap_autocreateaccount_emailattribute = 'mail';
 154                 }
 155                 if (!strlen($ldap_autocreateaccount_nameattribute)) {
 156                         $ldap_autocreateaccount_nameattribute = 'givenName';
 157                 }
 158                 $email_values = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute);
 159                 $name_values = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute);
 160
 161                 return ldap_createaccount($username, $password, $email_values[0] ?? '', $name_values[0] ?? '');
 162         }
 163
 164         try {
 165                 $authentication = User::getAuthenticationInfo($username);
 166                 return User::getById($authentication['uid']);
 167         } catch (Exception $e) {
 168                 Logger::notice('LDAP authentication error: ' . $e->getMessage());
 169                 return false;
 170         }
 171 }
 172
 173 function ldap_createaccount($username, $password, $email, $name)
 174 {
 175         if (!strlen($email) || !strlen($name)) {
 176                 Logger::notice('Could not create local user from LDAP data, no email or nickname provided');
 177                 return false;
 178         }
 179
 180         try {
 181                 $user = User::create([
 182                         'username' => $name,
 183                         'nickname' => $username,
 184                         'email'    => $email,
 185                         'password' => $password,
 186                         'verified' => 1
 187                 ]);
 188                 Logger::info('Local user created from LDAP data', ['username' => $username, 'name' => $name]);
 189                 return $user;
 190         } catch (Exception $ex) {
 191                 Logger::error('Could not create local user from LDAP data', ['username' => $username, 'exception' => $ex->getMessage()]);
 192         }
 193
 194         return false;
 195 }