123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608 |
- /*
- * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
- *
- * Licensed under the Apache License 2.0 (the "License"). You may not use
- * this file except in compliance with the License. You can obtain a copy
- * in the file LICENSE in the source distribution or at
- * https://www.openssl.org/source/license.html
- */
- #include <openssl/core.h>
- #include <openssl/core_dispatch.h>
- #include <openssl/encoder.h>
- #include <openssl/ui.h>
- #include "internal/core.h"
- #include "internal/namemap.h"
- #include "internal/property.h"
- #include "internal/provider.h"
- #include "crypto/encoder.h"
- #include "encoder_local.h"
- /*
- * Encoder can have multiple names, separated with colons in a name string
- */
- #define NAME_SEPARATOR ':'
- /* Simple method structure constructor and destructor */
- static OSSL_ENCODER *ossl_encoder_new(void)
- {
- OSSL_ENCODER *encoder = NULL;
- if ((encoder = OPENSSL_zalloc(sizeof(*encoder))) == NULL
- || (encoder->base.lock = CRYPTO_THREAD_lock_new()) == NULL) {
- OSSL_ENCODER_free(encoder);
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_MALLOC_FAILURE);
- return NULL;
- }
- encoder->base.refcnt = 1;
- return encoder;
- }
- int OSSL_ENCODER_up_ref(OSSL_ENCODER *encoder)
- {
- int ref = 0;
- CRYPTO_UP_REF(&encoder->base.refcnt, &ref, encoder->base.lock);
- return 1;
- }
- void OSSL_ENCODER_free(OSSL_ENCODER *encoder)
- {
- int ref = 0;
- if (encoder == NULL)
- return;
- CRYPTO_DOWN_REF(&encoder->base.refcnt, &ref, encoder->base.lock);
- if (ref > 0)
- return;
- OPENSSL_free(encoder->base.name);
- ossl_provider_free(encoder->base.prov);
- CRYPTO_THREAD_lock_free(encoder->base.lock);
- OPENSSL_free(encoder);
- }
- /* Permanent encoder method store, constructor and destructor */
- static void encoder_store_free(void *vstore)
- {
- ossl_method_store_free(vstore);
- }
- static void *encoder_store_new(OSSL_LIB_CTX *ctx)
- {
- return ossl_method_store_new(ctx);
- }
- static const OSSL_LIB_CTX_METHOD encoder_store_method = {
- OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
- encoder_store_new,
- encoder_store_free,
- };
- /* Data to be passed through ossl_method_construct() */
- struct encoder_data_st {
- OSSL_LIB_CTX *libctx;
- OSSL_METHOD_CONSTRUCT_METHOD *mcm;
- int id; /* For get_encoder_from_store() */
- const char *names; /* For get_encoder_from_store() */
- const char *propquery; /* For get_encoder_from_store() */
- unsigned int flag_construct_error_occurred : 1;
- };
- /*
- * Generic routines to fetch / create ENCODER methods with
- * ossl_method_construct()
- */
- /* Temporary encoder method store, constructor and destructor */
- static void *alloc_tmp_encoder_store(OSSL_LIB_CTX *ctx)
- {
- return ossl_method_store_new(ctx);
- }
- static void dealloc_tmp_encoder_store(void *store)
- {
- if (store != NULL)
- ossl_method_store_free(store);
- }
- /* Get the permanent encoder store */
- static OSSL_METHOD_STORE *get_encoder_store(OSSL_LIB_CTX *libctx)
- {
- return ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_ENCODER_STORE_INDEX,
- &encoder_store_method);
- }
- /* Get encoder methods from a store, or put one in */
- static void *get_encoder_from_store(OSSL_LIB_CTX *libctx, void *store,
- void *data)
- {
- struct encoder_data_st *methdata = data;
- void *method = NULL;
- int id;
- if ((id = methdata->id) == 0) {
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- id = ossl_namemap_name2num(namemap, methdata->names);
- }
- if (store == NULL
- && (store = get_encoder_store(libctx)) == NULL)
- return NULL;
- if (!ossl_method_store_fetch(store, id, methdata->propquery, &method))
- return NULL;
- return method;
- }
- static int put_encoder_in_store(OSSL_LIB_CTX *libctx, void *store,
- void *method, const OSSL_PROVIDER *prov,
- int operation_id, const char *names,
- const char *propdef, void *unused)
- {
- OSSL_NAMEMAP *namemap;
- int id;
- if ((namemap = ossl_namemap_stored(libctx)) == NULL
- || (id = ossl_namemap_name2num(namemap, names)) == 0)
- return 0;
- if (store == NULL && (store = get_encoder_store(libctx)) == NULL)
- return 0;
- return ossl_method_store_add(store, prov, id, propdef, method,
- (int (*)(void *))OSSL_ENCODER_up_ref,
- (void (*)(void *))OSSL_ENCODER_free);
- }
- /* Create and populate a encoder method */
- static void *encoder_from_algorithm(int id, const OSSL_ALGORITHM *algodef,
- OSSL_PROVIDER *prov)
- {
- OSSL_ENCODER *encoder = NULL;
- const OSSL_DISPATCH *fns = algodef->implementation;
- if ((encoder = ossl_encoder_new()) == NULL)
- return NULL;
- encoder->base.id = id;
- if ((encoder->base.name = ossl_algorithm_get1_first_name(algodef)) == NULL) {
- OSSL_ENCODER_free(encoder);
- return NULL;
- }
- encoder->base.propdef = algodef->property_definition;
- encoder->base.description = algodef->algorithm_description;
- for (; fns->function_id != 0; fns++) {
- switch (fns->function_id) {
- case OSSL_FUNC_ENCODER_NEWCTX:
- if (encoder->newctx == NULL)
- encoder->newctx =
- OSSL_FUNC_encoder_newctx(fns);
- break;
- case OSSL_FUNC_ENCODER_FREECTX:
- if (encoder->freectx == NULL)
- encoder->freectx =
- OSSL_FUNC_encoder_freectx(fns);
- break;
- case OSSL_FUNC_ENCODER_GET_PARAMS:
- if (encoder->get_params == NULL)
- encoder->get_params =
- OSSL_FUNC_encoder_get_params(fns);
- break;
- case OSSL_FUNC_ENCODER_GETTABLE_PARAMS:
- if (encoder->gettable_params == NULL)
- encoder->gettable_params =
- OSSL_FUNC_encoder_gettable_params(fns);
- break;
- case OSSL_FUNC_ENCODER_SET_CTX_PARAMS:
- if (encoder->set_ctx_params == NULL)
- encoder->set_ctx_params =
- OSSL_FUNC_encoder_set_ctx_params(fns);
- break;
- case OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS:
- if (encoder->settable_ctx_params == NULL)
- encoder->settable_ctx_params =
- OSSL_FUNC_encoder_settable_ctx_params(fns);
- break;
- case OSSL_FUNC_ENCODER_DOES_SELECTION:
- if (encoder->does_selection == NULL)
- encoder->does_selection =
- OSSL_FUNC_encoder_does_selection(fns);
- break;
- case OSSL_FUNC_ENCODER_ENCODE:
- if (encoder->encode == NULL)
- encoder->encode = OSSL_FUNC_encoder_encode(fns);
- break;
- case OSSL_FUNC_ENCODER_IMPORT_OBJECT:
- if (encoder->import_object == NULL)
- encoder->import_object =
- OSSL_FUNC_encoder_import_object(fns);
- break;
- case OSSL_FUNC_ENCODER_FREE_OBJECT:
- if (encoder->free_object == NULL)
- encoder->free_object =
- OSSL_FUNC_encoder_free_object(fns);
- break;
- }
- }
- /*
- * Try to check that the method is sensible.
- * If you have a constructor, you must have a destructor and vice versa.
- * You must have the encoding driver functions.
- */
- if (!((encoder->newctx == NULL && encoder->freectx == NULL)
- || (encoder->newctx != NULL && encoder->freectx != NULL)
- || (encoder->import_object != NULL && encoder->free_object != NULL)
- || (encoder->import_object == NULL && encoder->free_object == NULL))
- || encoder->encode == NULL
- || encoder->gettable_params == NULL
- || encoder->get_params == NULL) {
- OSSL_ENCODER_free(encoder);
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_INVALID_PROVIDER_FUNCTIONS);
- return NULL;
- }
- if (prov != NULL && !ossl_provider_up_ref(prov)) {
- OSSL_ENCODER_free(encoder);
- return NULL;
- }
- encoder->base.prov = prov;
- return encoder;
- }
- /*
- * The core fetching functionality passes the names of the implementation.
- * This function is responsible to getting an identity number for them,
- * then call encoder_from_algorithm() with that identity number.
- */
- static void *construct_encoder(const OSSL_ALGORITHM *algodef,
- OSSL_PROVIDER *prov, void *data)
- {
- /*
- * This function is only called if get_encoder_from_store() returned
- * NULL, so it's safe to say that of all the spots to create a new
- * namemap entry, this is it. Should the name already exist there, we
- * know that ossl_namemap_add() will return its corresponding number.
- */
- struct encoder_data_st *methdata = data;
- OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- const char *names = algodef->algorithm_names;
- int id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
- void *method = NULL;
- if (id != 0)
- method = encoder_from_algorithm(id, algodef, prov);
- /*
- * Flag to indicate that there was actual construction errors. This
- * helps inner_evp_generic_fetch() determine what error it should
- * record on inaccessible algorithms.
- */
- if (method == NULL)
- methdata->flag_construct_error_occurred = 1;
- return method;
- }
- /* Intermediary function to avoid ugly casts, used below */
- static void destruct_encoder(void *method, void *data)
- {
- OSSL_ENCODER_free(method);
- }
- static int up_ref_encoder(void *method)
- {
- return OSSL_ENCODER_up_ref(method);
- }
- static void free_encoder(void *method)
- {
- OSSL_ENCODER_free(method);
- }
- /* Fetching support. Can fetch by numeric identity or by name */
- static OSSL_ENCODER *inner_ossl_encoder_fetch(OSSL_LIB_CTX *libctx,
- int id, const char *name,
- const char *properties)
- {
- OSSL_METHOD_STORE *store = get_encoder_store(libctx);
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- void *method = NULL;
- int unsupported = 0;
- if (store == NULL || namemap == NULL) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_INVALID_ARGUMENT);
- return NULL;
- }
- /*
- * If we have been passed neither a name_id or a name, we have an
- * internal programming error.
- */
- if (!ossl_assert(id != 0 || name != NULL)) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_INTERNAL_ERROR);
- return NULL;
- }
- if (id == 0)
- id = ossl_namemap_name2num(namemap, name);
- /*
- * If we haven't found the name yet, chances are that the algorithm to
- * be fetched is unsupported.
- */
- if (id == 0)
- unsupported = 1;
- if (id == 0
- || !ossl_method_store_cache_get(store, id, properties, &method)) {
- OSSL_METHOD_CONSTRUCT_METHOD mcm = {
- alloc_tmp_encoder_store,
- dealloc_tmp_encoder_store,
- get_encoder_from_store,
- put_encoder_in_store,
- construct_encoder,
- destruct_encoder
- };
- struct encoder_data_st mcmdata;
- mcmdata.libctx = libctx;
- mcmdata.mcm = &mcm;
- mcmdata.id = id;
- mcmdata.names = name;
- mcmdata.propquery = properties;
- mcmdata.flag_construct_error_occurred = 0;
- if ((method = ossl_method_construct(libctx, OSSL_OP_ENCODER,
- 0 /* !force_cache */,
- &mcm, &mcmdata)) != NULL) {
- /*
- * If construction did create a method for us, we know that
- * there is a correct name_id and meth_id, since those have
- * already been calculated in get_encoder_from_store() and
- * put_encoder_in_store() above.
- */
- if (id == 0)
- id = ossl_namemap_name2num(namemap, name);
- ossl_method_store_cache_set(store, id, properties, method,
- up_ref_encoder, free_encoder);
- }
- /*
- * If we never were in the constructor, the algorithm to be fetched
- * is unsupported.
- */
- unsupported = !mcmdata.flag_construct_error_occurred;
- }
- if (method == NULL) {
- int code = unsupported ? ERR_R_UNSUPPORTED : ERR_R_FETCH_FAILED;
- if (name == NULL)
- name = ossl_namemap_num2name(namemap, id, 0);
- ERR_raise_data(ERR_LIB_OSSL_ENCODER, code,
- "%s, Name (%s : %d), Properties (%s)",
- ossl_lib_ctx_get_descriptor(libctx),
- name = NULL ? "<null>" : name, id,
- properties == NULL ? "<null>" : properties);
- }
- return method;
- }
- OSSL_ENCODER *OSSL_ENCODER_fetch(OSSL_LIB_CTX *libctx, const char *name,
- const char *properties)
- {
- return inner_ossl_encoder_fetch(libctx, 0, name, properties);
- }
- OSSL_ENCODER *ossl_encoder_fetch_by_number(OSSL_LIB_CTX *libctx, int id,
- const char *properties)
- {
- return inner_ossl_encoder_fetch(libctx, id, NULL, properties);
- }
- /*
- * Library of basic method functions
- */
- const OSSL_PROVIDER *OSSL_ENCODER_get0_provider(const OSSL_ENCODER *encoder)
- {
- if (!ossl_assert(encoder != NULL)) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
- return 0;
- }
- return encoder->base.prov;
- }
- const char *OSSL_ENCODER_get0_properties(const OSSL_ENCODER *encoder)
- {
- if (!ossl_assert(encoder != NULL)) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
- return 0;
- }
- return encoder->base.propdef;
- }
- int ossl_encoder_get_number(const OSSL_ENCODER *encoder)
- {
- if (!ossl_assert(encoder != NULL)) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
- return 0;
- }
- return encoder->base.id;
- }
- const char *OSSL_ENCODER_get0_name(const OSSL_ENCODER *encoder)
- {
- return encoder->base.name;
- }
- const char *OSSL_ENCODER_get0_description(const OSSL_ENCODER *encoder)
- {
- return encoder->base.description;
- }
- int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name)
- {
- if (encoder->base.prov != NULL) {
- OSSL_LIB_CTX *libctx = ossl_provider_libctx(encoder->base.prov);
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- return ossl_namemap_name2num(namemap, name) == encoder->base.id;
- }
- return 0;
- }
- struct encoder_do_all_data_st {
- void (*user_fn)(void *method, void *arg);
- void *user_arg;
- };
- static void encoder_do_one(OSSL_PROVIDER *provider,
- const OSSL_ALGORITHM *algodef,
- int no_store, void *vdata)
- {
- struct encoder_do_all_data_st *data = vdata;
- OSSL_LIB_CTX *libctx = ossl_provider_libctx(provider);
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- const char *names = algodef->algorithm_names;
- int id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
- void *method = NULL;
- if (id != 0)
- method =
- encoder_from_algorithm(id, algodef, provider);
- if (method != NULL) {
- data->user_fn(method, data->user_arg);
- OSSL_ENCODER_free(method);
- }
- }
- void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx,
- void (*fn)(OSSL_ENCODER *encoder, void *arg),
- void *arg)
- {
- struct encoder_do_all_data_st data;
- data.user_fn = (void (*)(void *, void *))fn;
- data.user_arg = arg;
- /*
- * No pre- or post-condition for this call, as this only creates methods
- * temporarly and then promptly destroys them.
- */
- ossl_algorithm_do_all(libctx, OSSL_OP_ENCODER, NULL, NULL,
- encoder_do_one, NULL, &data);
- }
- int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,
- void (*fn)(const char *name, void *data),
- void *data)
- {
- if (encoder == NULL)
- return 0;
- if (encoder->base.prov != NULL) {
- OSSL_LIB_CTX *libctx = ossl_provider_libctx(encoder->base.prov);
- OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
- return ossl_namemap_doall_names(namemap, encoder->base.id, fn, data);
- }
- return 1;
- }
- const OSSL_PARAM *
- OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder)
- {
- if (encoder != NULL && encoder->gettable_params != NULL) {
- void *provctx = ossl_provider_ctx(OSSL_ENCODER_get0_provider(encoder));
- return encoder->gettable_params(provctx);
- }
- return NULL;
- }
- int OSSL_ENCODER_get_params(OSSL_ENCODER *encoder, OSSL_PARAM params[])
- {
- if (encoder != NULL && encoder->get_params != NULL)
- return encoder->get_params(params);
- return 0;
- }
- const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder)
- {
- if (encoder != NULL && encoder->settable_ctx_params != NULL) {
- void *provctx = ossl_provider_ctx(OSSL_ENCODER_get0_provider(encoder));
- return encoder->settable_ctx_params(provctx);
- }
- return NULL;
- }
- /*
- * Encoder context support
- */
- OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(void)
- {
- OSSL_ENCODER_CTX *ctx;
- if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_MALLOC_FAILURE);
- return ctx;
- }
- int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX *ctx,
- const OSSL_PARAM params[])
- {
- int ok = 1;
- size_t i;
- size_t l;
- if (!ossl_assert(ctx != NULL)) {
- ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
- return 0;
- }
- if (ctx->encoder_insts == NULL)
- return 1;
- l = OSSL_ENCODER_CTX_get_num_encoders(ctx);
- for (i = 0; i < l; i++) {
- OSSL_ENCODER_INSTANCE *encoder_inst =
- sk_OSSL_ENCODER_INSTANCE_value(ctx->encoder_insts, i);
- OSSL_ENCODER *encoder = OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst);
- void *encoderctx = OSSL_ENCODER_INSTANCE_get_encoder_ctx(encoder_inst);
- if (encoderctx == NULL || encoder->set_ctx_params == NULL)
- continue;
- if (!encoder->set_ctx_params(encoderctx, params))
- ok = 0;
- }
- return ok;
- }
- void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX *ctx)
- {
- if (ctx != NULL) {
- sk_OSSL_ENCODER_INSTANCE_pop_free(ctx->encoder_insts,
- ossl_encoder_instance_free);
- OPENSSL_free(ctx->construct_data);
- ossl_pw_clear_passphrase_data(&ctx->pwdata);
- OPENSSL_free(ctx);
- }
- }
|