From 4c2883a9bf59c5ee31e8e2e101b3894a16c06950 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Sun, 20 Jan 2019 13:14:58 +0100 Subject: [PATCH] Replumbing: Add the Provider Object, type OSSL_PROVIDER The OSSL_PROVIDER is the core object involved in loading a provider module, initialize a provider and do the initial communication of provider wide and core wide dispatch tables. Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/8287) --- crypto/build.info | 4 + crypto/cpt_err.c | 10 +- crypto/err/openssl.txt | 4 + crypto/provider_core.c | 418 +++++++++++++++++++++++++++++++++ include/internal/provider.h | 61 +++++ include/internal/symhacks.h | 26 ++ include/openssl/core.h | 20 ++ include/openssl/core_numbers.h | 76 ++++++ include/openssl/cryptoerr.h | 4 + include/openssl/ossl_typ.h | 2 + util/perl/OpenSSL/ParseC.pm | 9 + 11 files changed, 633 insertions(+), 1 deletion(-) create mode 100644 crypto/provider_core.c create mode 100644 include/internal/provider.h create mode 100644 include/internal/symhacks.h create mode 100644 include/openssl/core_numbers.h diff --git a/crypto/build.info b/crypto/build.info index e3e9ceeec1..fdf0810dbe 100644 --- a/crypto/build.info +++ b/crypto/build.info @@ -8,6 +8,10 @@ SUBDIRS=objects buffer bio stack lhash rand evp asn1 pem x509 x509v3 conf \ err comp ocsp cms ts srp cmac ct async kmac ess LIBS=../libcrypto +# The Core +SOURCE[../libcrypto]=provider_core.c + +# Central utilities SOURCE[../libcrypto]=\ cryptlib.c mem.c mem_dbg.c cversion.c ex_data.c cpt_err.c \ ebcdic.c uid.c o_time.c o_str.c o_dir.c o_fopen.c ctype.c \ diff --git a/crypto/cpt_err.c b/crypto/cpt_err.c index 8c11da8883..a99d488fa1 100644 --- a/crypto/cpt_err.c +++ b/crypto/cpt_err.c @@ -1,6 +1,6 @@ /* * Generated by util/mkerr.pl DO NOT EDIT - * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved. + * Copyright 1995-2019 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 @@ -32,6 +32,8 @@ static const ERR_STRING_DATA CRYPTO_str_functs[] = { "CRYPTO_set_ex_data"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_FIPS_MODE_SET, 0), "FIPS_mode_set"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_GET_AND_LOCK, 0), "get_and_lock"}, + {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_GET_PROVIDER_STORE, 0), + "get_provider_store"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OPENSSL_ATEXIT, 0), "OPENSSL_atexit"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OPENSSL_BUF2HEXSTR, 0), "OPENSSL_buf2hexstr"}, @@ -44,6 +46,10 @@ static const ERR_STRING_DATA CRYPTO_str_functs[] = { {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OPENSSL_SK_DEEP_COPY, 0), "OPENSSL_sk_deep_copy"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OPENSSL_SK_DUP, 0), "OPENSSL_sk_dup"}, + {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OSSL_PROVIDER_ACTIVATE, 0), + "ossl_provider_activate"}, + {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_OSSL_PROVIDER_NEW, 0), + "ossl_provider_new"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_PKEY_HMAC_INIT, 0), "pkey_hmac_init"}, {ERR_PACK(ERR_LIB_CRYPTO, CRYPTO_F_PKEY_POLY1305_INIT, 0), "pkey_poly1305_init"}, @@ -60,6 +66,8 @@ static const ERR_STRING_DATA CRYPTO_str_reasons[] = { "illegal hex digit"}, {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_ODD_NUMBER_OF_DIGITS), "odd number of digits"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_PROVIDER_ALREADY_EXISTS), + "provider already exists"}, {0, NULL} }; diff --git a/crypto/err/openssl.txt b/crypto/err/openssl.txt index aec6a8dac8..4b331ebafa 100644 --- a/crypto/err/openssl.txt +++ b/crypto/err/openssl.txt @@ -359,6 +359,7 @@ CRYPTO_F_CRYPTO_OCB128_INIT:122:CRYPTO_ocb128_init CRYPTO_F_CRYPTO_SET_EX_DATA:102:CRYPTO_set_ex_data CRYPTO_F_FIPS_MODE_SET:109:FIPS_mode_set CRYPTO_F_GET_AND_LOCK:113:get_and_lock +CRYPTO_F_GET_PROVIDER_STORE:133:get_provider_store CRYPTO_F_OPENSSL_ATEXIT:114:OPENSSL_atexit CRYPTO_F_OPENSSL_BUF2HEXSTR:117:OPENSSL_buf2hexstr CRYPTO_F_OPENSSL_FOPEN:119:openssl_fopen @@ -367,6 +368,8 @@ CRYPTO_F_OPENSSL_INIT_CRYPTO:116:OPENSSL_init_crypto CRYPTO_F_OPENSSL_LH_NEW:126:OPENSSL_LH_new CRYPTO_F_OPENSSL_SK_DEEP_COPY:127:OPENSSL_sk_deep_copy CRYPTO_F_OPENSSL_SK_DUP:128:OPENSSL_sk_dup +CRYPTO_F_OSSL_PROVIDER_ACTIVATE:130:ossl_provider_activate +CRYPTO_F_OSSL_PROVIDER_NEW:131:ossl_provider_new CRYPTO_F_PKEY_HMAC_INIT:123:pkey_hmac_init CRYPTO_F_PKEY_POLY1305_INIT:124:pkey_poly1305_init CRYPTO_F_PKEY_SIPHASH_INIT:125:pkey_siphash_init @@ -2097,6 +2100,7 @@ CONF_R_VARIABLE_HAS_NO_VALUE:104:variable has no value CRYPTO_R_FIPS_MODE_NOT_SUPPORTED:101:fips mode not supported CRYPTO_R_ILLEGAL_HEX_DIGIT:102:illegal hex digit CRYPTO_R_ODD_NUMBER_OF_DIGITS:103:odd number of digits +CRYPTO_R_PROVIDER_ALREADY_EXISTS:104:provider already exists CT_R_BASE64_DECODE_ERROR:108:base64 decode error CT_R_INVALID_LOG_ID_LENGTH:100:invalid log id length CT_R_LOG_CONF_INVALID:109:log conf invalid diff --git a/crypto/provider_core.c b/crypto/provider_core.c new file mode 100644 index 0000000000..b3d44f1ac4 --- /dev/null +++ b/crypto/provider_core.c @@ -0,0 +1,418 @@ +/* + * Copyright 2019 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 +#include +#include +#include "internal/cryptlib.h" +#include "internal/thread_once.h" +#include "internal/provider.h" +#include "internal/refcount.h" + +/*- + * Provider Object structure + * ========================= + */ + +struct provider_store_st; /* Forward declaration */ + +struct ossl_provider_st { + /* Flag bits */ + unsigned int flag_initialized:1; + + /* OpenSSL library side data */ + CRYPTO_REF_COUNT refcnt; +#ifndef HAVE_ATOMICS + CRYPTO_RWLOCK refcnt_lock; /* For the ref counter */ +#endif + char *name; + DSO *module; + OSSL_provider_init_fn *init_function; + + /* Provider side functions */ + OSSL_provider_teardown_fn *teardown; + OSSL_provider_get_param_types_fn *get_param_types; + OSSL_provider_get_params_fn *get_params; +}; +DEFINE_STACK_OF(OSSL_PROVIDER) + +static int ossl_provider_cmp(const OSSL_PROVIDER * const *a, + const OSSL_PROVIDER * const *b) +{ + return strcmp((*a)->name, (*b)->name); +} + +/*- + * Provider Object store + * ===================== + * + * The Provider Object store is a library context object, and therefore needs + * an index. + */ + +struct provider_store_st { + STACK_OF(OSSL_PROVIDER) *providers; + CRYPTO_RWLOCK *lock; +}; +static int provider_store_index = -1; + +static void provider_store_free(void *vstore) +{ + struct provider_store_st *store = vstore; + + if (store == NULL) + return; + sk_OSSL_PROVIDER_pop_free(store->providers, ossl_provider_free); + CRYPTO_THREAD_lock_free(store->lock); + OPENSSL_free(store); +} + +static void *provider_store_new(void) +{ + struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store)); + + if (store == NULL + || (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL + || (store->lock = CRYPTO_THREAD_lock_new()) == NULL) { + provider_store_free(store); + store = NULL; + } + return store; +} + +static const OPENSSL_CTX_METHOD provider_store_method = { + provider_store_new, + provider_store_free, +}; + +static CRYPTO_ONCE provider_store_init_flag = CRYPTO_ONCE_STATIC_INIT; +DEFINE_RUN_ONCE_STATIC(do_provider_store_init) +{ + return OPENSSL_init_crypto(0, NULL) + && (provider_store_index = + openssl_ctx_new_index(&provider_store_method)) != -1; +} + + +static struct provider_store_st *get_provider_store(OPENSSL_CTX *libctx) +{ + struct provider_store_st *store = NULL; + + if (!RUN_ONCE(&provider_store_init_flag, do_provider_store_init)) + return NULL; + + store = openssl_ctx_get_data(libctx, provider_store_index); + if (store == NULL) + CRYPTOerr(CRYPTO_F_GET_PROVIDER_STORE, ERR_R_INTERNAL_ERROR); + return store; +} + +/*- + * Provider Object methods + * ======================= + */ + +int ossl_provider_upref(OSSL_PROVIDER *prov) +{ + int ref = 0; + +#ifndef HAVE_ATOMICS + CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock); +#else + CRYPTO_UP_REF(&prov->refcnt, &ref, NULL); +#endif + return ref; +} + +/* Finder, constructor and destructor */ +OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name) +{ + struct provider_store_st *store = NULL; + OSSL_PROVIDER *prov = NULL; + + if ((store = get_provider_store(libctx)) != NULL) { + OSSL_PROVIDER tmpl = { 0, }; + int i; + + tmpl.name = (char *)name; + CRYPTO_THREAD_write_lock(store->lock); + if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) == -1 + || (prov = sk_OSSL_PROVIDER_value(store->providers, i)) == NULL + || !ossl_provider_upref(prov)) + prov = NULL; + CRYPTO_THREAD_unlock(store->lock); + } + + return prov; +} + +OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name, + OSSL_provider_init_fn *init_function) +{ + struct provider_store_st *store = NULL; + OSSL_PROVIDER *prov = NULL; + + if ((store = get_provider_store(libctx)) == NULL) + return NULL; + + if ((prov = ossl_provider_find(libctx, name)) != NULL) { /* refcount +1 */ + ossl_provider_free(prov); /* refcount -1 */ + CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW, + CRYPTO_R_PROVIDER_ALREADY_EXISTS); + ERR_add_error_data(2, "name=", name); + return NULL; + } + + if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL + || !ossl_provider_upref(prov) /* +1 One reference to be returned */ + || (prov->name = OPENSSL_strdup(name)) == NULL) { + ossl_provider_free(prov); + CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW, ERR_R_MALLOC_FAILURE); + return NULL; + } + + prov->init_function = init_function; + + CRYPTO_THREAD_write_lock(store->lock); + if (!ossl_provider_upref(prov)) { /* +1 One reference for the store */ + ossl_provider_free(prov); /* -1 Reference that was to be returned */ + prov = NULL; + } else if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) { + ossl_provider_free(prov); /* -1 Store reference */ + ossl_provider_free(prov); /* -1 Reference that was to be returned */ + prov = NULL; + } + CRYPTO_THREAD_unlock(store->lock); + + if (prov == NULL) + CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW, ERR_R_MALLOC_FAILURE); + + /* + * At this point, the provider is only partially "loaded". To be + * fully "loaded", ossl_provider_activate() must also be called. + */ + + return prov; +} + +void ossl_provider_free(OSSL_PROVIDER *prov) +{ + if (prov != NULL) { + int ref = 0; + +#ifndef HAVE_ATOMICS + CRYPTO_DOWN_REF(&prov->refcnt, &ref, provider_lock); +#else + CRYPTO_DOWN_REF(&prov->refcnt, &ref, NULL); +#endif + + /* + * When the refcount drops down to one, there is only one reference, + * the store. + * When that happens, the provider is inactivated. + */ + if (ref == 1 && prov->flag_initialized) { + if (prov->teardown != NULL) + prov->teardown(); + prov->flag_initialized = 0; + } + + /* + * When the refcount drops to zero, it has been taken out of + * the store. All we have to do here is clean it out. + */ + if (ref == 0) { + DSO_free(prov->module); + OPENSSL_free(prov->name); + OPENSSL_free(prov); + } + } +} + +/* + * Provider activation. + * + * What "activation" means depends on the provider form; for built in + * providers (in the library or the application alike), the provider + * can already be considered to be loaded, all that's needed is to + * initialize it. However, for dynamically loadable provider modules, + * we must first load that module. + * + * Built in modules are distinguished from dynamically loaded modules + * with an already assigned init function. + */ +static const OSSL_DISPATCH *core_dispatch; /* Define further down */ + +int ossl_provider_activate(OSSL_PROVIDER *prov) +{ + const OSSL_DISPATCH *provider_dispatch = NULL; + + if (prov->flag_initialized) + return 1; + + /* + * If the init function isn't set, it indicates that this provider is + * a loadable module. + */ + if (prov->init_function == NULL) { + if (prov->module == NULL) { + char *platform_module_name = NULL; + char *module_path = NULL; + const char *load_dir = ossl_safe_getenv("OPENSSL_MODULES"); + + if ((prov->module = DSO_new()) == NULL) { + /* DSO_new() generates an error already */ + return 0; + } + + if (load_dir == NULL) + load_dir = MODULESDIR; + + DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS, + DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL); + if ((platform_module_name = + DSO_convert_filename(prov->module, prov->name)) == NULL + || (module_path = + DSO_merge(prov->module, platform_module_name, + load_dir)) == NULL + || DSO_load(prov->module, module_path, NULL, + DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == NULL) { + DSO_free(prov->module); + prov->module = NULL; + } + + OPENSSL_free(platform_module_name); + OPENSSL_free(module_path); + } + + if (prov->module != NULL) + prov->init_function = (OSSL_provider_init_fn *) + DSO_bind_func(prov->module, "OSSL_provider_init"); + } + + if (prov->init_function == NULL + || !prov->init_function(prov, core_dispatch, &provider_dispatch)) { + CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_ACTIVATE, ERR_R_INIT_FAIL); + ERR_add_error_data(2, "name=", prov->name); + DSO_free(prov->module); + prov->module = NULL; + return 0; + } + + for (; provider_dispatch->function_id != 0; provider_dispatch++) { + switch (provider_dispatch->function_id) { + case OSSL_FUNC_PROVIDER_TEARDOWN: + prov->teardown = + OSSL_get_provider_teardown(provider_dispatch); + break; + case OSSL_FUNC_PROVIDER_GET_PARAM_TYPES: + prov->get_param_types = + OSSL_get_provider_get_param_types(provider_dispatch); + break; + case OSSL_FUNC_PROVIDER_GET_PARAMS: + prov->get_params = + OSSL_get_provider_get_params(provider_dispatch); + break; + } + } + + /* With this flag set, this provider has become fully "loaded". */ + prov->flag_initialized = 1; + + return 1; +} + +/* Getters of Provider Object data */ +const char *ossl_provider_name(OSSL_PROVIDER *prov) +{ + return prov->name; +} + +const DSO *ossl_provider_dso(OSSL_PROVIDER *prov) +{ + return prov->module; +} + +const char *ossl_provider_module_name(OSSL_PROVIDER *prov) +{ + return DSO_get_filename(prov->module); +} + +const char *ossl_provider_module_path(OSSL_PROVIDER *prov) +{ + /* FIXME: Ensure it's a full path */ + return DSO_get_filename(prov->module); +} + +/* Wrappers around calls to the provider */ +void ossl_provider_teardown(const OSSL_PROVIDER *prov) +{ + if (prov->teardown != NULL) + prov->teardown(); +} + +const OSSL_ITEM *ossl_provider_get_param_types(const OSSL_PROVIDER *prov) +{ + return prov->get_param_types == NULL ? NULL : prov->get_param_types(prov); +} + +int ossl_provider_get_params(const OSSL_PROVIDER *prov, + const OSSL_PARAM params[]) +{ + return prov->get_params == NULL ? 0 : prov->get_params(prov, params); +} + +/*- + * Core functions for the provider + * =============================== + * + * This is the set of functions that the core makes available to the provider + */ + +/* + * This returns a list of Provider Object parameters with their types, for + * discovery. We do not expect that many providers will use this, but one + * never knows. + */ +static const OSSL_ITEM param_types[] = { + { OSSL_PARAM_UTF8_STRING_PTR, "openssl-version" }, + { OSSL_PARAM_UTF8_STRING_PTR, "provider-name" }, + { 0, NULL } +}; + +static const OSSL_ITEM *core_get_param_types(const OSSL_PROVIDER *prov) +{ + return param_types; +} + +static int core_get_params(const OSSL_PROVIDER *prov, const OSSL_PARAM params[]) +{ + int i; + + for (i = 0; params[i].key != NULL; i++) { + if (strcmp(params[i].key, "openssl-version") == 0) { + *(void **)params[i].buffer = OPENSSL_VERSION_STR; + if (params[i].return_size) + *params[i].return_size = sizeof(OPENSSL_VERSION_STR); + } else if (strcmp(params[i].key, "provider-name") == 0) { + *(void **)params[i].buffer = prov->name; + if (params[i].return_size) + *params[i].return_size = strlen(prov->name) + 1; + } + } + + return 1; +} + +static const OSSL_DISPATCH core_dispatch_[] = { + { OSSL_FUNC_CORE_GET_PARAM_TYPES, (void (*)(void))core_get_param_types }, + { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params }, + { 0, NULL } +}; +static const OSSL_DISPATCH *core_dispatch = core_dispatch_; diff --git a/include/internal/provider.h b/include/internal/provider.h new file mode 100644 index 0000000000..44d1d70461 --- /dev/null +++ b/include/internal/provider.h @@ -0,0 +1,61 @@ +/* + * Copyright 2019 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 + */ + +#ifndef OSSL_INTERNAL_PROVIDER_H +# define OSSL_INTERNAL_PROVIDER_H + +# include +# include "internal/dso.h" +# include "internal/symhacks.h" + +# ifdef __cplusplus +extern "C" { +# endif + +/* + * namespaces: + * + * ossl_provider_ Provider Object internal API + * OSSL_PROVIDER Provider Object + */ + +/* Provider Object finder, constructor and destructor */ +OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name); +OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name, + OSSL_provider_init_fn *init_function); +int ossl_provider_upref(OSSL_PROVIDER *prov); +void ossl_provider_free(OSSL_PROVIDER *prov); + +/* Setters */ +int ossl_provider_add_module_location(OSSL_PROVIDER *prov, const char *loc); + +/* + * Activate the Provider + * If the Provider is a module, the module will be loaded + * Inactivation is done by freeing the Provider + */ +int ossl_provider_activate(OSSL_PROVIDER *prov); + +/* Getters for other library functions */ +const char *ossl_provider_name(OSSL_PROVIDER *prov); +const DSO *ossl_provider_dso(OSSL_PROVIDER *prov); +const char *ossl_provider_module_name(OSSL_PROVIDER *prov); +const char *ossl_provider_module_path(OSSL_PROVIDER *prov); + +/* Thin wrappers around calls to the provider */ +void ossl_provider_teardown(const OSSL_PROVIDER *prov); +const OSSL_ITEM *ossl_provider_get_param_types(const OSSL_PROVIDER *prov); +int ossl_provider_get_params(const OSSL_PROVIDER *prov, + const OSSL_PARAM params[]); + +# ifdef __cplusplus +} +# endif + +#endif diff --git a/include/internal/symhacks.h b/include/internal/symhacks.h new file mode 100644 index 0000000000..2b09604619 --- /dev/null +++ b/include/internal/symhacks.h @@ -0,0 +1,26 @@ +/* + * Copyright 2019 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 + */ + +#ifndef OSSL_INTERNAL_SYMHACKS_H +# define OSSL_INTERNAL_SYMHACKS_H + +# include + +# if defined(OPENSSL_SYS_VMS) + +/* ossl_provider_get_param_types vs OSSL_PROVIDER_get_param_types */ +# undef ossl_provider_get_param_types +# define ossl_provider_get_param_types ossl_int_prov_get_param_types +/* ossl_provider_get_params vs OSSL_PROVIDER_get_params */ +# undef ossl_provider_get_params +# define ossl_provider_get_params ossl_int_prov_get_params + +# endif + +#endif /* ! defined HEADER_VMS_IDHACKS_H */ diff --git a/include/openssl/core.h b/include/openssl/core.h index 98b58bea69..15e88434cd 100644 --- a/include/openssl/core.h +++ b/include/openssl/core.h @@ -136,6 +136,26 @@ struct ossl_param_st { # define OSSL_PARAM_OCTET_STRING_PTR \ (OSSL_PARAM_OCTET_STRING|OSSL_PARAM_POINTER_FLAG) +/*- + * Provider entry point + * -------------------- + * + * This function is expected to be present in any dynamically loadable + * provider module. By definition, if this function doesn't exist in a + * module, that module is not an OpenSSL provider module. + */ +/*- + * |provider| pointer to opaque type OSSL_PROVIDER. This can be used + * together with some functions passed via |in| to query data. + * |in| is the array of functions that the Core passes to the provider. + * |out| will be the array of base functions that the provider passes + * back to the Core. + */ +typedef int (OSSL_provider_init_fn)(const OSSL_PROVIDER *provider, + const OSSL_DISPATCH *in, + const OSSL_DISPATCH **out); +extern OSSL_provider_init_fn OSSL_provider_init; + # ifdef __cplusplus } # endif diff --git a/include/openssl/core_numbers.h b/include/openssl/core_numbers.h new file mode 100644 index 0000000000..cd1093860a --- /dev/null +++ b/include/openssl/core_numbers.h @@ -0,0 +1,76 @@ +/* + * Copyright 2019 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 + */ + +#ifndef OSSL_CORE_NUMBERS_H +# define OSSL_CORE_NUMBERS_H + +# include + +# ifdef __cplusplus +extern "C" { +# endif + +/*- + * Identities + * ---------- + * + * All series start with 1, to allow 0 to be an array terminator. + * For any FUNC identity, we also provide a function signature typedef + * and a static inline function to extract a function pointer from a + * OSSL_DISPATCH element in a type safe manner. + * + * Names: + * for any function base name 'foo' (uppercase form 'FOO'), we will have + * the following: + * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivates + * thereof (to be specified further down) + * - a function signature typedef with the name OSSL_'foo'_fn + * - a function pointer extractor function with the name OSSL_'foo' + */ + +/* Helper macro to create the function signature typedef and the extractor */ +#define OSSL_CORE_MAKE_FUNC(type,name,args) \ + typedef type (OSSL_##name##_fn)args; \ + static ossl_inline \ + OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf) \ + { \ + return (OSSL_##name##_fn *)opf->function; \ + } + +/* + * Core function identities, for the two OSSL_DISPATCH tables being passed + * in the OSSL_provider_init call. + * + * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must + * therefore NEVER be used as a function identity. + */ +/* Functions provided by the Core to the provider, reserved numbers 1-1023 */ +# define OSSL_FUNC_CORE_GET_PARAM_TYPES 1 +OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, + core_get_param_types,(const OSSL_PROVIDER *prov)) +# define OSSL_FUNC_CORE_GET_PARAMS 2 +OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_PROVIDER *prov, + const OSSL_PARAM params[])) + +/* Functions provided by the provider to the Core, reserved numbers 1024-1535 */ +# define OSSL_FUNC_PROVIDER_TEARDOWN 1024 +OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void)) +# define OSSL_FUNC_PROVIDER_GET_PARAM_TYPES 1025 +OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, + provider_get_param_types,(const OSSL_PROVIDER *prov)) +# define OSSL_FUNC_PROVIDER_GET_PARAMS 1026 +OSSL_CORE_MAKE_FUNC(int,provider_get_params,(const OSSL_PROVIDER *prov, + const OSSL_PARAM params[])) + + +# ifdef __cplusplus +} +# endif + +#endif diff --git a/include/openssl/cryptoerr.h b/include/openssl/cryptoerr.h index f07d07e023..4924e336eb 100644 --- a/include/openssl/cryptoerr.h +++ b/include/openssl/cryptoerr.h @@ -34,6 +34,7 @@ int ERR_load_CRYPTO_strings(void); # define CRYPTO_F_CRYPTO_SET_EX_DATA 102 # define CRYPTO_F_FIPS_MODE_SET 109 # define CRYPTO_F_GET_AND_LOCK 113 +# define CRYPTO_F_GET_PROVIDER_STORE 133 # define CRYPTO_F_OPENSSL_ATEXIT 114 # define CRYPTO_F_OPENSSL_BUF2HEXSTR 117 # define CRYPTO_F_OPENSSL_FOPEN 119 @@ -42,6 +43,8 @@ int ERR_load_CRYPTO_strings(void); # define CRYPTO_F_OPENSSL_LH_NEW 126 # define CRYPTO_F_OPENSSL_SK_DEEP_COPY 127 # define CRYPTO_F_OPENSSL_SK_DUP 128 +# define CRYPTO_F_OSSL_PROVIDER_ACTIVATE 130 +# define CRYPTO_F_OSSL_PROVIDER_NEW 131 # define CRYPTO_F_PKEY_HMAC_INIT 123 # define CRYPTO_F_PKEY_POLY1305_INIT 124 # define CRYPTO_F_PKEY_SIPHASH_INIT 125 @@ -53,5 +56,6 @@ int ERR_load_CRYPTO_strings(void); # define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED 101 # define CRYPTO_R_ILLEGAL_HEX_DIGIT 102 # define CRYPTO_R_ODD_NUMBER_OF_DIGITS 103 +# define CRYPTO_R_PROVIDER_ALREADY_EXISTS 104 #endif diff --git a/include/openssl/ossl_typ.h b/include/openssl/ossl_typ.h index 9b97e3d3ab..07e5f02983 100644 --- a/include/openssl/ossl_typ.h +++ b/include/openssl/ossl_typ.h @@ -18,6 +18,8 @@ extern "C" { # include +typedef struct ossl_provider_st OSSL_PROVIDER; /* Provider Object */ + # ifdef NO_ASN1_TYPEDEFS # define ASN1_INTEGER ASN1_STRING # define ASN1_ENUMERATED ASN1_STRING diff --git a/util/perl/OpenSSL/ParseC.pm b/util/perl/OpenSSL/ParseC.pm index 7a13930d1a..59b08e8dca 100644 --- a/util/perl/OpenSSL/ParseC.pm +++ b/util/perl/OpenSSL/ParseC.pm @@ -578,6 +578,15 @@ my @chandlers = ( { regexp => qr/extern "C" (.*;)/, massager => sub { return ($1); }, }, + # any other extern is just ignored + { regexp => qr/^\s* # Any spaces before + extern # The keyword we look for + \b # word to non-word boundary + .* # Anything after + ; + /x, + massager => sub { return (); }, + }, # union, struct and enum definitions # Because this one might appear a little everywhere within type # definitions, we take it out and replace it with just -- 2.25.1