removed some debugs
[citadel.git] / citadel / ldap.c
index 04888318e2f840dc7eaea977541e1744f6d514b0..5c54953c1a668da9df86c90a86933e32974586f1 100644 (file)
@@ -1,17 +1,17 @@
-/*
- * These functions implement the portions of AUTHMODE_LDAP and AUTHMODE_LDAP_AD which
- * actually speak to the LDAP server.
- *
- * Copyright (c) 2011-2014 by the citadel.org development team.
- *
- * This program is open source software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- */
+// These functions implement the portions of AUTHMODE_LDAP and AUTHMODE_LDAP_AD which
+// actually speak to the LDAP server.
+//
+// Copyright (c) 2011-2022 by the citadel.org development team.
+//
+// This program is open source software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License, version 3.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// ldapsearch -D uid=admin,cn=users,cn=compat,dc=demo1,dc=freeipa,dc=org -w Secret123 -h ipa.demo1.freeipa.org
 
 int ctdl_require_ldap_version = 3;
 
@@ -22,178 +22,196 @@ int ctdl_require_ldap_version = 3;
 #include "citadel_ldap.h"
 #include "ctdl_module.h"
 #include "user_ops.h"
-
-#ifdef HAVE_LDAP
-#define LDAP_DEPRECATED 1      // Suppress libldap's warning that we are using deprecated API calls
+#include "internet_addressing.h"
+#include "config.h"
 #include <ldap.h>
 
-int CtdlTryUserLDAP(char *username,
-               char *found_dn, int found_dn_size,
-               char *fullname, int fullname_size,
-               uid_t *uid)
-{
-       LDAP *ldserver = NULL;
-       int i;
-       LDAPMessage *search_result = NULL;
-       LDAPMessage *entry = NULL;
-       char searchstring[1024];
-       struct timeval tv;
-       char **values;
-       char *user_dn = NULL;
 
-#ifndef LDAP_INITIALIZE
-       if (fullname) safestrncpy(fullname, username, fullname_size);
+// Utility function, supply a search result and get back the fullname (display name, common name, etc) from the first result
+//
+// POSIX schema:       the display name will be found in "cn" (common name)
+// Active Directory:   the display name will be found in "displayName"
+//
+void derive_fullname_from_ldap_result(char *fullname, int fullname_size, LDAP *ldserver, LDAPMessage *search_result) {
+       struct berval **values;
+
+       if (fullname == NULL) return;
+       if (search_result == NULL) return;
+       if (ldserver == NULL) return;
+
+       if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
+               values = ldap_get_values_len(ldserver, search_result, "displayName");
+               if (values) {
+                       if (ldap_count_values_len(values) > 0) {
+                               safestrncpy(fullname, values[0]->bv_val, fullname_size);
+                               syslog(LOG_DEBUG, "ldap: displayName = %s", fullname);
+                       }
+                       ldap_value_free_len(values);
+               }
+       }
+       else {
+               values = ldap_get_values_len(ldserver, search_result, "cn");
+               if (values) {
+                       if (ldap_count_values_len(values) > 0) {
+                               safestrncpy(fullname, values[0]->bv_val, fullname_size);
+                               syslog(LOG_DEBUG, "ldap: cn = %s", fullname);
+                       }
+                       ldap_value_free_len(values);
+               }
+       }
+}
+
 
-       ldserver = ldap_init(config.c_ldap_host, config.c_ldap_port);
-       if (ldserver == NULL) {
-               syslog(LOG_ALERT, "LDAP: Could not connect to %s:%d : %s",
-                       config.c_ldap_host, config.c_ldap_port,
-                       strerror(errno)
-               );
+// Utility function, supply a search result and get back the uid from the first result
+//
+// POSIX schema:       numeric user id will be in the "uidNumber" attribute
+// Active Directory:   we make a uid hashed from "objectGUID"
+//
+uid_t derive_uid_from_ldap(LDAP *ldserver, LDAPMessage *entry) {
+       struct berval **values;
+       uid_t uid = (-1);
+
+       if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
+               values = ldap_get_values_len(ldserver, entry, "objectGUID");
+               if (values) {
+                       if (ldap_count_values_len(values) > 0) {
+                               uid = abs(HashLittle(values[0]->bv_val, values[0]->bv_len));
+                       }
+                       ldap_value_free_len(values);
+               }
+       }
+       else {
+               values = ldap_get_values_len(ldserver, entry, "uidNumber");
+               if (values) {
+                       if (ldap_count_values_len(values) > 0) {
+                               uid = atoi(values[0]->bv_val);
+                       }
+                       ldap_value_free_len(values);
+               }
+       }
+
+       syslog(LOG_DEBUG, "ldap: uid = %d", uid);
+       return(uid);
+}
+
+
+// Wrapper function for ldap_initialize() that consistently fills in the correct fields
+int ctdl_ldap_initialize(LDAP **ld) {
+
+       char server_url[256];
+       int ret;
+
+       snprintf(server_url, sizeof server_url, "ldap://%s:%d", CtdlGetConfigStr("c_ldap_host"), CtdlGetConfigInt("c_ldap_port"));
+       ret = ldap_initialize(ld, server_url);
+       if (ret != LDAP_SUCCESS) {
+               syslog(LOG_ERR, "ldap: could not connect to %s : %m", server_url);
+               *ld = NULL;
                return(errno);
        }
 
+       return(ret);
+}
+
+
+// Bind to the LDAP server and return a working handle
+LDAP *ctdl_ldap_bind(void) {
+       LDAP *ldserver = NULL;
+       int i;
+
+       if (ctdl_ldap_initialize(&ldserver) != LDAP_SUCCESS) {
+               return(NULL);
+       }
+
        ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
        ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
 
-       striplt(config.c_ldap_bind_dn);
-       striplt(config.c_ldap_bind_pw);
-       syslog(LOG_DEBUG, "LDAP bind DN: %s", config.c_ldap_bind_dn);
+       striplt(CtdlGetConfigStr("c_ldap_bind_dn"));
+       striplt(CtdlGetConfigStr("c_ldap_bind_pw"));
        i = ldap_simple_bind_s(ldserver,
-               (!IsEmptyStr(config.c_ldap_bind_dn) ? config.c_ldap_bind_dn : NULL),
-               (!IsEmptyStr(config.c_ldap_bind_pw) ? config.c_ldap_bind_pw : NULL)
+               (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_dn")) ? CtdlGetConfigStr("c_ldap_bind_dn") : NULL),
+               (!IsEmptyStr(CtdlGetConfigStr("c_ldap_bind_pw")) ? CtdlGetConfigStr("c_ldap_bind_pw") : NULL)
        );
        if (i != LDAP_SUCCESS) {
-               syslog(LOG_ALERT, "LDAP: Cannot bind: %s (%d)", ldap_err2string(i), i);
-               return(i);
-       }
-#else
-       if (ldap_initialize(&ldserver, config.c_ldap_host))
-       {
-               syslog(LOG_ALERT, "LDAP: Could not connect to %s:%d : %s",
-                          config.c_ldap_host, config.c_ldap_port,
-                          strerror(errno)
-                       );
-               return(errno);
+               syslog(LOG_ERR, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
+               return(NULL);
        }
 
-       striplt(config.c_ldap_bind_dn);
-       striplt(config.c_ldap_bind_pw);
+       return(ldserver);
+}
 
-       syslog(LOG_DEBUG, "LDAP bind DN: %s", config.c_ldap_bind_dn);
-       i = ldap_simple_bind_s(ldserver,
-               (!IsEmptyStr(config.c_ldap_bind_dn) ? config.c_ldap_bind_dn : NULL),
-               (!IsEmptyStr(config.c_ldap_bind_pw) ? config.c_ldap_bind_pw : NULL)
-       );
 
-       if (i != LDAP_SUCCESS) {
-               syslog(LOG_ALERT, "LDAP: Cannot bind: %s (%d)", ldap_err2string(i), i);
-               return(i);
-       }
-#endif
+// Look up a user in the directory to see if this is an account that can be authenticated
+//
+// POSIX schema:       Search all "inetOrgPerson" objects with "uid" set to the supplied username
+// Active Directory:   Look for an account with "sAMAccountName" set to the supplied username
+//
+int CtdlTryUserLDAP(char *username, char *found_dn, int found_dn_size, char *fullname, int fullname_size, uid_t *uid) {
+       LDAP *ldserver = NULL;
+       LDAPMessage *search_result = NULL;
+       LDAPMessage *entry = NULL;
+       char searchstring[1024];
+       struct timeval tv;
+       char *user_dn = NULL;
 
+       ldserver = ctdl_ldap_bind();
+       if (!ldserver) return(-1);
 
+       if (fullname) safestrncpy(fullname, username, fullname_size);
        tv.tv_sec = 10;
        tv.tv_usec = 0;
 
-       if (config.c_auth_mode == AUTHMODE_LDAP_AD) {
-               sprintf(searchstring, "(sAMAccountName=%s)", username);
+       if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
+               snprintf(searchstring, sizeof(searchstring), "(sAMAccountName=%s)", username);
        }
        else {
-               sprintf(searchstring, "(&(objectclass=posixAccount)(uid=%s))", username);
+               snprintf(searchstring, sizeof(searchstring), "(&(objectclass=inetOrgPerson)(uid=%s))", username);
        }
 
-       syslog(LOG_DEBUG, "LDAP search: %s", searchstring);
-       (void) ldap_search_ext_s(
-               ldserver,                                       /* ld                           */
-               config.c_ldap_base_dn,                          /* base                         */
-               LDAP_SCOPE_SUBTREE,                             /* scope                        */
-               searchstring,                                   /* filter                       */
-               NULL,                                           /* attrs (all attributes)       */
-               0,                                              /* attrsonly (attrs + values)   */
-               NULL,                                           /* serverctrls (none)           */
-               NULL,                                           /* clientctrls (none)           */
-               &tv,                                            /* timeout                      */
-               1,                                              /* sizelimit (1 result max)     */
-               &search_result                                  /* res                          */
-       );
+       syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
+       syslog(LOG_DEBUG, "ldap: search results: %s", ldap_err2string(ldap_search_ext_s(
+               ldserver,                                       // ld
+               CtdlGetConfigStr("c_ldap_base_dn"),             // base
+               LDAP_SCOPE_SUBTREE,                             // scope
+               searchstring,                                   // filter
+               NULL,                                           // attrs (all attributes)
+               0,                                              // attrsonly (attrs + values)
+               NULL,                                           // serverctrls (none)
+               NULL,                                           // clientctrls (none)
+               &tv,                                            // timeout
+               1,                                              // sizelimit (1 result max)
+               &search_result                                  // put the result here
+       )));
 
-       /* Ignore the return value of ldap_search_ext_s().  Sometimes it returns an error even when
-        * the search succeeds.  Instead, we check to see whether search_result is still NULL.
-        */
+       // Ignore the return value of ldap_search_ext_s().  Sometimes it returns an error even when
+       // the search succeeds.  Instead, we check to see whether search_result is still NULL.
        if (search_result == NULL) {
-               syslog(LOG_DEBUG, "LDAP search: zero results were returned");
+               syslog(LOG_DEBUG, "ldap: zero search results were returned");
                ldap_unbind(ldserver);
                return(2);
        }
 
-       /* At this point we've got at least one result from our query.  If there are multiple
-        * results, we still only look at the first one.
-        */
+       // At this point we've got at least one result from our query.  If there are multiple
+       // results, we still only look at the first one.
        entry = ldap_first_entry(ldserver, search_result);
        if (entry) {
 
                user_dn = ldap_get_dn(ldserver, entry);
                if (user_dn) {
-                       syslog(LOG_DEBUG, "dn = %s", user_dn);
-               }
-
-               if (config.c_auth_mode == AUTHMODE_LDAP_AD) {
-                       values = ldap_get_values(ldserver, search_result, "displayName");
-                       if (values) {
-                               if (values[0]) {
-                                       if (fullname) safestrncpy(fullname, values[0], fullname_size);
-                                       syslog(LOG_DEBUG, "displayName = %s", values[0]);
-                               }
-                               ldap_value_free(values);
-                       }
-               }
-               else {
-                       values = ldap_get_values(ldserver, search_result, "cn");
-                       if (values) {
-                               if (values[0]) {
-                                       if (fullname) safestrncpy(fullname, values[0], fullname_size);
-                                       syslog(LOG_DEBUG, "cn = %s", values[0]);
-                               }
-                               ldap_value_free(values);
-                       }
-               }
-
-               if (config.c_auth_mode == AUTHMODE_LDAP_AD) {
-                       values = ldap_get_values(ldserver, search_result, "objectGUID");
-                       if (values) {
-                               if (values[0]) {
-                                       if (uid != NULL) {
-                                               *uid = abs(HashLittle(values[0], strlen(values[0])));
-                                               syslog(LOG_DEBUG, "uid hashed from objectGUID = %d", *uid);
-                                       }
-                               }
-                               ldap_value_free(values);
-                       }
-               }
-               else {
-                       values = ldap_get_values(ldserver, search_result, "uidNumber");
-                       if (values) {
-                               if (values[0]) {
-                                       syslog(LOG_DEBUG, "uidNumber = %s", values[0]);
-                                       if (uid != NULL) {
-                                               *uid = atoi(values[0]);
-                                       }
-                               }
-                               ldap_value_free(values);
-                       }
+                       syslog(LOG_DEBUG, "ldap: dn = %s", user_dn);
                }
 
+               derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, search_result);
+               *uid = derive_uid_from_ldap(ldserver, search_result);
        }
 
-       /* free the results */
+       // free the results
        ldap_msgfree(search_result);
 
-       /* unbind so we can go back in as the authenticating user */
+       // unbind so we can go back in as the authenticating user
        ldap_unbind(ldserver);
 
        if (!user_dn) {
-               syslog(LOG_DEBUG, "No such user was found.");
+               syslog(LOG_DEBUG, "ldap: No such user was found.");
                return(4);
        }
 
@@ -203,26 +221,26 @@ int CtdlTryUserLDAP(char *username,
 }
 
 
-int CtdlTryPasswordLDAP(char *user_dn, const char *password)
-{
+// This is an extension of CtdlTryPassword() which gets called when using LDAP authentication.
+int CtdlTryPasswordLDAP(char *user_dn, const char *password) {
        LDAP *ldserver = NULL;
        int i = (-1);
 
        if (IsEmptyStr(password)) {
-               syslog(LOG_DEBUG, "LDAP: empty passwords are not permitted");
+               syslog(LOG_DEBUG, "ldap: empty passwords are not permitted");
                return(1);
        }
 
-       syslog(LOG_DEBUG, "LDAP: trying to bind as %s", user_dn);
-       ldserver = ldap_init(config.c_ldap_host, config.c_ldap_port);
-       if (ldserver) {
+       syslog(LOG_DEBUG, "ldap: trying to bind as %s", user_dn);
+       i = ctdl_ldap_initialize(&ldserver);
+       if (i == LDAP_SUCCESS) {
                ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
                i = ldap_simple_bind_s(ldserver, user_dn, password);
                if (i == LDAP_SUCCESS) {
-                       syslog(LOG_DEBUG, "LDAP: bind succeeded");
+                       syslog(LOG_DEBUG, "ldap: bind succeeded");
                }
                else {
-                       syslog(LOG_DEBUG, "LDAP: Cannot bind: %s (%d)", ldap_err2string(i), i);
+                       syslog(LOG_DEBUG, "ldap: Cannot bind: %s (%d)", ldap_err2string(i), i);
                }
                ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
                ldap_unbind(ldserver);
@@ -236,206 +254,378 @@ int CtdlTryPasswordLDAP(char *user_dn, const char *password)
 }
 
 
-// return !0 iff property changed.
-//
-int vcard_set_props_iff_different(struct vCard *v,char *propname,int numvals, char **vals) {
+// set multiple properties
+// returns nonzero only if property changed.
+int vcard_set_props_iff_different(struct vCard *v, char *propname, int numvals, char **vals) {
        int i;
-       char *oldval;
-       for(i=0;i<numvals;i++) {
-         oldval = vcard_get_prop(v,propname,0,i,0);
-         if (oldval == NULL) break;
-         if (strcmp(vals[i],oldval)) break;
+       char *oldval = "";
+       for (i=0; i<numvals; i++) {
+               oldval = vcard_get_prop(v, propname, 0, i, 0);
+               if (oldval == NULL) break;
+               if (strcmp(vals[i],oldval)) break;
        }
-       if (i!=numvals) {
-               for(i=0;i<numvals;i++) vcard_set_prop(v,propname,vals[i],(i==0) ? 0 : 1);
+       if (i != numvals) {
+               syslog(LOG_DEBUG, "ldap: vcard property %s, element %d of %d changed from %s to %s", propname, i, numvals, oldval, vals[i]);
+               for (i=0; i<numvals; i++) {
+                       vcard_set_prop(v,propname,vals[i],(i==0) ? 0 : 1);
+               }
                return 1;
        }
        return 0;
 }
 
 
-// return !0 iff property changed.
-//
+// set one property
+// returns nonzero only if property changed.
 int vcard_set_one_prop_iff_different(struct vCard *v,char *propname, char *newfmt, ...) {
        va_list args;
        char *newvalue;
-       int changed_something;
+       int did_change = 0;
        va_start(args,newfmt);
-       if (-1==vasprintf(&newvalue,newfmt,args)) {
-               syslog(LOG_ALERT, "Out of memory!");
+       if (vasprintf(&newvalue, newfmt, args) < 0) {
+               syslog(LOG_ERR, "ldap: out of memory");
                return 0;
        }
-       changed_something = vcard_set_props_iff_different(v,propname,1,&newvalue);
+       did_change = vcard_set_props_iff_different(v, propname, 1, &newvalue);
        va_end(args);
        free(newvalue);
-       return changed_something;
+       return did_change;
 }
 
 
 // Learn LDAP attributes and stuff them into the vCard.
 // Returns nonzero if we changed anything.
-//
-int Ctdl_LDAP_to_vCard(char *ldap_dn, struct vCard *v)
-{
+int Ctdl_LDAP_to_vCard(char *ldap_dn, struct vCard *v) {
        int changed_something = 0;
        LDAP *ldserver = NULL;
-       int i;
        struct timeval tv;
        LDAPMessage *search_result = NULL;
        LDAPMessage *entry = NULL;
-       char **givenName;
-       char **sn;
-       char **cn;
-       char **initials;
-       char **o;
-       char **street;
-       char **l;
-       char **st;
-       char **postalCode;
-       char **telephoneNumber;
-       char **mobile;
-       char **homePhone;
-       char **facsimileTelephoneNumber;
-       char **mail;
-       char **uid;
-       char **homeDirectory;
-       char **uidNumber;
-       char **loginShell;
-       char **gidNumber;
-       char **c;
-       char **title;
-       char **uuid;
+       struct berval **givenName;
+       struct berval **sn;
+       struct berval **cn;
+       struct berval **initials;
+       struct berval **o;
+       struct berval **street;
+       struct berval **l;
+       struct berval **st;
+       struct berval **postalCode;
+       struct berval **telephoneNumber;
+       struct berval **mobile;
+       struct berval **homePhone;
+       struct berval **facsimileTelephoneNumber;
+       struct berval **mail;
+       struct berval **uid;
+       struct berval **homeDirectory;
+       struct berval **uidNumber;
+       struct berval **loginShell;
+       struct berval **gidNumber;
+       struct berval **c;
+       struct berval **title;
+       struct berval **uuid;
        char *attrs[] = { "*","+",NULL};
 
        if (!ldap_dn) return(0);
        if (!v) return(0);
-       ldserver = ldap_init(config.c_ldap_host, config.c_ldap_port);
-       if (ldserver == NULL) {
-               syslog(LOG_ALERT, "LDAP: Could not connect to %s:%d : %s",
-                       config.c_ldap_host, config.c_ldap_port,
-                       strerror(errno)
-               );
-               return(0);
-       }
 
-       ldap_set_option(ldserver, LDAP_OPT_PROTOCOL_VERSION, &ctdl_require_ldap_version);
-       ldap_set_option(ldserver, LDAP_OPT_REFERRALS, (void *)LDAP_OPT_OFF);
-
-       striplt(config.c_ldap_bind_dn);
-       striplt(config.c_ldap_bind_pw);
-       syslog(LOG_DEBUG, "LDAP bind DN: %s", config.c_ldap_bind_dn);
-       i = ldap_simple_bind_s(ldserver,
-               (!IsEmptyStr(config.c_ldap_bind_dn) ? config.c_ldap_bind_dn : NULL),
-               (!IsEmptyStr(config.c_ldap_bind_pw) ? config.c_ldap_bind_pw : NULL)
-       );
-       if (i != LDAP_SUCCESS) {
-               syslog(LOG_ALERT, "LDAP: Cannot bind: %s (%d)", ldap_err2string(i), i);
-               return(0);
-       }
+       ldserver = ctdl_ldap_bind();
+       if (!ldserver) return(-1);
 
        tv.tv_sec = 10;
        tv.tv_usec = 0;
 
-       syslog(LOG_DEBUG, "LDAP search: %s", ldap_dn);
-       (void) ldap_search_ext_s(
-               ldserver,                       // ld
-               ldap_dn,                        // base
-               LDAP_SCOPE_SUBTREE,             // scope
-               NULL,                           // filter
-               attrs,                          // attrs (all attributes)
-               0,                              // attrsonly (attrs + values)
-               NULL,                           // serverctrls (none)
-               NULL,                           // clientctrls (none)
-               &tv,                            // timeout
-               1,                              // sizelimit (1 result max)
-               &search_result                  // res
-       );
+       syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
+       syslog(LOG_DEBUG, "ldap: search results: %s", ldap_err2string(ldap_search_ext_s(
+               ldserver,                               // ld
+               ldap_dn,                                // base
+               LDAP_SCOPE_SUBTREE,                     // scope
+               NULL,                                   // filter
+               attrs,                                  // attrs (all attributes)
+               0,                                      // attrsonly (attrs + values)
+               NULL,                                   // serverctrls (none)
+               NULL,                                   // clientctrls (none)
+               &tv,                                    // timeout
+               1,                                      // sizelimit (1 result max)
+               &search_result                          // res
+       )));
        
        // Ignore the return value of ldap_search_ext_s().  Sometimes it returns an error even when
        // the search succeeds.  Instead, we check to see whether search_result is still NULL.
-        
        if (search_result == NULL) {
-               syslog(LOG_DEBUG, "LDAP search: zero results were returned");
+               syslog(LOG_DEBUG, "ldap: zero search results were returned");
                ldap_unbind(ldserver);
                return(0);
        }
 
        // At this point we've got at least one result from our query.  If there are multiple
        // results, we still only look at the first one.
-
        entry = ldap_first_entry(ldserver, search_result);
        if (entry) {
-               syslog(LOG_DEBUG, "LDAP search, got user details for vcard.");
-               givenName=ldap_get_values(ldserver, search_result, "givenName");
-               sn=ldap_get_values(ldserver, search_result, "sn");
-               cn=ldap_get_values(ldserver, search_result, "cn");
-               initials=ldap_get_values(ldserver, search_result, "initials");
-               title=ldap_get_values(ldserver, search_result, "title");
-               o=ldap_get_values(ldserver, search_result, "o");
-               street=ldap_get_values(ldserver, search_result, "street");
-               l=ldap_get_values(ldserver, search_result, "l");
-               st=ldap_get_values(ldserver, search_result, "st");
-               postalCode=ldap_get_values(ldserver, search_result, "postalCode");
-               telephoneNumber=ldap_get_values(ldserver, search_result, "telephoneNumber");
-               mobile=ldap_get_values(ldserver, search_result, "mobile");
-               homePhone=ldap_get_values(ldserver, search_result, "homePhone");
-               facsimileTelephoneNumber=ldap_get_values(ldserver, search_result, "facsimileTelephoneNumber");
-               mail=ldap_get_values(ldserver, search_result, "mail");
-               uid=ldap_get_values(ldserver, search_result, "uid");
-               homeDirectory=ldap_get_values(ldserver, search_result, "homeDirectory");
-               uidNumber=ldap_get_values(ldserver, search_result, "uidNumber");
-               loginShell=ldap_get_values(ldserver, search_result, "loginShell");
-               gidNumber=ldap_get_values(ldserver, search_result, "gidNumber");
-               c=ldap_get_values(ldserver, search_result, "c");
-               uuid=ldap_get_values(ldserver, search_result, "entryUUID");
-
-               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]);
-               if (telephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;work","%s",telephoneNumber[0]);
-               if (facsimileTelephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;fax","%s",facsimileTelephoneNumber[0]);
-               if (mobile) changed_something |= vcard_set_one_prop_iff_different(v,"tel;cell","%s",mobile[0]);
-               if (homePhone) changed_something |= vcard_set_one_prop_iff_different(v,"tel;home","%s",homePhone[0]);
+               syslog(LOG_DEBUG, "ldap: search got user details for vcard.");
+               givenName                       = ldap_get_values_len(ldserver, search_result, "givenName");
+               sn                              = ldap_get_values_len(ldserver, search_result, "sn");
+               cn                              = ldap_get_values_len(ldserver, search_result, "cn");
+               initials                        = ldap_get_values_len(ldserver, search_result, "initials");
+               title                           = ldap_get_values_len(ldserver, search_result, "title");
+               o                               = ldap_get_values_len(ldserver, search_result, "o");
+               street                          = ldap_get_values_len(ldserver, search_result, "street");
+               l                               = ldap_get_values_len(ldserver, search_result, "l");
+               st                              = ldap_get_values_len(ldserver, search_result, "st");
+               postalCode                      = ldap_get_values_len(ldserver, search_result, "postalCode");
+               telephoneNumber                 = ldap_get_values_len(ldserver, search_result, "telephoneNumber");
+               mobile                          = ldap_get_values_len(ldserver, search_result, "mobile");
+               homePhone                       = ldap_get_values_len(ldserver, search_result, "homePhone");
+               facsimileTelephoneNumber        = ldap_get_values_len(ldserver, search_result, "facsimileTelephoneNumber");
+               mail                            = ldap_get_values_len(ldserver, search_result, "mail");
+               uid                             = ldap_get_values_len(ldserver, search_result, "uid");
+               homeDirectory                   = ldap_get_values_len(ldserver, search_result, "homeDirectory");
+               uidNumber                       = ldap_get_values_len(ldserver, search_result, "uidNumber");
+               loginShell                      = ldap_get_values_len(ldserver, search_result, "loginShell");
+               gidNumber                       = ldap_get_values_len(ldserver, search_result, "gidNumber");
+               c                               = ldap_get_values_len(ldserver, search_result, "c");
+               uuid                            = ldap_get_values_len(ldserver, search_result, "entryUUID");
+
+               if (street && l && st && postalCode && c) changed_something |= vcard_set_one_prop_iff_different(v,"adr",";;%s;%s;%s;%s;%s",street[0]->bv_val,l[0]->bv_val,st[0]->bv_val,postalCode[0]->bv_val,c[0]->bv_val);
+               if (telephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;work","%s",telephoneNumber[0]->bv_val);
+               if (facsimileTelephoneNumber) changed_something |= vcard_set_one_prop_iff_different(v,"tel;fax","%s",facsimileTelephoneNumber[0]->bv_val);
+               if (mobile) changed_something |= vcard_set_one_prop_iff_different(v,"tel;cell","%s",mobile[0]->bv_val);
+               if (homePhone) changed_something |= vcard_set_one_prop_iff_different(v,"tel;home","%s",homePhone[0]->bv_val);
                if (givenName && sn) {
                        if (initials) {
-                               changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s;%s",sn[0],givenName[0],initials[0]);
+                               changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s;%s",sn[0]->bv_val,givenName[0]->bv_val,initials[0]->bv_val);
                        }
                        else {
-                               changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s",sn[0],givenName[0]);
+                               changed_something |= vcard_set_one_prop_iff_different(v,"n","%s;%s",sn[0]->bv_val,givenName[0]->bv_val);
                        }
                }
+
+               // FIXME we need a new way to do this.
+               //if (mail) {
+                       //changed_something |= vcard_set_props_iff_different(v,"email;internet",ldap_count_values_len(mail),mail);
+               //}
+
+               if (uuid) changed_something |= vcard_set_one_prop_iff_different(v,"X-uuid","%s",uuid[0]->bv_val);
+               if (o) changed_something |= vcard_set_one_prop_iff_different(v,"org","%s",o[0]->bv_val);
+               if (cn) changed_something |= vcard_set_one_prop_iff_different(v,"fn","%s",cn[0]->bv_val);
+               if (title) changed_something |= vcard_set_one_prop_iff_different(v,"title","%s",title[0]->bv_val);
+               
+               if (givenName)                  ldap_value_free_len(givenName);
+               if (initials)                   ldap_value_free_len(initials);
+               if (sn)                         ldap_value_free_len(sn);
+               if (cn)                         ldap_value_free_len(cn);
+               if (o)                          ldap_value_free_len(o);
+               if (street)                     ldap_value_free_len(street);
+               if (l)                          ldap_value_free_len(l);
+               if (st)                         ldap_value_free_len(st);
+               if (postalCode)                 ldap_value_free_len(postalCode);
+               if (telephoneNumber)            ldap_value_free_len(telephoneNumber);
+               if (mobile)                     ldap_value_free_len(mobile);
+               if (homePhone)                  ldap_value_free_len(homePhone);
+               if (facsimileTelephoneNumber)   ldap_value_free_len(facsimileTelephoneNumber);
+               if (mail)                       ldap_value_free_len(mail);
+               if (uid)                        ldap_value_free_len(uid);
+               if (homeDirectory)              ldap_value_free_len(homeDirectory);
+               if (uidNumber)                  ldap_value_free_len(uidNumber);
+               if (loginShell)                 ldap_value_free_len(loginShell);
+               if (gidNumber)                  ldap_value_free_len(gidNumber);
+               if (c)                          ldap_value_free_len(c);
+               if (title)                      ldap_value_free_len(title);
+               if (uuid)                       ldap_value_free_len(uuid);
+       }
+       // free the results
+       ldap_msgfree(search_result);
+
+       // unbind so we can go back in as the authenticating user
+       ldap_unbind(ldserver);
+       return(changed_something);      // tell the caller whether we made any changes
+}
+
+
+// Extract a user's Internet email addresses from LDAP.
+// Returns zero if we got a valid set of addresses; nonzero for error.
+int extract_email_addresses_from_ldap(char *ldap_dn, char *emailaddrs) {
+       LDAP *ldserver = NULL;
+       struct timeval tv;
+       LDAPMessage *search_result = NULL;
+       LDAPMessage *entry = NULL;
+       struct berval **mail;
+       char *attrs[] = { "*","+",NULL };
+
+       if (!ldap_dn) return(1);
+       if (!emailaddrs) return(1);
+
+       ldserver = ctdl_ldap_bind();
+       if (!ldserver) return(-1);
+
+       tv.tv_sec = 10;
+       tv.tv_usec = 0;
+
+       syslog(LOG_DEBUG, "ldap: search: %s", ldap_dn);
+       syslog(LOG_DEBUG, "ldap: search results: %s", ldap_err2string(ldap_search_ext_s(
+               ldserver,                               // ld
+               ldap_dn,                                // base
+               LDAP_SCOPE_SUBTREE,                     // scope
+               NULL,                                   // filter
+               attrs,                                  // attrs (all attributes)
+               0,                                      // attrsonly (attrs + values)
+               NULL,                                   // serverctrls (none)
+               NULL,                                   // clientctrls (none)
+               &tv,                                    // timeout
+               1,                                      // sizelimit (1 result max)
+               &search_result                          // res
+       )));
+       
+       // Ignore the return value of ldap_search_ext_s().  Sometimes it returns an error even when
+       // the search succeeds.  Instead, we check to see whether search_result is still NULL.
+       if (search_result == NULL) {
+               syslog(LOG_DEBUG, "ldap: zero search results were returned");
+               ldap_unbind(ldserver);
+               return(4);
+       }
+
+       // At this point we've got at least one result from our query.
+       // If there are multiple results, we still only look at the first one.
+       emailaddrs[0] = 0;                                                              // clear out any previous results
+       entry = ldap_first_entry(ldserver, search_result);
+       if (entry) {
+               syslog(LOG_DEBUG, "ldap: search got user details");
+               mail = ldap_get_values_len(ldserver, search_result, "mail");
                if (mail) {
-                       changed_something |= vcard_set_props_iff_different(v,"email;internet",ldap_count_values(mail),mail);
+                       int q;
+                       for (q=0; q<ldap_count_values_len(mail); ++q) {
+                               if (IsDirectory(mail[q]->bv_val, 0)) {
+                                       if ((strlen(emailaddrs) + mail[q]->bv_len + 2) > 512) {
+                                               syslog(LOG_ERR, "ldap: can't fit all email addresses into user record");
+                                       }
+                                       else {
+                                               if (!IsEmptyStr(emailaddrs)) {
+                                                       strcat(emailaddrs, "|");
+                                               }
+                                               strcat(emailaddrs, mail[q]->bv_val);
+                                       }
+                               }
+                       }
                }
-               if (uuid) changed_something |= vcard_set_one_prop_iff_different(v,"uid","%s",uuid[0]);
-               if (o) changed_something |= vcard_set_one_prop_iff_different(v,"org","%s",o[0]);
-               if (cn) changed_something |= vcard_set_one_prop_iff_different(v,"fn","%s",cn[0]);
-               if (title) changed_something |= vcard_set_one_prop_iff_different(v,"title","%s",title[0]);
-               if (givenName) ldap_value_free(givenName);
-               if (initials) ldap_value_free(initials);
-               if (sn) ldap_value_free(sn);
-               if (cn) ldap_value_free(cn);
-               if (o) ldap_value_free(o);
-               if (street) ldap_value_free(street);
-               if (l) ldap_value_free(l);
-               if (st) ldap_value_free(st);
-               if (postalCode) ldap_value_free(postalCode);
-               if (telephoneNumber) ldap_value_free(telephoneNumber);
-               if (mobile) ldap_value_free(mobile);
-               if (homePhone) ldap_value_free(homePhone);
-               if (facsimileTelephoneNumber) ldap_value_free(facsimileTelephoneNumber);
-               if (mail) ldap_value_free(mail);
-               if (uid) ldap_value_free(uid);
-               if (homeDirectory) ldap_value_free(homeDirectory);
-               if (uidNumber) ldap_value_free(uidNumber);
-               if (loginShell) ldap_value_free(loginShell);
-               if (gidNumber) ldap_value_free(gidNumber);
-               if (c) ldap_value_free(c);
-               if (title) ldap_value_free(title);
-               if (uuid) ldap_value_free(uuid);
        }
 
-       ldap_msgfree(search_result);    // free the results
-       ldap_unbind(ldserver);          // unbind so we can go back in as the authenticating user
-       return(changed_something);      // tell the caller whether we made any changes
+       // free the results
+       ldap_msgfree(search_result);
+
+       // unbind so we can go back in as the authenticating user
+       ldap_unbind(ldserver);
+       return(0);
+}
+
+
+// Remember that a particular user exists in the Citadel database.
+// As we scan the LDAP tree we will remove users from this list when we find them.
+// At the end of the scan, any users remaining in this list are stale and should be deleted.
+void ldap_note_user_in_citadel(char *username, void *data) {
+       return;
 }
 
-#endif /* HAVE_LDAP */
+
+// Scan LDAP for users and populate Citadel's user database with everyone
+//
+// POSIX schema:       All objects of class "inetOrgPerson"
+// Active Directory:   Objects that are class "user" and class "person" but NOT class "computer"
+//
+void CtdlSynchronizeUsersFromLDAP(void) {
+       LDAP *ldserver = NULL;
+       LDAPMessage *search_result = NULL;
+       LDAPMessage *entry = NULL;
+       char *user_dn = NULL;
+       char searchstring[1024];
+       struct timeval tv;
+
+       if ((CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP) && (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_LDAP_AD)) {
+               return;                                         // If this site is not running LDAP, stop here.
+       }
+
+       syslog(LOG_INFO, "ldap: synchronizing Citadel user database from LDAP");
+
+       // first, scan the existing Citadel user list
+       // ForEachUser(ldap_note_user_in_citadel, NULL);        // FIXME finish this
+
+       ldserver = ctdl_ldap_bind();
+       if (!ldserver) return;
+
+       tv.tv_sec = 10;
+       tv.tv_usec = 0;
+
+       if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD) {
+                       snprintf(searchstring, sizeof(searchstring), "(&(objectClass=user)(objectClass=person)(!(objectClass=computer)))");
+       }
+       else {
+                       snprintf(searchstring, sizeof(searchstring), "(objectClass=inetOrgPerson)");
+       }
+
+       syslog(LOG_DEBUG, "ldap: search: %s", searchstring);
+       syslog(LOG_DEBUG, "ldap: search results: %s", ldap_err2string(ldap_search_ext_s(
+               ldserver,                                       // ld
+               CtdlGetConfigStr("c_ldap_base_dn"),             // base
+               LDAP_SCOPE_SUBTREE,                             // scope
+               searchstring,                                   // filter
+               NULL,                                           // attrs (all attributes)
+               0,                                              // attrsonly (attrs + values)
+               NULL,                                           // serverctrls (none)
+               NULL,                                           // clientctrls (none)
+               &tv,                                            // timeout
+               INT_MAX,                                        // sizelimit (max)
+               &search_result                                  // put the result here
+       )));
+
+       // Ignore the return value of ldap_search_ext_s().  Sometimes it returns an error even when
+       // the search succeeds.  Instead, we check to see whether search_result is still NULL.
+       if (search_result == NULL) {
+               syslog(LOG_DEBUG, "ldap: zero search results were returned");
+               ldap_unbind(ldserver);
+               return;
+       }
+
+       syslog(LOG_DEBUG, "ldap: %d entries returned", ldap_count_entries(ldserver, search_result));
+       for (entry=ldap_first_entry(ldserver, search_result); entry!=NULL; entry=ldap_next_entry(ldserver, entry)) {
+               user_dn = ldap_get_dn(ldserver, entry);
+               if (user_dn) {
+                       syslog(LOG_DEBUG, "ldap: found %s", user_dn);
+
+                       int fullname_size = 256;
+                       char fullname[256] = { 0 } ;
+                       uid_t uid = (-1);
+                       char new_emailaddrs[512] = { 0 } ;
+
+                       uid = derive_uid_from_ldap(ldserver, entry);
+                       derive_fullname_from_ldap_result(fullname, fullname_size, ldserver, entry);
+                       syslog(LOG_DEBUG, "ldap: display name: <%s> , uid = <%d>", fullname, uid);
+
+                       // now create or update the user
+                       int found_user;
+                       struct ctdluser usbuf;
+
+                       found_user = getuserbyuid(&usbuf, uid);
+                       if (found_user != 0) {
+                               create_user(fullname, CREATE_USER_DO_NOT_BECOME_USER, uid);
+                               found_user = getuserbyuid(&usbuf, uid);
+                               strcpy(fullname, usbuf.fullname);
+                       }
+
+                       if (found_user == 0) {          // user record exists
+                                                       // now update the account email addresses if necessary
+                               if (CtdlGetConfigInt("c_ldap_sync_email_addrs") > 0) {
+                                       if (extract_email_addresses_from_ldap(user_dn, new_emailaddrs) == 0) {
+                                               if (strcmp(usbuf.emailaddrs, new_emailaddrs)) {                         // update only if changed
+                                                       CtdlSetEmailAddressesForUser(usbuf.fullname, new_emailaddrs);
+                                               }
+                                       }
+                               }
+                       }
+                       ldap_memfree(user_dn);
+               }
+       }
+
+       // free the results
+       ldap_msgfree(search_result);
+
+       // unbind so we can go back in as the authenticating user
+       ldap_unbind(ldserver);
+}