res/ari/config.c File Reference

Config framework stuffz for ARI. More...

#include <limits.h>
#include "asterisk.h"
#include "asterisk/sorcery.h"
#include "asterisk/config_options.h"
#include "asterisk/http_websocket.h"
#include "asterisk/websocket_client.h"
#include "asterisk/app.h"
#include "asterisk/channel.h"
#include "asterisk/vector.h"
#include "internal.h"

Include dependency graph for res/ari/config.c:

Go to the source code of this file.

Data Structures
struct	outbound_websocket_state

Macros
#define	MAX_VARS   128
#define	OWC_STATES_BUCKETS   13

Functions
void	ari_conf_destroy (void)
	Destroy the ARI configuration. More...
struct ari_conf_general *	ari_conf_get_general (void)
struct ari_conf_outbound_websocket *	ari_conf_get_owc (const char *id)
struct ari_conf_outbound_websocket *	ari_conf_get_owc_for_app (const char *app_name, unsigned int ws_type)
	Get the outbound websocket configuration for a Stasis app. More...
struct ao2_container *	ari_conf_get_owcs (void)
struct ari_conf_user *	ari_conf_get_user (const char *username)
struct ao2_container *	ari_conf_get_users (void)
static int	ari_conf_init (void)
int	ari_conf_load (enum ari_conf_load_flags flags)
	(Re)load the ARI configuration More...
enum ari_conf_owc_fields	ari_conf_owc_detect_changes (struct ari_conf_outbound_websocket *old_owc, struct ari_conf_outbound_websocket *new_owc)
	Detect changes between two outbound websocket configurations. More...
enum ari_conf_owc_fields	ari_conf_owc_get_invalid_fields (const char *id)
struct ari_conf_user *	ari_conf_validate_user (const char *username, const char *password)
	Validated a user's credentials. More...
int	ari_sorcery_observer_add (const char *object_type, const struct ast_sorcery_observer *callbacks)
int	ari_sorcery_observer_remove (const char *object_type, const struct ast_sorcery_observer *callbacks)
const char *	ari_websocket_type_to_str (enum ast_websocket_type type)
static void *	general_alloc (const char *name)
static int	general_apply (const struct ast_sorcery *sorcery, void *obj)
static void	general_dtor (void *obj)
	ast_ari_conf destructor. More...
static int	general_pretty_from_str (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Encoding format handler converts from boolean to enum. More...
static int	general_pretty_to_str (const void *obj, const intptr_t *args, char **buf)
static void *	outbound_websocket_alloc (const char *id)
static int	outbound_websocket_apply (const struct ast_sorcery *sorcery, void *obj)
	Callback to initialize an outbound websocket object. More...
static void	outbound_websocket_dtor (void *obj)
static int	outbound_websocket_state_cleanup (void *obj, void *arg, int flags)
static int	outbound_websocket_validate_cb (void *obj, void *args, int flags)
static int	outbound_websocket_websocket_client_id_from_str (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	outbound_websocket_websocket_client_id_to_str (const void *obj, const intptr_t *args, char **buf)
static void	outbound_websockets_validate (const char *name)
static void *	user_alloc (const char *cat)
	Allocate an ast_ari_conf_user for config parsing. More...
static int	user_apply (const struct ast_sorcery *sorcery, void *obj)
static void	user_dtor (void *obj)
	Destructor for ast_ari_conf_user. More...
static int	user_password_format_from_str (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Parses the ast_ari_password_format enum from a config file. More...
static int	user_password_format_to_str (const void *obj, const intptr_t *args, char **buf)
static void	ws_client_load (const char *name)

Variables
static struct ast_sorcery_observer	observer_callbacks
struct ao2_container *	owc_states = NULL
static struct ast_sorcery *	sorcery
static struct ast_sorcery_observer	ws_client_observer_callbacks

Detailed Description

Config framework stuffz for ARI.

Author

David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file res/ari/config.c.

Macro Definition Documentation

MAX_VARS

#define MAX_VARS   128

Definition at line 447 of file res/ari/config.c.

OWC_STATES_BUCKETS

#define OWC_STATES_BUCKETS   13

Definition at line 45 of file res/ari/config.c.

Function Documentation

ari_conf_destroy()

void ari_conf_destroy

(

void

)

Destroy the ARI configuration.

Definition at line 789 of file res/ari/config.c.

{
    ast_websocket_client_observer_remove(&ws_client_observer_callbacks);
 
    ast_sorcery_unref(sorcery);
    sorcery = NULL;
    ao2_cleanup(owc_states);
}

References ao2_cleanup, ast_sorcery_unref, ast_websocket_client_observer_remove(), NULL, owc_states, sorcery, and ws_client_observer_callbacks.

Referenced by unload_module().

ari_conf_get_general()

struct ari_conf_general * ari_conf_get_general

(

void

)

Definition at line 477 of file res/ari/config.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(sorcery, "general", "general");
}

References ast_sorcery_retrieve_by_id(), NULL, and sorcery.

Referenced by ari_show(), ast_ari_invoke(), ast_ari_json_format(), is_enabled(), origin_allowed(), and session_update().

ari_conf_get_owc()

struct ari_conf_outbound_websocket * ari_conf_get_owc

(

const char *

id

)

Definition at line 308 of file res/ari/config.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(sorcery, "outbound_websocket", id);
}

References ast_sorcery_retrieve_by_id(), NULL, and sorcery.

Referenced by ari_show_owc(), ari_start_owc(), outbound_sessions_load(), and outbound_websocket_state_cleanup().

ari_conf_get_owc_for_app()

struct ari_conf_outbound_websocket * ari_conf_get_owc_for_app	(	const char *	app_name,
		unsigned int	ws_type
	)

Get the outbound websocket configuration for a Stasis app.

Parameters

app_name	The application name to search for.
ws_type	An OR'd list of ari_websocket_types or ARI_WS_TYPE_ANY.

Return values

ARI	outbound websocket configuration object.
NULL	if not found.

Definition at line 317 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = NULL;
    struct ao2_container *owcs = NULL;
    struct ao2_iterator i;
 
    if (ast_strlen_zero(app_name)) {
        return NULL;
    }
 
    ast_debug(3, "Checking outbound websockets for app '%s'\n", app_name);
 
    owcs = ari_conf_get_owcs();
    if (!owcs || ao2_container_count(owcs) == 0) {
        ast_debug(3, "No outbound websockets found\n");
        return NULL;
    }
 
    i = ao2_iterator_init(owcs, 0);
    while ((owc = ao2_iterator_next(&i))) {
        const char *id = ast_sorcery_object_get_id(owc);
 
        ast_debug(3, "%s: Checking outbound websocket apps '%s' for app '%s'\n",
            id, owc->apps, app_name);
        if (owc->websocket_client->connection_type & ws_type
            && ast_in_delimited_string(app_name, owc->apps, ',')) {
            ast_debug(3, "%s: Found correct websocket type for apps '%s' for app '%s'\n",
                id, owc->apps, app_name);
            break;
        }
        ao2_cleanup(owc);
    }
    ao2_iterator_destroy(&i);
    ao2_cleanup(owcs);
    if (!owc) {
        ast_debug(3, "No outbound websocket found for app '%s'\n", app_name);
    }
 
    return owc;
}

References ao2_cleanup, ao2_container_count(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, app_name(), ari_conf_outbound_websocket::apps, ari_conf_get_owcs(), ast_debug, ast_in_delimited_string(), ast_sorcery_object_get_id(), ast_strlen_zero(), ast_websocket_client::connection_type, NULL, and ari_conf_outbound_websocket::websocket_client.

Referenced by ast_ari_create_per_call_websocket().

ari_conf_get_owcs()

struct ao2_container * ari_conf_get_owcs

(

void

)

Definition at line 298 of file res/ari/config.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_fields(sorcery, "outbound_websocket",
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), NULL, and sorcery.

Referenced by ari_conf_get_owc_for_app(), ari_show_owc(), ari_show_owcs(), ari_start_owc(), outbound_sessions_load(), outbound_websocket_validate_cb(), and outbound_websockets_validate().

ari_conf_get_user()

struct ari_conf_user * ari_conf_get_user

(

const char *

username

)

Definition at line 578 of file res/ari/config.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(sorcery, "user", username);
}

References ast_sorcery_retrieve_by_id(), NULL, and sorcery.

Referenced by ari_show_user().

ari_conf_get_users()

struct ao2_container * ari_conf_get_users

(

void

)

Definition at line 568 of file res/ari/config.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_fields(sorcery, "user",
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), NULL, and sorcery.

Referenced by ari_show_user(), and ari_show_users().

ari_conf_init()

static int ari_conf_init ( void  )

static

Definition at line 658 of file res/ari/config.c.

{
    int res = 0;
    ast_debug(2, "Initializing ARI configuration\n");
 
    owc_states = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX,
        AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, OWC_STATES_BUCKETS,
        outbound_websocket_state_hash_fn, NULL,
        outbound_websocket_state_cmp_fn);
    if (!owc_states) {
        ast_log(LOG_ERROR, "Failed to allocate outbound websocket states\n");
        return -1;
    }
 
    if (!(sorcery = ast_sorcery_open())) {
        ast_log(LOG_ERROR, "Failed to open sorcery\n");
        return -1;
    }
 
    ast_sorcery_apply_default(sorcery, "general", "config",
        "ari.conf,criteria=type=general,single_object=yes,explicit_name=general");
    ast_sorcery_apply_default(sorcery, "user", "config",
        "ari.conf,criteria=type=user");
    ast_sorcery_apply_default(sorcery, "outbound_websocket", "config",
        "ari.conf,criteria=type=outbound_websocket");
 
    if (ast_sorcery_object_register(sorcery, "general", general_alloc, NULL, general_apply)) {
        ast_log(LOG_ERROR, "Failed to register ARI general object with sorcery\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    if (ast_sorcery_object_register(sorcery, "user", user_alloc, NULL, user_apply)) {
        ast_log(LOG_ERROR, "Failed to register ARI user object with sorcery\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    if (ast_sorcery_object_register(sorcery, "outbound_websocket", outbound_websocket_alloc,
        NULL, outbound_websocket_apply)) {
        ast_log(LOG_ERROR, "Failed to register ARI outbound_websocket object with sorcery\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    if (ast_sorcery_observer_add(sorcery, "outbound_websocket", &observer_callbacks)) {
        ast_log(LOG_ERROR, "Failed to register ARI outbound_websocket observer with sorcery\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    ast_sorcery_object_field_register_nodoc(sorcery, "general", "type", "", OPT_NOOP_T, 0, 0);
    ast_sorcery_register_sf(general, ari_conf_general, auth_realm, auth_realm, "Asterisk REST Interface");
    ast_sorcery_register_sf(general, ari_conf_general, allowed_origins, allowed_origins, "");
    ast_sorcery_register_sf(general, ari_conf_general, channelvars, channelvars, "");
    ast_sorcery_register_bool(general, ari_conf_general, enabled, enabled, "yes");
    ast_sorcery_register_cust(general, pretty, "no");
    ast_sorcery_register_int(general, ari_conf_general, websocket_write_timeout, write_timeout,
        AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT);
 
 
    ast_sorcery_object_field_register(sorcery, "user", "type", "", OPT_NOOP_T, 0, 0);
    ast_sorcery_register_sf(user, ari_conf_user, password, password, "");
    ast_sorcery_register_bool(user, ari_conf_user, read_only, read_only, "no");
    ast_sorcery_register_cust(user, password_format, "plain");
 
    ast_sorcery_object_field_register(sorcery, "outbound_websocket", "type", "", OPT_NOOP_T, 0, 0);
    ast_sorcery_register_cust(outbound_websocket, websocket_client_id, "");
    ast_sorcery_register_sf(outbound_websocket, ari_conf_outbound_websocket, apps, apps, "");
    ast_sorcery_register_sf(outbound_websocket, ari_conf_outbound_websocket, local_ari_user, local_ari_user, "");
    ast_sorcery_register_bool(outbound_websocket, ari_conf_outbound_websocket, subscribe_all, subscribe_all, "no");
 
    res = ast_websocket_client_observer_add(&ws_client_observer_callbacks);
    if (res < 0) {
        ast_log(LOG_WARNING, "Failed to register websocket client observer\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    return 0;
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ast_debug, AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT, ast_log, ast_sorcery_apply_default, ast_sorcery_object_field_register, ast_sorcery_object_field_register_nodoc, ast_sorcery_object_register, ast_sorcery_observer_add(), ast_sorcery_open, ast_sorcery_register_bool, ast_sorcery_register_cust, ast_sorcery_register_int, ast_sorcery_register_sf, ast_sorcery_unref, ast_websocket_client_observer_add(), enabled, general_alloc(), general_apply(), LOG_ERROR, LOG_WARNING, NULL, observer_callbacks, OPT_NOOP_T, outbound_websocket_alloc(), outbound_websocket_apply(), owc_states, OWC_STATES_BUCKETS, sorcery, subscribe_all(), user_alloc(), user_apply(), and ws_client_observer_callbacks.

Referenced by ari_conf_load().

ari_conf_load()

int ari_conf_load

(

enum ari_conf_load_flags

flags

)

(Re)load the ARI configuration

Definition at line 745 of file res/ari/config.c.

{
    void (*loader)(const struct ast_sorcery *sorcery, const char *type);
    const char *msg_prefix;
 
    if (flags & ARI_CONF_RELOAD) {
        loader = ast_sorcery_reload_object;
        msg_prefix= "Reloading";
        ast_websocket_client_reload();
    } else {
        loader = ast_sorcery_load_object;
        msg_prefix= "Loading";
    }
 
    if (flags & ARI_CONF_INIT) {
        if (ari_conf_init() != 0) {
            ast_log(LOG_ERROR, "Failed to initialize ARI configuration\n");
            return -1;
        }
    }
 
    if (!sorcery) {
        ast_log(LOG_ERROR, "ARI configuration not initialized\n");
        return -1;
    }
 
    if (flags & ARI_CONF_LOAD_GENERAL) {
        ast_debug(2, "%s ARI '%s' configuration\n", msg_prefix, "general");
        loader(sorcery, "general");
    }
 
    if (flags & ARI_CONF_LOAD_USER) {
        ast_debug(2, "%s ARI '%s' configuration\n", msg_prefix, "user");
        loader(sorcery, "user");
    }
 
    if (flags & ARI_CONF_LOAD_OWC) {
        ast_debug(2, "%s ARI '%s' configuration\n", msg_prefix, "outbound_websocket");
        loader(sorcery, "outbound_websocket");
    }
 
    return 0;
}

References ari_conf_init(), ARI_CONF_INIT, ARI_CONF_LOAD_GENERAL, ARI_CONF_LOAD_OWC, ARI_CONF_LOAD_USER, ARI_CONF_RELOAD, ast_debug, ast_log, ast_sorcery_load_object(), ast_sorcery_reload_object(), ast_websocket_client_reload(), LOG_ERROR, sorcery, and type.

Referenced by load_module(), and reload_module().

ari_conf_owc_detect_changes()

enum ari_conf_owc_fields ari_conf_owc_detect_changes	(	struct ari_conf_outbound_websocket *	old_owc,
		struct ari_conf_outbound_websocket *	new_owc
	)

Detect changes between two outbound websocket configurations.

Parameters

old_owc	The old outbound websocket configuration.
new_owc	The new outbound websocket configuration.

Returns

A bitmask of changed fields.

Definition at line 377 of file res/ari/config.c.

{
    enum ari_conf_owc_fields changed = ARI_OWC_FIELD_NONE;
    const char *new_id = ast_sorcery_object_get_id(new_owc);
    RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);
    struct ast_variable *v = NULL;
    int res = 0;
    int changes_found = 0;
 
    ast_debug(2, "%s: Detecting changes\n", new_id);
 
    res = ast_sorcery_diff(sorcery, old_owc, new_owc, &changes);
    if (res != 0) {
        ast_log(LOG_WARNING, "%s: Failed to create changeset\n", new_id);
        return ARI_OWC_FIELD_NONE;
    }
 
    for (v = changes; v; v = v->next) {
        changes_found = 1;
        ast_debug(2, "%s: %s changed to %s\n", new_id, v->name, v->value);
        if (ast_strings_equal(v->name, "apps")) {
            changed |= ARI_OWC_FIELD_APPS;
        } else if (ast_strings_equal(v->name, "subscribe_all")) {
            changed |= ARI_OWC_FIELD_SUBSCRIBE_ALL;
        } else if (ast_strings_equal(v->name, "local_ari_user")) {
            changed |= ARI_OWC_FIELD_LOCAL_ARI_USER;
        } else if (ast_strings_equal(v->name, "local_ari_password")) {
            changed |= ARI_OWC_FIELD_LOCAL_ARI_PASSWORD;
        } else {
            ast_debug(2, "%s: Unknown change %s\n", new_id, v->name);
        }
    }
    if (!changes_found) {
        ast_debug(2, "%s: No changes found %p %p\n", new_id,
            old_owc->websocket_client,new_owc->websocket_client);
    }
 
    changed |= ast_websocket_client_get_field_diff(
        old_owc->websocket_client, new_owc->websocket_client);
 
    return changed;
 
}

References ARI_OWC_FIELD_APPS, ARI_OWC_FIELD_LOCAL_ARI_PASSWORD, ARI_OWC_FIELD_LOCAL_ARI_USER, ARI_OWC_FIELD_NONE, ARI_OWC_FIELD_SUBSCRIBE_ALL, ast_debug, ast_log, ast_sorcery_diff(), ast_sorcery_object_get_id(), ast_strings_equal(), ast_variables_destroy(), ast_websocket_client_get_field_diff(), LOG_WARNING, ast_variable::name, ast_variable::next, NULL, RAII_VAR, sorcery, ast_variable::value, and ari_conf_outbound_websocket::websocket_client.

Referenced by outbound_session_apply_config().

ari_conf_owc_get_invalid_fields()

enum ari_conf_owc_fields ari_conf_owc_get_invalid_fields

(

const char *

id

)

Definition at line 158 of file res/ari/config.c.

{
    RAII_VAR(struct outbound_websocket_state *, state, NULL, ao2_cleanup);
 
    state = ao2_find(owc_states, id, OBJ_SEARCH_KEY);
    return state ? state->invalid_fields : ARI_OWC_FIELD_NONE;
}

References ao2_cleanup, ao2_find, ARI_OWC_FIELD_NONE, NULL, OBJ_SEARCH_KEY, owc_states, and RAII_VAR.

Referenced by ari_show_owc(), ast_ari_create_per_call_websocket(), outbound_session_create(), and show_owc_cb().

ari_conf_validate_user()

struct ari_conf_user * ari_conf_validate_user	(	const char *	username,
		const char *	password
	)

Validated a user's credentials.

Parameters

username	Name of the user.
password	User's password.

Returns

User object.

Return values

NULL	if username or password is invalid.

Definition at line 591 of file res/ari/config.c.

{
    struct ari_conf_user *user = NULL;
    int is_valid = 0;
 
    if (ast_strlen_zero(username) || ast_strlen_zero(password)) {
        return NULL;
    }
 
    user = ast_sorcery_retrieve_by_id(sorcery, "user", username);
    if (!user) {
        return NULL;
    }
 
    switch (user->password_format) {
    case ARI_PASSWORD_FORMAT_PLAIN:
        is_valid = strcmp(password, user->password) == 0;
        break;
    case ARI_PASSWORD_FORMAT_CRYPT:
        is_valid = ast_crypt_validate(password, user->password);
        break;
    }
 
    if (!is_valid) {
        ao2_cleanup(user);
        user = NULL;
    }
 
    return user;
}

References ao2_cleanup, ARI_PASSWORD_FORMAT_CRYPT, ARI_PASSWORD_FORMAT_PLAIN, ast_crypt_validate(), ast_sorcery_retrieve_by_id(), ast_strlen_zero(), NULL, ari_conf_user::password, sorcery, and user.

Referenced by authenticate_api_key(), and authenticate_user().

ari_sorcery_observer_add()

int ari_sorcery_observer_add	(	const char *	object_type,
		const struct ast_sorcery_observer *	callbacks
	)

Definition at line 623 of file res/ari/config.c.

{
    if (!sorcery) {
        return -1;
    }
    return ast_sorcery_observer_add(sorcery, object_type, callbacks);
}

References ast_sorcery_observer_add(), callbacks, and sorcery.

Referenced by ari_websocket_load_module().

ari_sorcery_observer_remove()

int ari_sorcery_observer_remove	(	const char *	object_type,
		const struct ast_sorcery_observer *	callbacks
	)

Definition at line 632 of file res/ari/config.c.

{
    if (!sorcery) {
        return -1;
    }
    ast_sorcery_observer_remove(sorcery, object_type, callbacks);
    return 0;
}

References ast_sorcery_observer_remove(), callbacks, and sorcery.

Referenced by ari_websocket_unload_module().

ari_websocket_type_to_str()

const char * ari_websocket_type_to_str

(

enum ast_websocket_type

type

)

Definition at line 359 of file res/ari/config.c.

{
    switch (type) {
    case AST_WS_TYPE_CLIENT_PERSISTENT:
        return "persistent";
    case AST_WS_TYPE_CLIENT_PER_CALL:
        return "per_call";
    case AST_WS_TYPE_CLIENT_PER_CALL_CONFIG:
        return "per_call_config";
    case AST_WS_TYPE_INBOUND:
        return "inbound";
    case AST_WS_TYPE_ANY:
        return "any";
    default:
        return "unknown";
    }
}

References AST_WS_TYPE_ANY, AST_WS_TYPE_CLIENT_PER_CALL, AST_WS_TYPE_CLIENT_PER_CALL_CONFIG, AST_WS_TYPE_CLIENT_PERSISTENT, AST_WS_TYPE_INBOUND, and type.

Referenced by ari_show_owc(), session_shutdown_cb(), show_owc_cb(), and show_sessions_cb().

general_alloc()

static void * general_alloc ( const char *  name )

static

Definition at line 431 of file res/ari/config.c.

{
    struct ari_conf_general *general = ast_sorcery_generic_alloc(
        sizeof(*general), general_dtor);
 
    if (!general) {
        return NULL;
    }
 
    if (ast_string_field_init(general, 64) != 0) {
        return NULL;
    }
 
    return general;
}

References ast_sorcery_generic_alloc(), ast_string_field_init, general_dtor(), and NULL.

Referenced by ari_conf_init().

general_apply()

static int general_apply ( const struct ast_sorcery *  sorcery, void *  obj  )

static

Definition at line 449 of file res/ari/config.c.

{
    struct ari_conf_general *general = obj;
    char *parse = NULL;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(vars)[MAX_VARS];
    );
 
    ast_debug(2, "Initializing general config\n");
 
    parse = ast_strdupa(general->channelvars);
    AST_STANDARD_APP_ARGS(args, parse);
 
    ast_channel_set_ari_vars(args.argc, args.vars);
    return 0;
}

References args, AST_APP_ARG, ast_channel_set_ari_vars(), ast_debug, AST_DECLARE_APP_ARGS, AST_STANDARD_APP_ARGS, ast_strdupa, ari_conf_general::channelvars, MAX_VARS, and NULL.

Referenced by ari_conf_init().

general_dtor()

static void general_dtor ( void *  obj )

static

ast_ari_conf destructor.

Definition at line 424 of file res/ari/config.c.

{
    struct ari_conf_general *cfg = obj;
 
    ast_string_field_free_memory(cfg);
}

References ast_string_field_free_memory.

Referenced by general_alloc().

general_pretty_from_str()

static int general_pretty_from_str ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Encoding format handler converts from boolean to enum.

Definition at line 467 of file res/ari/config.c.

{
    struct ari_conf_general *general = obj;
 
    general->format = ast_true(var->value) ? AST_JSON_PRETTY : AST_JSON_COMPACT;
 
    return 0;
}

References AST_JSON_COMPACT, AST_JSON_PRETTY, ast_true(), ari_conf_general::format, and var.

general_pretty_to_str()

static int general_pretty_to_str ( const void *  obj, const intptr_t *  args, char **  buf  )

static

Definition at line 486 of file res/ari/config.c.

{
    const struct ari_conf_general *general = obj;
 
    if (general->format == AST_JSON_PRETTY) {
        *buf = ast_strdup("yes");
    } else {
        *buf = ast_strdup("no");
    }
    return 0;
}

References AST_JSON_PRETTY, ast_strdup, buf, and ari_conf_general::format.

outbound_websocket_alloc()

static void * outbound_websocket_alloc ( const char *  id )

static

Definition at line 59 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = NULL;
 
    owc = ast_sorcery_generic_alloc(sizeof(*owc), outbound_websocket_dtor);
    if (!owc) {
        return NULL;
    }
 
    if (ast_string_field_init(owc, 1024) != 0) {
        ao2_cleanup(owc);
        return NULL;
    }
 
    ast_debug(2, "%s: Allocated outbound websocket config\n", id);
    return owc;
}

References ao2_cleanup, ast_debug, ast_sorcery_generic_alloc(), ast_string_field_init, NULL, and outbound_websocket_dtor().

Referenced by ari_conf_init().

outbound_websocket_apply()

static int outbound_websocket_apply ( const struct ast_sorcery *  sorcery, void *  obj  )

static

Callback to initialize an outbound websocket object.

Return values

0	on success
CMP_MATCH	on error which will cause the object to be removed

Definition at line 114 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = obj;
    const char *id = ast_sorcery_object_get_id(owc);
    int res = 0;
 
    ast_debug(3, "%s: Initializing outbound websocket\n", id);
 
    if (ast_strlen_zero(owc->apps)) {
        ast_log(LOG_WARNING, "%s: Outbound websocket missing apps\n", id);
        res = -1;
    } else {
        char *apps = ast_strdupa(owc->apps);
        char *app;
        while ((app = ast_strsep(&apps, ',', AST_STRSEP_STRIP))) {
 
            if (ast_strlen_zero(app)) {
                ast_log(LOG_WARNING, "%s: Outbound websocket has empty app\n", id);
                res = -1;
            }
            if (strlen(app) > ARI_MAX_APP_NAME_LEN) {
                ast_log(LOG_WARNING, "%s: Outbound websocket app '%s' > %d characters\n",
                    id, app, (int)ARI_MAX_APP_NAME_LEN);
                res = -1;
            }
 
        }
    }
 
    if (ast_strlen_zero(owc->local_ari_user)) {
        ast_log(LOG_WARNING, "%s: Outbound websocket missing local_ari_user\n", id);
        res = -1;
    }
 
    if (res != 0) {
        ast_log(LOG_WARNING, "%s: Outbound websocket configuration failed\n", id);
    } else {
        ast_debug(3, "%s: Outbound websocket configuration succeeded\n", id);
    }
 
    /* Reminder: If res is -1, the config will be discarded. */
    return res;
}

References app, ari_conf_outbound_websocket::apps, ARI_MAX_APP_NAME_LEN, ast_debug, ast_log, ast_sorcery_object_get_id(), ast_strdupa, ast_strlen_zero(), ast_strsep(), AST_STRSEP_STRIP, ari_conf_outbound_websocket::local_ari_user, and LOG_WARNING.

Referenced by ari_conf_init().

outbound_websocket_dtor()

static void outbound_websocket_dtor ( void *  obj )

static

Definition at line 48 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = obj;
 
    ast_debug(3, "%s: Disposing of outbound websocket config\n",
        ast_sorcery_object_get_id(owc));
    ast_string_field_free_memory(owc);
    ao2_cleanup(owc->websocket_client);
    owc->websocket_client = NULL;
}

References ao2_cleanup, ast_debug, ast_sorcery_object_get_id(), ast_string_field_free_memory, NULL, and ari_conf_outbound_websocket::websocket_client.

Referenced by outbound_websocket_alloc().

outbound_websocket_state_cleanup()

static int outbound_websocket_state_cleanup ( void *  obj, void *  arg, int  flags  )

static

Definition at line 273 of file res/ari/config.c.

{
    struct outbound_websocket_state *state = obj;
    struct ari_conf_outbound_websocket *owc = ari_conf_get_owc(state->id);
    int res = 0;
 
    if (!owc) {
        ast_debug(3, "%s: Cleaning up orphaned outbound websocket state\n", state->id);
        res = CMP_MATCH;
    }
    ao2_cleanup(owc);
 
    return res;
}

References ao2_cleanup, ari_conf_get_owc(), ast_debug, and CMP_MATCH.

Referenced by outbound_websockets_validate().

outbound_websocket_validate_cb()

static int outbound_websocket_validate_cb ( void *  obj, void *  args, int  flags  )

static

Definition at line 166 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = obj;
    struct ari_conf_outbound_websocket *other_owc = NULL;
    RAII_VAR(struct ao2_container *, owcs, NULL, ao2_cleanup);
    struct ao2_iterator it;
    const char *id = ast_sorcery_object_get_id(owc);
    struct ast_vector_string apps = { 0, };
    struct ari_conf_user *user = NULL;
    struct outbound_websocket_state *state = NULL;
    int res = 0;
 
    ast_debug(2, "%s: Validating outbound websocket\n", id);
 
    owcs = ari_conf_get_owcs();
    if (!owcs || ao2_container_count(owcs) == 0) {
        return 0;
    }
 
    if (AST_VECTOR_INIT(&apps, 5) != 0) {
        return 0;
    }
 
    res = ast_vector_string_split(&apps, owc->apps, ",", 0, NULL);
    if (res != 0) {
        ast_log(LOG_WARNING, "%s: Outbound websocket apps '%s' failed to split\n",
            id, owc->apps);
        AST_VECTOR_RESET(&apps, ast_free_ptr);
        AST_VECTOR_FREE(&apps);
        return 0;
    }
 
    state = ao2_find(owc_states, id, OBJ_SEARCH_KEY);
    if (!state) {
        state = ao2_alloc(sizeof(*state) + strlen(id) + 1, NULL);
        if (!state) {
            ast_log(LOG_WARNING, "%s: Outbound websocket state allocation failed\n", id);
            AST_VECTOR_RESET(&apps, ast_free_ptr);
            AST_VECTOR_FREE(&apps);
            return 0;
        }
        strcpy(state->id, id); /* Safe */
        ast_debug(3, "%s: Created new outbound websocket state\n", id);
    } else {
        ast_debug(3, "%s: Outbound websocket state already exists\n", id);
    }
    state->invalid_fields = ARI_OWC_FIELD_NONE;
 
    /*
     * Check all other owcs to make sure we don't have
     * duplicate apps.
     */
    it = ao2_iterator_init(owcs, 0);
    while ((other_owc = ao2_iterator_next(&it))) {
        const char *other_id = ast_sorcery_object_get_id(other_owc);
        if (!ast_strings_equal(other_id, id)) {
            int i = 0;
            for (i = 0; i < AST_VECTOR_SIZE(&apps); i++) {
                const char *app = AST_VECTOR_GET(&apps, i);
                if (ast_in_delimited_string(app, other_owc->apps, ',')) {
                    ast_log(LOG_WARNING,
                        "%s: Outbound websocket '%s' is also trying to register app '%s'\n",
                        id, other_id, app);
                    state->invalid_fields |= ARI_OWC_FIELD_APPS;
                }
            }
        }
        ao2_cleanup(other_owc);
        if (owc->invalid) {
            break;
        }
    }
    ao2_iterator_destroy(&it);
    AST_VECTOR_RESET(&apps, ast_free_ptr);
    AST_VECTOR_FREE(&apps);
 
    /*
     * Check that the local_ari_user is valid and has
     * a plain text password.
     */
    user = ast_sorcery_retrieve_by_id(sorcery, "user", owc->local_ari_user);
    if (!user) {
        ast_log(LOG_WARNING, "%s: Outbound websocket ARI user '%s' not found\n",
            id, owc->local_ari_user);
        state->invalid_fields |= ARI_OWC_FIELD_LOCAL_ARI_USER;
    } else {
        if (user->password_format != ARI_PASSWORD_FORMAT_PLAIN) {
            ast_log(LOG_WARNING, "%s: Outbound websocket ARI user '%s' password MUST be plain text\n",
                id, owc->local_ari_user);
            state->invalid_fields |= ARI_OWC_FIELD_LOCAL_ARI_USER;
        }
        if (ast_string_field_set(owc, local_ari_password, user->password) != 0) {
            state->invalid_fields |= ARI_OWC_FIELD_LOCAL_ARI_USER;
        }
    }
    ao2_cleanup(user);
 
    /*
     * The container has AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE set so
     * this is an insert or replace operation.
     */
    ao2_link(owc_states, state);
    ao2_cleanup(state);
 
    return 0;
}

References ao2_alloc, ao2_cleanup, ao2_container_count(), ao2_find, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_link, app, ari_conf_outbound_websocket::apps, ari_conf_get_owcs(), ARI_OWC_FIELD_APPS, ARI_OWC_FIELD_LOCAL_ARI_USER, ARI_OWC_FIELD_NONE, ARI_PASSWORD_FORMAT_PLAIN, ast_debug, ast_free_ptr(), ast_in_delimited_string(), ast_log, ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_string_field_set, ast_strings_equal(), AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_RESET, AST_VECTOR_SIZE, ast_vector_string_split(), ari_conf_outbound_websocket::invalid, ari_conf_outbound_websocket::local_ari_user, LOG_WARNING, NULL, OBJ_SEARCH_KEY, owc_states, RAII_VAR, and sorcery.

Referenced by outbound_websockets_validate().

outbound_websocket_websocket_client_id_from_str()

static int outbound_websocket_websocket_client_id_from_str ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Definition at line 77 of file res/ari/config.c.

{
    struct ari_conf_outbound_websocket *owc = obj;
 
    if (ast_strlen_zero(var->value)) {
        ast_log(LOG_ERROR, "%s: Outbound websocket missing websocket client id\n",
            ast_sorcery_object_get_id(owc));
        return -1;
    }
    owc->websocket_client = ast_websocket_client_retrieve_by_id(var->value);
    if (!owc->websocket_client) {
        ast_log(LOG_ERROR, "%s: Outbound websocket invalid websocket client id '%s'\n",
            ast_sorcery_object_get_id(owc), var->value);
        return -1;
    }
    if (ast_string_field_set(owc, websocket_client_id, var->value) != 0) {
        return -1;
    }
    return 0;
}

References ast_log, ast_sorcery_object_get_id(), ast_string_field_set, ast_strlen_zero(), ast_websocket_client_retrieve_by_id(), LOG_ERROR, var, ari_conf_outbound_websocket::websocket_client, and ari_conf_outbound_websocket::websocket_client_id.

outbound_websocket_websocket_client_id_to_str()

static int outbound_websocket_websocket_client_id_to_str ( const void *  obj, const intptr_t *  args, char **  buf  )

static

Definition at line 99 of file res/ari/config.c.

{
    const struct ari_conf_outbound_websocket *owc = obj;
    if (!owc->websocket_client) {
        return -1;
    }
    *buf = ast_strdup(owc->websocket_client_id);
    return 0;
}

References ast_strdup, buf, ari_conf_outbound_websocket::websocket_client, and ari_conf_outbound_websocket::websocket_client_id.

outbound_websockets_validate()

static void outbound_websockets_validate ( const char *  name )

static

Definition at line 288 of file res/ari/config.c.

{
    RAII_VAR(struct ao2_container *, owcs, ari_conf_get_owcs(), ao2_cleanup);
 
    ao2_callback(owcs, OBJ_NODATA, outbound_websocket_validate_cb, NULL);
    /* Clean up any states whose configs have disappeared. */
    ao2_callback(owc_states, OBJ_NODATA | OBJ_UNLINK,
        outbound_websocket_state_cleanup, NULL);
}

References ao2_callback, ao2_cleanup, ari_conf_get_owcs(), NULL, OBJ_NODATA, OBJ_UNLINK, outbound_websocket_state_cleanup(), outbound_websocket_validate_cb(), owc_states, and RAII_VAR.

user_alloc()

static void * user_alloc ( const char *  cat )

static

Allocate an ast_ari_conf_user for config parsing.

Definition at line 507 of file res/ari/config.c.

{
    struct ari_conf_user *user = ast_sorcery_generic_alloc(
        sizeof(*user), user_dtor);
 
    if (!user) {
        return NULL;
    }
 
    if (ast_string_field_init(user, 64) != 0) {
        ao2_cleanup(user);
        user = NULL;
    }
 
    return user;
}

References ao2_cleanup, ast_sorcery_generic_alloc(), ast_string_field_init, NULL, user, and user_dtor().

Referenced by ari_conf_init().

user_apply()

static int user_apply ( const struct ast_sorcery *  sorcery, void *  obj  )

static

Definition at line 524 of file res/ari/config.c.

{
    struct ari_conf_user *user = obj;
    const char *id = ast_sorcery_object_get_id(user);
 
    ast_debug(2, "%s: Initializing user\n", id);
 
    if (ast_strlen_zero(user->password)) {
        ast_log(LOG_WARNING, "%s: User missing password\n", id);
        return -1;
    }
 
    return 0;
}

References ast_debug, ast_log, ast_sorcery_object_get_id(), ast_strlen_zero(), and LOG_WARNING.

Referenced by ari_conf_init().

user_dtor()

static void user_dtor ( void *  obj )

static

Destructor for ast_ari_conf_user.

Definition at line 499 of file res/ari/config.c.

{
    struct ari_conf_user *user = obj;
    ast_string_field_free_memory(user);
    ast_debug(3, "%s: Disposing of user\n", ast_sorcery_object_get_id(user));
}

References ast_debug, ast_sorcery_object_get_id(), and ast_string_field_free_memory.

Referenced by user_alloc().

user_password_format_from_str()

static int user_password_format_from_str ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Parses the ast_ari_password_format enum from a config file.

Definition at line 540 of file res/ari/config.c.

{
    struct ari_conf_user *user = obj;
 
    if (strcasecmp(var->value, "plain") == 0) {
        user->password_format = ARI_PASSWORD_FORMAT_PLAIN;
    } else if (strcasecmp(var->value, "crypt") == 0) {
        user->password_format = ARI_PASSWORD_FORMAT_CRYPT;
    } else {
        return -1;
    }
 
    return 0;
}

References ARI_PASSWORD_FORMAT_CRYPT, ARI_PASSWORD_FORMAT_PLAIN, and var.

user_password_format_to_str()

static int user_password_format_to_str ( const void *  obj, const intptr_t *  args, char **  buf  )

static

Definition at line 556 of file res/ari/config.c.

{
    const struct ari_conf_user *user = obj;
 
    if (user->password_format == ARI_PASSWORD_FORMAT_CRYPT) {
        *buf = ast_strdup("crypt");
    } else {
        *buf = ast_strdup("plain");
    }
    return 0;
}

References ARI_PASSWORD_FORMAT_CRYPT, ast_strdup, and buf.

ws_client_load()

static void ws_client_load ( const char *  name )

static

Definition at line 646 of file res/ari/config.c.

{
    ast_sorcery_force_reload_object(sorcery, "outbound_websocket");
}

References ast_sorcery_force_reload_object(), and sorcery.

Variable Documentation

observer_callbacks

struct ast_sorcery_observer observer_callbacks

static

Initial value:

= {
    .loaded = outbound_websockets_validate,
}

Definition at line 642 of file res/ari/config.c.

Referenced by ari_conf_init().

owc_states

struct ao2_container* owc_states = NULL

Definition at line 46 of file res/ari/config.c.

Referenced by ari_conf_destroy(), ari_conf_init(), ari_conf_owc_get_invalid_fields(), outbound_websocket_validate_cb(), and outbound_websockets_validate().

sorcery

struct ast_sorcery* sorcery

static

Definition at line 38 of file res/ari/config.c.

Referenced by __ast_sorcery_apply_config(), __ast_sorcery_apply_default(), __ast_sorcery_apply_wizard_mapping(), __ast_sorcery_insert_wizard_mapping(), __ast_sorcery_object_field_register(), __ast_sorcery_object_register(), __ast_sorcery_object_type_insert_wizard(), __ast_sorcery_object_type_remove_wizard(), __ast_sorcery_open(), __ast_sorcery_remove_wizard_mapping(), alloc_and_initialize_sorcery(), apply_list_configuration(), ari_conf_destroy(), ari_conf_get_general(), ari_conf_get_owc(), ari_conf_get_owcs(), ari_conf_get_user(), ari_conf_get_users(), ari_conf_init(), ari_conf_load(), ari_conf_owc_detect_changes(), ari_conf_validate_user(), ari_sorcery_observer_add(), ari_sorcery_observer_remove(), as_config_load(), as_config_reload(), ast_ari_asterisk_delete_object(), ast_ari_asterisk_get_object(), ast_ari_asterisk_update_object(), ast_sip_destroy_sorcery_global(), ast_sip_initialize_sorcery_auth(), ast_sip_initialize_sorcery_domain_alias(), ast_sip_initialize_sorcery_global(), ast_sip_initialize_sorcery_location(), ast_sip_initialize_sorcery_transport(), ast_sorcery_alloc(), ast_sorcery_copy(), ast_sorcery_create(), ast_sorcery_delete(), ast_sorcery_diff(), ast_sorcery_force_reload(), ast_sorcery_force_reload_object(), ast_sorcery_get_module(), ast_sorcery_get_object_type(), ast_sorcery_get_wizard_mapping(), ast_sorcery_get_wizard_mapping_count(), ast_sorcery_instance_observer_add(), ast_sorcery_instance_observer_remove(), ast_sorcery_is_stale(), ast_sorcery_load(), ast_sorcery_load_object(), ast_sorcery_object_fields_register(), ast_sorcery_object_set_congestion_levels(), ast_sorcery_object_set_copy_handler(), ast_sorcery_object_set_diff_handler(), ast_sorcery_object_unregister(), ast_sorcery_objectset_apply(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_sorcery_observer_add(), ast_sorcery_observer_remove(), ast_sorcery_ref(), ast_sorcery_reload(), ast_sorcery_reload_object(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_id(), ast_sorcery_retrieve_by_prefix(), ast_sorcery_retrieve_by_regex(), ast_sorcery_update(), AST_TEST_DEFINE(), bucket_file_wizard_create(), bucket_file_wizard_delete(), bucket_file_wizard_is_stale(), bucket_file_wizard_retrieve(), bucket_file_wizard_update(), bucket_http_wizard_retrieve_id(), bucket_wizard_create(), bucket_wizard_delete(), bucket_wizard_is_stale(), bucket_wizard_retrieve(), can_reuse_registration(), create_object(), deinitialize_sorcery(), global_loaded_observer(), handle_aor(), handle_auth(), handle_auths(), handle_endpoint(), handle_export_primitives(), handle_identify(), handle_phoneprov(), handle_registrations(), instance_created_observer(), instance_destroying_observer(), load_module(), memory_cache_full_update(), memory_cache_populate(), memory_cache_stale_check(), memory_cache_stale_check_object(), memory_cache_stale_update_full(), memory_cache_stale_update_object(), mock_retrieve_id(), object_type_loaded_observer(), object_type_registered_observer(), outbound_websocket_validate_cb(), profile_load(), profile_reload(), return_sorcery_object(), sorcery_astdb_create(), sorcery_astdb_filter_objectset(), sorcery_astdb_retrieve_fields(), sorcery_astdb_retrieve_fields_common(), sorcery_astdb_retrieve_id(), sorcery_astdb_retrieve_multiple(), sorcery_astdb_retrieve_prefix(), sorcery_astdb_retrieve_regex(), sorcery_astdb_update(), sorcery_config_internal_load(), sorcery_config_load(), sorcery_config_reload(), sorcery_config_retrieve_fields(), sorcery_config_retrieve_multiple(), sorcery_config_retrieve_prefix(), sorcery_config_retrieve_regex(), sorcery_destructor(), sorcery_function_read(), sorcery_is_configuration_met(), sorcery_is_explicit_name_met(), sorcery_memory_cache_create(), sorcery_memory_cache_load(), sorcery_memory_cache_retrieve_fields(), sorcery_memory_cache_retrieve_id(), sorcery_memory_cache_retrieve_multiple(), sorcery_memory_cache_retrieve_prefix(), sorcery_memory_cache_retrieve_regex(), sorcery_memory_cached_object_alloc(), sorcery_memory_retrieve_fields(), sorcery_memory_retrieve_multiple(), sorcery_memory_retrieve_prefix(), sorcery_memory_retrieve_regex(), sorcery_realtime_create(), sorcery_realtime_filter_objectset(), sorcery_realtime_retrieve_fields(), sorcery_realtime_retrieve_id(), sorcery_realtime_retrieve_multiple(), sorcery_realtime_retrieve_prefix(), sorcery_realtime_retrieve_regex(), sorcery_realtime_update(), sorcery_reloadable(), sorcery_test_retrieve_id(), sorcery_wizard_load(), stale_cache_update_task_data_alloc(), stale_update_task_data_alloc(), tn_config_load(), tn_config_reload(), transport_apply(), vs_config_load(), vs_config_reload(), wizard_apply_handler(), and ws_client_load().

ws_client_observer_callbacks

struct ast_sorcery_observer ws_client_observer_callbacks

static

Initial value:

= {
    .loaded = ws_client_load,
}

Definition at line 651 of file res/ari/config.c.

Referenced by ari_conf_destroy(), and ari_conf_init().