store.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2020, Sangoma Technologies Corporation
 *
 * Kevin Harwell <[email protected]>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

#include "asterisk.h"

#include <sys/stat.h>

#include "asterisk/cli.h"
#include "asterisk/sorcery.h"

#include "stir_shaken.h"
#include "store.h"
#include "asterisk/res_stir_shaken.h"

#define CONFIG_TYPE "store"

#define VARIABLE_SUBSTITUTE "${CERTIFICATE}"

struct stir_shaken_store {
   SORCERY_OBJECT(details);
   AST_DECLARE_STRING_FIELDS(
      /*! Path to a directory containing certificates */
      AST_STRING_FIELD(path);
      /*! URL to the public certificate */
      AST_STRING_FIELD(public_cert_url);
   );
};

static struct stir_shaken_store *stir_shaken_store_get(const char *id)
{
   return ast_sorcery_retrieve_by_id(ast_stir_shaken_sorcery(), CONFIG_TYPE, id);
}

static struct ao2_container *stir_shaken_store_get_all(void)
{
   return ast_sorcery_retrieve_by_fields(ast_stir_shaken_sorcery(), CONFIG_TYPE,
      AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

static void stir_shaken_store_destructor(void *obj)
{
   struct stir_shaken_store *cfg = obj;

   ast_string_field_free_memory(cfg);
}

static void *stir_shaken_store_alloc(const char *name)
{
   struct stir_shaken_store *cfg;

   cfg = ast_sorcery_generic_alloc(sizeof(*cfg), stir_shaken_store_destructor);
   if (!cfg) {
      return NULL;
   }

   if (ast_string_field_init(cfg, 512)) {
      ao2_ref(cfg, -1);
      return NULL;
   }

   return cfg;
}

static int stir_shaken_store_apply(const struct ast_sorcery *sorcery, void *obj)
{
   return 0;
}

static char *stir_shaken_store_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   struct stir_shaken_store *cfg;

   switch(cmd) {
   case CLI_INIT:
      e->command = "stir_shaken show store";
      e->usage =
         "Usage: stir_shaken show store <id>\n"
         "       Show the store stir/shaken settings for a given id\n";
      return NULL;
   case CLI_GENERATE:
      if (a->pos == 3) {
         return stir_shaken_tab_complete_name(a->word, stir_shaken_store_get_all());
      } else {
         return NULL;
      };
   }

   if (a->argc != 4) {
      return CLI_SHOWUSAGE;
   }

   cfg = stir_shaken_store_get(a->argv[3]);
   stir_shaken_cli_show(cfg, a, 0);
   ao2_cleanup(cfg);

   return CLI_SUCCESS;
}

static struct ast_cli_entry stir_shaken_store_cli[] = {
   AST_CLI_DEFINE(stir_shaken_store_show, "Show stir/shaken store configuration by id"),
};

static int on_load_path(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
   struct stir_shaken_store *cfg = obj;
   struct stat statbuf;

   if (stat(var->value, &statbuf)) {
      ast_log(LOG_ERROR, "stir/shaken - path '%s' not found\n", var->value);
      return -1;
   }

   if (!S_ISDIR(statbuf.st_mode)) {
      ast_log(LOG_ERROR, "stir/shaken - path '%s' is not a directory\n", var->value);
      return -1;
   }

   return ast_string_field_set(cfg, path, var->value);
}

static int path_to_str(const void *obj, const intptr_t *args, char **buf)
{
   const struct stir_shaken_store *cfg = obj;

   *buf = ast_strdup(cfg->path);

   return 0;
}

static int on_load_public_cert_url(const struct aco_option *opt, struct ast_variable *var, void *obj)
{
   struct stir_shaken_store *cfg = obj;

   if (!ast_begins_with(var->value, "http")) {
      ast_log(LOG_ERROR, "stir/shaken - public_cert_url scheme must be 'http[s]'\n");
      return -1;
   }

   if (!strstr(var->value, VARIABLE_SUBSTITUTE)) {
      ast_log(LOG_ERROR, "stir/shaken - public_cert_url must contain variable '%s' "
            "used for substitution\n", VARIABLE_SUBSTITUTE);
      return -1;
   }

   return ast_string_field_set(cfg, public_cert_url, var->value);
}

static int public_cert_url_to_str(const void *obj, const intptr_t *args, char **buf)
{
   const struct stir_shaken_store *cfg = obj;

   *buf = ast_strdup(cfg->public_cert_url);

   return 0;
}

int stir_shaken_store_unload(void)
{
   ast_cli_unregister_multiple(stir_shaken_store_cli,
      ARRAY_LEN(stir_shaken_store_cli));

   return 0;
}

int stir_shaken_store_load(void)
{
   struct ast_sorcery *sorcery = ast_stir_shaken_sorcery();

   ast_sorcery_apply_default(sorcery, CONFIG_TYPE, "config", "stir_shaken.conf,criteria=type=store");

   if (ast_sorcery_object_register(sorcery, CONFIG_TYPE, stir_shaken_store_alloc,
         NULL, stir_shaken_store_apply)) {
      ast_log(LOG_ERROR, "stir/shaken - failed to register '%s' sorcery object\n", CONFIG_TYPE);
      return -1;
   }

   ast_sorcery_object_field_register(sorcery, CONFIG_TYPE, "type", "", OPT_NOOP_T, 0, 0);
   ast_sorcery_object_field_register_custom(sorcery, CONFIG_TYPE, "path", "",
      on_load_path, path_to_str, NULL, 0, 0);
   ast_sorcery_object_field_register_custom(sorcery, CONFIG_TYPE, "public_cert_url", "",
      on_load_public_cert_url, public_cert_url_to_str, NULL, 0, 0);

   ast_cli_register_multiple(stir_shaken_store_cli,
      ARRAY_LEN(stir_shaken_store_cli));

   return 0;
}