X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=ldapauth%2Fldapauth.php;h=38e2d6a1ec16c4423e4c75a3575ab3b90d608696;hb=3b518462ab001c20f908fe6c7a7144075fe08a76;hp=55c855af99e839ccd3da4fd76e7b29cc7c8b8dce;hpb=362efbc6c8f542fb7127613596fcc6b87821a3e6;p=friendica-addons.git diff --git a/ldapauth/ldapauth.php b/ldapauth/ldapauth.php old mode 100755 new mode 100644 index 55c855af..38e2d6a1 --- a/ldapauth/ldapauth.php +++ b/ldapauth/ldapauth.php @@ -1,4 +1,5 @@ * Author: aymhce */ - + /** * Friendica addon - * + * * Module: LDAP Authenticate * * Authenticate a user against an LDAP directory @@ -18,172 +19,153 @@ * * Optionally authenticates only if a member of a given group in the directory. * - * By default, the person must have registered with Friendica using the normal registration + * By default, the person must have registered with Friendica using the normal registration * procedures in order to have a Friendica user record, contact, and profile. * However, it's possible with an option to automate the creation of a Friendica basic account. * * Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site - * ldap.conf file to the signing cert for your LDAP server. - * - * The configuration options for this module may be set in the .htconfig.php file - * e.g.: - * - * // ldap hostname server - required - * $a->config['ldapauth']['ldap_server'] = 'host.example.com'; - * // dn to search users - required - * $a->config['ldapauth']['ldap_searchdn'] = 'ou=users,dc=example,dc=com'; - * // attribute to find username - required - * $a->config['ldapauth']['ldap_userattr'] = 'uid'; - * - * // admin dn - optional - only if ldap server dont have anonymous access - * $a->config['ldapauth']['ldap_binddn'] = 'cn=admin,dc=example,dc=com'; - * // admin password - optional - only if ldap server dont have anonymous access - * $a->config['ldapauth']['ldap_bindpw'] = 'password'; - * - * // for create Friendica account if user exist in ldap - * // required an email and a simple (beautiful) nickname on user ldap object - * // active account creation - optional - default none - * $a->config['ldapauth']['ldap_autocreateaccount'] = 'true'; - * // attribute to get email - optional - default : 'mail' - * $a->config['ldapauth']['ldap_autocreateaccount_emailattribute'] = 'mail'; - * // attribute to get nickname - optional - default : 'givenName' - * $a->config['ldapauth']['ldap_autocreateaccount_nameattribute'] = 'givenName'; + * ldap.conf file to the signing cert for your LDAP server. * - * ...etc. + * The configuration options for this module are described in the config/ldapauth.config.php file */ -require_once('include/user.php'); - - -function ldapauth_install() { - register_hook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate'); -} - - -function ldapauth_uninstall() { - unregister_hook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate'); +use Friendica\App; +use Friendica\Core\Hook; +use Friendica\Core\Logger; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Model\User; +use Friendica\Core\Config\Util\ConfigFileManager; + +function ldapauth_install() +{ + Hook::register('load_config', 'addon/ldapauth/ldapauth.php', 'ldapauth_load_config'); + Hook::register('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate'); } - -function ldapauth_hook_authenticate($a,&$b) { - if(ldapauth_authenticate($b['username'],$b['password'])) { - $results = get_existing_account($b['username']); - if(! empty($results)){ - $b['user_record'] = $results[0]; - $b['authenticated'] = 1; - } - } - return; +function ldapauth_load_config(ConfigFileManager $loader) +{ + DI::app()->getConfigCache()->load($loader->loadAddonConfig('ldapauth'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC); } -function ldapauth_authenticate($username,$password) { - - $ldap_server = get_config('ldapauth','ldap_server'); - $ldap_binddn = get_config('ldapauth','ldap_binddn'); - $ldap_bindpw = get_config('ldapauth','ldap_bindpw'); - $ldap_searchdn = get_config('ldapauth','ldap_searchdn'); - $ldap_userattr = get_config('ldapauth','ldap_userattr'); - $ldap_group = get_config('ldapauth','ldap_group'); - $ldap_autocreateaccount = get_config('ldapauth','ldap_autocreateaccount'); - $ldap_autocreateaccount_emailattribute = get_config('ldapauth','ldap_autocreateaccount_emailattribute'); - $ldap_autocreateaccount_nameattribute = get_config('ldapauth','ldap_autocreateaccount_nameattribute'); - - if(! ((strlen($password)) - && (function_exists('ldap_connect')) - && (strlen($ldap_server)))) - return false; - - $connect = @ldap_connect($ldap_server); - - if(! $connect) - return false; - - @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION,3); - @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0); - if((@ldap_bind($connect,$ldap_binddn,$ldap_bindpw)) === false) { - return false; - } - - $res = @ldap_search($connect,$ldap_searchdn, $ldap_userattr . '=' . $username); - - if(! $res) { - return false; - } - - $id = @ldap_first_entry($connect,$res); - - if(! $id) { - return false; - } - - $dn = @ldap_get_dn($connect,$id); - - if(! @ldap_bind($connect,$dn,$password)) - return false; - - $emailarray = []; - $namearray = []; - if($ldap_autocreateaccount == "true"){ - if(! strlen($ldap_autocreateaccount_emailattribute)) - $ldap_autocreateaccount_emailattribute = "mail"; - if(! strlen($ldap_autocreateaccount_nameattribute)) - $ldap_autocreateaccount_nameattribute = "givenName"; - $emailarray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute); - $namearray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute); - } - - if(! strlen($ldap_group)){ - ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$emailarray[0],$namearray[0]); - return true; - } - - $r = @ldap_compare($connect,$ldap_group,'member',$dn); - if ($r === -1) { - $err = @ldap_error($connect); - $eno = @ldap_errno($connect); - @ldap_close($connect); - - if ($eno === 32) { - logger("ldapauth: access control group Does Not Exist"); - return false; - } - elseif ($eno === 16) { - logger('ldapauth: membership attribute does not exist in access control group'); - return false; - } - else { - logger('ldapauth: error: ' . $err); - return false; - } - } - elseif ($r === false) { - @ldap_close($connect); - return false; - } - - ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$emailarray[0],$namearray[0]); - return true; +function ldapauth_hook_authenticate(array &$b) +{ + $user = ldapauth_authenticate($b['username'], $b['password']); + if (!empty($user['uid'])) { + $b['user_record'] = User::getById($user['uid']); + $b['authenticated'] = 1; + } } -function ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$email,$name) { - if($ldap_autocreateaccount == "true"){ - $results = get_existing_account($username); - if(empty($results)){ - if (strlen($email) > 0 && strlen($name) > 0){ - $arr = array('username'=>$name,'nickname'=>$username,'email'=>$email,'password'=>$password,'verified'=>1); - $result = create_user($arr); - if ($result['success']){ - logger("ldapauth: account " . $username . " created"); - }else{ - logger("ldapauth: account " . $username . " was not created ! : " . implode($result)); - } - }else{ - logger("ldapauth: unable to create account, no email or nickname found"); - } - } - } +function ldapauth_authenticate($username, $password) +{ + $ldap_server = DI::config()->get('ldapauth', 'ldap_server'); + $ldap_binddn = DI::config()->get('ldapauth', 'ldap_binddn'); + $ldap_bindpw = DI::config()->get('ldapauth', 'ldap_bindpw'); + $ldap_searchdn = DI::config()->get('ldapauth', 'ldap_searchdn'); + $ldap_userattr = DI::config()->get('ldapauth', 'ldap_userattr'); + $ldap_group = DI::config()->get('ldapauth', 'ldap_group'); + $ldap_autocreateaccount = DI::config()->get('ldapauth', 'ldap_autocreateaccount'); + $ldap_autocreateaccount_emailattribute = DI::config()->get('ldapauth', 'ldap_autocreateaccount_emailattribute'); + $ldap_autocreateaccount_nameattribute = DI::config()->get('ldapauth', 'ldap_autocreateaccount_nameattribute'); + + if (!extension_loaded('ldap') || !strlen($ldap_server)) { + Logger::error('Addon not configured or missing php-ldap extension', ['extension_loaded' => extension_loaded('ldap'), 'server' => $ldap_server]); + return false; + } + + if (!strlen($password)) { + Logger::error('Empty password disallowed', ['provided_password_length' => strlen($password)]); + return false; + } + + $connect = @ldap_connect($ldap_server); + if ($connect === false) { + Logger::warning('Could not connect to LDAP server', ['server' => $ldap_server]); + return false; + } + + @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3); + @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0); + if ((@ldap_bind($connect, $ldap_binddn, $ldap_bindpw)) === false) { + Logger::warning('Could not bind to LDAP server', ['server' => $ldap_server, 'binddn' => $ldap_binddn, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]); + return false; + } + + $res = @ldap_search($connect, $ldap_searchdn, $ldap_userattr . '=' . $username); + if (!$res) { + Logger::notice('LDAP user not found.', ['searchdn' => $ldap_searchdn, 'userattr' => $ldap_userattr, 'username' => $username, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]); + return false; + } + + $id = @ldap_first_entry($connect, $res); + if (!$id) { + Logger::notice('Could not retrieve first LDAP entry.', ['searchdn' => $ldap_searchdn, 'userattr' => $ldap_userattr, 'username' => $username, 'errno' => ldap_errno($connect), 'error' => ldap_error($connect)]); + return false; + } + + $dn = @ldap_get_dn($connect, $id); + if (!@ldap_bind($connect, $dn, $password)) { + Logger::notice('Could not authenticate LDAP user with provided password', ['errno' => ldap_errno($connect), 'error' => ldap_error($connect)]); + return false; + } + + if (strlen($ldap_group) && @ldap_compare($connect, $ldap_group, 'member', $dn) !== true) { + $errno = @ldap_errno($connect); + if ($errno === 32) { + Logger::notice('LDAP Access Control Group does not exist', ['errno' => $errno, 'error' => ldap_error($connect)]); + } elseif ($errno === 16) { + Logger::notice('LDAP membership attribute does not exist in access control group', ['errno' => $errno, 'error' => ldap_error($connect)]); + } else { + Logger::notice('LDAP user isn\'t part of the authorized group', ['dn' => $dn]); + } + + @ldap_close($connect); + return false; + } + + if ($ldap_autocreateaccount == 'true' && !DBA::exists('user', ['nickname' => $username])) { + if (!strlen($ldap_autocreateaccount_emailattribute)) { + $ldap_autocreateaccount_emailattribute = 'mail'; + } + if (!strlen($ldap_autocreateaccount_nameattribute)) { + $ldap_autocreateaccount_nameattribute = 'givenName'; + } + $email_values = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute); + $name_values = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute); + + return ldap_createaccount($username, $password, $email_values[0] ?? '', $name_values[0] ?? ''); + } + + try { + $authentication = User::getAuthenticationInfo($username); + return User::getById($authentication['uid']); + } catch (Exception $e) { + Logger::notice('LDAP authentication error: ' . $e->getMessage()); + return false; + } } -function get_existing_account($username){ - return q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1",$username); +function ldap_createaccount($username, $password, $email, $name) +{ + if (!strlen($email) || !strlen($name)) { + Logger::notice('Could not create local user from LDAP data, no email or nickname provided'); + return false; + } + + try { + $user = User::create([ + 'username' => $name, + 'nickname' => $username, + 'email' => $email, + 'password' => $password, + 'verified' => 1 + ]); + Logger::info('Local user created from LDAP data', ['username' => $username, 'name' => $name]); + return $user; + } catch (Exception $ex) { + Logger::error('Could not create local user from LDAP data', ['username' => $username, 'exception' => $ex->getMessage()]); + } + + return false; }