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 * Wrapper function for ldap_initialize() that consistently fills in the correct fields
36 int ctdl_ldap_initialize(LDAP **ld) {
41 snprintf(server_url, sizeof server_url, "ldap://%s:%d", CtdlGetConfigStr("c_ldap_host"), CtdlGetConfigInt("c_ldap_port"));
42 ret = ldap_initialize(ld, server_url);
43 if (ret != LDAP_SUCCESS) {
44 syslog(LOG_ERR, "ldap: could not connect to %s : %m", server_url);
54 * Look up a user in the directory to see if this is an account that can be authenticated
56 int CtdlTryUserLDAP(char *username,
57 char *found_dn, int found_dn_size,
58 char *fullname, int fullname_size,
59 uid_t *uid, int lookup_based_on_username)
61 LDAP *ldserver = NULL;
63 LDAPMessage *search_result = NULL;
64 LDAPMessage *entry = NULL;
65 char searchstring[1024];
70 if (fullname) safestrncpy(fullname, username, fullname_size);
72 if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
76 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
77 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
79 striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
80 striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
81 syslog(LOG_DEBUG, "ldap: bind DN: %s", CtdlGetConfigStr("c_ldap_bind_dn"));
82 i = ldap_simple_bind_s(ldserver,
83 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
84 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
86 if (i != LDAP_SUCCESS) {
87 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
94 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
95 if (lookup_based_on_username != 0)
96 snprintf(searchstring, sizeof(searchstring), "(displayName=%s)",username);
98 snprintf(searchstring, sizeof(searchstring), "(sAMAccountName=%s)", username);
101 if (lookup_based_on_username != 0) {
102 snprintf(searchstring, sizeof(searchstring), "(cn=%s)",username);
105 snprintf(searchstring, sizeof(searchstring), "(&(objectclass=posixAccount)(uid=%s))", username);
109 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
110 (void) ldap_search_ext_s(
112 CtdlGetConfigStr("c_ldap_base_dn"), /* base */
113 LDAP_SCOPE_SUBTREE, /* scope */
114 searchstring, /* filter */
115 NULL, /* attrs (all attributes) */
116 0, /* attrsonly (attrs + values) */
117 NULL, /* serverctrls (none) */
118 NULL, /* clientctrls (none) */
120 1, /* sizelimit (1 result max) */
121 &search_result /* res */
124 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
125 * the search succeeds. Instead, we check to see whether search_result is still NULL.
127 if (search_result == NULL) {
128 syslog(LOG_DEBUG, "ldap: zero search results were returned");
129 ldap_unbind(ldserver);
133 /* At this point we've got at least one result from our query. If there are multiple
134 * results, we still only look at the first one.
136 entry = ldap_first_entry(ldserver, search_result);
139 user_dn = ldap_get_dn(ldserver, entry);
141 syslog(LOG_DEBUG, "ldap: dn = %s", user_dn);
144 /* begin - centralize this */
145 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
146 values = ldap_get_values(ldserver, search_result, "displayName");
149 if (fullname) safestrncpy(fullname, values[0], fullname_size);
150 syslog(LOG_DEBUG, "ldap: displayName = %s", values[0]);
152 ldap_value_free(values);
156 values = ldap_get_values(ldserver, search_result, "cn");
159 if (fullname) safestrncpy(fullname, values[0], fullname_size);
160 syslog(LOG_DEBUG, "ldap: cn = %s", values[0]);
162 ldap_value_free(values);
165 /* end - centralize this */
167 /* If we know the username is the CN/displayName, we already set the uid*/
168 if (lookup_based_on_username==0) {
169 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
170 values = ldap_get_values(ldserver, search_result, "objectGUID");
174 *uid = abs(HashLittle(values[0], strlen(values[0])));
175 syslog(LOG_DEBUG, "ldap: uid hashed from objectGUID = %d", *uid);
178 ldap_value_free(values);
182 values = ldap_get_values(ldserver, search_result, "uidNumber");
185 syslog(LOG_DEBUG, "ldap: uidNumber = %s", values[0]);
187 *uid = atoi(values[0]);
190 ldap_value_free(values);
197 /* free the results */
198 ldap_msgfree(search_result);
200 /* unbind so we can go back in as the authenticating user */
201 ldap_unbind(ldserver);
204 syslog(LOG_DEBUG, "ldap: No such user was found.");
208 if (found_dn) safestrncpy(found_dn, user_dn, found_dn_size);
209 ldap_memfree(user_dn);
214 int CtdlTryPasswordLDAP(char *user_dn, const char *password)
216 LDAP *ldserver = NULL;
219 if (IsEmptyStr(password)) {
220 syslog(LOG_DEBUG, "ldap: empty passwords are not permitted");
224 syslog(LOG_DEBUG, "ldap: trying to bind as %s", user_dn);
225 i = ctdl_ldap_initialize(&ldserver);
226 if (i == LDAP_SUCCESS) {
227 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
228 i = ldap_simple_bind_s(ldserver, user_dn, password);
229 if (i == LDAP_SUCCESS) {
230 syslog(LOG_DEBUG, "ldap: bind succeeded");
233 syslog(LOG_DEBUG, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
235 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
236 ldap_unbind(ldserver);
239 if (i == LDAP_SUCCESS) {
247 //return !0 iff property changed.
248 int vcard_set_props_iff_different(struct vCard *v,char *propname,int numvals, char **vals) {
251 for(i=0;i<numvals;i++) {
252 oldval = vcard_get_prop(v,propname,0,i,0);
253 if (oldval == NULL) break;
254 if (strcmp(vals[i],oldval)) break;
257 syslog(LOG_DEBUG, "ldap: vcard property %s, element %d of %d changed from %s to %s\n", propname, i, numvals, oldval, vals[i]);
258 for(i=0;i<numvals;i++) vcard_set_prop(v,propname,vals[i],(i==0) ? 0 : 1);
265 //return !0 iff property changed.
266 int vcard_set_one_prop_iff_different(struct vCard *v,char *propname, char *newfmt, ...) {
269 int changed_something;
270 va_start(args,newfmt);
271 if (-1==vasprintf(&newvalue,newfmt,args)) {
272 syslog(LOG_ERR, "ldap: out of memory!");
275 changed_something = vcard_set_props_iff_different(v,propname,1,&newvalue);
278 return changed_something;
283 * Learn LDAP attributes and stuff them into the vCard.
284 * Returns nonzero if we changed anything.
286 int Ctdl_LDAP_to_vCard(char *ldap_dn, struct vCard *v)
288 int changed_something = 0;
289 LDAP *ldserver = NULL;
292 LDAPMessage *search_result = NULL;
293 LDAPMessage *entry = NULL;
303 char **telephoneNumber;
306 char **facsimileTelephoneNumber;
309 char **homeDirectory;
316 char *attrs[] = { "*","+",NULL};
318 if (!ldap_dn) return(0);
321 if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
325 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
326 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
328 striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
329 striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
330 syslog(LOG_DEBUG, "ldap: bind DN: %s", CtdlGetConfigStr("c_ldap_bind_dn"));
331 i = ldap_simple_bind_s(ldserver,
332 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
333 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
335 if (i != LDAP_SUCCESS) {
336 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
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;
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 if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
470 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
471 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
473 striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
474 striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
475 syslog(LOG_DEBUG, "ldap: bind DN: %s", CtdlGetConfigStr("c_ldap_bind_dn"));
476 i = ldap_simple_bind_s(ldserver,
477 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
478 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
480 if (i != LDAP_SUCCESS) {
481 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
488 syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
489 (void) ldap_search_ext_s(
492 LDAP_SCOPE_SUBTREE, // scope
494 attrs, // attrs (all attributes)
495 0, // attrsonly (attrs + values)
496 NULL, // serverctrls (none)
497 NULL, // clientctrls (none)
499 1, // sizelimit (1 result max)
500 &search_result // res
503 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
504 * the search succeeds. Instead, we check to see whether search_result is still NULL.
506 if (search_result == NULL) {
507 syslog(LOG_DEBUG, "ldap: zero search results were returned");
508 ldap_unbind(ldserver);
512 /* At this point we've got at least one result from our query. If there are multiple
513 * results, we still only look at the first one.
515 emailaddrs[0] = 0; /* clear out any previous results */
516 entry = ldap_first_entry(ldserver, search_result);
518 syslog(LOG_DEBUG, "ldap: search got user details");
519 mail=ldap_get_values(ldserver, search_result, "mail");
523 for (q=0; q<ldap_count_values(mail); ++q) {
524 if (IsDirectory(mail[q], 0)) {
525 syslog(LOG_DEBUG, "\035FIXME YES DIRECTORY %s\033[0m", mail[q]);
526 if ((strlen(emailaddrs) + strlen(mail[q]) + 2) > 512) {
527 syslog(LOG_ERR, "ldap: can't fit all email addresses into user record");
530 if (!IsEmptyStr(emailaddrs)) {
531 strcat(emailaddrs, "|");
533 strcat(emailaddrs, mail[q]);
540 /* free the results */
541 ldap_msgfree(search_result);
543 /* unbind so we can go back in as the authenticating user */
544 ldap_unbind(ldserver);
550 * Scan LDAP for users and populate Citadel's user database with everyone
552 void CtdlSynchronizeUsersFromLDAP(void)
554 LDAP *ldserver = NULL;
556 LDAPMessage *search_result = NULL;
557 LDAPMessage *entry = NULL;
558 char *user_dn = NULL;
559 char searchstring[1024];
563 if ((CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP) && (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP_AD)) {
564 return; // not running LDAP
567 syslog(LOG_INFO, "ldap: synchronizing Citadel user database from LDAP");
569 if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
573 ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
574 ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
576 striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
577 striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
578 syslog(LOG_DEBUG, "ldap: bind DN: %s", CtdlGetConfigStr("c_ldap_bind_dn"));
579 i = ldap_simple_bind_s(ldserver,
580 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
581 (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
583 if (i != LDAP_SUCCESS) {
584 syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
591 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
592 snprintf(searchstring, sizeof(searchstring), "(&(objectClass=user)(objectClass=person)(!(objectClass=computer)))");
594 snprintf(searchstring, sizeof(searchstring), "(objectClass=inetOrgPerson)");
597 syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
598 (void) ldap_search_ext_s(
600 CtdlGetConfigStr("c_ldap_base_dn"), // base
601 LDAP_SCOPE_SUBTREE, // scope
602 searchstring, // filter
603 NULL, // attrs (all attributes)
604 0, // attrsonly (attrs + values)
605 NULL, // serverctrls (none)
606 NULL, // clientctrls (none)
608 INT_MAX, // sizelimit (max)
609 &search_result // result
612 /* Ignore the return value of ldap_search_ext_s(). Sometimes it returns an error even when
613 * the search succeeds. Instead, we check to see whether search_result is still NULL.
615 if (search_result == NULL) {
616 syslog(LOG_DEBUG, "ldap: zero search results were returned");
617 ldap_unbind(ldserver);
621 syslog(LOG_DEBUG, "ldap: %d entries returned", ldap_count_entries(ldserver, search_result));
622 entry = ldap_first_entry(ldserver, search_result);
625 user_dn = ldap_get_dn(ldserver, entry);
627 syslog(LOG_DEBUG, "ldap: found %s", user_dn);
629 int fullname_size = 256;
630 char fullname[256] = { 0 } ;
633 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
634 values = ldap_get_values(ldserver, entry, "displayName"); // AD schema: fullname = displayName
637 safestrncpy(fullname, values[0], fullname_size);
639 ldap_value_free(values);
641 values = ldap_get_values(ldserver, entry, "objectGUID"); // AD schema: uid hashed from objectGUID
644 uid = abs(HashLittle(values[0], strlen(values[0])));
646 ldap_value_free(values);
650 values = ldap_get_values(ldserver, entry, "cn"); // POSIX schema: fullname = cn
653 safestrncpy(fullname, values[0], fullname_size);
655 ldap_value_free(values);
657 values = ldap_get_values(ldserver, entry, "uidNumber"); // POSIX schema: uid = uidNumber
660 uid = atoi(values[0]);
662 ldap_value_free(values);
666 syslog(LOG_DEBUG, "\033[33mldap: display name: <%s> , uid = <%d>\033[0m", fullname, uid);
668 // FIXME now create or update the user
673 entry = ldap_next_entry(ldserver, entry);
676 /* free the results */
677 ldap_msgfree(search_result);
679 /* unbind so we can go back in as the authenticating user */
680 ldap_unbind(ldserver);
683 #endif /* HAVE_LDAP */