src/auth/db-ldap.c

	db-ldap.c revision a64adf62fa33f2463a86f990217b0c9078531a40
310N/A/* Copyright (c) 2003-2009 Dovecot authors, see the included COPYING file */
310N/A
310N/A#include "common.h"
310N/A
310N/A#if defined(PASSDB_LDAP) || defined(USERDB_LDAP)
310N/A
310N/A#include "network.h"
310N/A#include "ioloop.h"
310N/A#include "array.h"
310N/A#include "hash.h"
310N/A#include "aqueue.h"
310N/A#include "str.h"
310N/A#include "env-util.h"
310N/A#include "var-expand.h"
310N/A#include "settings.h"
310N/A#include "userdb.h"
310N/A#include "db-ldap.h"
310N/A
310N/A#include <stddef.h>
310N/A#include <stdlib.h>
310N/A
310N/A#define HAVE_LDAP_SASL
310N/A#ifdef HAVE_SASL_SASL_H
310N/A#  include <sasl/sasl.h>
310N/A#elif defined (HAVE_SASL_H)
310N/A#  include <sasl.h>
310N/A#else
310N/A#  undef HAVE_LDAP_SASL
310N/A#endif
310N/A#ifdef LDAP_OPT_X_TLS
586N/A#  define OPENLDAP_TLS_OPTIONS
618N/A#endif
586N/A#if SASL_VERSION_MAJOR < 2
310N/A#  undef HAVE_LDAP_SASL
310N/A#endif
310N/A
310N/A#ifndef LDAP_SASL_QUIET
310N/A#  define LDAP_SASL_QUIET 0 /* Doesn't exist in Solaris LDAP */
310N/A#endif
310N/A
310N/A/* Older versions may require calling ldap_result() twice */
310N/A#if LDAP_VENDOR_VERSION <= 20112
310N/A#  define OPENLDAP_ASYNC_WORKAROUND
310N/A#endif
310N/A
310N/A/* Solaris LDAP library doesn't have LDAP_OPT_SUCCESS */
310N/A#ifndef LDAP_OPT_SUCCESS
310N/A#  define LDAP_OPT_SUCCESS LDAP_SUCCESS
310N/A#endif
310N/A
310N/Astruct db_ldap_result_iterate_context {
310N/A    struct ldap_connection *conn;
310N/A    LDAPMessage *entry;
310N/A    struct auth_request *auth_request;
310N/A
310N/A    struct hash_table *attr_map;
310N/A    struct var_expand_table *var_table;
310N/A
310N/A    char *attr, **vals;
310N/A    const char *name, *value, *template, *val_1_arr[2];
310N/A    const char *const *static_attrs;
310N/A    BerElement *ber;
310N/A
310N/A    string_t *var, *debug;
310N/A    unsigned int value_idx;
310N/A};

struct db_ldap_sasl_bind_context {
    const char *authcid;
    const char *passwd;
    const char *realm;
    const char *authzid;
};

#define DEF_STR(name) DEF_STRUCT_STR(name, ldap_settings)
#define DEF_INT(name) DEF_STRUCT_INT(name, ldap_settings)
#define DEF_BOOL(name) DEF_STRUCT_BOOL(name, ldap_settings)

static struct setting_def setting_defs[] = {
    DEF_STR(hosts),
    DEF_STR(uris),
    DEF_STR(dn),
    DEF_STR(dnpass),
    DEF_BOOL(auth_bind),
    DEF_STR(auth_bind_userdn),
    DEF_BOOL(tls),
    DEF_BOOL(sasl_bind),
    DEF_STR(sasl_mech),
    DEF_STR(sasl_realm),
    DEF_STR(sasl_authz_id),
    DEF_STR(tls_ca_cert_file),
    DEF_STR(tls_ca_cert_dir),
    DEF_STR(tls_cert_file),
    DEF_STR(tls_key_file),
    DEF_STR(tls_cipher_suite),
    DEF_STR(tls_require_cert),
    DEF_STR(deref),
    DEF_STR(scope),
    DEF_STR(base),
    DEF_INT(ldap_version),
    DEF_STR(debug_level),
    DEF_STR(ldaprc_path),
    DEF_STR(user_attrs),
    DEF_STR(user_filter),
    DEF_STR(pass_attrs),
    DEF_STR(pass_filter),
    DEF_STR(default_pass_scheme),

    { 0, NULL, 0 }
};

static struct ldap_settings default_ldap_settings = {
    MEMBER(hosts) NULL,
    MEMBER(uris) NULL,
    MEMBER(dn) NULL,
    MEMBER(dnpass) NULL,
    MEMBER(auth_bind) FALSE,
    MEMBER(auth_bind_userdn) NULL,
    MEMBER(tls) FALSE,
    MEMBER(sasl_bind) FALSE,
    MEMBER(sasl_mech) NULL,
    MEMBER(sasl_realm) NULL,
    MEMBER(sasl_authz_id) NULL,
    MEMBER(tls_ca_cert_file) NULL,
    MEMBER(tls_ca_cert_dir) NULL,
    MEMBER(tls_cert_file) NULL,
    MEMBER(tls_key_file) NULL,
    MEMBER(tls_cipher_suite) NULL,
    MEMBER(tls_require_cert) NULL,
    MEMBER(deref) "never",
    MEMBER(scope) "subtree",
    MEMBER(base) NULL,
    MEMBER(ldap_version) 2,
    MEMBER(debug_level) "0",
    MEMBER(ldaprc_path) "",
    MEMBER(user_attrs) "homeDirectory=home,uidNumber=uid,gidNumber=gid",
    MEMBER(user_filter) "(&(objectClass=posixAccount)(uid=%u))",
    MEMBER(pass_attrs) "uid=user,userPassword=password",
    MEMBER(pass_filter) "(&(objectClass=posixAccount)(uid=%u))",
    MEMBER(default_pass_scheme) "crypt"
};

static struct ldap_connection *ldap_connections = NULL;

static int db_ldap_bind(struct ldap_connection *conn);
static void db_ldap_conn_close(struct ldap_connection *conn);

static int deref2str(const char *str)
{
    if (strcasecmp(str, "never") == 0)
        return LDAP_DEREF_NEVER;
    if (strcasecmp(str, "searching") == 0)
        return LDAP_DEREF_SEARCHING;
    if (strcasecmp(str, "finding") == 0)
        return LDAP_DEREF_FINDING;
    if (strcasecmp(str, "always") == 0)
        return LDAP_DEREF_ALWAYS;

    i_fatal("LDAP: Unknown deref option '%s'", str);
}

static int scope2str(const char *str)
{
    if (strcasecmp(str, "base") == 0)
        return LDAP_SCOPE_BASE;
    if (strcasecmp(str, "onelevel") == 0)
        return LDAP_SCOPE_ONELEVEL;
    if (strcasecmp(str, "subtree") == 0)
        return LDAP_SCOPE_SUBTREE;

    i_fatal("LDAP: Unknown scope option '%s'", str);
}

#ifdef OPENLDAP_TLS_OPTIONS
static int tls_require_cert2str(const char *str)
{
    if (strcasecmp(str, "never") == 0)
        return LDAP_OPT_X_TLS_NEVER;
    if (strcasecmp(str, "hard") == 0)
        return LDAP_OPT_X_TLS_HARD;
    if (strcasecmp(str, "demand") == 0)
        return LDAP_OPT_X_TLS_DEMAND;
    if (strcasecmp(str, "allow") == 0)
        return LDAP_OPT_X_TLS_ALLOW;
    if (strcasecmp(str, "try") == 0)
        return LDAP_OPT_X_TLS_TRY;

    i_fatal("LDAP: Unknown tls_require_cert value '%s'", str);
}
#endif

static int ldap_get_errno(struct ldap_connection *conn)
{
    int ret, err;

    ret = ldap_get_option(conn->ld, LDAP_OPT_ERROR_NUMBER, (void *) &err);
    if (ret != LDAP_SUCCESS) {
        i_error("LDAP: Can't get error number: %s",
            ldap_err2string(ret));
        return LDAP_UNAVAILABLE;
    }

    return err;
}

const char *ldap_get_error(struct ldap_connection *conn)
{
    return ldap_err2string(ldap_get_errno(conn));
}

static void ldap_conn_reconnect(struct ldap_connection *conn)
{
    db_ldap_conn_close(conn);
    if (db_ldap_connect(conn) < 0)
        db_ldap_conn_close(conn);
}

static int ldap_handle_error(struct ldap_connection *conn)
{
    int err = ldap_get_errno(conn);

    switch (err) {
    case LDAP_SUCCESS:
        i_unreached();
    case LDAP_SIZELIMIT_EXCEEDED:
    case LDAP_TIMELIMIT_EXCEEDED:
    case LDAP_NO_SUCH_ATTRIBUTE:
    case LDAP_UNDEFINED_TYPE:
    case LDAP_INAPPROPRIATE_MATCHING:
    case LDAP_CONSTRAINT_VIOLATION:
    case LDAP_TYPE_OR_VALUE_EXISTS:
    case LDAP_INVALID_SYNTAX:
    case LDAP_NO_SUCH_OBJECT:
    case LDAP_ALIAS_PROBLEM:
    case LDAP_INVALID_DN_SYNTAX:
    case LDAP_IS_LEAF:
    case LDAP_ALIAS_DEREF_PROBLEM:
    case LDAP_FILTER_ERROR:
        /* invalid input */
        return -1;
    case LDAP_SERVER_DOWN:
    case LDAP_TIMEOUT:
    case LDAP_UNAVAILABLE:
    case LDAP_BUSY:
#ifdef LDAP_CONNECT_ERROR
    case LDAP_CONNECT_ERROR:
#endif
    case LDAP_LOCAL_ERROR:
    case LDAP_INVALID_CREDENTIALS:
    default:
        /* connection problems */
        ldap_conn_reconnect(conn);
        return 0;
    }
}

static int db_ldap_request_bind(struct ldap_connection *conn,
                struct ldap_request *request)
{
    struct ldap_request_bind *brequest =
        (struct ldap_request_bind *)request;

    i_assert(request->type == LDAP_REQUEST_TYPE_BIND);
    i_assert(request->msgid == -1);
    i_assert(conn->conn_state == LDAP_CONN_STATE_BOUND_AUTH ||
         conn->conn_state == LDAP_CONN_STATE_BOUND_DEFAULT);
    i_assert(conn->pending_count == 0);

    request->msgid = ldap_bind(conn->ld, brequest->dn,
                   request->auth_request->mech_password,
                   LDAP_AUTH_SIMPLE);
    if (request->msgid == -1) {
        auth_request_log_error(request->auth_request, "ldap",
                       "ldap_bind(%s) failed: %s",
                       brequest->dn, ldap_get_error(conn));
        if (ldap_handle_error(conn) < 0) {
            /* broken request, remove it */
            return 0;
        }
        return -1;
    }
    conn->conn_state = LDAP_CONN_STATE_BINDING;
    return 1;
}

static int db_ldap_request_search(struct ldap_connection *conn,
                  struct ldap_request *request)
{
    struct ldap_request_search *srequest =
        (struct ldap_request_search *)request;

    i_assert(conn->conn_state == LDAP_CONN_STATE_BOUND_DEFAULT);
    i_assert(request->msgid == -1);

    request->msgid =
        ldap_search(conn->ld, srequest->base, conn->set.ldap_scope,
                srequest->filter, srequest->attributes, 0);
    if (request->msgid == -1) {
        auth_request_log_error(request->auth_request, "ldap",
                       "ldap_search() failed (filter %s): %s",
                       srequest->filter, ldap_get_error(conn));
        if (ldap_handle_error(conn) < 0) {
            /* broken request, remove it */
            return 0;
        }
        return -1;
    }
    return 1;
}

static bool db_ldap_request_queue_next(struct ldap_connection *conn)
{
    struct ldap_request *const *requestp, *request;
    unsigned int queue_size = aqueue_count(conn->request_queue);
    int ret = -1;

    if (conn->pending_count == queue_size) {
        /* no non-pending requests */
        return FALSE;
    }
    if (queue_size > DB_LDAP_MAX_PENDING_REQUESTS) {
        /* wait until server has replied to some requests */
        return FALSE;
    }

    if (db_ldap_connect(conn) < 0)
        return FALSE;

    requestp = array_idx(&conn->request_array,
                 aqueue_idx(conn->request_queue,
                    conn->pending_count));
    request = *requestp;

    if (conn->pending_count > 0 &&
        request->type == LDAP_REQUEST_TYPE_BIND) {
        /* we can't do binds until all existing requests are finished */
        return FALSE;
    }

    switch (conn->conn_state) {
    case LDAP_CONN_STATE_DISCONNECTED:
    case LDAP_CONN_STATE_BINDING:
        /* wait until we're in bound state */
        return FALSE;
    case LDAP_CONN_STATE_BOUND_AUTH:
        if (request->type == LDAP_REQUEST_TYPE_BIND)
            break;

        /* bind to default dn first */
        i_assert(conn->pending_count == 0);
        (void)db_ldap_bind(conn);
        return FALSE;
    case LDAP_CONN_STATE_BOUND_DEFAULT:
        /* we can do anything in this state */
        break;
    }

    switch (request->type) {
    case LDAP_REQUEST_TYPE_BIND:
        ret = db_ldap_request_bind(conn, request);
        break;
    case LDAP_REQUEST_TYPE_SEARCH:
        ret = db_ldap_request_search(conn, request);
        break;
    }

    if (ret > 0) {
        /* success */
        i_assert(request->msgid != -1);
        conn->pending_count++;
        return TRUE;
    } else if (ret < 0) {
        /* disconnected */
        return FALSE;
    } else {
        /* broken request, remove from queue */
        aqueue_delete_tail(conn->request_queue);
        request->callback(conn, request, NULL);
        return TRUE;
    }
}

void db_ldap_request(struct ldap_connection *conn,
             struct ldap_request *request)
{
    i_assert(request->auth_request != NULL);

    request->msgid = -1;
    request->create_time = ioloop_time;

    if (conn->request_queue->full &&
        aqueue_count(conn->request_queue) >= DB_LDAP_MAX_QUEUE_SIZE) {
        /* Queue is full already, fail this request */
        struct ldap_request *const *first_requestp;

        first_requestp = array_idx(&conn->request_array,
                       aqueue_idx(conn->request_queue, 0));
        auth_request_log_error(request->auth_request, "ldap",
            "Request queue is full (oldest added %d secs ago)",
            (int)(time(NULL) - (*first_requestp)->create_time));
        request->callback(conn, request, NULL);
        return;
    }

    aqueue_append(conn->request_queue, &request);
    (void)db_ldap_request_queue_next(conn);
}

static int db_ldap_connect_finish(struct ldap_connection *conn, int ret)
{
    if (ret == LDAP_SERVER_DOWN) {
        i_error("LDAP: Can't connect to server: %s",
            conn->set.uris != NULL ?
            conn->set.uris : conn->set.hosts);
        return -1;
    }
    if (ret != LDAP_SUCCESS) {
        i_error("LDAP: binding failed (dn %s): %s",
            conn->set.dn == NULL ? "(none)" : conn->set.dn,
            ldap_get_error(conn));
        return -1;
    }

    conn->conn_state = LDAP_CONN_STATE_BOUND_DEFAULT;
    while (db_ldap_request_queue_next(conn))
        ;
    return 0;
}

static void db_ldap_default_bind_finished(struct ldap_connection *conn,
                      LDAPMessage *res)
{
    int ret;

    i_assert(conn->pending_count == 0);
    conn->default_bind_msgid = -1;

    ret = ldap_result2error(conn->ld, res, FALSE);
    if (db_ldap_connect_finish(conn, ret) < 0) {
        /* lost connection, close it */
        db_ldap_conn_close(conn);
    }
}

static void db_ldap_abort_requests(struct ldap_connection *conn,
                   unsigned int max_count,
                   unsigned int timeout_secs,
                   bool error, const char *reason)
{
    struct ldap_request *const *requestp, *request;
    time_t diff;

    while (aqueue_count(conn->request_queue) > 0 && max_count > 0) {
        requestp = array_idx(&conn->request_array,
                     aqueue_idx(conn->request_queue, 0));
        request = *requestp;

        diff = ioloop_time - request->create_time;
        if (diff < (time_t)timeout_secs)
            break;

        /* timed out, abort */
        aqueue_delete_tail(conn->request_queue);

        if (request->msgid != -1) {
            i_assert(conn->pending_count > 0);
            conn->pending_count--;
        }
        if (error) {
            auth_request_log_error(request->auth_request, "ldap",
                           "%s", reason);
        } else {
            auth_request_log_info(request->auth_request, "ldap",
                          "%s", reason);
        }
        request->callback(conn, request, NULL);
        max_count--;
    }
}

static void
db_ldap_handle_result(struct ldap_connection *conn, LDAPMessage *res)
{
    struct ldap_request *const *requests, *request = NULL;
    unsigned int i, count;
    int msgid, ret;

    msgid = ldap_msgid(res);
    if (msgid == conn->default_bind_msgid) {
        db_ldap_default_bind_finished(conn, res);
        return;
    }

    count = aqueue_count(conn->request_queue);
    requests = count == 0 ? NULL : array_idx(&conn->request_array, 0);
    for (i = 0; i < count; i++) {
        request = requests[aqueue_idx(conn->request_queue, i)];
        if (request->msgid == msgid)
            break;
        if (request->msgid == -1) {
            request = NULL;
            break;
        }
    }
    if (request == NULL) {
        i_error("LDAP: Reply with unknown msgid %d", msgid);
        return;
    }

    if (request->type == LDAP_REQUEST_TYPE_BIND) {
        i_assert(conn->conn_state == LDAP_CONN_STATE_BINDING);
        i_assert(conn->pending_count == 1);
        conn->conn_state = LDAP_CONN_STATE_BOUND_AUTH;
    }
    i_assert(conn->pending_count > 0);
    conn->pending_count--;
    aqueue_delete(conn->request_queue, i);

    ret = ldap_result2error(conn->ld, res, 0);
    if (ret != LDAP_SUCCESS && request->type == LDAP_REQUEST_TYPE_SEARCH) {
        /* handle search failures here */
        struct ldap_request_search *srequest =
            (struct ldap_request_search *)request;

        auth_request_log_error(request->auth_request, "ldap",
                       "ldap_search(%s) failed: %s",
                       srequest->filter, ldap_err2string(ret));
        res = NULL;
    }

    T_BEGIN {
        request->callback(conn, request, res);
    } T_END;

    if (i > 0) {
        /* see if there are timed out requests */
        db_ldap_abort_requests(conn, i,
                       DB_LDAP_REQUEST_LOST_TIMEOUT_SECS,
                       TRUE, "Request lost");
    }
}

static void ldap_input(struct ldap_connection *conn)
{
    struct timeval timeout;
    LDAPMessage *res;
    int ret;

    for (;;) {
        if (conn->ld == NULL)
            return;

        memset(&timeout, 0, sizeof(timeout));
        ret = ldap_result(conn->ld, LDAP_RES_ANY, 1, &timeout, &res);
#ifdef OPENLDAP_ASYNC_WORKAROUND
        if (ret == 0) {
            /* try again, there may be another in buffer */
            ret = ldap_result(conn->ld, LDAP_RES_ANY, 1,
                      &timeout, &res);
        }
#endif
        if (ret <= 0)
            break;

        db_ldap_handle_result(conn, res);
        ldap_msgfree(res);
    }
    conn->last_reply_stamp = ioloop_time;

    if (ret == 0) {
        /* send more requests */
        while (db_ldap_request_queue_next(conn))
            ;
    } else if (ldap_get_errno(conn) != LDAP_SERVER_DOWN) {
        i_error("LDAP: ldap_result() failed: %s", ldap_get_error(conn));
        ldap_conn_reconnect(conn);
    } else if (aqueue_count(conn->request_queue) > 0 ||
           ioloop_time - conn->last_reply_stamp <
                        DB_LDAP_IDLE_RECONNECT_SECS) {
        i_error("LDAP: Connection lost to LDAP server, reconnecting");
        ldap_conn_reconnect(conn);
    } else {
        /* server probably disconnected an idle connection. don't
           reconnect until the next request comes. */
        db_ldap_conn_close(conn);
    }
}

#ifdef HAVE_LDAP_SASL
static int
sasl_interact(LDAP *ld ATTR_UNUSED, unsigned flags ATTR_UNUSED,
          void *defaults, void *interact)
{
    struct db_ldap_sasl_bind_context *context = defaults;
    sasl_interact_t *in;
    const char *str;

    for (in = interact; in->id != SASL_CB_LIST_END; in++) {
        switch (in->id) {
        case SASL_CB_GETREALM:
            str = context->realm;
            break;
        case SASL_CB_AUTHNAME:
            str = context->authcid;
            break;
        case SASL_CB_USER:
            str = context->authzid;
            break;
        case SASL_CB_PASS:
            str = context->passwd;
            break;
        default:
            str = NULL;
            break;
        }
        if (str != NULL) {
            in->len = strlen(str);
            in->result = str;
        }

    }
    return LDAP_SUCCESS;
}
#endif

static int db_ldap_bind(struct ldap_connection *conn)
{
    int msgid;

    i_assert(conn->conn_state != LDAP_CONN_STATE_BINDING);
    i_assert(conn->default_bind_msgid == -1);
    i_assert(conn->pending_count == 0);

    msgid = ldap_bind(conn->ld, conn->set.dn, conn->set.dnpass,
              LDAP_AUTH_SIMPLE);
    if (msgid == -1) {
        i_assert(ldap_get_errno(conn) != LDAP_SUCCESS);
        if (db_ldap_connect_finish(conn, ldap_get_errno(conn)) < 0) {
            /* lost connection, close it */
            db_ldap_conn_close(conn);
        }
        return -1;
    }

    conn->conn_state = LDAP_CONN_STATE_BINDING;
    conn->default_bind_msgid = msgid;
    return 0;
}

static void db_ldap_get_fd(struct ldap_connection *conn)
{
    int ret;

    /* get the connection's fd */
    ret = ldap_get_option(conn->ld, LDAP_OPT_DESC, (void *)&conn->fd);
    if (ret != LDAP_SUCCESS) {
        i_fatal("LDAP: Can't get connection fd: %s",
            ldap_err2string(ret));
    }
    if (conn->fd <= CLIENT_LISTEN_FD) {
        /* Solaris LDAP library seems to be broken */
        i_fatal("LDAP: Buggy LDAP library returned wrong fd: %d",
            conn->fd);
    }
    i_assert(conn->fd != -1);
    net_set_nonblock(conn->fd, TRUE);
}

static void
db_ldap_set_opt(struct ldap_connection *conn, int opt, const void *value,
        const char *optname, const char *value_str)
{
    int ret;

    ret = ldap_set_option(conn == NULL ? NULL : conn->ld, opt, value);
    if (ret != LDAP_SUCCESS) {
        i_fatal("LDAP: Can't set option %s to %s: %s",
            optname, value_str, ldap_err2string(ret));
    }
}

static void
db_ldap_set_opt_str(struct ldap_connection *conn, int opt, const char *value,
            const char *optname)
{
    if (value != NULL)
        db_ldap_set_opt(conn, opt, value, optname, value);
}

static void db_ldap_set_tls_options(struct ldap_connection *conn)
{
    if (!conn->set.tls)
        return;

#ifdef OPENLDAP_TLS_OPTIONS
    db_ldap_set_opt_str(NULL, LDAP_OPT_X_TLS_CACERTFILE,
                conn->set.tls_ca_cert_file, "tls_ca_cert_file");
    db_ldap_set_opt_str(NULL, LDAP_OPT_X_TLS_CACERTDIR,
                conn->set.tls_ca_cert_dir, "tls_ca_cert_dir");
    db_ldap_set_opt_str(NULL, LDAP_OPT_X_TLS_CERTFILE,
                conn->set.tls_cert_file, "tls_cert_file");
    db_ldap_set_opt_str(NULL, LDAP_OPT_X_TLS_KEYFILE,
                conn->set.tls_key_file, "tls_key_file");
    db_ldap_set_opt_str(NULL, LDAP_OPT_X_TLS_CIPHER_SUITE,
                conn->set.tls_cipher_suite, "tls_cipher_suite");
    if (conn->set.tls_require_cert != NULL) {
        int value = tls_require_cert2str(conn->set.tls_require_cert);
        db_ldap_set_opt(NULL, LDAP_OPT_X_TLS_REQUIRE_CERT, &value,
                "tls_require_cert", conn->set.tls_require_cert);
    }
#else
    if (conn->set.tls_ca_cert_file != NULL ||
        conn->set.tls_ca_cert_dir != NULL ||
        conn->set.tls_cert_file != NULL ||
        conn->set.tls_key_file != NULL ||
        conn->set.tls_cipher_suite != NULL)
        i_warning("LDAP: tls_* settings ignored, "
              "your LDAP library doesn't seem to support them");
#endif
}

static void db_ldap_set_options(struct ldap_connection *conn)
{
    unsigned int ldap_version;
    int value;

    db_ldap_set_opt(conn, LDAP_OPT_DEREF, &conn->set.ldap_deref,
            "deref", conn->set.deref);
#ifdef LDAP_OPT_DEBUG_LEVEL
    value = atoi(conn->set.debug_level);
    if (value != 0) {
        db_ldap_set_opt(NULL, LDAP_OPT_DEBUG_LEVEL, &value,
                "debug_level", conn->set.debug_level);
    }
#endif

    if (conn->set.ldap_version < 3) {
        if (conn->set.sasl_bind)
            i_fatal("LDAP: sasl_bind=yes requires ldap_version=3");
        if (conn->set.tls)
            i_fatal("LDAP: tls=yes requires ldap_version=3");
    }

    ldap_version = conn->set.ldap_version;
    db_ldap_set_opt(conn, LDAP_OPT_PROTOCOL_VERSION, &ldap_version,
            "protocol_version", dec2str(ldap_version));
    db_ldap_set_tls_options(conn);
}

int db_ldap_connect(struct ldap_connection *conn)
{
    int ret;

    if (conn->conn_state != LDAP_CONN_STATE_DISCONNECTED)
        return 0;

    i_assert(conn->pending_count == 0);
    if (conn->ld == NULL) {
        if (conn->set.uris != NULL) {
#ifdef LDAP_HAVE_INITIALIZE
            if (ldap_initialize(&conn->ld, conn->set.uris) != LDAP_SUCCESS)
                conn->ld = NULL;
#else
            i_fatal("LDAP: Your LDAP library doesn't support "
                "'uris' setting, use 'hosts' instead.");
#endif
        } else
            conn->ld = ldap_init(conn->set.hosts, LDAP_PORT);

        if (conn->ld == NULL)
            i_fatal("LDAP: ldap_init() failed with hosts: %s",
                conn->set.hosts);

        db_ldap_set_options(conn);
    }

    if (conn->set.tls) {
#ifdef LDAP_HAVE_START_TLS_S
        ret = ldap_start_tls_s(conn->ld, NULL, NULL);
        if (ret != LDAP_SUCCESS) {
            if (ret == LDAP_OPERATIONS_ERROR &&
                strncmp(conn->set.uris, "ldaps:", 6) == 0) {
                i_fatal("LDAP: Don't use both tls=yes "
                    "and ldaps URI");
            }
            i_error("LDAP: ldap_start_tls_s() failed: %s",
                ldap_err2string(ret));
            return -1;
        }
#else
        i_error("LDAP: Your LDAP library doesn't support TLS");
        return -1;
#endif
    }

    if (conn->set.sasl_bind) {
#ifdef HAVE_LDAP_SASL
        struct db_ldap_sasl_bind_context context;

        memset(&context, 0, sizeof(context));
        context.authcid = conn->set.dn;
        context.passwd = conn->set.dnpass;
        context.realm = conn->set.sasl_realm;
        context.authzid = conn->set.sasl_authz_id;

        /* There doesn't seem to be a way to do SASL binding
           asynchronously.. */
        ret = ldap_sasl_interactive_bind_s(conn->ld, NULL,
                           conn->set.sasl_mech,
                           NULL, NULL, LDAP_SASL_QUIET,
                           sasl_interact, &context);
        if (db_ldap_connect_finish(conn, ret) < 0)
            return -1;
#else
        i_fatal("LDAP: sasl_bind=yes but no SASL support compiled in");
#endif
        conn->conn_state = LDAP_CONN_STATE_BOUND_DEFAULT;
    } else {
        if (db_ldap_bind(conn) < 0)
            return -1;
    }

    db_ldap_get_fd(conn);
    conn->io = io_add(conn->fd, IO_READ, ldap_input, conn);
    return 0;
}

static void db_ldap_disconnect_timeout(struct ldap_connection *conn)
{
    db_ldap_abort_requests(conn, -1U,
                   DB_LDAP_REQUEST_DISCONNECT_TIMEOUT_SECS,
                   FALSE, "LDAP server not connected");

    if (aqueue_count(conn->request_queue) == 0) {
        /* no requests left, remove this timeout handler */
        timeout_remove(&conn->to);
    }
}

static void db_ldap_conn_close(struct ldap_connection *conn)
{
    struct ldap_request *const *requests, *request;
    unsigned int i;

    conn->conn_state = LDAP_CONN_STATE_DISCONNECTED;
    conn->default_bind_msgid = -1;

    if (conn->pending_count != 0) {
        requests = array_idx(&conn->request_array, 0);
        for (i = 0; i < conn->pending_count; i++) {
            request = requests[aqueue_idx(conn->request_queue, i)];

            i_assert(request->msgid != -1);
            request->msgid = -1;
        }
        conn->pending_count = 0;
    }

    if (conn->ld != NULL) {
        ldap_unbind(conn->ld);
        conn->ld = NULL;
    }
    conn->fd = -1;

    if (conn->io != NULL) {
        /* the fd may have already been closed before ldap_unbind(),
           so we'll have to use io_remove_closed(). */
        io_remove_closed(&conn->io);
    }

    if (aqueue_count(conn->request_queue) == 0) {
        if (conn->to != NULL)
            timeout_remove(&conn->to);
    } else if (conn->to == NULL) {
        conn->to = timeout_add(DB_LDAP_REQUEST_DISCONNECT_TIMEOUT_SECS *
                       1000/2, db_ldap_disconnect_timeout, conn);
    }
}

void db_ldap_set_attrs(struct ldap_connection *conn, const char *attrlist,
               char ***attr_names_r, struct hash_table *attr_map,
               const char *skip_attr)
{
    const char *const *attr, *attr_data, *p;
    string_t *static_data;
    char *name, *value;
    unsigned int i, j, size;

    if (*attrlist == '\0')
        return;

    attr = t_strsplit(attrlist, ",");
    static_data = t_str_new(128);

    /* @UNSAFE */
    for (size = 0; attr[size] != NULL; size++) ;
    *attr_names_r = p_new(conn->pool, char *, size + 1);

    for (i = j = 0; i < size; i++) {
        /* allow spaces here so "foo=1, bar=2" works */
        attr_data = attr[i];
        while (*attr_data == ' ') attr_data++;

        p = strchr(attr_data, '=');
        if (p == NULL)
            name = value = p_strdup(conn->pool, attr_data);
        else if (p != attr_data) {
            name = p_strdup_until(conn->pool, attr_data, p);
            value = p_strdup(conn->pool, p + 1);
        } else {
            /* =<static key>=<static value> */
            if (str_len(static_data) > 0)
                str_append_c(static_data, ',');
            str_append(static_data, p + 1);
            continue;
        }

        if (*name != '\0' &&
            (skip_attr == NULL || strcmp(skip_attr, value) != 0)) {
            hash_table_insert(attr_map, name, value);
            (*attr_names_r)[j++] = name;
        }
    }
    if (str_len(static_data) > 0) {
        hash_table_insert(attr_map, "",
                  p_strdup(conn->pool, str_c(static_data)));
    }
}

struct var_expand_table *
db_ldap_value_get_var_expand_table(struct auth_request *auth_request)
{
    const struct var_expand_table *auth_table;
    struct var_expand_table *table;
    unsigned int count;

    auth_table = auth_request_get_var_expand_table(auth_request, NULL);
    for (count = 0; auth_table[count].key != '\0'; count++) ;
    count++;

    table = t_new(struct var_expand_table, count + 1);
    table[0].key = '$';
    memcpy(table + 1, auth_table, sizeof(*table) * count);
    return table;
}

#define IS_LDAP_ESCAPED_CHAR(c) \
    ((c) == '*' || (c) == '(' || (c) == ')' || (c) == '\\')

const char *ldap_escape(const char *str,
            const struct auth_request *auth_request ATTR_UNUSED)
{
    const char *p;
    string_t *ret;

    for (p = str; *p != '\0'; p++) {
        if (IS_LDAP_ESCAPED_CHAR(*p))
            break;
    }

    if (*p == '\0')
        return str;

    ret = t_str_new((size_t) (p - str) + 64);
    str_append_n(ret, str, (size_t) (p - str));

    for (; *p != '\0'; p++) {
        if (IS_LDAP_ESCAPED_CHAR(*p))
            str_append_c(ret, '\\');
        str_append_c(ret, *p);
    }
    return str_c(ret);
}

struct db_ldap_result_iterate_context *
db_ldap_result_iterate_init(struct ldap_connection *conn, LDAPMessage *entry,
                struct auth_request *auth_request,
                struct hash_table *attr_map)
{
    struct db_ldap_result_iterate_context *ctx;
    const char *static_data;

    ctx = t_new(struct db_ldap_result_iterate_context, 1);
    ctx->conn = conn;
    ctx->entry = entry;
    ctx->auth_request = auth_request;
    ctx->attr_map = attr_map;

    static_data = hash_table_lookup(attr_map, "");
    if (static_data != NULL) {
        const struct var_expand_table *table;
        string_t *str;

        table = auth_request_get_var_expand_table(auth_request, NULL);
        str = t_str_new(256);
        var_expand(str, static_data, table);
        ctx->static_attrs = t_strsplit(str_c(str), ",");
    }

    if (auth_request->auth->set->debug)
        ctx->debug = t_str_new(256);

    ctx->attr = ldap_first_attribute(conn->ld, entry, &ctx->ber);
    return ctx;
}

static void
db_ldap_result_iterate_finish(struct db_ldap_result_iterate_context *ctx)
{
    if (ctx->debug != NULL) {
        if (str_len(ctx->debug) > 0) {
            auth_request_log_debug(ctx->auth_request, "ldap",
                "result: %s", str_c(ctx->debug) + 1);
        } else {
            auth_request_log_debug(ctx->auth_request, "ldap",
                "no fields returned by the server");
        }
    }

    ber_free(ctx->ber, 0);
}

static void
db_ldap_result_change_attr(struct db_ldap_result_iterate_context *ctx)
{
    ctx->name = hash_table_lookup(ctx->attr_map, ctx->attr);
    ctx->template = NULL;

    if (ctx->debug != NULL) {
        str_printfa(ctx->debug, " %s(%s)=", ctx->attr,
                ctx->name != NULL ? ctx->name : "?unknown?");
    }

    if (ctx->name == NULL || *ctx->name == '\0') {
        ctx->value = NULL;
        return;
    }

    if (strchr(ctx->name, '%') != NULL &&
        (ctx->template = strchr(ctx->name, '=')) != NULL) {
        /* we want to use variables */
        ctx->name = t_strdup_until(ctx->name, ctx->template);
        ctx->template++;
        if (ctx->var_table == NULL) {
            ctx->var_table = db_ldap_value_get_var_expand_table(
                            ctx->auth_request);
            ctx->var = t_str_new(256);
        }
    }

    ctx->vals = ldap_get_values(ctx->conn->ld, ctx->entry,
                    ctx->attr);
    ctx->value = ctx->vals[0];
    ctx->value_idx = 0;
}

static void
db_ldap_result_return_value(struct db_ldap_result_iterate_context *ctx)
{
    bool first = ctx->value_idx == 0;

    if (ctx->template != NULL) {
        ctx->var_table[0].value = ctx->value;
        str_truncate(ctx->var, 0);
        var_expand(ctx->var, ctx->template, ctx->var_table);
        ctx->value = str_c(ctx->var);
    }

    if (ctx->debug != NULL) {
        if (!first)
            str_append_c(ctx->debug, '/');
        if (ctx->auth_request->auth->set->debug_passwords ||
            strcmp(ctx->name, "password") != 0)
            str_append(ctx->debug, ctx->value);
        else
            str_append(ctx->debug, PASSWORD_HIDDEN_STR);
    }
}

static bool db_ldap_result_int_next(struct db_ldap_result_iterate_context *ctx)
{
    const char *p;

    while (ctx->attr != NULL) {
        if (ctx->vals == NULL) {
            /* a new attribute */
            db_ldap_result_change_attr(ctx);
        } else {
            /* continuing existing attribute */
            if (ctx->value != NULL)
                ctx->value = ctx->vals[++ctx->value_idx];
        }

        if (ctx->value != NULL) {
            db_ldap_result_return_value(ctx);
            return TRUE;
        }

        ldap_value_free(ctx->vals); ctx->vals = NULL;
        ldap_memfree(ctx->attr);
        ctx->attr = ldap_next_attribute(ctx->conn->ld, ctx->entry,
                        ctx->ber);
    }

    if (ctx->static_attrs != NULL && *ctx->static_attrs != NULL) {
        p = strchr(*ctx->static_attrs, '=');
        if (p == NULL) {
            ctx->name = *ctx->static_attrs;
            ctx->value = "";
        } else {
            ctx->name = t_strdup_until(*ctx->static_attrs, p);
            ctx->value = p + 1;
        }
        /* make _next_all() return correct values */
        ctx->template = "";
        ctx->val_1_arr[0] = ctx->value;
        ctx->static_attrs++;
        return TRUE;
    }

    db_ldap_result_iterate_finish(ctx);
    return FALSE;
}

bool db_ldap_result_iterate_next(struct db_ldap_result_iterate_context *ctx,
                 const char **name_r, const char **value_r)
{
    if (!db_ldap_result_int_next(ctx))
        return FALSE;

    *name_r = ctx->name;
    *value_r = ctx->value;
    return TRUE;
}

bool db_ldap_result_iterate_next_all(struct db_ldap_result_iterate_context *ctx,
                     const char **name_r,
                     const char *const **values_r)
{
    if (!db_ldap_result_int_next(ctx))
        return FALSE;

    if (ctx->template != NULL) {
        /* we can use only one value with templates */
        ctx->val_1_arr[0] = ctx->value;
        *values_r = ctx->val_1_arr;
    } else {
        *values_r = (const char *const *)ctx->vals;
    }
    ctx->value = NULL;
    *name_r = ctx->name;
    return TRUE;
}

static const char *parse_setting(const char *key, const char *value,
                 struct ldap_connection *conn)
{
    return parse_setting_from_defs(conn->pool, setting_defs,
                       &conn->set, key, value);
}

static struct ldap_connection *ldap_conn_find(const char *config_path)
{
    struct ldap_connection *conn;

    for (conn = ldap_connections; conn != NULL; conn = conn->next) {
        if (strcmp(conn->config_path, config_path) == 0)
            return conn;
    }

    return NULL;
}

struct ldap_connection *db_ldap_init(const char *config_path)
{
    struct ldap_connection *conn;
    const char *str;
    pool_t pool;

    /* see if it already exists */
    conn = ldap_conn_find(config_path);
    if (conn != NULL) {
        conn->refcount++;
        return conn;
    }

    if (*config_path == '\0')
        i_fatal("LDAP: Configuration file path not given");

    pool = pool_alloconly_create("ldap_connection", 1024);
    conn = p_new(pool, struct ldap_connection, 1);
    conn->pool = pool;
    conn->refcount = 1;

    conn->conn_state = LDAP_CONN_STATE_DISCONNECTED;
    conn->default_bind_msgid = -1;
    conn->fd = -1;
    conn->config_path = p_strdup(pool, config_path);
    conn->set = default_ldap_settings;
    if (!settings_read(config_path, NULL, parse_setting,
               null_settings_section_callback, conn))
        exit(FATAL_DEFAULT);

    if (conn->set.base == NULL)
        i_fatal("LDAP: No base given");

    if (conn->set.uris == NULL && conn->set.hosts == NULL)
        i_fatal("LDAP: No uris or hosts set");
#ifndef LDAP_HAVE_INITIALIZE
    if (conn->set.uris != NULL) {
        i_fatal("LDAP: Dovecot compiled without support for LDAP uris "
            "(ldap_initialize not found)");
    }
#endif

    if (*conn->set.ldaprc_path != '\0') {
        str = getenv("LDAPRC");
        if (str != NULL && strcmp(str, conn->set.ldaprc_path) != 0) {
            i_fatal("LDAP: Multiple different ldaprc_path "
                "settings not allowed (%s and %s)",
                str, conn->set.ldaprc_path);
        }
        env_put(t_strconcat("LDAPRC=", conn->set.ldaprc_path, NULL));
    }

        conn->set.ldap_deref = deref2str(conn->set.deref);
    conn->set.ldap_scope = scope2str(conn->set.scope);

    i_array_init(&conn->request_array, DB_LDAP_MAX_QUEUE_SIZE);
    conn->request_queue = aqueue_init(&conn->request_array.arr);

    conn->next = ldap_connections;
        ldap_connections = conn;
    return conn;
}

void db_ldap_unref(struct ldap_connection **_conn)
{
        struct ldap_connection *conn = *_conn;
    struct ldap_connection **p;

    *_conn = NULL;
    i_assert(conn->refcount >= 0);
    if (--conn->refcount > 0)
        return;

    for (p = &ldap_connections; *p != NULL; p = &(*p)->next) {
        if (*p == conn) {
            *p = conn->next;
            break;
        }
    }

    db_ldap_abort_requests(conn, -1U, 0, FALSE, "Shutting down");
    i_assert(conn->pending_count == 0);
    db_ldap_conn_close(conn);
    i_assert(conn->to == NULL);

    array_free(&conn->request_array);
    aqueue_deinit(&conn->request_queue);

    if (conn->pass_attr_map != NULL)
        hash_table_destroy(&conn->pass_attr_map);
    if (conn->user_attr_map != NULL)
        hash_table_destroy(&conn->user_attr_map);
    pool_unref(&conn->pool);
}

#ifndef BUILTIN_LDAP
/* Building a plugin */
extern struct passdb_module_interface passdb_ldap;
extern struct userdb_module_interface userdb_ldap;

void authdb_ldap_init(void);
void authdb_ldap_deinit(void);

void authdb_ldap_init(void)
{
    passdb_register_module(&passdb_ldap);
    userdb_register_module(&userdb_ldap);

}
void authdb_ldap_deinit(void)
{
    passdb_unregister_module(&passdb_ldap);
    userdb_unregister_module(&userdb_ldap);
}
#endif

#endif