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 i = ldap_simple_bind_s(ldserver,
133 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
134 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
136 if (i != LDAP_SUCCESS) {
137 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
146 * Look up a user in the directory to see if this is an account that can be authenticated
148 int CtdlTryUserLDAP(char *username,
149 char *found_dn, int found_dn_size,
150 char *fullname, int fullname_size,
153 LDAP *ldserver = NULL;
154 LDAPMessage *search_result = NULL;
155 LDAPMessage *entry = NULL;
156 char searchstring[1024];
158 char *user_dn = NULL;
160 ldserver = ctdl_ldap_bind();
161 if (!ldserver) return(-1);
163 if (fullname) safestrncpy(fullname, username, fullname_size);
167 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
168 snprintf(searchstring, sizeof(searchstring), "(sAMAccountName=%s)", username);
171 snprintf(searchstring, sizeof(searchstring), "(&(objectclass=posixAccount)(cn=%s))", username);
172 // snprintf(searchstring, sizeof(searchstring), "(&(objectclass=posixAccount)(uid=%s))", username);
175 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
176 (void) ldap_search_ext_s(
178 CtdlGetConfigStr("c_ldap_base_dn"), /* base */
179 LDAP_SCOPE_SUBTREE, /* scope */
180 searchstring, /* filter */
181 NULL, /* attrs (all attributes) */
182 0, /* attrsonly (attrs + values) */
183 NULL, /* serverctrls (none) */
184 NULL, /* clientctrls (none) */
186 1, /* sizelimit (1 result max) */
187 &search_result /* res */
190 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
191 * the search succeeds. Instead, we check to see whether search_result is still NULL.
193 if (search_result == NULL) {
194 syslog(LOG_DEBUG, "ldap: zero search results were returned");
195 ldap_unbind(ldserver);
199 /* At this point we've got at least one result from our query. If there are multiple
200 * results, we still only look at the first one.
202 entry = ldap_first_entry(ldserver, search_result);
205 user_dn = ldap_get_dn(ldserver, entry);
207 syslog(LOG_DEBUG, "ldap: dn = %s", user_dn);
210 derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, search_result);
211 *uid = derive_uid_from_ldap(ldserver, search_result);
214 /* free the results */
215 ldap_msgfree(search_result);
217 /* unbind so we can go back in as the authenticating user */
218 ldap_unbind(ldserver);
221 syslog(LOG_DEBUG, "ldap: No such user was found.");
225 if (found_dn) safestrncpy(found_dn, user_dn, found_dn_size);
226 ldap_memfree(user_dn);
231 int CtdlTryPasswordLDAP(char *user_dn, const char *password)
233 LDAP *ldserver = NULL;
236 if (IsEmptyStr(password)) {
237 syslog(LOG_DEBUG, "ldap: empty passwords are not permitted");
241 syslog(LOG_DEBUG, "ldap: trying to bind as %s", user_dn);
242 i = ctdl_ldap_initialize(&ldserver);
243 if (i == LDAP_SUCCESS) {
244 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
245 i = ldap_simple_bind_s(ldserver, user_dn, password);
246 if (i == LDAP_SUCCESS) {
247 syslog(LOG_DEBUG, "ldap: bind succeeded");
250 syslog(LOG_DEBUG, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
252 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
253 ldap_unbind(ldserver);
256 if (i == LDAP_SUCCESS) {
264 //return !0 iff property changed.
265 int vcard_set_props_iff_different(struct vCard *v,char *propname,int numvals, char **vals) {
268 for(i=0;i<numvals;i++) {
269 oldval = vcard_get_prop(v,propname,0,i,0);
270 if (oldval == NULL) break;
271 if (strcmp(vals[i],oldval)) break;
274 syslog(LOG_DEBUG, "ldap: vcard property %s, element %d of %d changed from %s to %s\n", propname, i, numvals, oldval, vals[i]);
275 for(i=0;i<numvals;i++) vcard_set_prop(v,propname,vals[i],(i==0) ? 0 : 1);
282 //return !0 iff property changed.
283 int vcard_set_one_prop_iff_different(struct vCard *v,char *propname, char *newfmt, ...) {
286 int changed_something;
287 va_start(args,newfmt);
288 if (-1==vasprintf(&newvalue,newfmt,args)) {
289 syslog(LOG_ERR, "ldap: out of memory!");
292 changed_something = vcard_set_props_iff_different(v,propname,1,&newvalue);
295 return changed_something;
300 * Learn LDAP attributes and stuff them into the vCard.
301 * Returns nonzero if we changed anything.
303 int Ctdl_LDAP_to_vCard(char *ldap_dn, struct vCard *v)
305 int changed_something = 0;
306 LDAP *ldserver = NULL;
308 LDAPMessage *search_result = NULL;
309 LDAPMessage *entry = NULL;
319 char **telephoneNumber;
322 char **facsimileTelephoneNumber;
325 char **homeDirectory;
332 char *attrs[] = { "*","+",NULL};
334 if (!ldap_dn) return(0);
337 ldserver = ctdl_ldap_bind();
338 if (!ldserver) return(-1);
343 syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
344 (void) ldap_search_ext_s(
347 LDAP_SCOPE_SUBTREE, // scope
349 attrs, // attrs (all attributes)
350 0, // attrsonly (attrs + values)
351 NULL, // serverctrls (none)
352 NULL, // clientctrls (none)
354 1, // sizelimit (1 result max)
355 &search_result // res
358 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
359 * the search succeeds. Instead, we check to see whether search_result is still NULL.
361 if (search_result == NULL) {
362 syslog(LOG_DEBUG, "ldap: zero search results were returned");
363 ldap_unbind(ldserver);
367 /* At this point we've got at least one result from our query. If there are multiple
368 * results, we still only look at the first one.
370 entry = ldap_first_entry(ldserver, search_result);
372 syslog(LOG_DEBUG, "ldap: search got user details for vcard.");
373 givenName=ldap_get_values(ldserver, search_result, "givenName");
374 sn=ldap_get_values(ldserver, search_result, "sn");
375 cn=ldap_get_values(ldserver, search_result, "cn");
376 initials=ldap_get_values(ldserver, search_result, "initials");
377 title=ldap_get_values(ldserver, search_result, "title");
378 o=ldap_get_values(ldserver, search_result, "o");
379 street=ldap_get_values(ldserver, search_result, "street");
380 l=ldap_get_values(ldserver, search_result, "l");
381 st=ldap_get_values(ldserver, search_result, "st");
382 postalCode=ldap_get_values(ldserver, search_result, "postalCode");
383 telephoneNumber=ldap_get_values(ldserver, search_result, "telephoneNumber");
384 mobile=ldap_get_values(ldserver, search_result, "mobile");
385 homePhone=ldap_get_values(ldserver, search_result, "homePhone");
386 facsimileTelephoneNumber=ldap_get_values(ldserver, search_result, "facsimileTelephoneNumber");
387 mail=ldap_get_values(ldserver, search_result, "mail");
388 uid=ldap_get_values(ldserver, search_result, "uid");
389 homeDirectory=ldap_get_values(ldserver, search_result, "homeDirectory");
390 uidNumber=ldap_get_values(ldserver, search_result, "uidNumber");
391 loginShell=ldap_get_values(ldserver, search_result, "loginShell");
392 gidNumber=ldap_get_values(ldserver, search_result, "gidNumber");
393 c=ldap_get_values(ldserver, search_result, "c");
394 uuid=ldap_get_values(ldserver, search_result, "entryUUID");
396 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]);
397 if (telephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;work","%s",telephoneNumber[0]);
398 if (facsimileTelephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;fax","%s",facsimileTelephoneNumber[0]);
399 if (mobile) changed_something |= vcard_set_one_prop_iff_different(v,"tel;cell","%s",mobile[0]);
400 if (homePhone) changed_something |= vcard_set_one_prop_iff_different(v,"tel;home","%s",homePhone[0]);
401 if (givenName && sn) {
403 changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s;%s",sn[0],givenName[0],initials[0]);
406 changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s",sn[0],givenName[0]);
410 changed_something |= vcard_set_props_iff_different(v,"email;internet",ldap_count_values(mail),mail);
412 if (uuid) changed_something |= vcard_set_one_prop_iff_different(v,"X-uuid","%s",uuid[0]);
413 if (o) changed_something |= vcard_set_one_prop_iff_different(v,"org","%s",o[0]);
414 if (cn) changed_something |= vcard_set_one_prop_iff_different(v,"fn","%s",cn[0]);
415 if (title) changed_something |= vcard_set_one_prop_iff_different(v,"title","%s",title[0]);
417 if (givenName) ldap_value_free(givenName);
418 if (initials) ldap_value_free(initials);
419 if (sn) ldap_value_free(sn);
420 if (cn) ldap_value_free(cn);
421 if (o) ldap_value_free(o);
422 if (street) ldap_value_free(street);
423 if (l) ldap_value_free(l);
424 if (st) ldap_value_free(st);
425 if (postalCode) ldap_value_free(postalCode);
426 if (telephoneNumber) ldap_value_free(telephoneNumber);
427 if (mobile) ldap_value_free(mobile);
428 if (homePhone) ldap_value_free(homePhone);
429 if (facsimileTelephoneNumber) ldap_value_free(facsimileTelephoneNumber);
430 if (mail) ldap_value_free(mail);
431 if (uid) ldap_value_free(uid);
432 if (homeDirectory) ldap_value_free(homeDirectory);
433 if (uidNumber) ldap_value_free(uidNumber);
434 if (loginShell) ldap_value_free(loginShell);
435 if (gidNumber) ldap_value_free(gidNumber);
436 if (c) ldap_value_free(c);
437 if (title) ldap_value_free(title);
438 if (uuid) ldap_value_free(uuid);
440 /* free the results */
441 ldap_msgfree(search_result);
443 /* unbind so we can go back in as the authenticating user */
444 ldap_unbind(ldserver);
445 return(changed_something); /* tell the caller whether we made any changes */
450 * Extract a user's Internet email addresses from LDAP.
451 * Returns zero if we got a valid set of addresses; nonzero for error.
453 int extract_email_addresses_from_ldap(char *ldap_dn, char *emailaddrs)
455 LDAP *ldserver = NULL;
457 LDAPMessage *search_result = NULL;
458 LDAPMessage *entry = NULL;
460 char *attrs[] = { "*","+",NULL};
462 if (!ldap_dn) return(1);
463 if (!emailaddrs) return(1);
465 ldserver = ctdl_ldap_bind();
466 if (!ldserver) return(-1);
471 syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
472 (void) ldap_search_ext_s(
475 LDAP_SCOPE_SUBTREE, // scope
477 attrs, // attrs (all attributes)
478 0, // attrsonly (attrs + values)
479 NULL, // serverctrls (none)
480 NULL, // clientctrls (none)
482 1, // sizelimit (1 result max)
483 &search_result // res
486 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
487 * the search succeeds. Instead, we check to see whether search_result is still NULL.
489 if (search_result == NULL) {
490 syslog(LOG_DEBUG, "ldap: zero search results were returned");
491 ldap_unbind(ldserver);
495 /* At this point we've got at least one result from our query. If there are multiple
496 * results, we still only look at the first one.
498 emailaddrs[0] = 0; /* clear out any previous results */
499 entry = ldap_first_entry(ldserver, search_result);
501 syslog(LOG_DEBUG, "ldap: search got user details");
502 mail = ldap_get_values(ldserver, search_result, "mail");
506 for (q=0; q<ldap_count_values(mail); ++q) {
507 if (IsDirectory(mail[q], 0)) {
508 if ((strlen(emailaddrs) + strlen(mail[q]) + 2) > 512) {
509 syslog(LOG_ERR, "ldap: can't fit all email addresses into user record");
512 if (!IsEmptyStr(emailaddrs)) {
513 strcat(emailaddrs, "|");
515 strcat(emailaddrs, mail[q]);
522 /* free the results */
523 ldap_msgfree(search_result);
525 /* unbind so we can go back in as the authenticating user */
526 ldap_unbind(ldserver);
532 * Scan LDAP for users and populate Citadel's user database with everyone
534 void CtdlSynchronizeUsersFromLDAP(void)
536 LDAP *ldserver = NULL;
537 LDAPMessage *search_result = NULL;
538 LDAPMessage *entry = NULL;
539 char *user_dn = NULL;
540 char searchstring[1024];
543 if ((CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP) && (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP_AD)) {
544 return; // not running LDAP
547 syslog(LOG_INFO, "ldap: synchronizing Citadel user database from LDAP");
549 ldserver = ctdl_ldap_bind();
550 if (!ldserver) return;
555 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
556 snprintf(searchstring, sizeof(searchstring), "(&(objectClass=user)(objectClass=person)(!(objectClass=computer)))");
558 snprintf(searchstring, sizeof(searchstring), "(objectClass=inetOrgPerson)");
561 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
562 (void) ldap_search_ext_s(
564 CtdlGetConfigStr("c_ldap_base_dn"), // base
565 LDAP_SCOPE_SUBTREE, // scope
566 searchstring, // filter
567 NULL, // attrs (all attributes)
568 0, // attrsonly (attrs + values)
569 NULL, // serverctrls (none)
570 NULL, // clientctrls (none)
572 INT_MAX, // sizelimit (max)
573 &search_result // result
576 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
577 * the search succeeds. Instead, we check to see whether search_result is still NULL.
579 if (search_result == NULL) {
580 syslog(LOG_DEBUG, "ldap: zero search results were returned");
581 ldap_unbind(ldserver);
585 syslog(LOG_DEBUG, "ldap: %d entries returned", ldap_count_entries(ldserver, search_result));
586 entry = ldap_first_entry(ldserver, search_result);
589 user_dn = ldap_get_dn(ldserver, entry);
591 syslog(LOG_DEBUG, "ldap: found %s", user_dn);
593 int fullname_size = 256;
594 char fullname[256] = { 0 } ;
596 char new_emailaddrs[512] = { 0 } ;
598 derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, entry);
599 uid = derive_uid_from_ldap(ldserver, entry);
600 syslog(LOG_DEBUG, "ldap: display name: <%s> , uid = <%d>", fullname, uid);
602 // now create or update the user
604 struct ctdluser usbuf;
606 found_user = getuserbyuid(&usbuf, uid);
607 if (found_user != 0) {
608 create_user(fullname, CREATE_USER_DO_NOT_BECOME_USER, uid);
609 found_user = getuserbyuid(&usbuf, uid);
610 strcpy(fullname, usbuf.fullname);
613 if (found_user == 0) { // user record exists
614 // now update the account email addresses if necessary
615 if (CtdlGetConfigInt("c_ldap_sync_email_addrs") > 0) {
616 if (extract_email_addresses_from_ldap(user_dn, new_emailaddrs) == 0) {
617 if (strcmp(usbuf.emailaddrs, new_emailaddrs)) { // update only if changed
618 CtdlSetEmailAddressesForUser(usbuf.fullname, new_emailaddrs);
623 ldap_memfree(user_dn);
626 entry = ldap_next_entry(ldserver, entry);
629 /* free the results */
630 ldap_msgfree(search_result);
632 /* unbind so we can go back in as the authenticating user */
633 ldap_unbind(ldserver);
636 #endif /* HAVE_LDAP */