s3: add LDAP Alias Dereferencing support
[ira/wip.git] / source3 / lib / smbldap.c
index 4f54f9ad582dda5290b10faea23cbe13ae4eede1..4727c1593e57f84e79bdf8ab845ee977ba4ecb7c 100644 (file)
@@ -6,20 +6,20 @@
    Copyright (C) Shahms King                   2001
    Copyright (C) Andrew Bartlett               2002-2003
    Copyright (C) Stefan (metze) Metzmacher     2002-2003
-    
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    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.
-   
+
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-   
+
 */
 
 #include "includes.h"
@@ -217,13 +217,13 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
  const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
 {
        int i = 0;
-       
+
        while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
                if ( table[i].attrib == key )
                        return table[i].name;
                i++;
        }
-       
+
        return NULL;
 }
 
@@ -236,7 +236,7 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
 {
        const char **names;
        int i = 0;
-       
+
        while ( table[i].attrib != LDAP_ATTR_LIST_END )
                i++;
        i++;
@@ -253,7 +253,7 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
                i++;
        }
        names[i] = NULL;
-       
+
        return names;
 }
 
@@ -266,25 +266,25 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
                                    int max_len)
 {
        char **values;
-       
+
        if ( !attribute )
                return False;
-               
+
        value[0] = '\0';
 
        if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
                DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
-               
+
                return False;
        }
-       
+
        if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
                DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n", 
                          attribute, values[0]));
                ldap_value_free(values);
                return False;
        }
-       
+
        ldap_value_free(values);
 #ifdef DEBUG_PASSWORDS
        DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
@@ -333,6 +333,101 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
        return result;
 }
 
+ char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
+                                         const char *attribute,
+                                         TALLOC_CTX *mem_ctx)
+{
+       char **values;
+       char *result;
+       size_t converted_size;
+       int i, num_values;
+
+       if (attribute == NULL) {
+               return NULL;
+       }
+
+       values = ldap_get_values(ldap_struct, entry, attribute);
+
+       if (values == NULL) {
+               DEBUG(10, ("attribute %s does not exist\n", attribute));
+               return NULL;
+       }
+
+       if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
+               DEBUG(10, ("pull_utf8_talloc failed\n"));
+               ldap_value_free(values);
+               return NULL;
+       }
+
+       num_values = ldap_count_values(values);
+
+       for (i=1; i<num_values; i++) {
+               char *tmp;
+
+               if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
+                                     &converted_size)) {
+                       DEBUG(10, ("pull_utf8_talloc failed\n"));
+                       TALLOC_FREE(result);
+                       ldap_value_free(values);
+                       return NULL;
+               }
+
+               if (StrCaseCmp(tmp, result) < 0) {
+                       TALLOC_FREE(result);
+                       result = tmp;
+               } else {
+                       TALLOC_FREE(tmp);
+               }
+       }
+
+       ldap_value_free(values);
+
+#ifdef DEBUG_PASSWORDS
+       DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
+                    attribute, result));
+#endif
+       return result;
+}
+
+ bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
+                                LDAPMessage *msg, const char *attrib,
+                                DATA_BLOB *blob)
+{
+       struct berval **values;
+
+       values = ldap_get_values_len(ld, msg, attrib);
+       if (!values) {
+               return false;
+       }
+
+       if (ldap_count_values_len(values) != 1) {
+               DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
+                          ldap_count_values_len(values)));
+               return false;
+       }
+
+       *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
+                                values[0]->bv_len);
+       ldap_value_free_len(values);
+
+       return (blob->data != NULL);
+}
+
+ bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
+                      struct dom_sid *sid)
+{
+       DATA_BLOB blob;
+       bool ret;
+
+       if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
+                                       &blob)) {
+               return false;
+       }
+       ret = sid_parse((char *)blob.data, blob.length, sid);
+       TALLOC_FREE(blob.data);
+       return ret;
+}
+
  static int ldapmsg_destructor(LDAPMessage **result) {
        ldap_msgfree(*result);
        return 0;
@@ -438,18 +533,20 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
                        for (; mods[i]->mod_values[j] != NULL; j++);
                }
                mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
-                                              
+
                if (mods[i]->mod_values == NULL) {
                        smb_panic("smbldap_set_mod: out of memory!");
                        /* notreached. */
                }
 
-               if (!push_utf8_allocate(&utf8_value, value, &converted_size)) {
+               if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
                        smb_panic("smbldap_set_mod: String conversion failure!");
                        /* notreached. */
                }
 
-               mods[i]->mod_values[j] = utf8_value;
+               mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
+               TALLOC_FREE(utf8_value);
+               SMB_ASSERT(mods[i]->mod_values[j] != NULL);
 
                mods[i]->mod_values[j + 1] = NULL;
        }
@@ -482,9 +579,9 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
        }
 
        /* all of our string attributes are case insensitive */
-       
+
        if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
-               
+
                /* Believe it or not, but LDAP will deny a delete and
                   an add at the same time if the values are the
                   same... */
@@ -503,7 +600,7 @@ ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
                /* This will also allow modifying single valued attributes 
                 * in Novell NDS. In NDS you have to first remove attribute and then
                 * you could add new value */
-               
+
                DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
                smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
        }
@@ -561,7 +658,7 @@ static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
 {
        struct smbldap_state *tmp_ldap_state;
        struct smbldap_state_lookup *t;
-       
+
        if ((tmp_ldap_state = smbldap_find_state(ld))) {
                SMB_ASSERT(tmp_ldap_state == smbldap_state);
                return;
@@ -569,7 +666,7 @@ static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
 
        t = SMB_XMALLOC_P(struct smbldap_state_lookup);
        ZERO_STRUCTP(t);
-       
+
        DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
        t->ld = ld;
        t->smbldap_state = smbldap_state;
@@ -584,11 +681,11 @@ int smb_ldap_start_tls(LDAP *ldap_struct, int version)
 #ifdef LDAP_OPT_X_TLS
        int rc;
 #endif
-       
+
        if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
                return LDAP_SUCCESS;
        }
-       
+
 #ifdef LDAP_OPT_X_TLS
        if (version != LDAP_VERSION3) {
                DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
@@ -618,15 +715,24 @@ int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
        int rc;
 
        DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
-       
+
 #ifdef HAVE_LDAP_INITIALIZE
-       
+
        rc = ldap_initialize(ldap_struct, uri);
        if (rc) {
                DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
+               return rc;
        }
 
-       return rc;
+       if (lp_ldap_follow_referral() != Auto) {
+               rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
+                    lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
+               if (rc != LDAP_SUCCESS)
+                       DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
+                               ldap_err2string(rc)));
+       }
+
+       return LDAP_SUCCESS;
 #else 
 
        /* Parse the string manually */
@@ -642,9 +748,9 @@ int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
                if ( strnequal( uri, "URL:", 4 ) ) {
                        uri += 4;
                }
-               
+
                sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
-               
+
                if (port == 0) {
                        if (strequal(protocol, "ldap")) {
                                port = LDAP_PORT;
@@ -654,12 +760,12 @@ int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
                                DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
                        }
                }
-               
+
                if ((*ldap_struct = ldap_init(host, port)) == NULL)     {
                        DEBUG(0, ("ldap_init failed !\n"));
                        return LDAP_OPERATIONS_ERROR;
                }
-               
+
                if (strequal(protocol, "ldaps")) {
 #ifdef LDAP_OPT_X_TLS
                        int tls = LDAP_OPT_X_TLS_HARD;
@@ -667,7 +773,7 @@ int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
                        {
                                DEBUG(0, ("Failed to setup a TLS session\n"));
                        }
-                       
+
                        DEBUG(3,("LDAPS option set...!\n"));
 #else
                        DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
@@ -677,7 +783,6 @@ int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
        }
 #endif /* HAVE_LDAP_INITIALIZE */
 
-
        /* now set connection timeout */
 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
        {
@@ -713,7 +818,7 @@ int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
 {
        int version;
        int rc;
-       
+
        /* assume the worst */
        *new_version = LDAP_VERSION2;
 
@@ -733,7 +838,7 @@ int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
        if (rc) {
                return rc;
        }
-               
+
        *new_version = LDAP_VERSION3;
        return LDAP_SUCCESS;
 }
@@ -772,6 +877,7 @@ static int smbldap_open_connection (struct smbldap_state *ldap_state)
 {
        int rc = LDAP_SUCCESS;
        int version;
+       int deref;
        LDAP **ldap_struct = &ldap_state->ldap_struct;
 
        rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
@@ -796,7 +902,17 @@ static int smbldap_open_connection (struct smbldap_state *ldap_state)
        if (rc) {
                return rc;
        }
-       
+
+       /* Set alias dereferencing method */
+       deref = lp_ldap_deref();
+       if (deref != -1) {
+               if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
+                       DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
+               } else {
+                       DEBUG(5,("Set dereferencing method: %d\n", deref));
+               }
+       }
+
        DEBUG(2, ("smbldap_open_connection: connection opened\n"));
        return rc;
 }
@@ -811,11 +927,11 @@ static int rebindproc_with_state  (LDAP * ld, char **whop, char **credp,
                                   int *methodp, int freeit, void *arg)
 {
        struct smbldap_state *ldap_state = arg;
-       
+
        /** @TODO Should we be doing something to check what servers we rebind to?
            Could we get a referral to a machine that we don't want to give our
            username and password to? */
-       
+
        if (freeit) {
                SAFE_FREE(*whop);
                if (*credp) {
@@ -844,7 +960,7 @@ static int rebindproc_with_state  (LDAP * ld, char **whop, char **credp,
        }
 
        GetTimeOfDay(&ldap_state->last_rebind);
-               
+
        return 0;
 }
 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
@@ -919,7 +1035,6 @@ static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
 
        return rebindproc_with_state(ldap_struct, whop, credp,
                                     method, freeit, ldap_state);
-       
 }
 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
@@ -950,17 +1065,23 @@ static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_
        int version;
 
        if (!ldap_state->anonymous && !ldap_state->bind_dn) {
+               char *bind_dn = NULL;
+               char *bind_secret = NULL;
 
                /* get the default dn and password only if they are not set already */
-               if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
+               if (!fetch_ldap_pw(&bind_dn, &bind_secret)) {
                        DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
                        return LDAP_INVALID_CREDENTIALS;
                }
+               smbldap_set_creds(ldap_state, false, bind_dn, bind_secret);
+               SAFE_FREE(bind_dn);
+               memset(bind_secret, '\0', strlen(bind_secret));
+               SAFE_FREE(bind_secret);
        }
 
        /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite 
           (OpenLDAP) doesnt' seem to support it */
-          
+
        DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
                  ldap_state->uri, ldap_state->bind_dn));
 
@@ -1096,17 +1217,17 @@ static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
 {
        if (!ldap_state)
                return NT_STATUS_INVALID_PARAMETER;
-               
+
        if (ldap_state->ldap_struct != NULL) {
                ldap_unbind(ldap_state->ldap_struct);
                ldap_state->ldap_struct = NULL;
        }
 
        smbldap_delete_state(ldap_state);
-       
+
        DEBUG(5,("The connection to the LDAP server was closed\n"));
        /* maybe free the results here --metze */
-       
+
        return NT_STATUS_OK;
 }
 
@@ -1200,7 +1321,7 @@ static int smbldap_search_ext(struct smbldap_state *ldap_state,
        size_t          converted_size;
 
        SMB_ASSERT(ldap_state);
-       
+
        DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
                 "scope => [%d]\n", base, filter, scope));
 
@@ -1353,7 +1474,7 @@ int smbldap_search_paged(struct smbldap_state *ldap_state,
                goto done;
        }
 
-       DEBUG(3,("smbldap_search_paged: search was successfull\n"));
+       DEBUG(3,("smbldap_search_paged: search was successful\n"));
 
        rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL, 
                               NULL, NULL, &rcontrols,  0);
@@ -1427,7 +1548,7 @@ int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *at
                        }
                }
        }
-               
+
        TALLOC_FREE(utf8_dn);
        return rc;
 }
@@ -1439,7 +1560,7 @@ int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs
        char           *utf8_dn;
        time_t          endtime = time(NULL)+lp_ldap_timeout();
        size_t          converted_size;
-       
+
        SMB_ASSERT(ldap_state);
 
        DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
@@ -1471,7 +1592,7 @@ int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs
                        }
                }
        }
-       
+
        TALLOC_FREE(utf8_dn);
        return rc;
 }
@@ -1483,7 +1604,7 @@ int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
        char           *utf8_dn;
        time_t          endtime = time(NULL)+lp_ldap_timeout();
        size_t          converted_size;
-       
+
        SMB_ASSERT(ldap_state);
 
        DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
@@ -1515,7 +1636,7 @@ int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
                        }
                }
        }
-       
+
        TALLOC_FREE(utf8_dn);
        return rc;
 }
@@ -1528,7 +1649,7 @@ int smbldap_extended_operation(struct smbldap_state *ldap_state,
        int             rc = LDAP_SERVER_DOWN;
        int             attempts = 0;
        time_t          endtime = time(NULL)+lp_ldap_timeout();
-       
+
        if (!ldap_state)
                return (-1);
 
@@ -1557,7 +1678,7 @@ int smbldap_extended_operation(struct smbldap_state *ldap_state,
                        }
                }
        }
-               
+
        return rc;
 }
 
@@ -1585,7 +1706,7 @@ static void smbldap_idle_fn(struct event_context *event_ctx,
                DEBUG(10,("ldap connection not connected...\n"));
                return;
        }
-               
+
        if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
                DEBUG(10,("ldap connection not idle...\n"));
 
@@ -1596,7 +1717,7 @@ static void smbldap_idle_fn(struct event_context *event_ctx,
                        private_data);
                return;
        }
-               
+
        DEBUG(7,("ldap connection idle...closing connection\n"));
        smbldap_close(state);
 }
@@ -1608,7 +1729,7 @@ static void smbldap_idle_fn(struct event_context *event_ctx,
 void smbldap_free_struct(struct smbldap_state **ldap_state) 
 {
        smbldap_close(*ldap_state);
-       
+
        if ((*ldap_state)->bind_secret) {
                memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
        }