attestation_config.c File Reference

#include "asterisk.h"
#include "asterisk/cli.h"
#include "asterisk/logger.h"
#include "asterisk/sorcery.h"
#include "asterisk/paths.h"
#include "stir_shaken.h"

Include dependency graph for attestation_config.c:

Go to the source code of this file.

Macros
#define	_TRACE_PREFIX_   "ac",__LINE__, ""
#define	CONFIG_TYPE   "attestation"
#define	DEFAULT_attest_level   attest_level_NOT_SET
#define	DEFAULT_check_tn_cert_public_url   check_tn_cert_public_url_NO
#define	DEFAULT_global_disable   0
#define	DEFAULT_private_key_file   NULL
#define	DEFAULT_public_cert_url   NULL
#define	DEFAULT_send_mky   send_mky_NO
#define	DEFAULT_unknown_tn_attest_level   attest_level_NOT_SET

Functions
void	acfg_cleanup (struct attestation_cfg_common *acfg_common)
int	as_check_common_config (const char *id, struct attestation_cfg_common *acfg_common)
int	as_config_load (void)
int	as_config_reload (void)
int	as_config_unload (void)
int	as_copy_cfg_common (const char *id, struct attestation_cfg_common *cfg_dst, struct attestation_cfg_common *cfg_src)
struct attestation_cfg *	as_get_cfg (void)
int	as_is_config_loaded (void)
static void *	attestation_alloc (const char *name)
static int	attestation_apply (const struct ast_sorcery *sorcery, void *obj)
static void	attestation_destructor (void *obj)
static char *	attestation_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	generate_acfg_common_sorcery_handlers (attestation_cfg)
	generate_sorcery_enum_from_str_ex (attestation_cfg,, unknown_tn_attest_level, attest_level, UNKNOWN)
	generate_sorcery_enum_to_str_ex (attestation_cfg,, unknown_tn_attest_level, attest_level)

Variables
static struct ast_cli_entry	attestation_cli []
static struct attestation_cfg *	empty_cfg = NULL

Macro Definition Documentation

_TRACE_PREFIX_

#define _TRACE_PREFIX_   "ac",__LINE__, ""

Definition at line 19 of file attestation_config.c.

CONFIG_TYPE

#define CONFIG_TYPE   "attestation"

Definition at line 30 of file attestation_config.c.

DEFAULT_attest_level

#define DEFAULT_attest_level   attest_level_NOT_SET

Definition at line 37 of file attestation_config.c.

DEFAULT_check_tn_cert_public_url

#define DEFAULT_check_tn_cert_public_url   check_tn_cert_public_url_NO

Definition at line 34 of file attestation_config.c.

DEFAULT_global_disable

#define DEFAULT_global_disable   0

Definition at line 32 of file attestation_config.c.

DEFAULT_private_key_file

#define DEFAULT_private_key_file   NULL

Definition at line 35 of file attestation_config.c.

DEFAULT_public_cert_url

#define DEFAULT_public_cert_url   NULL

Definition at line 36 of file attestation_config.c.

DEFAULT_send_mky

#define DEFAULT_send_mky   send_mky_NO

Definition at line 39 of file attestation_config.c.

DEFAULT_unknown_tn_attest_level

#define DEFAULT_unknown_tn_attest_level   attest_level_NOT_SET

Definition at line 38 of file attestation_config.c.

Function Documentation

acfg_cleanup()

void acfg_cleanup

(

struct attestation_cfg_common *

acfg_common

)

Definition at line 68 of file attestation_config.c.

{
    if (!acfg_common) {
        return;
    }
    ast_string_field_free_memory(acfg_common);
    ao2_cleanup(acfg_common->raw_key);
}

References attestation_cfg::acfg_common, ao2_cleanup, ast_string_field_free_memory, and attestation_cfg_common::raw_key.

Referenced by attestation_destructor(), profile_destructor(), and tn_destructor().

as_check_common_config()

int as_check_common_config	(	const char *	id,
		struct attestation_cfg_common *	acfg_common
	)

Definition at line 139 of file attestation_config.c.

{
    SCOPE_ENTER(3, "%s: Checking common config\n", id);
 
    if (!ast_strlen_zero(acfg_common->private_key_file)
        && !ast_file_is_readable(acfg_common->private_key_file)) {
        SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: default_private_key_path %s is missing or not readable\n", id,
            acfg_common->private_key_file);
    }
 
    if (ENUM_BOOL(acfg_common->check_tn_cert_public_url,
        check_tn_cert_public_url)
        && !ast_strlen_zero(acfg_common->public_cert_url)) {
        RAII_VAR(char *, public_cert_data, NULL, ast_std_free);
        X509 *public_cert;
        size_t public_cert_len;
        int rc = 0;
        long http_code;
        SCOPE_ENTER(3 , "%s: Checking public cert url '%s'\n",
            id, acfg_common->public_cert_url);
 
        http_code = curl_download_to_memory(acfg_common->public_cert_url,
            &public_cert_len, &public_cert_data, NULL);
        if (http_code / 100 != 2) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: public_cert '%s' could not be downloaded\n", id,
                acfg_common->public_cert_url);
        }
 
        public_cert = crypto_load_cert_from_memory(public_cert_data,
            public_cert_len);
        if (!public_cert) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: public_cert '%s' could not be parsed as a certificate\n", id,
                acfg_common->public_cert_url);
        }
        rc = crypto_is_cert_time_valid(public_cert, 0);
        X509_free(public_cert);
        if (!rc) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: public_cert '%s' is not valid yet or has expired\n", id,
                acfg_common->public_cert_url);
        }
 
        rc = crypto_has_private_key_from_memory(public_cert_data, public_cert_len);
        if (rc) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: DANGER!!! public_cert_url '%s' has a private key in the file!!!\n", id,
                acfg_common->public_cert_url);
        }
        SCOPE_EXIT("%s: Done\n", id);
    }
 
    if (!ast_strlen_zero(acfg_common->private_key_file)) {
        EVP_PKEY *private_key;
        RAII_VAR(unsigned char *, raw_key, NULL, ast_free);
 
        private_key = crypto_load_privkey_from_file(acfg_common->private_key_file);
        if (!private_key) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: Could not extract raw private key from file '%s'\n", id,
                acfg_common->private_key_file);
        }
 
        acfg_common->raw_key_length = crypto_extract_raw_privkey(private_key, &raw_key);
        EVP_PKEY_free(private_key);
        if (acfg_common->raw_key_length == 0 || raw_key == NULL) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR, "%s: Could not extract raw private key from file '%s'\n", id,
                acfg_common->private_key_file);
        }
 
        /*
         * We're making this an ao2 object so it can be referenced
         * by a profile instead of having to copy it.
         */
        acfg_common->raw_key = ao2_alloc(acfg_common->raw_key_length, NULL);
        if (!acfg_common->raw_key) {
            SCOPE_EXIT_LOG_RTN_VALUE(-1, LOG_ERROR,
                "%s: Could not allocate memory for raw private key\n", id);
        }
        memcpy(acfg_common->raw_key, raw_key, acfg_common->raw_key_length);
 
    }
 
    SCOPE_EXIT_RTN_VALUE(0, "%s: Done\n", id);
}

References attestation_cfg::acfg_common, ao2_alloc, ast_file_is_readable(), ast_free, ast_std_free(), ast_strlen_zero(), attestation_cfg_common::check_tn_cert_public_url, crypto_extract_raw_privkey(), crypto_has_private_key_from_memory(), crypto_is_cert_time_valid(), crypto_load_cert_from_memory(), crypto_load_privkey_from_file(), curl_download_to_memory(), ENUM_BOOL, LOG_ERROR, NULL, attestation_cfg_common::private_key_file, attestation_cfg_common::public_cert_url, RAII_VAR, attestation_cfg_common::raw_key, attestation_cfg_common::raw_key_length, SCOPE_ENTER, SCOPE_EXIT, SCOPE_EXIT_LOG_RTN_VALUE, and SCOPE_EXIT_RTN_VALUE.

Referenced by attestation_apply(), profile_apply(), and tn_apply().

as_config_load()

int as_config_load

(

void

)

Definition at line 300 of file attestation_config.c.

{
    struct ast_sorcery *sorcery = get_sorcery();
 
    ast_sorcery_apply_default(sorcery, CONFIG_TYPE, "config",
        "stir_shaken.conf,criteria=type=" CONFIG_TYPE ",single_object=yes,explicit_name=" CONFIG_TYPE);
 
    if (ast_sorcery_object_register(sorcery, CONFIG_TYPE, attestation_alloc,
            NULL, attestation_apply)) {
        ast_log(LOG_ERROR, "stir/shaken - failed to register '%s' sorcery object\n", CONFIG_TYPE);
        return -1;
    }
 
    ast_sorcery_object_field_register_nodoc(sorcery, CONFIG_TYPE, "type",
        "", OPT_NOOP_T, 0, 0);
 
    ast_sorcery_object_field_register(sorcery, CONFIG_TYPE, "global_disable",
        DEFAULT_global_disable ? "yes" : "no",
        OPT_YESNO_T, 1, FLDSET(struct attestation_cfg, global_disable));
 
    enum_option_register_ex(sorcery, CONFIG_TYPE, unknown_tn_attest_level,
        unknown_tn_attest_level, attest_level,);
 
    register_common_attestation_fields(sorcery, attestation_cfg, CONFIG_TYPE,);
 
    ast_sorcery_load_object(sorcery, CONFIG_TYPE);
 
    if (!as_is_config_loaded()) {
        ast_log(LOG_WARNING,"Stir/Shaken attestation service disabled.  Either there were errors in the 'attestation' object in stir_shaken.conf or it was missing altogether.\n");
    }
    if (!empty_cfg) {
        empty_cfg = attestation_alloc(CONFIG_TYPE);
        if (!empty_cfg) {
            return -1;
        }
        empty_cfg->global_disable = 1;
    }
 
    ast_cli_register_multiple(attestation_cli,
        ARRAY_LEN(attestation_cli));
 
    return 0;
}

References ARRAY_LEN, as_is_config_loaded(), ast_cli_register_multiple, ast_log, ast_sorcery_apply_default, ast_sorcery_load_object(), ast_sorcery_object_field_register, ast_sorcery_object_field_register_nodoc, ast_sorcery_object_register, attestation_alloc(), attestation_apply(), attestation_cli, CONFIG_TYPE, DEFAULT_global_disable, empty_cfg, enum_option_register_ex, FLDSET, get_sorcery(), attestation_cfg::global_disable, LOG_ERROR, LOG_WARNING, NULL, OPT_NOOP_T, OPT_YESNO_T, register_common_attestation_fields, and sorcery.

Referenced by as_load().

as_config_reload()

int as_config_reload

(

void

)

Definition at line 272 of file attestation_config.c.

{
    struct ast_sorcery *sorcery = get_sorcery();
    ast_sorcery_force_reload_object(sorcery, CONFIG_TYPE);
 
    if (!as_is_config_loaded()) {
        ast_log(LOG_WARNING,"Stir/Shaken attestation service disabled.  Either there were errors in the 'attestation' object in stir_shaken.conf or it was missing altogether.\n");
    }
    if (!empty_cfg) {
        empty_cfg = attestation_alloc(CONFIG_TYPE);
        if (!empty_cfg) {
            return -1;
        }
        empty_cfg->global_disable = 1;
    }
 
    return 0;
}

References as_is_config_loaded(), ast_log, ast_sorcery_force_reload_object(), attestation_alloc(), CONFIG_TYPE, empty_cfg, get_sorcery(), attestation_cfg::global_disable, LOG_WARNING, and sorcery.

Referenced by as_reload().

as_config_unload()

int as_config_unload

(

void

)

Definition at line 291 of file attestation_config.c.

{
    ast_cli_unregister_multiple(attestation_cli,
        ARRAY_LEN(attestation_cli));
    ao2_cleanup(empty_cfg);
 
    return 0;
}

References ao2_cleanup, ARRAY_LEN, ast_cli_unregister_multiple(), attestation_cli, and empty_cfg.

Referenced by as_unload().

as_copy_cfg_common()

int as_copy_cfg_common	(	const char *	id,
		struct attestation_cfg_common *	cfg_dst,
		struct attestation_cfg_common *	cfg_src
	)

Definition at line 113 of file attestation_config.c.

{
    int rc = 0;
 
    if (!cfg_dst || !cfg_src) {
        return -1;
    }
 
    cfg_sf_copy_wrapper(id, cfg_dst, cfg_src, private_key_file);
    cfg_sf_copy_wrapper(id, cfg_dst, cfg_src, public_cert_url);
 
    cfg_enum_copy(cfg_dst, cfg_src, attest_level);
    cfg_enum_copy(cfg_dst, cfg_src, check_tn_cert_public_url);
    cfg_enum_copy(cfg_dst, cfg_src, send_mky);
 
    if (cfg_src->raw_key) {
        /* Free and overwrite the destination */
        ao2_cleanup(cfg_dst->raw_key);
        cfg_dst->raw_key = ao2_bump(cfg_src->raw_key);
        cfg_dst->raw_key_length = cfg_src->raw_key_length;
    }
 
    return rc;
}

References ao2_bump, ao2_cleanup, cfg_enum_copy, cfg_sf_copy_wrapper, attestation_cfg_common::raw_key, and attestation_cfg_common::raw_key_length.

Referenced by create_effective_profile(), and tn_get_etn().

as_get_cfg()

struct attestation_cfg * as_get_cfg

(

void

)

Definition at line 43 of file attestation_config.c.

{
    struct attestation_cfg *cfg = ast_sorcery_retrieve_by_id(get_sorcery(),
        CONFIG_TYPE, CONFIG_TYPE);
    if (cfg) {
        return cfg;
    }
 
    return empty_cfg ? ao2_bump(empty_cfg) : NULL;
}

References ao2_bump, ast_sorcery_retrieve_by_id(), CONFIG_TYPE, empty_cfg, get_sorcery(), and NULL.

Referenced by ast_stir_shaken_as_ctx_create(), attestation_show(), and create_effective_profile().

as_is_config_loaded()

int as_is_config_loaded

(

void

)

Definition at line 54 of file attestation_config.c.

{
    struct attestation_cfg *cfg = ast_sorcery_retrieve_by_id(get_sorcery(),
        CONFIG_TYPE, CONFIG_TYPE);
    ao2_cleanup(cfg);
 
    return !!cfg;
}

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

Referenced by as_config_load(), as_config_reload(), and attestation_show().

attestation_alloc()

static void * attestation_alloc ( const char *  name )

static

Definition at line 85 of file attestation_config.c.

{
    struct attestation_cfg *cfg;
 
    cfg = ast_sorcery_generic_alloc(sizeof(*cfg), attestation_destructor);
    if (!cfg) {
        return NULL;
    }
 
    if (ast_string_field_init(cfg, 1024)) {
        ao2_ref(cfg, -1);
        return NULL;
    }
 
    /*
     * The memory for acfg_common 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)) {
        ao2_ref(cfg, -1);
        return NULL;
    }
 
    return cfg;
}

References attestation_cfg::acfg_common, ao2_ref, ast_sorcery_generic_alloc(), ast_string_field_init, attestation_destructor(), and NULL.

Referenced by as_config_load(), and as_config_reload().

attestation_apply()

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

static

Definition at line 221 of file attestation_config.c.

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

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

Referenced by as_config_load().

attestation_destructor()

static void attestation_destructor ( void *  obj )

static

Definition at line 77 of file attestation_config.c.

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

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

Referenced by attestation_alloc().

attestation_show()

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

static

Definition at line 233 of file attestation_config.c.

{
    struct attestation_cfg *cfg;
    struct config_object_cli_data data = {
        .title = "Default Attestation",
        .object_type = config_object_type_attestation,
    };
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "stir_shaken show attestation";
        e->usage =
            "Usage: stir_shaken show attestation\n"
            "       Show the stir/shaken attestation settings\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 3) {
        return CLI_SHOWUSAGE;
    }
 
    if (!as_is_config_loaded()) {
        ast_log(LOG_WARNING,"Stir/Shaken attestation service disabled.  Either there were errors in the 'attestation' object in stir_shaken.conf or it was missing altogether.\n");
        return CLI_FAILURE;
    }
 
    cfg = as_get_cfg();
    config_object_cli_show(cfg, a, &data, 0);
    ao2_cleanup(cfg);
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, as_get_cfg(), as_is_config_loaded(), ast_log, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, config_object_cli_show(), config_object_type_attestation, LOG_WARNING, NULL, config_object_cli_data::title, and ast_cli_entry::usage.

generate_acfg_common_sorcery_handlers()

generate_acfg_common_sorcery_handlers

(

attestation_cfg

)

generate_sorcery_enum_from_str_ex()

generate_sorcery_enum_from_str_ex	(	attestation_cfg	,
		unknown_tn_attest_level	,
		attest_level	,
		UNKNOWN
	)

generate_sorcery_enum_to_str_ex()

generate_sorcery_enum_to_str_ex	(	attestation_cfg	,
		unknown_tn_attest_level	,
		attest_level
	)

Variable Documentation

attestation_cli

struct ast_cli_entry attestation_cli[]

static

Initial value:

= {
    { .handler =  attestation_show , .summary =  "Show stir/shaken attestation configuration" ,},
}

Definition at line 268 of file attestation_config.c.

Referenced by as_config_load(), and as_config_unload().

empty_cfg

struct attestation_cfg* empty_cfg = NULL

static

Definition at line 41 of file attestation_config.c.

Referenced by as_config_load(), as_config_reload(), as_config_unload(), and as_get_cfg().