tn_config.c File Reference

#include "asterisk.h"
#include <sys/stat.h>
#include "asterisk/cli.h"
#include "asterisk/module.h"
#include "asterisk/sorcery.h"
#include "stir_shaken.h"

Include dependency graph for tn_config.c:

Go to the source code of this file.

Macros
#define	_TRACE_PREFIX_   "tc",__LINE__, ""
#define	CONFIG_TYPE   "tn"
#define	DEFAULT_attest_level   attest_level_NOT_SET
#define	DEFAULT_check_tn_cert_public_url   check_tn_cert_public_url_NOT_SET
#define	DEFAULT_private_key_file   NULL
#define	DEFAULT_public_cert_url   NULL
#define	DEFAULT_send_mky   send_mky_NOT_SET

Functions
static char *	cli_tn_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_tn_show_all (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static void *	etn_alloc (const char *name)
	generate_acfg_common_sorcery_handlers (tn_cfg)
static struct ao2_container *	get_tn_all (void)
static int	init_tn (struct tn_cfg *cfg)
static void *	tn_alloc (const char *name)
static int	tn_apply (const struct ast_sorcery *sorcery, void *obj)
int	tn_config_load (void)
int	tn_config_reload (void)
int	tn_config_unload (void)
static void	tn_destructor (void *obj)
struct tn_cfg *	tn_get_cfg (const char *id)
struct tn_cfg *	tn_get_etn (const char *id, struct profile_cfg *eprofile)

Variables
static struct ast_cli_entry	stir_shaken_certificate_cli []

Macro Definition Documentation

_TRACE_PREFIX_

#define _TRACE_PREFIX_   "tc",__LINE__, ""

Definition at line 19 of file tn_config.c.

CONFIG_TYPE

#define CONFIG_TYPE   "tn"

Definition at line 31 of file tn_config.c.

DEFAULT_attest_level

#define DEFAULT_attest_level   attest_level_NOT_SET

Definition at line 36 of file tn_config.c.

DEFAULT_check_tn_cert_public_url

#define DEFAULT_check_tn_cert_public_url   check_tn_cert_public_url_NOT_SET

Definition at line 33 of file tn_config.c.

DEFAULT_private_key_file

#define DEFAULT_private_key_file   NULL

Definition at line 34 of file tn_config.c.

DEFAULT_public_cert_url

#define DEFAULT_public_cert_url   NULL

Definition at line 35 of file tn_config.c.

DEFAULT_send_mky

#define DEFAULT_send_mky   send_mky_NOT_SET

Definition at line 37 of file tn_config.c.

Function Documentation

cli_tn_show()

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

static

Definition at line 213 of file tn_config.c.

{
    struct tn_cfg *cfg;
    struct config_object_cli_data data = {
        .title = "TN",
        .object_type = config_object_type_tn,
    };
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "stir_shaken show tn";
        e->usage =
            "Usage: stir_shaken show tn <id>\n"
            "       Show the settings for a given TN\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 3) {
            return config_object_tab_complete_name(a->word, get_tn_all());
        } else {
            return NULL;
        }
    }
 
    if (a->argc != 4) {
        return CLI_SHOWUSAGE;
    }
 
    cfg = tn_get_cfg(a->argv[3]);
    config_object_cli_show(cfg, a, &data, 0);
    ao2_cleanup(cfg);
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, config_object_cli_show(), config_object_tab_complete_name(), config_object_type_tn, get_tn_all(), NULL, config_object_cli_data::title, tn_get_cfg(), and ast_cli_entry::usage.

cli_tn_show_all()

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

static

Definition at line 177 of file tn_config.c.

{
    struct ao2_container *container;
    struct config_object_cli_data data = {
        .title = "TN",
        .object_type = config_object_type_tn,
    };
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "stir_shaken show tns";
        e->usage =
            "Usage: stir_shaken show tns\n"
            "       Show all attestation TNs\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 3) {
        return CLI_SHOWUSAGE;
    }
 
    container = get_tn_all();
    if (!container || ao2_container_count(container) == 0) {
        ast_cli(a->fd, "No stir/shaken TNs found\n");
        ao2_cleanup(container);
        return CLI_SUCCESS;
    }
 
    ao2_callback_data(container, OBJ_NODATA, config_object_cli_show, a,&data);
    ao2_ref(container, -1);
 
    return CLI_SUCCESS;
}

References a, ao2_callback_data, ao2_cleanup, ao2_container_count(), ao2_ref, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, config_object_cli_show(), config_object_type_tn, container, get_tn_all(), NULL, OBJ_NODATA, config_object_cli_data::title, and ast_cli_entry::usage.

etn_alloc()

static void * etn_alloc ( const char *  name )

static

Definition at line 95 of file tn_config.c.

{
    struct tn_cfg *cfg;
 
    cfg = ao2_alloc_options(sizeof(*cfg), tn_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
    if (!cfg) {
        return NULL;
    }
 
    if (init_tn(cfg) != 0) {
        ao2_cleanup(cfg);
        cfg = NULL;
    }
    return cfg;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_cleanup, init_tn(), NULL, and tn_destructor().

Referenced by tn_get_etn().

generate_acfg_common_sorcery_handlers()

generate_acfg_common_sorcery_handlers

(

tn_cfg

)

get_tn_all()

static struct ao2_container * get_tn_all ( void  )

static

Definition at line 44 of file tn_config.c.

{
    return ast_sorcery_retrieve_by_fields(get_sorcery(), CONFIG_TYPE,
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), CONFIG_TYPE, get_sorcery(), and NULL.

Referenced by cli_tn_show(), and cli_tn_show_all().

init_tn()

static int init_tn ( struct tn_cfg *  cfg )

static

Definition at line 60 of file tn_config.c.

{
    if (ast_string_field_init(cfg, 1024)) {
        return -1;
    }
 
    /*
     * The memory for the commons actually comes from cfg
     * due to the weirdness of the STRFLDSET macro used with
     * sorcery.  We just use a token amount of memory in
     * this call so the initialize doesn't fail.
     */
    if (ast_string_field_init(&cfg->acfg_common, 8)) {
        return -1;
    }
 
    return 0;
}

References tn_cfg::acfg_common, and ast_string_field_init.

Referenced by etn_alloc(), and tn_alloc().

tn_alloc()

static void * tn_alloc ( const char *  name )

static

Definition at line 79 of file tn_config.c.

{
    struct tn_cfg *cfg;
 
    cfg = ast_sorcery_generic_alloc(sizeof(*cfg), tn_destructor);
    if (!cfg) {
        return NULL;
    }
 
    if (init_tn(cfg) != 0) {
        ao2_cleanup(cfg);
        cfg = NULL;
    }
    return cfg;
}

References ao2_cleanup, ast_sorcery_generic_alloc(), init_tn(), NULL, and tn_destructor().

Referenced by tn_config_load().

tn_apply()

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

static

Definition at line 164 of file tn_config.c.

{
    struct tn_cfg *cfg = obj;
    const char *id = ast_sorcery_object_get_id(cfg);
    int rc = 0;
 
    if (as_check_common_config(id, &cfg->acfg_common) != 0) {
        return -1;
    }
 
    return rc;
}

References tn_cfg::acfg_common, as_check_common_config(), and ast_sorcery_object_get_id().

Referenced by tn_config_load().

tn_config_load()

int tn_config_load

(

void

)

Definition at line 268 of file tn_config.c.

{
    struct ast_sorcery *sorcery = get_sorcery();
 
    ast_sorcery_apply_default(sorcery, CONFIG_TYPE, "config", "stir_shaken.conf,criteria=type=tn");
 
    if (ast_sorcery_object_register(sorcery, CONFIG_TYPE, tn_alloc,
            NULL, tn_apply)) {
        ast_log(LOG_ERROR, "stir/shaken - failed to register '%s' sorcery object\n", CONFIG_TYPE);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_object_field_register(sorcery, CONFIG_TYPE, "type", "",
        OPT_NOOP_T, 0, 0);
 
    register_common_attestation_fields(sorcery, tn_cfg, CONFIG_TYPE,);
 
    ast_sorcery_load_object(sorcery, CONFIG_TYPE);
 
    ast_cli_register_multiple(stir_shaken_certificate_cli,
        ARRAY_LEN(stir_shaken_certificate_cli));
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_sorcery_apply_default, ast_sorcery_load_object(), ast_sorcery_object_field_register, ast_sorcery_object_register, CONFIG_TYPE, get_sorcery(), LOG_ERROR, NULL, OPT_NOOP_T, register_common_attestation_fields, sorcery, stir_shaken_certificate_cli, tn_alloc(), and tn_apply().

Referenced by common_config_load().

tn_config_reload()

int tn_config_reload

(

void

)

Definition at line 253 of file tn_config.c.

{
    struct ast_sorcery *sorcery = get_sorcery();
    ast_sorcery_force_reload_object(sorcery, CONFIG_TYPE);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, ast_sorcery_force_reload_object(), CONFIG_TYPE, get_sorcery(), and sorcery.

Referenced by common_config_reload().

tn_config_unload()

int tn_config_unload

(

void

)

Definition at line 260 of file tn_config.c.

{
    ast_cli_unregister_multiple(stir_shaken_certificate_cli,
        ARRAY_LEN(stir_shaken_certificate_cli));
 
    return 0;
}

References ARRAY_LEN, ast_cli_unregister_multiple(), and stir_shaken_certificate_cli.

Referenced by common_config_unload().

tn_destructor()

static void tn_destructor ( void *  obj )

static

Definition at line 52 of file tn_config.c.

{
    struct tn_cfg *cfg = obj;
 
    ast_string_field_free_memory(cfg);
    acfg_cleanup(&cfg->acfg_common);
}

References acfg_cleanup(), tn_cfg::acfg_common, and ast_string_field_free_memory.

Referenced by etn_alloc(), and tn_alloc().

tn_get_cfg()

struct tn_cfg * tn_get_cfg

(

const char *

id

)

Definition at line 39 of file tn_config.c.

{
    return ast_sorcery_retrieve_by_id(get_sorcery(), CONFIG_TYPE, id);
}

References ast_sorcery_retrieve_by_id(), CONFIG_TYPE, and get_sorcery().

Referenced by cli_tn_show().

tn_get_etn()

struct tn_cfg * tn_get_etn	(	const char *	id,
		struct profile_cfg *	eprofile
	)

Definition at line 111 of file tn_config.c.

{
    const char *profile_id = eprofile ? ast_sorcery_object_get_id(eprofile) : "unknown";
    RAII_VAR(struct tn_cfg *, tn,
        ast_sorcery_retrieve_by_id(get_sorcery(), CONFIG_TYPE, S_OR(id, "")),
        ao2_cleanup);
    RAII_VAR(struct tn_cfg *, etn, etn_alloc(id), ao2_cleanup);
    enum attest_level_enum effective_al = attest_level_NOT_SET;
    int rc = 0;
    SCOPE_ENTER(3, "%s:%s: Getting effective TN\n", profile_id, S_OR(id, ""));
 
    if (ast_strlen_zero(id) || !eprofile || !etn) {
        SCOPE_EXIT_RTN_VALUE(NULL, "Missing params\n");
    }
 
    if (!tn) {
        if (eprofile->unknown_tn_attest_level != attest_level_NOT_SET
            && eprofile->unknown_tn_attest_level != attest_level_UNKNOWN) {
            effective_al = eprofile->unknown_tn_attest_level;
            ast_trace(-1, "%s:%s: TN not found. Using unknown_tn_attest_level %s\n",
                profile_id, id, attest_level_to_str(effective_al));
        } else {
            SCOPE_EXIT_RTN_VALUE(NULL, "%s:%s: TN not found and unknown_tn_attest_level not set\n", profile_id, id);
        }
    }
 
    /* Initialize with the acfg from the eprofile first */
    rc = as_copy_cfg_common(id, &etn->acfg_common,
        &eprofile->acfg_common);
    if (rc != 0) {
        SCOPE_EXIT_RTN_VALUE(NULL, "%s:%s: Couldn't copy from eprofile\n", profile_id, id);
    }
 
    /* Overwrite with anything in the TN itself */
    if (tn) {
        rc = as_copy_cfg_common(id, &etn->acfg_common,
            &tn->acfg_common);
        if (rc != 0) {
            SCOPE_EXIT_RTN_VALUE(NULL, "%s:%s: Couldn't copy from tn\n", profile_id, id);
        }
    } else {
        etn->acfg_common.attest_level = effective_al;
    }
 
    /*
     * Unlike profile, we're not going to actually add a
     * new object to sorcery because, although unlikely,
     * the same TN could be used with multiple profiles.
     */
 
    SCOPE_EXIT_RTN_VALUE(ao2_bump(etn), "%s:%s: Done\n", profile_id, id);
}

References profile_cfg::acfg_common, ao2_bump, ao2_cleanup, as_copy_cfg_common(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_strlen_zero(), ast_trace, CONFIG_TYPE, etn_alloc(), get_sorcery(), NULL, RAII_VAR, S_OR, SCOPE_ENTER, SCOPE_EXIT_RTN_VALUE, and profile_cfg::unknown_tn_attest_level.

Referenced by ast_stir_shaken_as_ctx_create().

Variable Documentation

stir_shaken_certificate_cli

struct ast_cli_entry stir_shaken_certificate_cli[]

static

Initial value:

= {
    { .handler =  cli_tn_show , .summary =  "Show stir/shaken TN configuration by id" ,},
    { .handler =  cli_tn_show_all , .summary =  "Show all stir/shaken attestation TN configurations" ,},
}

Definition at line 248 of file tn_config.c.

Referenced by tn_config_load(), and tn_config_unload().