X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=ldapauth%2Fldapauth.php;h=699d0dca71b3c2ec5d73fd37046a57c5b25fed2b;hb=42eefed6e68d241bd8bdf9eceea96abc445a9cac;hp=7230302e9dc1c2d7de125a5a8932c6e536cb019f;hpb=d7bd2246c18f5880fc3c083bf3d698fe4f29fcb6;p=friendica-addons.git diff --git a/ldapauth/ldapauth.php b/ldapauth/ldapauth.php index 7230302e..699d0dca 100755 --- a/ldapauth/ldapauth.php +++ b/ldapauth/ldapauth.php @@ -2,12 +2,13 @@ /** * Name: LDAP Authenticate * Description: Authenticate a user against an LDAP directory - * Version: 1.0 + * Version: 1.1 * Author: Mike Macgirvin + * Author: aymhce */ /** - * Friendika addon + * Friendica addon * * Module: LDAP Authenticate * @@ -17,20 +18,43 @@ * * Optionally authenticates only if a member of a given group in the directory. * - * The person must have registered with Friendika using the normal registration - * procedures in order to have a Friendika user record, contact, and profile. + * 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 required configuration options for this module may be set in the .htconfig.php file + * 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'; - * ...etc. + * // 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'] = 'cn'; * + * ...etc. */ +require_once('include/user.php'); + +use Friendica\Core\Config; function ldapauth_install() { @@ -44,47 +68,53 @@ function ldapauth_uninstall() { function ldapauth_hook_authenticate($a,&$b) { - if(ldapauth_authenticate($b['username'],$b['password'])) { - $results = q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1", - dbesc($b['username']) - ); - if(count($results)) { - $b['user_record'] = $results[0]; - $b['authenticated'] = 1; - } - } - return; + 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_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_server = Config::get('ldapauth','ldap_server'); + $ldap_binddn = Config::get('ldapauth','ldap_binddn'); + $ldap_bindpw = Config::get('ldapauth','ldap_bindpw'); + $ldap_searchdn = Config::get('ldapauth','ldap_searchdn'); + $ldap_userattr = Config::get('ldapauth','ldap_userattr'); + $ldap_group = Config::get('ldapauth','ldap_group'); + $ldap_autocreateaccount = Config::get('ldapauth','ldap_autocreateaccount'); + $ldap_autocreateaccount_emailattribute = Config::get('ldapauth','ldap_autocreateaccount_emailattribute'); + $ldap_autocreateaccount_nameattribute = Config::get('ldapauth','ldap_autocreateaccount_nameattribute'); + if(! ((strlen($password)) && (function_exists('ldap_connect')) - && (strlen($ldap_server)))) + && (strlen($ldap_server)))) { + logger("ldapauth: not configured or missing php-ldap module"); return false; + } $connect = @ldap_connect($ldap_server); - if(! $connect) + if($connect === false) { + logger("ldapauth: could not connect to $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("ldapauth: could not bind $ldap_server as $ldap_binddn"); return false; } $res = @ldap_search($connect,$ldap_searchdn, $ldap_userattr . '=' . $username); if(! $res) { + logger("ldapauth: $ldap_userattr=$username,$ldap_searchdn not found"); return false; } @@ -98,9 +128,22 @@ function ldapauth_authenticate($username,$password) { 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)) + 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) { @@ -126,5 +169,29 @@ function ldapauth_authenticate($username,$password) { return false; } + ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$emailarray[0],$namearray[0]); return true; } + +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 get_existing_account($username){ + return q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1",$username); +}