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