ldapauth/ldapauth.php

   1 <?php
   2 /**
   3  * Name: LDAP Authenticate
   4  * Description: Authenticate a user against an LDAP directory
   5  * Version: 1.1
   6  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   7  * Author: aymhce
   8  */
   9
  10 /**
  11  * Friendica addon
  12  *
  13  * Module: LDAP Authenticate
  14  *
  15  * Authenticate a user against an LDAP directory
  16  * Useful for Windows Active Directory and other LDAP-based organisations
  17  * to maintain a single password across the organisation.
  18  *
  19  * Optionally authenticates only if a member of a given group in the directory.
  20  *
  21  * By default, the person must have registered with Friendica using the normal registration
  22  * procedures in order to have a Friendica user record, contact, and profile.
  23  * However, it's possible with an option to automate the creation of a Friendica basic account.
  24  *
  25  * Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
  26  * ldap.conf file to the signing cert for your LDAP server.
  27  *
  28  * The required configuration options for this module may be set in the .htconfig.php file
  29  * e.g.:
  30  *
  31  * $a->config['ldapauth']['ldap_server'] = 'host.example.com';
  32  * ...etc.
  33  *
  34  */
  35
  36 require_once('include/user.php');
  37
  38
  39 function ldapauth_install() {
  40         register_hook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  41 }
  42
  43
  44 function ldapauth_uninstall() {
  45         unregister_hook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
  46 }
  47
  48
  49 function ldapauth_hook_authenticate($a,&$b) {
  50         if(ldapauth_authenticate($b['username'],$b['password']) && is_existing_account($b['username'])) {
  51                 $b['user_record'] = $results[0];
  52                 $b['authenticated'] = 1;
  53         }
  54         return;
  55 }
  56
  57 function ldapauth_authenticate($username,$password) {
  58
  59     $ldap_server   = get_config('ldapauth','ldap_server');
  60     $ldap_binddn   = get_config('ldapauth','ldap_binddn');
  61     $ldap_bindpw   = get_config('ldapauth','ldap_bindpw');
  62     $ldap_searchdn = get_config('ldapauth','ldap_searchdn');
  63     $ldap_userattr = get_config('ldapauth','ldap_userattr');
  64     $ldap_group    = get_config('ldapauth','ldap_group');
  65         $ldap_autocreateaccount = get_config('ldapauth','ldap_autocreateaccount');
  66         $ldap_autocreateaccount_emailattribute = get_config('ldapauth','ldap_autocreateaccount_emailattribute');
  67         $ldap_autocreateaccount_nameattribute = get_config('ldapauth','ldap_autocreateaccount_nameattribute');
  68
  69         if(! strlen($ldap_autocreateaccount_emailattribute))
  70                 $ldap_autocreateaccount_emailattribute = "mail";
  71         if(! strlen($ldap_autocreateaccount_nameattribute))
  72                 $ldap_autocreateaccount_nameattribute = "givenName";
  73
  74     if(! ((strlen($password))
  75             && (function_exists('ldap_connect'))
  76             && (strlen($ldap_server))))
  77             return false;
  78
  79     $connect = @ldap_connect($ldap_server);
  80
  81     if(! $connect)
  82         return false;
  83
  84     @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION,3);
  85     @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0);
  86     if((@ldap_bind($connect,$ldap_binddn,$ldap_bindpw)) === false) {
  87         return false;
  88     }
  89
  90     $res = @ldap_search($connect,$ldap_searchdn, $ldap_userattr . '=' . $username);
  91
  92     if(! $res) {
  93         return false;
  94     }
  95
  96     $id = @ldap_first_entry($connect,$res);
  97
  98     if(! $id) {
  99         return false;
 100     }
 101
 102     $dn = @ldap_get_dn($connect,$id);
 103
 104     if(! @ldap_bind($connect,$dn,$password))
 105         return false;
 106
 107         $emailarray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute);
 108         $namearray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute);
 109
 110     if(! strlen($ldap_group)){
 111                 ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$emailarray[0],$namearray[0]);
 112         return true;
 113         }
 114
 115     $r = @ldap_compare($connect,$ldap_group,'member',$dn);
 116     if ($r === -1) {
 117         $err = @ldap_error($connect);
 118         $eno = @ldap_errno($connect);
 119         @ldap_close($connect);
 120
 121         if ($eno === 32) {
 122             logger("ldapauth: access control group Does Not Exist");
 123             return false;
 124         }
 125         elseif ($eno === 16) {
 126             logger('ldapauth: membership attribute does not exist in access control group');
 127             return false;
 128         }
 129         else {
 130             logger('ldapauth: error: ' . $err);
 131             return false;
 132         }
 133     }
 134     elseif ($r === false) {
 135         @ldap_close($connect);
 136         return false;
 137     }
 138
 139         ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$emailarray[0],$namearray[0]);
 140     return true;
 141 }
 142
 143 function ldap_autocreateaccount($ldap_autocreateaccount,$username,$password,$email,$name) {
 144         if($ldap_autocreateaccount == "true" && !is_existing_account($username)){
 145                 if (strlen($email) > 0 && strlen($name) > 0){
 146                         $arr = array('username'=>$name,'nickname'=>$username,'email'=>$email,'password'=>$password,'verified'=>1);
 147                         $result = create_user($arr);
 148                         if ($result['success']){
 149                                 logger("ldapauth: account " . $username . " created");
 150                         }else{
 151                                 logger("ldapauth: account " . $username . " was not created ! : " . implode($result));
 152                         }
 153                 }else{
 154                         logger("ldapauth: unable to create account, no email or nickname found");
 155                 }
 156         }
 157 }
 158
 159 function is_existing_account($username){
 160         $results = q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1",$username);
 161         if(count($results)) {
 162                 return true;
 163         }
 164         return false;
 165 }