directory.c

Go to the documentation of this file.

/*
 *   This program is 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 2 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, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: 9af4bde1933d9f774159825f74f98209204f5805 $
 * @file lib/ldap/directory.c
 * @brief Determine remote server implementation and capabilities.
 *
 * As described by http://ldapwiki.willeke.com/wiki/Determine%20LDAP%20Server%20Vendor
 *
 * @copyright 2016 The FreeRADIUS Server Project.
 * @copyright 2016 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSID("$Id: 9af4bde1933d9f774159825f74f98209204f5805 $")
 
USES_APPLE_DEPRECATED_API
 
#define LOG_PREFIX name
 
#include <freeradius-devel/ldap/base.h>
 
static fr_table_num_sorted_t const fr_ldap_directory_type_table[] = {
        { L("Active Directory"),                FR_LDAP_DIRECTORY_ACTIVE_DIRECTORY              },
        { L("IBM"),                             FR_LDAP_DIRECTORY_IBM                           },
        { L("NetScape"),                        FR_LDAP_DIRECTORY_NETSCAPE                      },
        { L("OpenLDAP"),                        FR_LDAP_DIRECTORY_OPENLDAP                      },
        { L("Oracle Internet Directory"),       FR_LDAP_DIRECTORY_ORACLE_INTERNET_DIRECTORY     },
        { L("Oracle Unified Directory"),        FR_LDAP_DIRECTORY_ORACLE_UNIFIED_DIRECTORY      },
        { L("Oracle Virtual Directory"),        FR_LDAP_DIRECTORY_ORACLE_VIRTUAL_DIRECTORY      },
        { L("Siemens AG"),                      FR_LDAP_DIRECTORY_SIEMENS_AG                    },
        { L("Sun One Directory"),               FR_LDAP_DIRECTORY_SUN_ONE_DIRECTORY             },
        { L("Unbound ID"),                      FR_LDAP_DIRECTORY_UNBOUND_ID                    },
        { L("Unknown"),                         FR_LDAP_DIRECTORY_UNKNOWN                       },
        { L("eDirectory"),                      FR_LDAP_DIRECTORY_EDIRECTORY                    }
};
static size_t fr_ldap_directory_type_table_len = NUM_ELEMENTS(fr_ldap_directory_type_table);
 
int fr_ldap_directory_result_parse(fr_ldap_directory_t *directory, LDAP *handle,
                                   LDAPMessage *result, char const *name)
{
        int                     entry_cnt, i, num, ldap_errno;
        LDAPMessage             *entry;
        struct berval           **values = NULL;
 
        entry_cnt = ldap_count_entries(handle, result);
        if (entry_cnt != 1) {
                WARN("Capability check failed: Ambiguous result for rootDSE, expected 1 entry, got %i", entry_cnt);
                return 1;
        }
 
        entry = ldap_first_entry(handle, result);
        if (!entry) {
                ldap_get_option(handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
 
                WARN("Capability check failed: Failed retrieving entry: %s", ldap_err2string(ldap_errno));
                return 1;
        }
 
        values = ldap_get_values_len(handle, entry, "vendorname");
        if (values) {
                directory->vendor_str = fr_ldap_berval_to_string(directory, values[0]);
                INFO("Directory vendor: %s", directory->vendor_str);
 
                ldap_value_free_len(values);
        }
 
        values = ldap_get_values_len(handle, entry, "vendorversion");
        if (values) {
                directory->version_str = fr_ldap_berval_to_string(directory, values[0]);
                INFO("Directory version: %s", directory->version_str);
 
                ldap_value_free_len(values);
        }
 
        if (directory->vendor_str) {
                if (strcasestr(directory->vendor_str, "International Business Machines")) {
                        directory->type = FR_LDAP_DIRECTORY_IBM;
                }
 
                goto found;
        }
 
        if (directory->version_str) {
                /*
                 *      Novell eDirectory vendorversion contains eDirectory
                 */
                if (strcasestr(directory->version_str, "eDirectory")) {
                        directory->type = FR_LDAP_DIRECTORY_EDIRECTORY;
                /*
                 *      Oracle unified directory vendorversion contains Oracle Unified Directory
                 */
                } else if (strcasestr(directory->version_str, "Oracle Unified Directory")) {
                        directory->type = FR_LDAP_DIRECTORY_ORACLE_UNIFIED_DIRECTORY;
                /*
                 *      Unbound directory vendorversion contains UnboundID
                 */
                } else if (strcasestr(directory->version_str, "UnboundID")) {
                        directory->type = FR_LDAP_DIRECTORY_UNBOUND_ID;
                /*
                 *      NetScape directory venderversion contains Netscape-Directory
                 */
                } else if (strcasestr(directory->version_str, "Netscape-Directory")) {
                        directory->type = FR_LDAP_DIRECTORY_NETSCAPE;
                /*
                 *      Siemens AG directory vendorversion contains DirX Directory
                 */
                } else if (strcasestr(directory->version_str, "DirX Directory")) {
                        directory->type = FR_LDAP_DIRECTORY_SIEMENS_AG;
                /*
                 *      Sun One Directory vendorversion contains Sun Java
                 */
                } else if (strcasestr(directory->version_str, "Sun Java")) {
                        directory->type = FR_LDAP_DIRECTORY_SUN_ONE_DIRECTORY;
                }
                goto found;
        }
 
        /*
         *      isGlobalCatalogReady is only present on ActiveDirectory
         *      instances. AD doesn't provide vendorname or vendorversion
         */
        values = ldap_get_values_len(handle, entry, "isGlobalCatalogReady");
        if (values) {
                directory->type = FR_LDAP_DIRECTORY_ACTIVE_DIRECTORY;
                ldap_value_free_len(values);
                goto found;
        }
 
        /*
         *      OpenLDAP has a special objectClass for its RootDSE
         */
        values = ldap_get_values_len(handle, entry, "objectClass");
        if (values) {
                num = ldap_count_values_len(values);
                for (i = 0; i < num; i++) {
                        if (strncmp("OpenLDAProotDSE", values[i]->bv_val, values[i]->bv_len) == 0) {
                                directory->type = FR_LDAP_DIRECTORY_OPENLDAP;
                        }
                }
                ldap_value_free_len(values);
                goto found;
        }
 
        /*
         *      Oracle Virtual Directory and Oracle Internet Directory
         */
        values = ldap_get_values_len(handle, entry, "orcldirectoryversion");
        if (values) {
                if (memmem(values[0]->bv_val, values[0]->bv_len, "OID", 3)) {
                        directory->type = FR_LDAP_DIRECTORY_ORACLE_INTERNET_DIRECTORY;
                } else if (memmem(values[0]->bv_val, values[0]->bv_len, "OVD", 3)) {
                        directory->type = FR_LDAP_DIRECTORY_ORACLE_VIRTUAL_DIRECTORY;
                }
                ldap_value_free_len(values);
        }
 
found:
        INFO("Directory type: %s", fr_table_str_by_value(fr_ldap_directory_type_table, directory->type, "<INVALID>"));
 
        switch (directory->type) {
        case FR_LDAP_DIRECTORY_ACTIVE_DIRECTORY:
        case FR_LDAP_DIRECTORY_EDIRECTORY:
                directory->cleartext_password = false;
                break;
 
        default:
                directory->cleartext_password = true;
                break;
        }
 
        /*
         *      Evaluate what type of sync the directory supports
         */
        values = ldap_get_values_len(handle, entry, "supportedControl");
        if (values) {
                num = ldap_count_values_len(values);
                for (i = 0; i < num; i++) {
                        if (strncmp(LDAP_CONTROL_SYNC, values[i]->bv_val, values[i]->bv_len) == 0) {
                                INFO("Directory supports RFC 4533");
                                directory->sync_type = FR_LDAP_SYNC_RFC4533;
                                break;
                        }
                        if (strncmp(LDAP_SERVER_NOTIFICATION_OID, values[i]->bv_val, values[i]->bv_len) == 0) {
                                INFO("Directory supports LDAP_SERVER_NOTIFICATION_OID");
                                directory->sync_type = FR_LDAP_SYNC_ACTIVE_DIRECTORY;
                                break;
                        }
                        if (strncmp(LDAP_CONTROL_PERSIST_REQUEST, values[i]->bv_val, values[i]->bv_len) == 0) {
                                INFO("Directory supports persistent search");
                                directory->sync_type = FR_LDAP_SYNC_PERSISTENT_SEARCH;
                                break;
                        }
                }
                ldap_value_free_len(values);
        } else {
                WARN("No supportedControl returned by LDAP server");
        }
 
        /*
         *      Extract naming contexts
         */
        values = ldap_get_values_len(handle, entry, "namingContexts");
        if (!values) return 0;
 
        num = ldap_count_values_len(values);
        directory->naming_contexts = talloc_array(directory, char const *, num);
        for (i = 0; i < num; i++) {
                directory->naming_contexts[i] = fr_ldap_berval_to_string(directory, values[i]);
        }
        ldap_value_free_len(values);
 
        return 0;
}
 
/** Parse results of search on rootDSE to gather data on LDAP server
 *
 * @param[in] handle    on which the query was run.
 * @param[in] query     which requested the rootDSE.
 * @param[in] result    head of LDAP results message chain.
 * @param[in] rctx      LDAP directory whose properties are to be populated.
 */
static void ldap_trunk_directory_alloc_read(LDAP *handle, fr_ldap_query_t *query, LDAPMessage *result, void *rctx)
{
        fr_ldap_config_t const  *config = query->ldap_conn->config;
        fr_ldap_directory_t     *directory = talloc_get_type_abort(rctx, fr_ldap_directory_t);
 
        (void)fr_ldap_directory_result_parse(directory, handle, result, config->name);
}
 
/** Async extract useful information from the rootDSE of the LDAP server
 *
 * This is called once for each new thread trunk when it first connects.
 *
 * @param[in] ctx       to allocate fr_ldap_directory_t in.
 * @param[in] ttrunk    Thread trunk connection to be queried
 * @return
 *      - 0 on success
 *      < 0 on failure
 */
int fr_ldap_trunk_directory_alloc_async(TALLOC_CTX *ctx, fr_ldap_thread_trunk_t *ttrunk)
{
        fr_ldap_query_t         *query;
        static char const       *attrs[] = LDAP_DIRECTORY_ATTRS;
        fr_trunk_request_t      *treq;
 
        ttrunk->directory = talloc_zero(ctx, fr_ldap_directory_t);
        if (!ttrunk->directory) return -1;
 
        treq = fr_trunk_request_alloc(ttrunk->trunk, NULL);
        if (!treq) return -1;
 
        query = fr_ldap_search_alloc(treq, "", LDAP_SCOPE_BASE, "(objectclass=*)", attrs, NULL, NULL);
        query->parser = ldap_trunk_directory_alloc_read;
        query->treq = treq;
 
        fr_trunk_request_enqueue(&query->treq, ttrunk->trunk, NULL, query, ttrunk->directory);
 
        return 0;
}
 
/** Async extract useful information from the rootDSE of the LDAP server
 *
 * This version is for a single connection rather than a connection trunk
 *
 * @param[in] ldap_conn connection to be queried
 * @return
 *      - message ID on success
 *      < 0 on failure
 */
int fr_ldap_conn_directory_alloc_async(fr_ldap_connection_t *ldap_conn)
{
        int                     msgid;
        static char const       *attrs[] = LDAP_DIRECTORY_ATTRS;
 
        ldap_conn->directory = talloc_zero(ldap_conn, fr_ldap_directory_t);
        if (!ldap_conn->directory) return -1;
 
        if (fr_ldap_search_async(&msgid, NULL, ldap_conn, "", LDAP_SCOPE_BASE, "(objectclass=*)", attrs,
                                 NULL, NULL) != LDAP_PROC_SUCCESS) return -1;
 
        return msgid;
}