Move addon-specific config to config/addon.ini.php
[friendica-addons.git/.git] / 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.ini.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 use Friendica\Core\Addon;
57 use Friendica\Core\Config;
58 use Friendica\Model\User;
59
60 function ldapauth_install()
61 {
62         Addon::registerHook('load_config',  'addon/ldapauth/ldapauth.php', 'ldapauth_load_config');
63         Addon::registerHook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
64 }
65
66 function ldapauth_uninstall()
67 {
68         Addon::unregisterHook('load_config',  'addon/ldapauth/ldapauth.php', 'ldapauth_load_config');
69         Addon::unregisterHook('authenticate', 'addon/ldapauth/ldapauth.php', 'ldapauth_hook_authenticate');
70 }
71
72 function ldapauth_load_config(\Friendica\App $a)
73 {
74         $a->loadConfigFile(__DIR__. '/config/ldapauth.ini.php');
75 }
76
77 function ldapauth_hook_authenticate($a, &$b)
78 {
79         if (ldapauth_authenticate($b['username'], $b['password'])) {
80                 $results = get_existing_account($b['username']);
81                 if (!empty($results)) {
82                         $b['user_record'] = $results[0];
83                         $b['authenticated'] = 1;
84                 }
85         }
86         return;
87 }
88
89 function ldapauth_authenticate($username, $password)
90 {
91         $ldap_server   = Config::get('ldapauth', 'ldap_server');
92         $ldap_binddn   = Config::get('ldapauth', 'ldap_binddn');
93         $ldap_bindpw   = Config::get('ldapauth', 'ldap_bindpw');
94         $ldap_searchdn = Config::get('ldapauth', 'ldap_searchdn');
95         $ldap_userattr = Config::get('ldapauth', 'ldap_userattr');
96         $ldap_group    = Config::get('ldapauth', 'ldap_group');
97         $ldap_autocreateaccount = Config::get('ldapauth', 'ldap_autocreateaccount');
98         $ldap_autocreateaccount_emailattribute = Config::get('ldapauth', 'ldap_autocreateaccount_emailattribute');
99         $ldap_autocreateaccount_nameattribute  = Config::get('ldapauth', 'ldap_autocreateaccount_nameattribute');
100
101         if (!(strlen($password) && function_exists('ldap_connect') && strlen($ldap_server))) {
102                 logger("ldapauth: not configured or missing php-ldap module");
103                 return false;
104         }
105
106         $connect = @ldap_connect($ldap_server);
107
108         if ($connect === false) {
109                 logger("ldapauth: could not connect to $ldap_server");
110                 return false;
111         }
112
113         @ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
114         @ldap_set_option($connect, LDAP_OPT_REFERRALS, 0);
115         if ((@ldap_bind($connect, $ldap_binddn, $ldap_bindpw)) === false) {
116                 logger("ldapauth: could not bind $ldap_server as $ldap_binddn");
117                 return false;
118         }
119
120         $res = @ldap_search($connect, $ldap_searchdn, $ldap_userattr . '=' . $username);
121
122         if (!$res) {
123                 logger("ldapauth: $ldap_userattr=$username,$ldap_searchdn not found");
124                 return false;
125         }
126
127         $id = @ldap_first_entry($connect, $res);
128
129         if (!$id) {
130                 return false;
131         }
132
133         $dn = @ldap_get_dn($connect, $id);
134
135         if (!@ldap_bind($connect, $dn, $password)) {
136                 return false;
137         }
138
139         $emailarray = [];
140         $namearray = [];
141         if ($ldap_autocreateaccount == "true") {
142                 if (!strlen($ldap_autocreateaccount_emailattribute)) {
143                         $ldap_autocreateaccount_emailattribute = "mail";
144                 }
145                 if (!strlen($ldap_autocreateaccount_nameattribute)) {
146                         $ldap_autocreateaccount_nameattribute = "givenName";
147                 }
148                 $emailarray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_emailattribute);
149                 $namearray = @ldap_get_values($connect, $id, $ldap_autocreateaccount_nameattribute);
150         }
151
152         if (!strlen($ldap_group)) {
153                 ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
154                 return true;
155         }
156
157         $r = @ldap_compare($connect, $ldap_group, 'member', $dn);
158         if ($r === -1) {
159                 $err = @ldap_error($connect);
160                 $eno = @ldap_errno($connect);
161                 @ldap_close($connect);
162
163                 if ($eno === 32) {
164                         logger("ldapauth: access control group Does Not Exist");
165                         return false;
166                 } elseif ($eno === 16) {
167                         logger('ldapauth: membership attribute does not exist in access control group');
168                         return false;
169                 } else {
170                         logger('ldapauth: error: ' . $err);
171                         return false;
172                 }
173         } elseif ($r === false) {
174                 @ldap_close($connect);
175                 return false;
176         }
177
178         ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $emailarray[0], $namearray[0]);
179         return true;
180 }
181
182 function ldap_autocreateaccount($ldap_autocreateaccount, $username, $password, $email, $name)
183 {
184         if ($ldap_autocreateaccount == "true") {
185                 $results = get_existing_account($username);
186                 if (empty($results)) {
187                         if (strlen($email) > 0 && strlen($name) > 0) {
188                                 $arr = ['username' => $name, 'nickname' => $username, 'email' => $email, 'password' => $password, 'verified' => 1];
189
190                                 try {
191                                         User::create($arr);
192                                         logger("ldapauth: account " . $username . " created");
193                                 } catch (Exception $ex) {
194                                         logger("ldapauth: account " . $username . " was not created ! : " . $ex->getMessage());
195                                 }
196                         } else {
197                                 logger("ldapauth: unable to create account, no email or nickname found");
198                         }
199                 }
200         }
201 }
202
203 function get_existing_account($username)
204 {
205         return q("SELECT * FROM `user` WHERE `nickname` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1", $username);
206 }