res_config_ldap.c File Reference

LDAP plugin for portable configuration engine (ARA) More...

#include "asterisk.h"
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <stdio.h>
#include <ldap.h>
#include "asterisk/channel.h"
#include "asterisk/logger.h"
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/lock.h"
#include "asterisk/options.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/strings.h"
#include "asterisk/pbx.h"
#include "asterisk/linkedlists.h"

Include dependency graph for res_config_ldap.c:

Go to the source code of this file.

Data Structures
struct	category_and_metric
struct	ldap_table_config
	Table configuration. More...
struct	table_configs
	Should be locked before using it. More...

Macros
#define	MAXRESULT   2048
#define	RES_CONFIG_LDAP_CONF   "res_ldap.conf"
#define	RES_CONFIG_LDAP_DEFAULT_BASEDN   "asterisk"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	append_var_and_value_to_filter (struct ast_str **filter, struct ldap_table_config *table_config, const char *name, const char *value)
	Append a name=value filter string. The filter string can grow.
struct ast_module *	AST_MODULE_SELF_SYM (void)
static char *	cleaned_basedn (struct ast_channel *channel, const char *basedn)
static int	compare_categories (const void *a, const void *b)
	Sorting alogrithm for qsort to find the order of the variables a and b.
static int	config_can_be_inherited (const char *key)
static struct ast_config *	config_ldap (const char *basedn, const char *table_name, const char *file, struct ast_config *cfg, struct ast_flags config_flags, const char *sugg_incl, const char *who_asked)
	See Asterisk Realtime Documentation.
static const char *	convert_attribute_name_from_ldap (struct ldap_table_config *table_config, const char *attribute_name)
	Convert ldap attribute name to variable name.
static const char *	convert_attribute_name_to_ldap (struct ldap_table_config *table_config, const char *attribute_name)
	Convert variable name to ldap attribute name.
static struct ast_str *	create_lookup_filter (struct ldap_table_config *config, const struct ast_variable *fields)
static int	is_ldap_connect_error (int err)
	Check if we have a connection error.
static int	ldap_entry_has_attribute (LDAPMessage *entry, const char *lookup)
static void	ldap_filter_escape_value (const char *value, struct ast_str **escaped)
static struct ast_variable *	ldap_loadentry (struct ldap_table_config *table_config, const char *dn)
	Get LDAP entry by dn and return attributes as variables.
static LDAPMod *	ldap_mod_append (LDAPMod *src, const char *new_value)
static LDAPMod *	ldap_mod_create (const char *attribute, const char *new_value)
static LDAPMod *	ldap_mod_duplicate (const LDAPMod *src)
static LDAPMod *	ldap_mod_find (LDAPMod **modifications, const char *lookup)
static int	ldap_reconnect (void)
static void	ldap_table_config_add_attribute (struct ldap_table_config *table_config, const char *attribute_name, const char *attribute_value)
	add attribute to table config
static int	load_module (void)
	Load the module.
static LDAPMod **	massage_mods_for_entry (LDAPMessage *entry, LDAPMod **mods)
static int	parse_config (void)
	parse the configuration file
static struct ast_variable *	realtime_arguments_to_fields (va_list ap)
static struct ast_variable *	realtime_ldap (const char *basedn, const char *table_name, const struct ast_variable *fields)
	See Asterisk doc.
static struct ast_variable **	realtime_ldap_base (unsigned int *entries_count_ptr, const char *basedn, const char *table_name,...)
	same as realtime_ldap_base_ap but take variable arguments count list
static struct ast_variable **	realtime_ldap_base_ap (unsigned int *entries_count_ptr, const char *basedn, const char *table_name, const struct ast_variable *fields)
	LDAP base function.
static struct ast_variable *	realtime_ldap_entry_to_var (struct ldap_table_config *table_config, LDAPMessage *ldap_entry)
	Get variables from ldap entry attributes.
static struct ast_variable **	realtime_ldap_result_to_vars (struct ldap_table_config *table_config, LDAPMessage *ldap_result_msg, unsigned int *entries_count_ptr)
	Get variables from ldap entry attributes - Should be locked before using it.
static char *	realtime_ldap_status (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	Realtime Status.
static struct ast_config *	realtime_multi_ldap (const char *basedn, const char *table_name, const struct ast_variable *fields)
	See Asterisk doc.
static int	reload (void)
	Reload Module.
static int	replace_string_in_string (char *string, const char *search, const char *by)
	Replace <search> by <by> in string.
static int	semicolon_count_str (const char *somestr)
	Count semicolons in string.
static int	semicolon_count_var (struct ast_variable *var)
	Count semicolons in variables.
static char *	substituted (struct ast_channel *channel, const char *string)
static struct ldap_table_config *	table_config_for_table_name (const char *table_name)
	Find a table_config.
static struct ldap_table_config *	table_config_new (const char *table_name)
	Create a new table_config.
static void	table_configs_free (void)
	Free table_config.
static int	unload_module (void)
	Unload Module.
static int	update2_ldap (const char *basedn, const char *table_name, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields)
static int	update_ldap (const char *basedn, const char *table_name, const char *attribute, const char *lookup, const struct ast_variable *fields)
static struct ast_variable *	variable_named (struct ast_variable *var, const char *name)
	Find variable by name.
static size_t	variables_count (const struct ast_variable *vars)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "LDAP realtime interface" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_REALTIME_DRIVER, .requires = "extconfig", }
	Module Information.
static const struct ast_module_info *	ast_module_info = &__mod_info
static char	base_distinguished_name [512]
static struct ldap_table_config *	base_table_config
static time_t	connect_time
static struct ast_cli_entry	ldap_cli []
static struct ast_config_engine	ldap_engine
static ast_mutex_t	ldap_lock = AST_MUTEX_INIT_VALUE
static LDAP *	ldapConn
static char	pass [512]
static struct ldap_table_config *	static_table_config
static struct table_configs	table_configs = AST_LIST_HEAD_NOLOCK_INIT_VALUE
static char	url [512]
static char	user [512]
static int	version

Detailed Description

LDAP plugin for portable configuration engine (ARA)

Author

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Manuel Guesdon

Carl-Einar Thorner cthor.nosp@m.ner@.nosp@m.voice.nosp@m.rd.c.nosp@m.om

Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

OpenLDAP http://www.openldap.org

Definition in file res_config_ldap.c.

Macro Definition Documentation

MAXRESULT

#define MAXRESULT   2048

RES_CONFIG_LDAP_CONF

#define RES_CONFIG_LDAP_CONF   "res_ldap.conf"

Definition at line 68 of file res_config_ldap.c.

RES_CONFIG_LDAP_DEFAULT_BASEDN

#define RES_CONFIG_LDAP_DEFAULT_BASEDN   "asterisk"

Definition at line 69 of file res_config_ldap.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 2056 of file res_config_ldap.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 2056 of file res_config_ldap.c.

append_var_and_value_to_filter()

static void append_var_and_value_to_filter ( struct ast_str **  filter, struct ldap_table_config *  table_config, const char *  name, const char *  value  )

static

Append a name=value filter string. The filter string can grow.

Definition at line 772 of file res_config_ldap.c.

{
    char *new_name = NULL;
    char *new_value = NULL;
    const char *like_pos = strstr(name, " LIKE");
    struct ast_str *escaped_value;
 
    ast_debug(2, "name='%s' value='%s'\n", name, value);
 
    escaped_value = ast_str_create(256);
    if (!escaped_value) {
        return;
    }
 
    if (like_pos) {
        int len = like_pos - name;
 
        name = new_name = ast_strdupa(name);
        new_name[len] = '\0';
        value = new_value = ast_strdupa(value);
        replace_string_in_string(new_value, "\\_", "_");
        replace_string_in_string(new_value, "%", "*");
        name = convert_attribute_name_to_ldap(table_config, name);
        /* Note: The LIKE path preserves original wildcard behavior.
         * A more comprehensive escaping of the LIKE path is left
         * to the maintainers familiar with the query semantics.
         */
        ast_str_append(filter, 0, "(%s=%s)", name, value);
    } else {
        name = convert_attribute_name_to_ldap(table_config, name);
        ldap_filter_escape_value(value, &escaped_value);
        ast_str_append(filter, 0, "(%s=%s)", name,
            ast_str_buffer(escaped_value));
    }
 
    ast_free(escaped_value);
}

References ast_debug, ast_free, ast_str_append(), ast_str_buffer(), ast_str_create, ast_strdupa, convert_attribute_name_to_ldap(), filter(), ldap_filter_escape_value(), len(), name, NULL, replace_string_in_string(), and value.

Referenced by create_lookup_filter().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 2056 of file res_config_ldap.c.

cleaned_basedn()

static char * cleaned_basedn ( struct ast_channel *  channel, const char *  basedn  )

static

Note

caller should free returned pointer

Definition at line 685 of file res_config_ldap.c.

{
    char *cbasedn = NULL;
    if (basedn) {
        char *p = NULL;
        cbasedn = substituted(channel, basedn);
        if (*cbasedn == '"') {
            cbasedn++;
            if (!ast_strlen_zero(cbasedn)) {
                int len = strlen(cbasedn);
                if (cbasedn[len - 1] == '"')
                    cbasedn[len - 1] = '\0';
 
            }
        }
        p = cbasedn;
        while (*p) {
            if (*p == '|')
                *p = ',';
            p++;
        }
    }
    ast_debug(2, "basedn: '%s' => '%s' \n", basedn, cbasedn);
    return cbasedn;
}

References ast_debug, ast_strlen_zero(), len(), NULL, and substituted().

Referenced by realtime_ldap_base_ap(), and update2_ldap().

compare_categories()

static int compare_categories ( const void *  a, const void *  b  )

static

Sorting alogrithm for qsort to find the order of the variables a and b.

Parameters

a	pointer to category_and_metric struct
b	pointer to category_and_metric struct

Return values

-1	for if b is greater
0	zero for equal
1	if a is greater

Definition at line 1148 of file res_config_ldap.c.

{
    const struct category_and_metric *as = a;
    const struct category_and_metric *bs = b;
 
    if (as->metric < bs->metric) {
        return -1;
    } else if (as->metric > bs->metric) {
        return 1;
    } else if (as->metric == bs->metric && strcmp(as->name, bs->name) != 0) {
        return strcmp(as->name, bs->name);
    }
    /* if the metric and the category name is the same, we check the variable metric */
    if (as->var_metric < bs->var_metric) {
        return -1;
    } else if (as->var_metric > bs->var_metric) {
        return 1;
    }
 
    return 0;
}

References a, b, bs, category_and_metric::metric, category_and_metric::name, and category_and_metric::var_metric.

Referenced by config_ldap().

config_can_be_inherited()

static int config_can_be_inherited ( const char *  key )

static

Definition at line 1842 of file res_config_ldap.c.

{
    int i;
    static const char * const config[] = {
        "basedn", "host", "pass", "port", "protocol", "url", "user", "version", NULL
    };
 
    for (i = 0; config[i]; i++) {
        if (!strcasecmp(key, config[i])) {
            return 0;
        }
    }
    return 1;
}

References config, and NULL.

Referenced by parse_config().

config_ldap()

static struct ast_config * config_ldap ( const char *  basedn, const char *  table_name, const char *  file, struct ast_config *  cfg, struct ast_flags  config_flags, const char *  sugg_incl, const char *  who_asked  )

static

See Asterisk Realtime Documentation.

This is for Static Realtime

load the configuration stuff for the .conf files called on a reload

Note

Since the items come back in random order, they need to be sorted first, and since the data could easily exceed stack size, this is allocated from the heap.

Definition at line 1177 of file res_config_ldap.c.

{
    unsigned int vars_count = 0;
    struct ast_variable **vars;
    int i = 0;
    struct ast_variable *new_v = NULL;
    struct ast_category *cur_cat = NULL;
    const char *last_category = NULL;
    int last_category_metric = 0;
    struct category_and_metric *categories;
    struct ast_variable **p;
 
    if (ast_strlen_zero(file) || !strcasecmp(file, RES_CONFIG_LDAP_CONF)) {
        ast_log(LOG_ERROR, "Missing configuration file: %s. Can't configure myself.\n", RES_CONFIG_LDAP_CONF);
        return NULL;
    }
 
    vars = realtime_ldap_base(&vars_count, basedn, table_name, "filename", file, "commented", "FALSE", NULL);
 
    if (!vars) {
        ast_log(LOG_WARNING, "Could not find config '%s' in directory.\n", file);
        return NULL;
    }
 
    /*! \note Since the items come back in random order, they need to be sorted
     * first, and since the data could easily exceed stack size, this is
     * allocated from the heap.
     */
    if (!(categories = ast_calloc(vars_count, sizeof(*categories)))) {
        return NULL;
    }
 
    for (vars_count = 0, p = vars; *p; p++) {
        struct ast_variable *category = variable_named(*p, "category");
        struct ast_variable *cat_metric = variable_named(*p, "cat_metric");
        struct ast_variable *var_name = variable_named(*p, "variable_name");
        struct ast_variable *var_val = variable_named(*p, "variable_value");
        struct ast_variable *var_metric = variable_named(*p, "var_metric");
        struct ast_variable *dn = variable_named(*p, "dn");
 
        if (!category) {
            ast_log(LOG_ERROR, "No category name in entry '%s'  for file '%s'.\n",
                    (dn ? dn->value : "?"), file);
        } else if (!cat_metric) {
            ast_log(LOG_ERROR, "No category metric in entry '%s'(category: %s) for file '%s'.\n",
                    (dn ? dn->value : "?"), category->value, file);
        } else if (!var_metric) {
            ast_log(LOG_ERROR, "No variable metric in entry '%s'(category: %s) for file '%s'.\n",
                    (dn ? dn->value : "?"), category->value, file);
        } else if (!var_name) {
            ast_log(LOG_ERROR, "No variable name in entry '%s' (category: %s metric: %s) for file '%s'.\n",
                    (dn ? dn->value : "?"), category->value,
                    cat_metric->value, file);
        } else if (!var_val) {
            ast_log(LOG_ERROR, "No variable value in entry '%s' (category: %s metric: %s variable: %s) for file '%s'.\n",
                    (dn ? dn->value : "?"), category->value,
                    cat_metric->value, var_name->value, file);
        } else {
            categories[vars_count].name = category->value;
            categories[vars_count].metric = atoi(cat_metric->value);
            categories[vars_count].variable_name = var_name->value;
            categories[vars_count].variable_value = var_val->value;
            categories[vars_count].var_metric = atoi(var_metric->value);
            vars_count++;
        }
 
        ast_debug(3, "category: %s\n", category->value);
        ast_debug(3, "var_name: %s\n", var_name->value);
        ast_debug(3, "var_val: %s\n", var_val->value);
        ast_debug(3, "cat_metric: %s\n", cat_metric->value);
 
    }
 
    qsort(categories, vars_count, sizeof(*categories), compare_categories);
 
    for (i = 0; i < vars_count; i++) {
        if (!strcmp(categories[i].variable_name, "#include")) {
            struct ast_flags flags = { 0 };
            if (!ast_config_internal_load(categories[i].variable_value, cfg, flags, "", who_asked)) {
                break;
            }
            continue;
        }
 
        if (!last_category || strcmp(last_category, categories[i].name) ||
            last_category_metric != categories[i].metric) {
 
            cur_cat = ast_category_new_dynamic(categories[i].name);
            if (!cur_cat) {
                break;
            }
            last_category = categories[i].name;
            last_category_metric = categories[i].metric;
            ast_category_append(cfg, cur_cat);
        }
 
        if (!(new_v = ast_variable_new(categories[i].variable_name, categories[i].variable_value, table_name))) {
            break;
        }
 
        ast_variable_append(cur_cat, new_v);
    }
 
    ast_free(vars);
    ast_free(categories);
 
    return cfg;
}

References ast_calloc, ast_category_append(), ast_category_new_dynamic, ast_config_internal_load(), ast_debug, ast_free, ast_log, ast_strlen_zero(), ast_variable_append(), ast_variable_new, categories, compare_categories(), ast_variable::file, ast_flags::flags, LOG_ERROR, LOG_WARNING, name, NULL, realtime_ldap_base(), RES_CONFIG_LDAP_CONF, ast_variable::value, and variable_named().

convert_attribute_name_from_ldap()

static const char * convert_attribute_name_from_ldap ( struct ldap_table_config *  table_config, const char *  attribute_name  )

static

Convert ldap attribute name to variable name.

Note

Should be locked before using it

Definition at line 280 of file res_config_ldap.c.

{
    int i = 0;
    struct ldap_table_config *configs[] = { table_config, base_table_config };
 
    for (i = 0; i < ARRAY_LEN(configs); i++) {
        struct ast_variable *attribute;
 
        if (!configs[i]) {
            continue;
        }
 
        attribute = configs[i]->attributes;
        for (; attribute; attribute = attribute->next) {
            if (strcasecmp(attribute_name, attribute->value) == 0) {
                return attribute->name;
            }
        }
    }
 
    return attribute_name;
}

References ARRAY_LEN, base_table_config, ast_variable::name, ast_variable::next, and ast_variable::value.

Referenced by realtime_ldap_entry_to_var(), and realtime_ldap_result_to_vars().

convert_attribute_name_to_ldap()

static const char * convert_attribute_name_to_ldap ( struct ldap_table_config *  table_config, const char *  attribute_name  )

static

Convert variable name to ldap attribute name.

Note

Should be locked before using it

Definition at line 252 of file res_config_ldap.c.

{
    int i = 0;
    struct ldap_table_config *configs[] = { table_config, base_table_config };
 
    for (i = 0; i < ARRAY_LEN(configs); i++) {
        struct ast_variable *attribute;
 
        if (!configs[i]) {
            continue;
        }
 
        attribute = configs[i]->attributes;
        for (; attribute; attribute = attribute->next) {
            if (!strcasecmp(attribute_name, attribute->name)) {
                return attribute->value;
            }
        }
    }
 
    return attribute_name;
}

References ARRAY_LEN, base_table_config, ast_variable::name, ast_variable::next, and ast_variable::value.

Referenced by append_var_and_value_to_filter(), and update2_ldap().

create_lookup_filter()

static struct ast_str * create_lookup_filter ( struct ldap_table_config *  config, const struct ast_variable *  fields  )

static

Definition at line 821 of file res_config_ldap.c.

{
    struct ast_str *filter;
    const struct ast_variable *field;
 
    filter = ast_str_create(80);
    if (!filter) {
        return NULL;
    }
 
    /*
     * Create the filter with the table additional filter and the
     * parameter/value pairs we were given
     */
    ast_str_append(&filter, 0, "(&");
    if (config && config->additional_filter) {
        ast_str_append(&filter, 0, "%s", config->additional_filter);
    }
    if (config != base_table_config
        && base_table_config
        && base_table_config->additional_filter) {
        ast_str_append(&filter, 0, "%s", base_table_config->additional_filter);
    }
    /* Append the lookup fields */
    for (field = fields; field; field = field->next) {
        append_var_and_value_to_filter(&filter, config, field->name, field->value);
    }
    ast_str_append(&filter, 0, ")");
 
    return filter;
}

References ldap_table_config::additional_filter, append_var_and_value_to_filter(), ast_str_append(), ast_str_create, base_table_config, config, filter(), ast_variable::name, ast_variable::next, NULL, and ast_variable::value.

Referenced by realtime_ldap_base_ap(), and update2_ldap().

is_ldap_connect_error()

static int is_ldap_connect_error ( int  err )

static

Check if we have a connection error.

Definition at line 582 of file res_config_ldap.c.

{
    return (err == LDAP_SERVER_DOWN || err == LDAP_TIMEOUT || err == LDAP_CONNECT_ERROR);
}

Referenced by ldap_loadentry(), realtime_ldap_base_ap(), and update2_ldap().

ldap_entry_has_attribute()

static int ldap_entry_has_attribute ( LDAPMessage *  entry, const char *  lookup  )

static

Definition at line 1448 of file res_config_ldap.c.

{
    BerElement *ber = NULL;
    char *attribute;
 
    attribute = ldap_first_attribute(ldapConn, entry, &ber);
    while (attribute) {
        if (!strcasecmp(attribute, lookup)) {
            ldap_memfree(attribute);
            ber_free(ber, 0);
            return 1;
        }
        ldap_memfree(attribute);
        attribute = ldap_next_attribute(ldapConn, entry, ber);
    }
    ber_free(ber, 0);
    return 0;
}

References ldapConn, and NULL.

Referenced by massage_mods_for_entry().

ldap_filter_escape_value()

static void ldap_filter_escape_value ( const char *  value, struct ast_str **  escaped  )

static

Definition at line 746 of file res_config_ldap.c.

{
    ast_str_reset(*escaped);
    for (; *value; value++) {
        switch (*value) {
        case '*':
            ast_str_append(escaped, 0, "\\2a");
            break;
        case '(':
            ast_str_append(escaped, 0, "\\28");
            break;
        case ')':
            ast_str_append(escaped, 0, "\\29");
            break;
        case '\\':
            ast_str_append(escaped, 0, "\\5c");
            break;
        default:
            ast_str_append(escaped, 0, "%c", *value);
            break;
        }
    }
}

References ast_str_append(), ast_str_reset(), and value.

Referenced by append_var_and_value_to_filter().

ldap_loadentry()

static struct ast_variable * ldap_loadentry ( struct ldap_table_config *  table_config, const char *  dn  )

static

Get LDAP entry by dn and return attributes as variables.

Should be locked before using it

This is used for setting the default values of an object i.e., with accountBaseDN

< not using this

Definition at line 594 of file res_config_ldap.c.

{
    if (!table_config) {
        ast_log(LOG_ERROR, "No table config\n");
        return NULL;
    } else {
        struct ast_variable **vars = NULL;
        struct ast_variable *var = NULL;
        int result = -1;
        LDAPMessage *ldap_result_msg = NULL;
        int tries = 0;
 
        ast_debug(2, "ldap_loadentry dn=%s\n", dn);
 
        do {
            result = ldap_search_ext_s(ldapConn, dn, LDAP_SCOPE_BASE,
                       "(objectclass=*)", NULL, 0, NULL, NULL, NULL, LDAP_NO_LIMIT, &ldap_result_msg);
            if (result != LDAP_SUCCESS && is_ldap_connect_error(result)) {
                ast_log(LOG_WARNING, "Failed to query directory. Try %d/3\n", tries + 1);
                tries++;
                if (tries < 3) {
                    usleep(500000L * tries);
                    if (ldapConn) {
                        ldap_unbind_ext_s(ldapConn, NULL, NULL);
                        ldapConn = NULL;
                    }
                    if (!ldap_reconnect()) {
                        break;
                    }
                }
            }
        } while (result != LDAP_SUCCESS && tries < 3 && is_ldap_connect_error(result));
 
        if (result != LDAP_SUCCESS) {
            ast_log(LOG_WARNING, "Failed to query directory. Error: %s.\n", ldap_err2string(result));
            ast_debug(2, "dn=%s\n", dn);
            ast_mutex_unlock(&ldap_lock);
            return NULL;
        } else {
            int num_entry = 0;
            unsigned int *entries_count_ptr = NULL; /*!< not using this */
 
            if ((num_entry = ldap_count_entries(ldapConn, ldap_result_msg)) > 0) {
                ast_debug(3, "num_entry: %d\n", num_entry);
 
                vars = realtime_ldap_result_to_vars(table_config, ldap_result_msg, entries_count_ptr);
                if (num_entry > 1) {
                    ast_log(LOG_NOTICE, "More than one entry for dn=%s. Take only 1st one\n", dn);
                }
            } else {
                ast_debug(2, "Could not find any entry dn=%s.\n", dn);
            }
        }
        ldap_msgfree(ldap_result_msg);
 
        /* Chopping \a vars down to one variable */
        if (vars != NULL) {
            struct ast_variable **p = vars;
 
            /* Only take the first one. */
            var = *vars;
 
            /* Destroy the rest. */
            while (*++p) {
                ast_variables_destroy(*p);
            }
            ast_free(vars);
        }
 
        return var;
    }
}

References ast_debug, ast_free, ast_log, ast_mutex_unlock, ast_variables_destroy(), is_ldap_connect_error(), ldap_lock, ldap_reconnect(), ldapConn, LOG_ERROR, LOG_NOTICE, LOG_WARNING, NULL, realtime_ldap_result_to_vars(), result, and var.

Referenced by realtime_ldap_base_ap().

ldap_mod_append()

static LDAPMod * ldap_mod_append ( LDAPMod *  src, const char *  new_value  )

static

Definition at line 1346 of file res_config_ldap.c.

{
    char *new_buffer;
 
    if (src->mod_op != LDAP_MOD_REPLACE) {
        return src;
    }
 
    new_buffer = ldap_memrealloc(
            src->mod_values[0],
            strlen(src->mod_values[0]) + strlen(new_value) + sizeof(";"));
 
    if (!new_buffer) {
        ast_log(LOG_ERROR, "Memory allocation failure creating LDAP modification\n");
        return NULL;
    }
 
    strcat(new_buffer, ";");
    strcat(new_buffer, new_value);
 
    src->mod_values[0] = new_buffer;
 
    return src;
}

References ast_log, LOG_ERROR, and NULL.

Referenced by update2_ldap().

ldap_mod_create()

static LDAPMod * ldap_mod_create ( const char *  attribute, const char *  new_value  )

static

Definition at line 1296 of file res_config_ldap.c.

{
    LDAPMod *mod;
    char *type;
 
    mod = ldap_memcalloc(1, sizeof(LDAPMod));
    type = ldap_strdup(attribute);
 
    if (!(mod && type)) {
        ast_log(LOG_ERROR, "Memory allocation failure creating LDAP modification\n");
        ldap_memfree(type);
        ldap_memfree(mod);
        return NULL;
    }
 
    mod->mod_type = type;
 
    if (strlen(new_value)) {
        char **values, *value;
        values = ldap_memcalloc(2, sizeof(char *));
        value = ldap_strdup(new_value);
 
        if (!(values && value)) {
            ast_log(LOG_ERROR, "Memory allocation failure creating LDAP modification\n");
            ldap_memfree(value);
            ldap_memfree(values);
            ldap_memfree(type);
            ldap_memfree(mod);
            return NULL;
        }
 
        mod->mod_op = LDAP_MOD_REPLACE;
        mod->mod_values = values;
        mod->mod_values[0] = value;
    } else {
        mod->mod_op = LDAP_MOD_DELETE;
    }
 
    return mod;
}

References ast_log, LOG_ERROR, NULL, type, and value.

Referenced by update2_ldap().

ldap_mod_duplicate()

static LDAPMod * ldap_mod_duplicate ( const LDAPMod *  src )

static

Definition at line 1379 of file res_config_ldap.c.

{
    LDAPMod *mod;
    char *type, **values = NULL;
 
    mod = ldap_memcalloc(1, sizeof(LDAPMod));
    type = ldap_strdup(src->mod_type);
 
    if (!(mod && type)) {
        ast_log(LOG_ERROR, "Memory allocation failure creating LDAP modification\n");
        ldap_memfree(type);
        ldap_memfree(mod);
        return NULL;
    }
 
    if (src->mod_op == LDAP_MOD_REPLACE) {
        char *value;
 
        values = ldap_memcalloc(2, sizeof(char *));
        value = ldap_strdup(src->mod_values[0]);
 
        if (!(values && value)) {
            ast_log(LOG_ERROR, "Memory allocation failure creating LDAP modification\n");
            ldap_memfree(value);
            ldap_memfree(values);
            ldap_memfree(type);
            ldap_memfree(mod);
            return NULL;
        }
 
        values[0] = value;
    }
 
    mod->mod_op = src->mod_op;
    mod->mod_type = type;
    mod->mod_values = values;
    return mod;
}

References ast_log, LOG_ERROR, NULL, type, and value.

Referenced by massage_mods_for_entry().

ldap_mod_find()

static LDAPMod * ldap_mod_find ( LDAPMod **  modifications, const char *  lookup  )

static

Definition at line 1427 of file res_config_ldap.c.

{
    size_t i;
    for (i = 0; modifications[i]; i++) {
        if (modifications[i]->mod_op == LDAP_MOD_REPLACE &&
            !strcasecmp(modifications[i]->mod_type, lookup)) {
            return modifications[i];
        }
    }
    return NULL;
}

References NULL.

Referenced by update2_ldap().

ldap_reconnect()

static int ldap_reconnect ( void  )

static

Note

ldap_lock should have been locked before calling this function.

Definition at line 1961 of file res_config_ldap.c.

{
    int bind_result = 0;
    struct berval cred;
 
    if (ldapConn) {
        ast_debug(2, "Everything seems fine.\n");
        return 1;
    }
 
    if (ast_strlen_zero(url)) {
        ast_log(LOG_ERROR, "Not enough parameters to connect to ldap directory\n");
        return 0;
    }
 
    if (LDAP_SUCCESS != ldap_initialize(&ldapConn, url)) {
        ast_log(LOG_ERROR, "Failed to init ldap connection to '%s'. Check debug for more info.\n", url);
        return 0;
    }
 
    if (LDAP_OPT_SUCCESS != ldap_set_option(ldapConn, LDAP_OPT_PROTOCOL_VERSION, &version)) {
        ast_log(LOG_WARNING, "Unable to set LDAP protocol version to %d, falling back to default.\n", version);
    }
 
    if (!ast_strlen_zero(user)) {
        ast_debug(2, "bind to '%s' as user '%s'\n", url, user);
        cred.bv_val = (char *) pass;
        cred.bv_len = strlen(pass);
        bind_result = ldap_sasl_bind_s(ldapConn, user, LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL);
    } else {
        ast_debug(2, "bind %s anonymously\n", url);
        cred.bv_val = NULL;
        cred.bv_len = 0;
        bind_result = ldap_sasl_bind_s(ldapConn, NULL, LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL);
    }
    if (bind_result == LDAP_SUCCESS) {
        ast_debug(2, "Successfully connected to directory.\n");
        connect_time = time(NULL);
        return 1;
    } else {
        ast_log(LOG_WARNING, "bind failed: %s\n", ldap_err2string(bind_result));
        ldap_unbind_ext_s(ldapConn, NULL, NULL);
        ldapConn = NULL;
        return 0;
    }
}

References ast_debug, ast_log, ast_strlen_zero(), connect_time, ldapConn, LOG_ERROR, LOG_WARNING, NULL, pass, url, and version.

Referenced by ldap_loadentry(), load_module(), realtime_ldap_base_ap(), reload(), and update2_ldap().

ldap_table_config_add_attribute()

static void ldap_table_config_add_attribute ( struct ldap_table_config *  table_config, const char *  attribute_name, const char *  attribute_value  )

static

add attribute to table config

Should be locked before using it

Definition at line 204 of file res_config_ldap.c.

{
    struct ast_variable *var;
 
    if (ast_strlen_zero(attribute_name) || ast_strlen_zero(attribute_value)) {
        return;
    }
 
    if (!(var = ast_variable_new(attribute_name, attribute_value, table_config->table_name))) {
        return;
    }
 
    if (table_config->attributes) {
        var->next = table_config->attributes;
    }
    table_config->attributes = var;
}

References ast_strlen_zero(), ast_variable_new, ldap_table_config::attributes, ast_variable::next, ldap_table_config::table_name, and var.

Referenced by parse_config().

load_module()

static int load_module ( void  )

static

Load the module.

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Todo:

Don't error or warn on a default install. If the config is default we should not attempt to connect to a server. -lathama

Definition at line 1766 of file res_config_ldap.c.

{
    if (parse_config() < 0) {
        ast_log(LOG_ERROR, "Cannot load LDAP RealTime driver.\n");
        return 0;
    }
 
    ast_mutex_lock(&ldap_lock);
 
    if (!ldap_reconnect())  {
        ast_log(LOG_WARNING, "Couldn't establish connection to LDAP directory. Check debug.\n");
    }
 
    ast_config_engine_register(&ldap_engine);
    ast_verb(1, "LDAP RealTime driver loaded.\n");
    ast_cli_register_multiple(ldap_cli, ARRAY_LEN(ldap_cli));
 
    ast_mutex_unlock(&ldap_lock);
 
    return 0;
}

References ARRAY_LEN, ast_cli_register_multiple, ast_config_engine_register(), ast_log, ast_mutex_lock, ast_mutex_unlock, ast_verb, ldap_cli, ldap_engine, ldap_lock, ldap_reconnect(), LOG_ERROR, LOG_WARNING, and parse_config().

massage_mods_for_entry()

static LDAPMod ** massage_mods_for_entry ( LDAPMessage *  entry, LDAPMod **  mods  )

static

Definition at line 1483 of file res_config_ldap.c.

{
    size_t k, i, remove_count;
    LDAPMod **copies;
 
    for (i = remove_count = 0; mods[i]; i++) {
        if (mods[i]->mod_op == LDAP_MOD_DELETE
            && !ldap_entry_has_attribute(entry, mods[i]->mod_type)) {
            remove_count++;
        }
    }
 
    if (!remove_count) {
        return NULL;
    }
 
    copies = ldap_memcalloc(i - remove_count + 1, sizeof(LDAPMod *));
    if (!copies) {
        ast_log(LOG_ERROR, "Memory allocation failure massaging LDAP modification\n");
        return NULL;
    }
 
    for (i = k = 0; mods[i]; i++) {
        if (mods[i]->mod_op != LDAP_MOD_DELETE
            || ldap_entry_has_attribute(entry, mods[i]->mod_type)) {
            copies[k] = ldap_mod_duplicate(mods[i]);
            if (!copies[k]) {
                ast_log(LOG_ERROR, "Memory allocation failure massaging LDAP modification\n");
                ldap_mods_free(copies, 1);
                return NULL;
            }
            k++;
        } else {
            ast_debug(3, "Skipping %s deletion because it doesn't exist\n",
                    mods[i]->mod_type);
        }
    }
 
    return copies;
}

References ast_debug, ast_log, ldap_entry_has_attribute(), ldap_mod_duplicate(), LOG_ERROR, and NULL.

Referenced by update2_ldap().

parse_config()

static int parse_config ( void  )

static

parse the configuration file

< using the [config] context for Static RealTime

Definition at line 1859 of file res_config_ldap.c.

{
    struct ast_config *config;
    struct ast_flags config_flags = {0};
    const char *s, *host;
    int port;
    char *category_name = NULL;
 
    /* Make sure that global variables are reset */
    url[0] = '\0';
    user[0] = '\0';
    pass[0] = '\0';
    base_distinguished_name[0] = '\0';
    version = 3;
 
    config = ast_config_load(RES_CONFIG_LDAP_CONF, config_flags);
    if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_ERROR, "Cannot load configuration file: %s\n", RES_CONFIG_LDAP_CONF);
        return -1;
    }
 
    if (!(s = ast_variable_retrieve(config, "_general", "user"))) {
        ast_log(LOG_NOTICE, "No directory user found, anonymous binding as default.\n");
        user[0] = '\0';
    } else {
        ast_copy_string(user, s, sizeof(user));
    }
 
    if (!ast_strlen_zero(user)) {
        if (!(s = ast_variable_retrieve(config, "_general", "pass"))) {
            ast_log(LOG_WARNING, "No directory password found, using 'asterisk' as default.\n");
            ast_copy_string(pass, "asterisk", sizeof(pass));
        } else {
            ast_copy_string(pass, s, sizeof(pass));
        }
    }
 
    /* URL is preferred, use host and port if not found */
    if ((s = ast_variable_retrieve(config, "_general", "url"))) {
        ast_copy_string(url, s, sizeof(url));
    } else if ((host = ast_variable_retrieve(config, "_general", "host"))) {
        if (!(s = ast_variable_retrieve(config, "_general", "port")) || sscanf(s, "%5d", &port) != 1 || port > 65535) {
            ast_log(LOG_NOTICE, "No directory port found, using 389 as default.\n");
            port = 389;
        }
 
        snprintf(url, sizeof(url), "ldap://%s:%d", host, port);
    } else {
        ast_log(LOG_ERROR, "No directory URL or host found.\n");
        ast_config_destroy(config);
        return -1;
    }
 
    if (!(s = ast_variable_retrieve(config, "_general", "basedn"))) {
        ast_log(LOG_ERROR, "No LDAP base dn found, using '%s' as default.\n", RES_CONFIG_LDAP_DEFAULT_BASEDN);
        ast_copy_string(base_distinguished_name, RES_CONFIG_LDAP_DEFAULT_BASEDN, sizeof(base_distinguished_name));
    } else
        ast_copy_string(base_distinguished_name, s, sizeof(base_distinguished_name));
 
    if (!(s = ast_variable_retrieve(config, "_general", "version")) && !(s = ast_variable_retrieve(config, "_general", "protocol"))) {
        ast_log(LOG_NOTICE, "No explicit LDAP version found, using 3 as default.\n");
    } else if (sscanf(s, "%30d", &version) != 1 || version < 1 || version > 6) {
        ast_log(LOG_WARNING, "Invalid LDAP version '%s', using 3 as default.\n", s);
        version = 3;
    }
 
    table_configs_free();
 
    while ((category_name = ast_category_browse(config, category_name))) {
        int is_general = (strcasecmp(category_name, "_general") == 0);
        int is_config = (strcasecmp(category_name, "config") == 0); /*!< using the [config] context for Static RealTime */
        struct ast_variable *var = ast_variable_browse(config, category_name);
 
        if (var) {
            struct ldap_table_config *table_config =
                table_config_for_table_name(category_name);
            if (!table_config) {
                table_config = table_config_new(category_name);
                AST_LIST_INSERT_HEAD(&table_configs, table_config, entry);
                if (is_general)
                    base_table_config = table_config;
                if (is_config)
                    static_table_config = table_config;
            }
            for (; var; var = var->next) {
                if (!strcasecmp(var->name, "additionalFilter")) {
                    table_config->additional_filter = ast_strdup(var->value);
                } else {
                    if (!is_general || config_can_be_inherited(var->name)) {
                        ldap_table_config_add_attribute(table_config, var->name, var->value);
                    }
                }
            }
        }
    }
 
    ast_config_destroy(config);
 
    return 1;
}

References ldap_table_config::additional_filter, ast_category_browse(), ast_config_destroy(), ast_config_load, ast_copy_string(), AST_LIST_INSERT_HEAD, ast_log, ast_strdup, ast_strlen_zero(), ast_variable_browse(), ast_variable_retrieve(), base_distinguished_name, base_table_config, config, config_can_be_inherited(), CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEMISSING, ldap_table_config::entry, ldap_table_config_add_attribute(), LOG_ERROR, LOG_NOTICE, LOG_WARNING, NULL, pass, RES_CONFIG_LDAP_CONF, RES_CONFIG_LDAP_DEFAULT_BASEDN, static_table_config, table_config_for_table_name(), table_config_new(), table_configs_free(), url, var, and version.

Referenced by load_module(), load_module(), load_module(), load_module(), load_module(), reload(), reload(), reload(), reload(), and reload().

realtime_arguments_to_fields()

static struct ast_variable * realtime_arguments_to_fields ( va_list  ap )

static

Definition at line 1011 of file res_config_ldap.c.

{
    struct ast_variable *fields = NULL;
    const char *newparam, *newval;
 
    while ((newparam = va_arg(ap, const char *))) {
        struct ast_variable *field;
 
        newval = va_arg(ap, const char *);
        if (!(field = ast_variable_new(newparam, newval, ""))) {
            ast_variables_destroy(fields);
            return NULL;
        }
 
        field->next = fields;
        fields = field;
    }
 
    return fields;
}

References ast_variable_new, ast_variables_destroy(), ast_variable::next, and NULL.

realtime_ldap()

static struct ast_variable * realtime_ldap ( const char *  basedn, const char *  table_name, const struct ast_variable *  fields  )

static

See Asterisk doc.

For Realtime Dynamic(i.e., switch, queues, and directory)

Definition at line 1054 of file res_config_ldap.c.

{
    struct ast_variable **vars = realtime_ldap_base_ap(NULL, basedn, table_name, fields);
    struct ast_variable *var = NULL;
 
    if (vars) {
        struct ast_variable *last_var = NULL;
        struct ast_variable **p = vars;
 
        /* Chain the vars array of lists into one list to return. */
        while (*p) {
            if (last_var) {
                while (last_var->next) {
                    last_var = last_var->next;
                }
                last_var->next = *p;
            } else {
                var = *p;
                last_var = var;
            }
            p++;
        }
        ast_free(vars);
    }
    return var;
}

References ast_free, ast_variable::next, NULL, realtime_ldap_base_ap(), and var.

realtime_ldap_base()

static struct ast_variable ** realtime_ldap_base ( unsigned int *  entries_count_ptr, const char *  basedn, const char *  table_name,   ...  )

static

same as realtime_ldap_base_ap but take variable arguments count list

Definition at line 1034 of file res_config_ldap.c.

{
    RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
    struct ast_variable **vars = NULL;
    va_list ap;
 
    va_start(ap, table_name);
    fields = realtime_arguments_to_fields(ap);
    va_end(ap);
 
    vars = realtime_ldap_base_ap(entries_count_ptr, basedn, table_name, fields);
 
    return vars;
}

References ast_variables_destroy(), NULL, RAII_VAR, realtime_arguments_to_fields, and realtime_ldap_base_ap().

Referenced by config_ldap().

realtime_ldap_base_ap()

static struct ast_variable ** realtime_ldap_base_ap ( unsigned int *  entries_count_ptr, const char *  basedn, const char *  table_name, const struct ast_variable *  fields  )

static

LDAP base function.

Returns

a null terminated array of ast_variable (one per entry) or NULL if no entry is found or if an error occured caller should free the returned array and ast_variables

Parameters

entries_count_ptr	is a pointer to found entries count (can be NULL)
basedn	is the base DN
table_name	is the table_name (used dor attribute convertion and additional filter)
fields	contains list of pairs name/value

Todo:

get the default variables from the accountBaseDN, not implemented with delimited values

Todo:

XXX The interactions with base_var and append_var may cause a memory leak of base_var nodes. Also the append_var list and base_var list may get cross linked.

Definition at line 861 of file res_config_ldap.c.

{
    struct ast_variable **vars = NULL;
    const struct ast_variable *field = fields;
    struct ldap_table_config *table_config = NULL;
    char *clean_basedn = cleaned_basedn(NULL, basedn);
    struct ast_str *filter = NULL;
    int tries = 0;
    int result = 0;
    LDAPMessage *ldap_result_msg = NULL;
 
    if (!table_name) {
        ast_log(LOG_ERROR, "No table_name specified.\n");
        ast_free(clean_basedn);
        return NULL;
    }
 
    if (!field) {
        ast_log(LOG_ERROR, "Realtime retrieval requires at least 1 parameter"
            " and 1 value to search on.\n");
        ast_free(clean_basedn);
        return NULL;
    }
 
    ast_mutex_lock(&ldap_lock);
 
    /* We now have our complete statement; Lets connect to the server and execute it.  */
    if (!ldap_reconnect()) {
        ast_mutex_unlock(&ldap_lock);
        ast_free(clean_basedn);
        return NULL;
    }
 
    table_config = table_config_for_table_name(table_name);
    if (!table_config) {
        ast_log(LOG_WARNING, "No table named '%s'.\n", table_name);
        ast_mutex_unlock(&ldap_lock);
        ast_free(clean_basedn);
        return NULL;
    }
 
    filter = create_lookup_filter(table_config, fields);
    if (!filter) {
        ast_mutex_unlock(&ldap_lock);
        ast_free(clean_basedn);
        return NULL;
    }
 
    do {
        /* freeing ldap_result further down */
        result = ldap_search_ext_s(ldapConn, clean_basedn,
                  LDAP_SCOPE_SUBTREE, ast_str_buffer(filter), NULL, 0, NULL, NULL, NULL, LDAP_NO_LIMIT,
                  &ldap_result_msg);
        if (result != LDAP_SUCCESS && is_ldap_connect_error(result)) {
            ast_debug(1, "Failed to query directory. Try %d/10\n", tries + 1);
            if (++tries < 10) {
                usleep(1);
                if (ldapConn) {
                    ldap_unbind_ext_s(ldapConn, NULL, NULL);
                    ldapConn = NULL;
                }
                if (!ldap_reconnect()) {
                    break;
                }
            }
        }
    } while (result != LDAP_SUCCESS && tries < 10 && is_ldap_connect_error(result));
 
    if (result != LDAP_SUCCESS) {
        ast_log(LOG_WARNING, "Failed to query directory. Error: %s.\n", ldap_err2string(result));
        ast_log(LOG_WARNING, "Query: %s\n", ast_str_buffer(filter));
    } else {
        /* this is where we create the variables from the search result
         * freeing this \a vars outside this function */
        if (ldap_count_entries(ldapConn, ldap_result_msg) > 0) {
            /* is this a static var or some other? they are handled different for delimited values */
            vars = realtime_ldap_result_to_vars(table_config, ldap_result_msg, entries_count_ptr);
        } else {
            ast_debug(1, "Could not find any entry matching %s in base dn %s.\n", ast_str_buffer(filter), clean_basedn);
        }
 
        ldap_msgfree(ldap_result_msg);
 
        /*! \todo get the default variables from the accountBaseDN, not implemented with delimited values
         */
        if (vars) {
            struct ast_variable **p = vars;
            while (*p) {
                struct ast_variable *append_var = NULL;
                struct ast_variable *tmp = *p;
                while (tmp) {
                    if (strcasecmp(tmp->name, "accountBaseDN") == 0) {
                        /* Get the variable to compare with for the defaults */
                        struct ast_variable *base_var = ldap_loadentry(table_config, tmp->value);
 
                        while (base_var) {
                            struct ast_variable *next = base_var->next;
                            struct ast_variable *test_var = *p;
                            int base_var_found = 0;
 
                            /* run throught the default values and fill it inn if it is missing */
                            while (test_var) {
                                if (strcasecmp(test_var->name, base_var->name) == 0) {
                                    base_var_found = 1;
                                    break;
                                } else {
                                    test_var = test_var->next;
                                }
                            }
                            if (base_var_found) {
                                base_var->next = NULL;
                                ast_variables_destroy(base_var);
                                base_var = next;
                            } else {
                                /*!
                                 * \todo XXX The interactions with base_var and append_var may
                                 * cause a memory leak of base_var nodes.  Also the append_var
                                 * list and base_var list may get cross linked.
                                 */
                                if (append_var) {
                                    base_var->next = append_var;
                                } else {
                                    base_var->next = NULL;
                                }
                                append_var = base_var;
                                base_var = next;
                            }
                        }
                    }
                    if (!tmp->next && append_var) {
                        tmp->next = append_var;
                        tmp = NULL;
                    } else {
                        tmp = tmp->next;
                    }
                }
                p++;
            }
        }
    }
 
    ast_free(filter);
    ast_free(clean_basedn);
 
    ast_mutex_unlock(&ldap_lock);
 
    return vars;
}

References ast_debug, ast_free, ast_log, ast_mutex_lock, ast_mutex_unlock, ast_str_buffer(), ast_variables_destroy(), cleaned_basedn(), create_lookup_filter(), filter(), is_ldap_connect_error(), ldap_loadentry(), ldap_lock, ldap_reconnect(), ldapConn, LOG_ERROR, LOG_WARNING, ast_variable::name, ast_variable::next, NULL, realtime_ldap_result_to_vars(), result, table_config_for_table_name(), and ast_variable::value.

Referenced by realtime_ldap(), realtime_ldap_base(), and realtime_multi_ldap().

realtime_ldap_entry_to_var()

static struct ast_variable * realtime_ldap_entry_to_var ( struct ldap_table_config *  table_config, LDAPMessage *  ldap_entry  )

static

Get variables from ldap entry attributes.

Note

Should be locked before using it

Returns

a linked list of ast_variable variables.

Definition at line 308 of file res_config_ldap.c.

{
    BerElement *ber = NULL;
    struct ast_variable *var = NULL;
    struct ast_variable *prev = NULL;
#if 0
    int is_delimited = 0;
    int i = 0;
#endif
    char *ldap_attribute_name;
    struct berval *value;
    int pos = 0;
 
    ldap_attribute_name = ldap_first_attribute(ldapConn, ldap_entry, &ber);
 
    while (ldap_attribute_name) {
        struct berval **values = NULL;
        const char *attribute_name = convert_attribute_name_from_ldap(table_config, ldap_attribute_name);
        int is_realmed_password_attribute = strcasecmp(attribute_name, "md5secret") == 0;
 
        values = ldap_get_values_len(ldapConn, ldap_entry, ldap_attribute_name); /* these are freed at the end */
        if (values) {
            struct berval **v;
            char *valptr;
 
            for (v = values; *v; v++) {
                value = *v;
                valptr = value->bv_val;
                ast_debug(2, "attribute_name: %s LDAP value: %s\n", attribute_name, valptr);
                if (is_realmed_password_attribute) {
                    if (!strncasecmp(valptr, "{md5}", 5)) {
                        valptr += 5;
                    }
                    ast_debug(2, "md5: %s\n", valptr);
                }
                if (valptr) {
#if 0
                    /* ok, so looping through all delimited values except the last one (not, last character is not delimited...) */
                    if (is_delimited) {
                        i = 0;
                        pos = 0;
                        while (!ast_strlen_zero(valptr + i)) {
                            if (valptr[i] == ';') {
                                valptr[i] = '\0';
                                if (prev) {
                                    prev->next = ast_variable_new(attribute_name, &valptr[pos], table_config->table_name);
                                    if (prev->next) {
                                        prev = prev->next;
                                    }
                                } else {
                                    prev = var = ast_variable_new(attribute_name, &valptr[pos], table_config->table_name);
                                }
                                pos = i + 1;
                            }
                            i++;
                        }
                    }
#endif
                    /* for the last delimited value or if the value is not delimited: */
                    if (prev) {
                        prev->next = ast_variable_new(attribute_name, &valptr[pos], table_config->table_name);
                        if (prev->next) {
                            prev = prev->next;
                        }
                    } else {
                        prev = var = ast_variable_new(attribute_name, &valptr[pos], table_config->table_name);
                    }
                }
            }
            ldap_value_free_len(values);
        }
        ldap_memfree(ldap_attribute_name);
        ldap_attribute_name = ldap_next_attribute(ldapConn, ldap_entry, ber);
    }
    ber_free(ber, 0);
 
    return var;
}

References ast_debug, ast_strlen_zero(), ast_variable_new, convert_attribute_name_from_ldap(), ldapConn, ast_variable::next, NULL, ldap_table_config::table_name, value, and var.

Referenced by realtime_ldap_result_to_vars().

realtime_ldap_result_to_vars()

static struct ast_variable ** realtime_ldap_result_to_vars ( struct ldap_table_config *  table_config, LDAPMessage *  ldap_result_msg, unsigned int *  entries_count_ptr  )

static

Get variables from ldap entry attributes - Should be locked before using it.

The results are freed outside this function so is the vars array.

Returns

vars - an array of ast_variable variables terminated with a null.

First find the total count

Note

Now that we have the total count we allocate space and create the variables Remember that each element in vars is a linked list that points to realtime variable. If the we are dealing with a static realtime variable we create a new element in the vars array for each delimited value in variable_value; otherwise, we keep vars static and increase the length of the linked list of variables in the array element. This memory must be freed outside of this function.

For each static realtime variable we may create several entries in the vars array if it's delimited

Definition at line 394 of file res_config_ldap.c.

{
    struct ast_variable **vars;
    int i = 0;
    int tot_count = 0;
    int entry_index = 0;
    LDAPMessage *ldap_entry = NULL;
    BerElement *ber = NULL;
    struct ast_variable *var = NULL;
    struct ast_variable *prev = NULL;
    int is_delimited = 0;
    char *delim_value = NULL;
    int delim_tot_count = 0;
    int delim_count = 0;
 
    /*! \brief First find the total count
     */
    ldap_entry = ldap_first_entry(ldapConn, ldap_result_msg);
 
    for (tot_count = 0; ldap_entry; tot_count++) {
        struct ast_variable *tmp = realtime_ldap_entry_to_var(table_config, ldap_entry);
        tot_count += semicolon_count_var(tmp);
        ldap_entry = ldap_next_entry(ldapConn, ldap_entry);
        ast_variables_destroy(tmp);
    }
 
    if (entries_count_ptr) {
        *entries_count_ptr = tot_count;
    }
 
    /*! \note Now that we have the total count we allocate space and create the variables
     * Remember that each element in vars is a linked list that points to realtime variable.
     * If the we are dealing with a static realtime variable we create a new element in the \a vars array for each delimited
     * value in \a variable_value; otherwise, we keep \a vars static and increase the length of the linked list of variables in the array element.
     * This memory must be freed outside of this function.
     */
    vars = ast_calloc(tot_count + 1, sizeof(struct ast_variable *));
 
    ldap_entry = ldap_first_entry(ldapConn, ldap_result_msg);
 
    i = 0;
 
    /*! \brief For each static realtime variable we may create several entries in the \a vars array if it's delimited
     */
    for (entry_index = 0; ldap_entry; ) {
        int pos = 0;
        delim_value = NULL;
        delim_tot_count = 0;
        delim_count = 0;
 
        do { /* while delim_count */
 
            /* Starting new static var */
            char *ldap_attribute_name = ldap_first_attribute(ldapConn, ldap_entry, &ber);
            struct berval *value;
            while (ldap_attribute_name) {
                const char *attribute_name = convert_attribute_name_from_ldap(table_config, ldap_attribute_name);
                int is_realmed_password_attribute = strcasecmp(attribute_name, "md5secret") == 0;
                struct berval **values = NULL;
 
                values = ldap_get_values_len(ldapConn, ldap_entry, ldap_attribute_name);
                if (values) {
                    struct berval **v;
                    char *valptr;
 
                    for (v = values; *v; v++) {
                        value = *v;
                        valptr = value->bv_val;
                        if (is_realmed_password_attribute) {
                            if (strncasecmp(valptr, "{md5}", 5) == 0) {
                                valptr += 5;
                            }
                            ast_debug(2, "md5: %s\n", valptr);
                        }
                        if (valptr) {
                            if (delim_value == NULL && !is_realmed_password_attribute
                                && (static_table_config != table_config || strcmp(attribute_name, "variable_value") == 0)) {
 
                                delim_value = ast_strdup(valptr);
 
                                if ((delim_tot_count = semicolon_count_str(delim_value)) > 0) {
                                    ast_debug(4, "is delimited %d times: %s\n", delim_tot_count, delim_value);
                                    is_delimited = 1;
                                }
                            }
 
                            if (is_delimited != 0 && !is_realmed_password_attribute
                                && (static_table_config != table_config || strcmp(attribute_name, "variable_value") == 0) ) {
                                /* for non-Static RealTime, first */
 
                                for (i = pos; !ast_strlen_zero(valptr + i); i++) {
                                    ast_debug(4, "DELIM pos: %d i: %d\n", pos, i);
                                    if (delim_value[i] == ';') {
                                        delim_value[i] = '\0';
 
                                        ast_debug(2, "DELIM - attribute_name: %s value: %s pos: %d\n", attribute_name, &delim_value[pos], pos);
 
                                        if (prev) {
                                            prev->next = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
                                            if (prev->next) {
                                                prev = prev->next;
                                            }
                                        } else {
                                            prev = var = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
                                        }
                                        pos = i + 1;
 
                                        if (static_table_config == table_config) {
                                            break;
                                        }
                                    }
                                }
                                if (ast_strlen_zero(valptr + i)) {
                                    ast_debug(4, "DELIM pos: %d i: %d delim_count: %d\n", pos, i, delim_count);
                                    /* Last delimited value */
                                    ast_debug(4, "DELIM - attribute_name: %s value: %s pos: %d\n", attribute_name, &delim_value[pos], pos);
                                    if (prev) {
                                        prev->next = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
                                        if (prev->next) {
                                            prev = prev->next;
                                        }
                                    } else {
                                        prev = var = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
                                    }
                                    /* Remembering to free memory */
                                    is_delimited = 0;
                                    pos = 0;
                                }
                                ast_free(delim_value);
                                delim_value = NULL;
 
                                ast_debug(4, "DELIM pos: %d i: %d\n", pos, i);
                            } else {
                                /* not delimited */
                                if (delim_value) {
                                    ast_free(delim_value);
                                    delim_value = NULL;
                                }
                                ast_debug(2, "attribute_name: %s value: %s\n", attribute_name, valptr);
 
                                if (prev) {
                                    prev->next = ast_variable_new(attribute_name, valptr, table_config->table_name);
                                    if (prev->next) {
                                        prev = prev->next;
                                    }
                                } else {
                                    prev = var = ast_variable_new(attribute_name, valptr, table_config->table_name);
                                }
                            }
                        }
                    } /*!< for (v = values; *v; v++) */
                    ldap_value_free_len(values);
                }/*!< if (values) */
                ldap_memfree(ldap_attribute_name);
                ldap_attribute_name = ldap_next_attribute(ldapConn, ldap_entry, ber);
            } /*!< while (ldap_attribute_name) */
            ber_free(ber, 0);
            if (static_table_config == table_config) {
                if (DEBUG_ATLEAST(3)) {
                    const struct ast_variable *tmpdebug = variable_named(var, "variable_name");
                    const struct ast_variable *tmpdebug2 = variable_named(var, "variable_value");
                    if (tmpdebug && tmpdebug2) {
                        ast_log(LOG_DEBUG, "Added to vars - %s = %s\n", tmpdebug->value, tmpdebug2->value);
                    }
                }
                vars[entry_index++] = var;
                prev = NULL;
            }
 
            delim_count++;
        } while (delim_count <= delim_tot_count && static_table_config == table_config);
 
        if (static_table_config != table_config) {
            ast_debug(3, "Added to vars - non static\n");
 
            vars[entry_index++] = var;
            prev = NULL;
        }
        ldap_entry = ldap_next_entry(ldapConn, ldap_entry);
    } /*!< end for loop over ldap_entry */
 
    return vars;
}

References ast_calloc, ast_debug, ast_free, ast_log, ast_strdup, ast_strlen_zero(), ast_variable_new, ast_variables_destroy(), convert_attribute_name_from_ldap(), DEBUG_ATLEAST, ldapConn, LOG_DEBUG, ast_variable::next, NULL, realtime_ldap_entry_to_var(), semicolon_count_str(), semicolon_count_var(), static_table_config, ldap_table_config::table_name, ast_variable::value, value, var, and variable_named().

Referenced by ldap_loadentry(), and realtime_ldap_base_ap().

realtime_ldap_status()

static char * realtime_ldap_status ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Realtime Status.

Definition at line 2011 of file res_config_ldap.c.

{
    struct ast_str *buf;
    int ctimesec = time(NULL) - connect_time;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime show ldap status";
        e->usage =
            "Usage: realtime show ldap status\n"
            "          Shows connection information for the LDAP RealTime driver\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (!ldapConn)
        return CLI_FAILURE;
 
    buf = ast_str_create(512);
    if (!ast_strlen_zero(url)) {
        ast_str_append(&buf, 0, "Connected to '%s', baseDN %s", url, base_distinguished_name);
    }
 
    if (!ast_strlen_zero(user)) {
        ast_str_append(&buf, 0, " with username %s", user);
    }
 
    ast_str_append(&buf, 0, " for ");
    ast_cli_print_timestr_fromseconds(a->fd, ctimesec, ast_str_buffer(buf));
    ast_free(buf);
 
    return CLI_SUCCESS;
}

References a, ast_cli_print_timestr_fromseconds(), ast_free, ast_str_append(), ast_str_buffer(), ast_str_create, ast_strlen_zero(), base_distinguished_name, buf, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, connect_time, ldapConn, NULL, url, and ast_cli_entry::usage.

realtime_multi_ldap()

static struct ast_config * realtime_multi_ldap ( const char *  basedn, const char *  table_name, const struct ast_variable *  fields  )

static

See Asterisk doc.

this function will be called for the switch statement if no match is found with the realtime_ldap function(i.e. it is a failover); however, the ast_load_realtime wil match on wildcharacters also depending on what the mode is set to this is an area of asterisk that could do with a lot of modification I think this function returns Realtime dynamic objects

Definition at line 1089 of file res_config_ldap.c.

{
    char *op;
    char *initfield = NULL;
    struct ast_variable **vars =
        realtime_ldap_base_ap(NULL, basedn, table_name, fields);
    struct ast_config *cfg = NULL;
 
    if (!fields) {
        ast_log(LOG_WARNING, "realtime retrieval requires at least 1 parameter and 1 value to search on.\n");
        return NULL;
    }
    initfield = ast_strdupa(fields->name);
    if ((op = strchr(initfield, ' '))) {
        *op = '\0';
    }
 
    if (vars) {
        cfg = ast_config_new();
        if (!cfg) {
            ast_log(LOG_ERROR, "Unable to create a config!\n");
        } else {
            struct ast_variable **p = vars;
 
            while (*p) {
                struct ast_category *cat = ast_category_new_anonymous();
                if (!cat) {
                    break;
                } else {
                    struct ast_variable *var = *p;
                    while (var) {
                        struct ast_variable *next = var->next;
                        if (initfield && !strcmp(initfield, var->name)) {
                            ast_category_rename(cat, var->value);
                        }
                        var->next = NULL;
                        ast_variable_append(cat, var);
                        var = next;
                    }
                }
                ast_category_append(cfg, cat);
                p++;
            }
        }
        ast_free(vars);
    }
    return cfg;
 
}

References ast_category_append(), ast_category_new_anonymous, ast_category_rename(), ast_config_new(), ast_free, ast_log, ast_strdupa, ast_variable_append(), LOG_ERROR, LOG_WARNING, ast_variable::name, ast_variable::next, NULL, realtime_ldap_base_ap(), and var.

reload()

static int reload ( void  )

static

Reload Module.

Definition at line 1814 of file res_config_ldap.c.

{
    /* Aquire control before doing anything to the module itself. */
    ast_mutex_lock(&ldap_lock);
 
    if (ldapConn) {
        ldap_unbind_ext_s(ldapConn, NULL, NULL);
        ldapConn = NULL;
    }
 
    if (parse_config() < 0) {
        ast_log(LOG_NOTICE, "Cannot reload LDAP RealTime driver.\n");
        ast_mutex_unlock(&ldap_lock);
        return 0;
    }
 
    if (!ldap_reconnect())  {
        ast_log(LOG_WARNING, "Couldn't establish connection to your directory server. Check debug.\n");
    }
 
    ast_verb(2, "LDAP RealTime driver reloaded.\n");
 
    /* Done reloading. Release lock so others can now use driver. */
    ast_mutex_unlock(&ldap_lock);
 
    return 0;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, ast_verb, ldap_lock, ldap_reconnect(), ldapConn, LOG_NOTICE, LOG_WARNING, NULL, and parse_config().

replace_string_in_string()

static int replace_string_in_string ( char *  string, const char *  search, const char *  by  )

static

Replace <search> by <by> in string.

Note

No check is done on string allocated size !

Definition at line 714 of file res_config_ldap.c.

{
    int search_len = strlen(search);
    int by_len = strlen(by);
    int replaced = 0;
    char *p = strstr(string, search);
 
    if (p) {
        replaced = 1;
        while (p) {
            if (by_len == search_len) {
                memcpy(p, by, by_len);
            } else {
                memmove(p + by_len, p + search_len, strlen(p + search_len) + 1);
                memcpy(p, by, by_len);
            }
            p = strstr(p + by_len, search);
        }
    }
    return replaced;
}

Referenced by append_var_and_value_to_filter().

semicolon_count_str()

static int semicolon_count_str ( const char *  somestr )

static

Count semicolons in string.

Parameters

somestr

- pointer to a string

Returns

number of occurances of the delimiter(semicolon)

Definition at line 169 of file res_config_ldap.c.

{
    int count = 0;
 
    for (; *somestr; somestr++) {
        if (*somestr == ';')
            count++;
    }
 
    return count;
}

Referenced by realtime_ldap_result_to_vars(), and semicolon_count_var().

semicolon_count_var()

static int semicolon_count_var ( struct ast_variable *  var )

static

Count semicolons in variables.

takes a linked list of ast_variable variables, finds the one with the name variable_value and returns the number of semicolons in the value for that ast_variable

Definition at line 187 of file res_config_ldap.c.

{
    struct ast_variable *var_value = variable_named(var, "variable_value");
 
    if (!var_value) {
        return 0;
    }
 
    ast_debug(2, "semicolon_count_var: %s\n", var_value->value);
 
    return semicolon_count_str(var_value->value);
}

References ast_debug, semicolon_count_str(), ast_variable::value, var, and variable_named().

Referenced by realtime_ldap_result_to_vars().

substituted()

static char * substituted ( struct ast_channel *  channel, const char *  string  )

static

Note

caller should free returned pointer

Definition at line 670 of file res_config_ldap.c.

{
#define MAXRESULT   2048
    char *ret_string = NULL;
 
    if (!ast_strlen_zero(string)) {
        ret_string = ast_calloc(1, MAXRESULT);
        pbx_substitute_variables_helper(channel, string, ret_string, MAXRESULT - 1);
    }
    ast_debug(2, "substituted: string: '%s' => '%s' \n", string, ret_string);
    return ret_string;
}

References ast_calloc, ast_debug, ast_strlen_zero(), MAXRESULT, NULL, and pbx_substitute_variables_helper().

Referenced by cleaned_basedn(), and handle_eval_function().

table_config_for_table_name()

static struct ldap_table_config * table_config_for_table_name ( const char *  table_name )

static

Find a table_config.

Should be locked before using it

Note

This function assumes ldap_lock to be locked.

Definition at line 139 of file res_config_ldap.c.

{
    struct ldap_table_config *c = NULL;
 
    AST_LIST_TRAVERSE(&table_configs, c, entry) {
        if (!strcmp(c->table_name, table_name))
            break;
    }
 
    return c;
}

References AST_LIST_TRAVERSE, c, ldap_table_config::entry, NULL, and ldap_table_config::table_name.

Referenced by parse_config(), realtime_ldap_base_ap(), and update2_ldap().

table_config_new()

static struct ldap_table_config * table_config_new ( const char *  table_name )

static

Create a new table_config.

Definition at line 116 of file res_config_ldap.c.

{
    struct ldap_table_config *p;
 
    if (!(p = ast_calloc(1, sizeof(*p))))
        return NULL;
 
    if (table_name) {
        if (!(p->table_name = ast_strdup(table_name))) {
            ast_free(p);
            return NULL;
        }
    }
 
    return p;
}

References ast_calloc, ast_free, ast_strdup, NULL, and ldap_table_config::table_name.

Referenced by parse_config().

table_configs_free()

static void table_configs_free ( void  )

static

Free table_config.

Note

assumes ldap_lock to be locked

Definition at line 227 of file res_config_ldap.c.

{
    struct ldap_table_config *c;
 
    while ((c = AST_LIST_REMOVE_HEAD(&table_configs, entry))) {
        if (c->table_name) {
            ast_free(c->table_name);
        }
        if (c->additional_filter) {
            ast_free(c->additional_filter);
        }
        if (c->attributes) {
            ast_variables_destroy(c->attributes);
        }
        ast_free(c);
    }
 
    base_table_config = NULL;
    static_table_config = NULL;
}

References ast_free, AST_LIST_REMOVE_HEAD, ast_variables_destroy(), base_table_config, c, ldap_table_config::entry, NULL, and static_table_config.

Referenced by parse_config(), and unload_module().

unload_module()

static int unload_module ( void  )

static

Unload Module.

Definition at line 1791 of file res_config_ldap.c.

{
    /* Aquire control before doing anything to the module itself. */
    ast_mutex_lock(&ldap_lock);
 
    table_configs_free();
 
    if (ldapConn) {
        ldap_unbind_ext_s(ldapConn, NULL, NULL);
        ldapConn = NULL;
    }
    ast_cli_unregister_multiple(ldap_cli, ARRAY_LEN(ldap_cli));
    ast_config_engine_deregister(&ldap_engine);
    ast_verb(1, "LDAP RealTime driver unloaded.\n");
 
    /* Unlock so something else can destroy the lock. */
    ast_mutex_unlock(&ldap_lock);
 
    return 0;
}

References ARRAY_LEN, ast_cli_unregister_multiple(), ast_config_engine_deregister(), ast_mutex_lock, ast_mutex_unlock, ast_verb, ldap_cli, ldap_engine, ldap_lock, ldapConn, NULL, and table_configs_free().

update2_ldap()

static int update2_ldap ( const char *  basedn, const char *  table_name, const struct ast_variable *  lookup_fields, const struct ast_variable *  update_fields  )

static

Definition at line 1542 of file res_config_ldap.c.

{
    const struct ast_variable *field;
    struct ldap_table_config *table_config = NULL;
    char *clean_basedn = NULL;
    struct ast_str *filter = NULL;
    int search_result = 0;
    int res = -1;
    int tries = 0;
    size_t update_count, update_index, entry_count;
 
    LDAPMessage *ldap_entry = NULL;
    LDAPMod **modifications;
    LDAPMessage *ldap_result_msg = NULL;
 
    if (!table_name) {
        ast_log(LOG_ERROR, "No table_name specified.\n");
        return res;
    }
 
    update_count = variables_count(update_fields);
    if (!update_count) {
        ast_log(LOG_WARNING, "Need at least one parameter to modify.\n");
        return res;
    }
 
    ast_mutex_lock(&ldap_lock);
 
    /* We now have our complete statement; Lets connect to the server and execute it.  */
    if (!ldap_reconnect()) {
        ast_mutex_unlock(&ldap_lock);
        return res;
    }
 
    table_config = table_config_for_table_name(table_name);
    if (!table_config) {
        ast_log(LOG_ERROR, "No table named '%s'.\n", table_name);
        ast_mutex_unlock(&ldap_lock);
        return res;
    }
 
    clean_basedn = cleaned_basedn(NULL, basedn);
 
    filter = create_lookup_filter(table_config, lookup_fields);
    if (!filter) {
        ast_mutex_unlock(&ldap_lock);
        ast_free(clean_basedn);
        return res;
    }
 
    /*
     * Find LDAP records that match our lookup filter. If there are none, then
     * we don't go through the hassle of building our modifications list.
     */
 
    do {
        search_result = ldap_search_ext_s(
                ldapConn,
                clean_basedn,
                LDAP_SCOPE_SUBTREE,
                ast_str_buffer(filter),
                NULL, 0, NULL, NULL, NULL,
                LDAP_NO_LIMIT,
                &ldap_result_msg);
        if (search_result != LDAP_SUCCESS && is_ldap_connect_error(search_result)) {
            ast_log(LOG_WARNING, "Failed to query directory. Try %d/3\n", tries + 1);
            tries++;
            if (tries < 3) {
                usleep(500000L * tries);
                if (ldapConn) {
                    ldap_unbind_ext_s(ldapConn, NULL, NULL);
                    ldapConn = NULL;
                }
                if (!ldap_reconnect()) {
                    break;
                }
            }
        }
    } while (search_result != LDAP_SUCCESS && tries < 3 && is_ldap_connect_error(search_result));
 
    if (search_result != LDAP_SUCCESS) {
        ast_log(LOG_WARNING, "Failed to query directory. Error: %s.\n", ldap_err2string(search_result));
        ast_log(LOG_WARNING, "Query: %s\n", ast_str_buffer(filter));
        goto early_bailout;
    }
 
    entry_count = ldap_count_entries(ldapConn, ldap_result_msg);
    if (!entry_count) {
        /* Nothing found, nothing to update */
        res = 0;
        goto early_bailout;
    }
 
    /* We need to NULL terminate, so we allocate one more than we need */
    modifications = ldap_memcalloc(update_count + 1, sizeof(LDAPMod *));
    if (!modifications) {
        ast_log(LOG_ERROR, "Memory allocation failure\n");
        goto early_bailout;
    }
 
    /*
     * Create the modification array with the parameter/value pairs we were given,
     * if there are several parameters with the same name, we collect them into
     * one parameter/value pair and delimit them with a semicolon
     */
    for (field = update_fields, update_index = 0; field; field = field->next) {
        LDAPMod *mod;
 
        const char *ldap_attribute_name = convert_attribute_name_to_ldap(
                table_config,
                field->name);
 
        /* See if we already have it */
        mod = ldap_mod_find(modifications, ldap_attribute_name);
        if (mod) {
            mod = ldap_mod_append(mod, field->value);
            if (!mod) {
                goto late_bailout;
            }
        } else {
            mod = ldap_mod_create(ldap_attribute_name, field->value);
            if (!mod) {
                goto late_bailout;
            }
            modifications[update_index++] = mod;
        }
    }
 
    /* Ready to update */
    ast_debug(3, "Modifying %zu matched entries\n", entry_count);
    if (DEBUG_ATLEAST(3)) {
        size_t i;
        for (i = 0; modifications[i]; i++) {
            if (modifications[i]->mod_op != LDAP_MOD_DELETE) {
                ast_log(LOG_DEBUG, "%s => %s\n", modifications[i]->mod_type,
                    modifications[i]->mod_values[0]);
            } else {
                ast_log(LOG_DEBUG, "deleting %s\n", modifications[i]->mod_type);
            }
        }
    }
 
    for (ldap_entry = ldap_first_entry(ldapConn, ldap_result_msg);
        ldap_entry;
        ldap_entry = ldap_next_entry(ldapConn, ldap_entry)) {
        int error;
        LDAPMod **massaged, **working;
 
        char *dn = ldap_get_dn(ldapConn, ldap_entry);
        if (!dn) {
            ast_log(LOG_ERROR, "Memory allocation failure\n");
            goto late_bailout;
        }
 
        working = modifications;
 
        massaged = massage_mods_for_entry(ldap_entry, modifications);
        if (massaged) {
            /* Did we massage everything out of the list? */
            if (!massaged[0]) {
                ast_debug(3, "Nothing left to modify - skipping\n");
                ldap_mods_free(massaged, 1);
                ldap_memfree(dn);
                continue;
            }
            working = massaged;
        }
 
        if ((error = ldap_modify_ext_s(ldapConn, dn, working, NULL, NULL)) != LDAP_SUCCESS)  {
            ast_log(LOG_ERROR, "Couldn't modify dn:%s because %s", dn, ldap_err2string(error));
        }
 
        if (massaged) {
            ldap_mods_free(massaged, 1);
        }
 
        ldap_memfree(dn);
    }
 
    res = entry_count;
 
late_bailout:
    ldap_mods_free(modifications, 1);
 
early_bailout:
    ldap_msgfree(ldap_result_msg);
    ast_free(filter);
    ast_free(clean_basedn);
    ast_mutex_unlock(&ldap_lock);
 
    return res;
}

References ast_debug, ast_free, ast_log, ast_mutex_lock, ast_mutex_unlock, ast_str_buffer(), cleaned_basedn(), convert_attribute_name_to_ldap(), create_lookup_filter(), DEBUG_ATLEAST, error(), filter(), is_ldap_connect_error(), ldap_lock, ldap_mod_append(), ldap_mod_create(), ldap_mod_find(), ldap_reconnect(), ldapConn, LOG_DEBUG, LOG_ERROR, LOG_WARNING, massage_mods_for_entry(), ast_variable::name, ast_variable::next, NULL, table_config_for_table_name(), ast_variable::value, and variables_count().

Referenced by update_ldap().

update_ldap()

static int update_ldap ( const char *  basedn, const char *  table_name, const char *  attribute, const char *  lookup, const struct ast_variable *  fields  )

static

Definition at line 1735 of file res_config_ldap.c.

{
    int res;
    struct ast_variable *lookup_fields = ast_variable_new(attribute, lookup, "");
    res = update2_ldap(basedn, table_name, lookup_fields, fields);
    ast_variables_destroy(lookup_fields);
    return res;
}

References ast_variable_new, ast_variables_destroy(), and update2_ldap().

variable_named()

static struct ast_variable * variable_named ( struct ast_variable *  var, const char *  name  )

static

Find variable by name.

Definition at line 153 of file res_config_ldap.c.

{
    for (; var; var = var->next) {
        if (!strcasecmp(name, var->name))
            break;
    }
 
    return var;
}

References name, and var.

Referenced by config_ldap(), realtime_ldap_result_to_vars(), and semicolon_count_var().

variables_count()

static size_t variables_count ( const struct ast_variable *  vars )

static

Definition at line 1532 of file res_config_ldap.c.

{
    const struct ast_variable *var;
    size_t count = 0;
    for (var = vars; var; var = var->next) {
        count++;
    }
    return count;
}

References ast_variable::next, and var.

Referenced by update2_ldap().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "LDAP realtime interface" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_REALTIME_DRIVER, .requires = "extconfig", }

static

Module Information.

Definition at line 2056 of file res_config_ldap.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 2056 of file res_config_ldap.c.

base_distinguished_name

char base_distinguished_name[512]

static

Definition at line 77 of file res_config_ldap.c.

Referenced by parse_config(), and realtime_ldap_status().

base_table_config

struct ldap_table_config* base_table_config

static

Definition at line 107 of file res_config_ldap.c.

Referenced by convert_attribute_name_from_ldap(), convert_attribute_name_to_ldap(), create_lookup_filter(), parse_config(), and table_configs_free().

connect_time

time_t connect_time

static

Definition at line 79 of file res_config_ldap.c.

Referenced by ldap_reconnect(), and realtime_ldap_status().

ldap_cli

struct ast_cli_entry ldap_cli[]

static

Initial value:

= {
    { .handler =  realtime_ldap_status , .summary =  "Shows connection information for the LDAP RealTime driver" ,},
}

Definition at line 110 of file res_config_ldap.c.

                                         {
    AST_CLI_DEFINE(realtime_ldap_status, "Shows connection information for the LDAP RealTime driver"),
};

Referenced by load_module(), and unload_module().

ldap_engine

struct ast_config_engine ldap_engine

static

Definition at line 1744 of file res_config_ldap.c.

                                              {
    .name = "ldap",
    .load_func = config_ldap,
    .realtime_func = realtime_ldap,
    .realtime_multi_func = realtime_multi_ldap,
    .update_func = update_ldap,
    .update2_func = update2_ldap,
};

Referenced by load_module(), and unload_module().

ldap_lock

ast_mutex_t ldap_lock = AST_MUTEX_INIT_VALUE

static

Definition at line 71 of file res_config_ldap.c.

Referenced by ldap_loadentry(), load_module(), realtime_ldap_base_ap(), reload(), unload_module(), and update2_ldap().

ldapConn

LDAP* ldapConn

static

Definition at line 73 of file res_config_ldap.c.

Referenced by ldap_entry_has_attribute(), ldap_loadentry(), ldap_reconnect(), realtime_ldap_base_ap(), realtime_ldap_entry_to_var(), realtime_ldap_result_to_vars(), realtime_ldap_status(), reload(), unload_module(), and update2_ldap().

pass

char pass[512]

static

Definition at line 76 of file res_config_ldap.c.

Referenced by __ast_dsp_call_progress(), build_transactions(), ldap_reconnect(), manager_login(), and parse_config().

static_table_config

struct ldap_table_config* static_table_config

static

Definition at line 108 of file res_config_ldap.c.

Referenced by parse_config(), realtime_ldap_result_to_vars(), and table_configs_free().

table_configs

struct table_configs table_configs = AST_LIST_HEAD_NOLOCK_INIT_VALUE

static

url

char url[512]

static

Definition at line 74 of file res_config_ldap.c.

Referenced by acf_curl_exec(), aeap_create(), aeap_transport_connect(), aeap_transport_create_and_connect(), ast_aeap_connect(), ast_aeap_create_and_connect(), ast_ari_response_created(), ast_channel_sendurl(), caldav_load_calendar(), config_curl(), curl_download_to_file(), curl_download_to_memory(), curler(), destroy_curl(), dial_exec_full(), ewscal_load_calendar(), exchangecal_load_calendar(), fetch_access_token(), fetch_google_access_token(), ical_load_calendar(), ldap_reconnect(), load_module(), parse_config(), queue_exec(), queue_match(), realtime_curl(), realtime_ldap_status(), realtime_multi_curl(), require_curl(), store_curl(), try_calling(), update2_curl(), update_curl(), url_is_vulnerable(), and websocket_connect().

user

char user[512]

static

Definition at line 75 of file res_config_ldap.c.

version

int version

static

Definition at line 78 of file res_config_ldap.c.

Referenced by ldap_reconnect(), and parse_config().