2 * These functions implement the portions of AUTHMODE_LDAP and AUTHMODE_LDAP_AD which
3 * actually speak to the LDAP server.
5 * Copyright (c) 2011-2017 by the citadel.org development team.
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 int ctdl_require_ldap_version = 3;
18 #define _GNU_SOURCE // Needed to suppress warning about vasprintf() when running on Linux/Linux
20 #include <libcitadel.h>
21 #include "citserver.h"
22 #include "citadel_ldap.h"
23 #include "ctdl_module.h"
25 #include "internet_addressing.h"
29 #define LDAP_DEPRECATED 1 // Suppress libldap's warning that we are using deprecated API calls
34 * Utility function, supply a search result and get back the fullname (display name, common name, etc) from the first result
36 void derive_fullname_from_ldap_result(char *fullname, int fullname_size, LDAP *ldserver, LDAPMessage *search_result)
40 if (fullname == NULL) return;
42 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
43 values = ldap_get_values(ldserver, search_result, "displayName");
46 if (fullname) safestrncpy(fullname, values[0], fullname_size);
47 syslog(LOG_DEBUG, "ldap: displayName = %s", values[0]);
49 ldap_value_free(values);
53 values = ldap_get_values(ldserver, search_result, "cn");
56 if (fullname) safestrncpy(fullname, values[0], fullname_size);
57 syslog(LOG_DEBUG, "ldap: cn = %s", values[0]);
59 ldap_value_free(values);
66 * Utility function, supply a search result and get back the uid from the first result
68 uid_t derive_uid_from_ldap(LDAP *ldserver, LDAPMessage *entry)
73 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
74 values = ldap_get_values(ldserver, entry, "objectGUID"); // AD schema: uid hashed from objectGUID
77 uid = abs(HashLittle(values[0], strlen(values[0])));
79 ldap_value_free(values);
83 values = ldap_get_values(ldserver, entry, "uidNumber"); // POSIX schema: uid = uidNumber
86 uid = atoi(values[0]);
88 ldap_value_free(values);
97 * Wrapper function for ldap_initialize() that consistently fills in the correct fields
99 int ctdl_ldap_initialize(LDAP **ld) {
101 char server_url[256];
104 snprintf(server_url, sizeof server_url, "ldap://%s:%d", CtdlGetConfigStr("c_ldap_host"), CtdlGetConfigInt("c_ldap_port"));
105 ret = ldap_initialize(ld, server_url);
106 if (ret != LDAP_SUCCESS) {
107 syslog(LOG_ERR, "ldap: could not connect to %s : %m", server_url);
117 * Bind to the LDAP server and return a working handle
119 LDAP *ctdl_ldap_bind(void) {
120 LDAP *ldserver = NULL;
123 if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
127 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
128 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
130 striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
131 striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
132 syslog(LOG_DEBUG, "ldap: bind DN: %s", CtdlGetConfigStr("c_ldap_bind_dn"));
133 i = ldap_simple_bind_s(ldserver,
134 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
135 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
137 if (i != LDAP_SUCCESS) {
138 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
147 * Look up a user in the directory to see if this is an account that can be authenticated
149 int CtdlTryUserLDAP(char *username,
150 char *found_dn, int found_dn_size,
151 char *fullname, int fullname_size,
154 LDAP *ldserver = NULL;
155 LDAPMessage *search_result = NULL;
156 LDAPMessage *entry = NULL;
157 char searchstring[1024];
159 char *user_dn = NULL;
161 ldserver = ctdl_ldap_bind();
162 if (!ldserver) return(-1);
164 if (fullname) safestrncpy(fullname, username, fullname_size);
168 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
169 snprintf(searchstring, sizeof(searchstring), "(sAMAccountName=%s)", username);
172 snprintf(searchstring, sizeof(searchstring), "(&(objectclass=posixAccount)(cn=%s))", username);
173 // snprintf(searchstring, sizeof(searchstring), "(&(objectclass=posixAccount)(uid=%s))", username);
176 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
177 (void) ldap_search_ext_s(
179 CtdlGetConfigStr("c_ldap_base_dn"), /* base */
180 LDAP_SCOPE_SUBTREE, /* scope */
181 searchstring, /* filter */
182 NULL, /* attrs (all attributes) */
183 0, /* attrsonly (attrs + values) */
184 NULL, /* serverctrls (none) */
185 NULL, /* clientctrls (none) */
187 1, /* sizelimit (1 result max) */
188 &search_result /* res */
191 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
192 * the search succeeds. Instead, we check to see whether search_result is still NULL.
194 if (search_result == NULL) {
195 syslog(LOG_DEBUG, "ldap: zero search results were returned");
196 ldap_unbind(ldserver);
200 /* At this point we've got at least one result from our query. If there are multiple
201 * results, we still only look at the first one.
203 entry = ldap_first_entry(ldserver, search_result);
206 user_dn = ldap_get_dn(ldserver, entry);
208 syslog(LOG_DEBUG, "ldap: dn = %s", user_dn);
211 derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, search_result);
212 *uid = derive_uid_from_ldap(ldserver, search_result);
215 /* free the results */
216 ldap_msgfree(search_result);
218 /* unbind so we can go back in as the authenticating user */
219 ldap_unbind(ldserver);
222 syslog(LOG_DEBUG, "ldap: No such user was found.");
226 if (found_dn) safestrncpy(found_dn, user_dn, found_dn_size);
227 ldap_memfree(user_dn);
232 int CtdlTryPasswordLDAP(char *user_dn, const char *password)
234 LDAP *ldserver = NULL;
237 if (IsEmptyStr(password)) {
238 syslog(LOG_DEBUG, "ldap: empty passwords are not permitted");
242 syslog(LOG_DEBUG, "ldap: trying to bind as %s", user_dn);
243 i = ctdl_ldap_initialize(&ldserver);
244 if (i == LDAP_SUCCESS) {
245 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
246 i = ldap_simple_bind_s(ldserver, user_dn, password);
247 if (i == LDAP_SUCCESS) {
248 syslog(LOG_DEBUG, "ldap: bind succeeded");
251 syslog(LOG_DEBUG, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
253 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
254 ldap_unbind(ldserver);
257 if (i == LDAP_SUCCESS) {
265 //return !0 iff property changed.
266 int vcard_set_props_iff_different(struct vCard *v,char *propname,int numvals, char **vals) {
269 for(i=0;i<numvals;i++) {
270 oldval = vcard_get_prop(v,propname,0,i,0);
271 if (oldval == NULL) break;
272 if (strcmp(vals[i],oldval)) break;
275 syslog(LOG_DEBUG, "ldap: vcard property %s, element %d of %d changed from %s to %s\n", propname, i, numvals, oldval, vals[i]);
276 for(i=0;i<numvals;i++) vcard_set_prop(v,propname,vals[i],(i==0) ? 0 : 1);
283 //return !0 iff property changed.
284 int vcard_set_one_prop_iff_different(struct vCard *v,char *propname, char *newfmt, ...) {
287 int changed_something;
288 va_start(args,newfmt);
289 if (-1==vasprintf(&newvalue,newfmt,args)) {
290 syslog(LOG_ERR, "ldap: out of memory!");
293 changed_something = vcard_set_props_iff_different(v,propname,1,&newvalue);
296 return changed_something;
301 * Learn LDAP attributes and stuff them into the vCard.
302 * Returns nonzero if we changed anything.
304 int Ctdl_LDAP_to_vCard(char *ldap_dn, struct vCard *v)
306 int changed_something = 0;
307 LDAP *ldserver = NULL;
309 LDAPMessage *search_result = NULL;
310 LDAPMessage *entry = NULL;
320 char **telephoneNumber;
323 char **facsimileTelephoneNumber;
326 char **homeDirectory;
333 char *attrs[] = { "*","+",NULL};
335 if (!ldap_dn) return(0);
338 ldserver = ctdl_ldap_bind();
339 if (!ldserver) return(-1);
344 syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
345 (void) ldap_search_ext_s(
348 LDAP_SCOPE_SUBTREE, // scope
350 attrs, // attrs (all attributes)
351 0, // attrsonly (attrs + values)
352 NULL, // serverctrls (none)
353 NULL, // clientctrls (none)
355 1, // sizelimit (1 result max)
356 &search_result // res
359 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
360 * the search succeeds. Instead, we check to see whether search_result is still NULL.
362 if (search_result == NULL) {
363 syslog(LOG_DEBUG, "ldap: zero search results were returned");
364 ldap_unbind(ldserver);
368 /* At this point we've got at least one result from our query. If there are multiple
369 * results, we still only look at the first one.
371 entry = ldap_first_entry(ldserver, search_result);
373 syslog(LOG_DEBUG, "ldap: search got user details for vcard.");
374 givenName=ldap_get_values(ldserver, search_result, "givenName");
375 sn=ldap_get_values(ldserver, search_result, "sn");
376 cn=ldap_get_values(ldserver, search_result, "cn");
377 initials=ldap_get_values(ldserver, search_result, "initials");
378 title=ldap_get_values(ldserver, search_result, "title");
379 o=ldap_get_values(ldserver, search_result, "o");
380 street=ldap_get_values(ldserver, search_result, "street");
381 l=ldap_get_values(ldserver, search_result, "l");
382 st=ldap_get_values(ldserver, search_result, "st");
383 postalCode=ldap_get_values(ldserver, search_result, "postalCode");
384 telephoneNumber=ldap_get_values(ldserver, search_result, "telephoneNumber");
385 mobile=ldap_get_values(ldserver, search_result, "mobile");
386 homePhone=ldap_get_values(ldserver, search_result, "homePhone");
387 facsimileTelephoneNumber=ldap_get_values(ldserver, search_result, "facsimileTelephoneNumber");
388 mail=ldap_get_values(ldserver, search_result, "mail");
389 uid=ldap_get_values(ldserver, search_result, "uid");
390 homeDirectory=ldap_get_values(ldserver, search_result, "homeDirectory");
391 uidNumber=ldap_get_values(ldserver, search_result, "uidNumber");
392 loginShell=ldap_get_values(ldserver, search_result, "loginShell");
393 gidNumber=ldap_get_values(ldserver, search_result, "gidNumber");
394 c=ldap_get_values(ldserver, search_result, "c");
395 uuid=ldap_get_values(ldserver, search_result, "entryUUID");
397 if (street && l && st && postalCode && c) changed_something |= vcard_set_one_prop_iff_different(v,"adr",";;%s;%s;%s;%s;%s",street[0],l[0],st[0],postalCode[0],c[0]);
398 if (telephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;work","%s",telephoneNumber[0]);
399 if (facsimileTelephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;fax","%s",facsimileTelephoneNumber[0]);
400 if (mobile) changed_something |= vcard_set_one_prop_iff_different(v,"tel;cell","%s",mobile[0]);
401 if (homePhone) changed_something |= vcard_set_one_prop_iff_different(v,"tel;home","%s",homePhone[0]);
402 if (givenName && sn) {
404 changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s;%s",sn[0],givenName[0],initials[0]);
407 changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s",sn[0],givenName[0]);
411 changed_something |= vcard_set_props_iff_different(v,"email;internet",ldap_count_values(mail),mail);
413 if (uuid) changed_something |= vcard_set_one_prop_iff_different(v,"X-uuid","%s",uuid[0]);
414 if (o) changed_something |= vcard_set_one_prop_iff_different(v,"org","%s",o[0]);
415 if (cn) changed_something |= vcard_set_one_prop_iff_different(v,"fn","%s",cn[0]);
416 if (title) changed_something |= vcard_set_one_prop_iff_different(v,"title","%s",title[0]);
418 if (givenName) ldap_value_free(givenName);
419 if (initials) ldap_value_free(initials);
420 if (sn) ldap_value_free(sn);
421 if (cn) ldap_value_free(cn);
422 if (o) ldap_value_free(o);
423 if (street) ldap_value_free(street);
424 if (l) ldap_value_free(l);
425 if (st) ldap_value_free(st);
426 if (postalCode) ldap_value_free(postalCode);
427 if (telephoneNumber) ldap_value_free(telephoneNumber);
428 if (mobile) ldap_value_free(mobile);
429 if (homePhone) ldap_value_free(homePhone);
430 if (facsimileTelephoneNumber) ldap_value_free(facsimileTelephoneNumber);
431 if (mail) ldap_value_free(mail);
432 if (uid) ldap_value_free(uid);
433 if (homeDirectory) ldap_value_free(homeDirectory);
434 if (uidNumber) ldap_value_free(uidNumber);
435 if (loginShell) ldap_value_free(loginShell);
436 if (gidNumber) ldap_value_free(gidNumber);
437 if (c) ldap_value_free(c);
438 if (title) ldap_value_free(title);
439 if (uuid) ldap_value_free(uuid);
441 /* free the results */
442 ldap_msgfree(search_result);
444 /* unbind so we can go back in as the authenticating user */
445 ldap_unbind(ldserver);
446 return(changed_something); /* tell the caller whether we made any changes */
451 * Extract a user's Internet email addresses from LDAP.
452 * Returns zero if we got a valid set of addresses; nonzero for error.
454 int extract_email_addresses_from_ldap(char *ldap_dn, char *emailaddrs)
456 LDAP *ldserver = NULL;
458 LDAPMessage *search_result = NULL;
459 LDAPMessage *entry = NULL;
461 char *attrs[] = { "*","+",NULL};
463 if (!ldap_dn) return(1);
464 if (!emailaddrs) return(1);
466 ldserver = ctdl_ldap_bind();
467 if (!ldserver) return(-1);
472 syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
473 (void) ldap_search_ext_s(
476 LDAP_SCOPE_SUBTREE, // scope
478 attrs, // attrs (all attributes)
479 0, // attrsonly (attrs + values)
480 NULL, // serverctrls (none)
481 NULL, // clientctrls (none)
483 1, // sizelimit (1 result max)
484 &search_result // res
487 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
488 * the search succeeds. Instead, we check to see whether search_result is still NULL.
490 if (search_result == NULL) {
491 syslog(LOG_DEBUG, "ldap: zero search results were returned");
492 ldap_unbind(ldserver);
496 /* At this point we've got at least one result from our query. If there are multiple
497 * results, we still only look at the first one.
499 emailaddrs[0] = 0; /* clear out any previous results */
500 entry = ldap_first_entry(ldserver, search_result);
502 syslog(LOG_DEBUG, "ldap: search got user details");
503 mail = ldap_get_values(ldserver, search_result, "mail");
507 for (q=0; q<ldap_count_values(mail); ++q) {
508 if (IsDirectory(mail[q], 0)) {
509 if ((strlen(emailaddrs) + strlen(mail[q]) + 2) > 512) {
510 syslog(LOG_ERR, "ldap: can't fit all email addresses into user record");
513 if (!IsEmptyStr(emailaddrs)) {
514 strcat(emailaddrs, "|");
516 strcat(emailaddrs, mail[q]);
523 /* free the results */
524 ldap_msgfree(search_result);
526 /* unbind so we can go back in as the authenticating user */
527 ldap_unbind(ldserver);
533 * Scan LDAP for users and populate Citadel's user database with everyone
535 void CtdlSynchronizeUsersFromLDAP(void)
537 LDAP *ldserver = NULL;
538 LDAPMessage *search_result = NULL;
539 LDAPMessage *entry = NULL;
540 char *user_dn = NULL;
541 char searchstring[1024];
544 if ((CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP) && (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP_AD)) {
545 return; // not running LDAP
548 syslog(LOG_INFO, "ldap: synchronizing Citadel user database from LDAP");
550 ldserver = ctdl_ldap_bind();
551 if (!ldserver) return;
556 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
557 snprintf(searchstring, sizeof(searchstring), "(&(objectClass=user)(objectClass=person)(!(objectClass=computer)))");
559 snprintf(searchstring, sizeof(searchstring), "(objectClass=inetOrgPerson)");
562 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
563 (void) ldap_search_ext_s(
565 CtdlGetConfigStr("c_ldap_base_dn"), // base
566 LDAP_SCOPE_SUBTREE, // scope
567 searchstring, // filter
568 NULL, // attrs (all attributes)
569 0, // attrsonly (attrs + values)
570 NULL, // serverctrls (none)
571 NULL, // clientctrls (none)
573 INT_MAX, // sizelimit (max)
574 &search_result // result
577 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
578 * the search succeeds. Instead, we check to see whether search_result is still NULL.
580 if (search_result == NULL) {
581 syslog(LOG_DEBUG, "ldap: zero search results were returned");
582 ldap_unbind(ldserver);
586 syslog(LOG_DEBUG, "ldap: %d entries returned", ldap_count_entries(ldserver, search_result));
587 entry = ldap_first_entry(ldserver, search_result);
590 user_dn = ldap_get_dn(ldserver, entry);
592 syslog(LOG_DEBUG, "ldap: found %s", user_dn);
594 int fullname_size = 256;
595 char fullname[256] = { 0 } ;
598 derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, entry);
599 uid = derive_uid_from_ldap(ldserver, entry);
600 syslog(LOG_DEBUG, "\033[33mldap: display name: <%s> , uid = <%d>\033[0m", fullname, uid);
602 // FIXME now create or update the user
604 struct ctdluser usbuf;
606 i = getuserbyuid(&usbuf, uid);
608 syslog(LOG_DEBUG, "\033[32m...and that user EXISTZ0RS!!!\033[0m");
611 syslog(LOG_DEBUG, "\033[31m...and that user D0EZ N0T EXISTZ0R!!\033[0m");
617 entry = ldap_next_entry(ldserver, entry);
620 /* free the results */
621 ldap_msgfree(search_result);
623 /* unbind so we can go back in as the authenticating user */
624 ldap_unbind(ldserver);
627 #endif /* HAVE_LDAP */