diff options
author | Richard Levitte <levitte@openssl.org> | 2019-06-01 11:18:15 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-08-15 22:12:25 +0200 |
commit | 2e5db6ad84ecd80954a66e250eae7d96e4565ea1 (patch) | |
tree | f03b092fb7ba01b7258d97c67b015626debaac2d /providers | |
parent | 55a0a117e7d911752bc7e3e00a67f7a5ad168159 (diff) |
Move CMAC to providers
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8877)
Diffstat (limited to 'providers')
-rw-r--r-- | providers/common/build.info | 2 | ||||
-rw-r--r-- | providers/common/include/internal/provider_algs.h | 1 | ||||
-rw-r--r-- | providers/common/macs/build.info | 11 | ||||
-rw-r--r-- | providers/common/macs/cmac_prov.c | 265 | ||||
-rw-r--r-- | providers/default/defltprov.c | 3 | ||||
-rw-r--r-- | providers/fips/fipsprov.c | 7 |
6 files changed, 288 insertions, 1 deletions
diff --git a/providers/common/build.info b/providers/common/build.info index bc106d0b0f..4c977d3f25 100644 --- a/providers/common/build.info +++ b/providers/common/build.info @@ -1,4 +1,4 @@ -SUBDIRS=digests ciphers exchange keymgmt +SUBDIRS=digests ciphers macs exchange keymgmt SOURCE[../../libcrypto]=\ provider_err.c provlib.c diff --git a/providers/common/include/internal/provider_algs.h b/providers/common/include/internal/provider_algs.h index c35230758e..c59fc18690 100644 --- a/providers/common/include/internal/provider_algs.h +++ b/providers/common/include/internal/provider_algs.h @@ -69,6 +69,7 @@ extern const OSSL_DISPATCH aria128gcm_functions[]; /* MACs */ extern const OSSL_DISPATCH blake2bmac_functions[]; extern const OSSL_DISPATCH blake2smac_functions[]; +extern const OSSL_DISPATCH cmac_functions[]; /* Key management */ extern const OSSL_DISPATCH dh_keymgmt_functions[]; diff --git a/providers/common/macs/build.info b/providers/common/macs/build.info new file mode 100644 index 0000000000..4871e4b524 --- /dev/null +++ b/providers/common/macs/build.info @@ -0,0 +1,11 @@ +$COMMON=cmac_prov.c + +LIBS=../../../libcrypto +SOURCE[../../../libcrypto]=$COMMON +INCLUDE[../../../libcrypto]=. ../../../crypto + +IF[{- !$disabled{fips} -}] + MODULES=../../fips + SOURCE[../../fips]=$COMMON + INCLUDE[../../fips]=. ../../../crypto +ENDIF diff --git a/providers/common/macs/cmac_prov.c b/providers/common/macs/cmac_prov.c new file mode 100644 index 0000000000..ca42a671ae --- /dev/null +++ b/providers/common/macs/cmac_prov.c @@ -0,0 +1,265 @@ +/* + * Copyright 2018 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/opensslconf.h> +#ifndef OPENSSL_NO_CMAC + +# include <openssl/core_numbers.h> +# include <openssl/core_names.h> +# include <openssl/params.h> +# include <openssl/engine.h> +# include <openssl/evp.h> +# include <openssl/cmac.h> + +# include "internal/provider_algs.h" +# include "internal/provider_ctx.h" + +/* + * Forward declaration of everything implemented here. This is not strictly + * necessary for the compiler, but provides an assurance that the signatures + * of the functions in the dispatch table are correct. + */ +static OSSL_OP_mac_newctx_fn cmac_new; +static OSSL_OP_mac_dupctx_fn cmac_dup; +static OSSL_OP_mac_freectx_fn cmac_free; +static OSSL_OP_mac_gettable_ctx_params_fn cmac_gettable_ctx_params; +static OSSL_OP_mac_ctx_get_params_fn cmac_ctx_get_params; +static OSSL_OP_mac_settable_ctx_params_fn cmac_settable_ctx_params; +static OSSL_OP_mac_ctx_set_params_fn cmac_ctx_set_params; +static OSSL_OP_mac_init_fn cmac_init; +static OSSL_OP_mac_update_fn cmac_update; +static OSSL_OP_mac_final_fn cmac_final; + +/* local CMAC data */ + +struct cmac_data_st { + void *provctx; + CMAC_CTX *ctx; + + /* + * References to the underlying cipher implementation. tmpcipher + * caches the cipher, always. alloc_cipher only holds a reference + * to an explicitly fetched cipher. + * tmpcipher is cleared after a CMAC_Init call. + */ + const EVP_CIPHER *tmpcipher; /* cached CMAC cipher */ + EVP_CIPHER *alloc_cipher; /* fetched CMAC cipher */ + + /* + * Conditions for legacy EVP_CIPHER uses. + * tmpengine is cleared after a CMAC_Init call. + */ + ENGINE *tmpengine; /* CMAC cipher engine (legacy) */ +}; + +static void *cmac_new(void *provctx) +{ + struct cmac_data_st *macctx; + + if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL + || (macctx->ctx = CMAC_CTX_new()) == NULL) { + OPENSSL_free(macctx); + macctx = NULL; + } + macctx->provctx = provctx; + + return macctx; +} + +static void cmac_free(void *vmacctx) +{ + struct cmac_data_st *macctx = vmacctx; + + if (macctx != NULL) { + CMAC_CTX_free(macctx->ctx); + EVP_CIPHER_meth_free(macctx->alloc_cipher); + OPENSSL_free(macctx); + } +} + +static void *cmac_dup(void *vsrc) +{ + struct cmac_data_st *src = vsrc; + struct cmac_data_st *dst = cmac_new(src->provctx); + + if (!CMAC_CTX_copy(dst->ctx, src->ctx)) { + cmac_free(dst); + return NULL; + } + + if (src->alloc_cipher != NULL && !EVP_CIPHER_up_ref(src->alloc_cipher)) { + cmac_free(dst); + return NULL; + } + + dst->tmpengine = src->tmpengine; + dst->tmpcipher = src->tmpcipher; + dst->alloc_cipher = src->alloc_cipher; + return dst; +} + +static size_t cmac_size(void *vmacctx) +{ + struct cmac_data_st *macctx = vmacctx; + + return EVP_CIPHER_CTX_block_size(CMAC_CTX_get0_cipher_ctx(macctx->ctx)); +} + +static int cmac_init(void *vmacctx) +{ + struct cmac_data_st *macctx = vmacctx; + int rv = CMAC_Init(macctx->ctx, NULL, 0, macctx->tmpcipher, + (ENGINE *)macctx->tmpengine); + + macctx->tmpcipher = NULL; + macctx->tmpengine = NULL; + + return rv; +} + +static int cmac_update(void *vmacctx, const unsigned char *data, + size_t datalen) +{ + struct cmac_data_st *macctx = vmacctx; + + return CMAC_Update(macctx->ctx, data, datalen); +} + +static int cmac_final(void *vmacctx, unsigned char *out, size_t *outl, + size_t outsize) +{ + struct cmac_data_st *macctx = vmacctx; + + return CMAC_Final(macctx->ctx, out, outl); +} + +static const OSSL_PARAM known_gettable_ctx_params[] = { + OSSL_PARAM_size_t(OSSL_MAC_PARAM_OUTLEN, NULL), + OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL), /* Same as "outlen" */ + OSSL_PARAM_END +}; +static const OSSL_PARAM *cmac_gettable_ctx_params(void) +{ + return known_gettable_ctx_params; +} + +static int cmac_ctx_get_params(void *vmacctx, OSSL_PARAM params[]) +{ + OSSL_PARAM *p; + + if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_OUTLEN)) != NULL + || (p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL) + return OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)); + + return 1; +} + +static const OSSL_PARAM known_settable_ctx_params[] = { + /* "algorithm" and "cipher" are the same parameter */ + OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_ALGORITHM, NULL, 0), + OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER, NULL, 0), + OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_ENGINE, NULL, 0), + OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0), + OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0), + OSSL_PARAM_END +}; +static const OSSL_PARAM *cmac_settable_ctx_params(void) +{ + return known_settable_ctx_params; +} + +/* + * ALL parameters should be set before init(). + */ +static int cmac_ctx_set_params(void *vmacctx, const OSSL_PARAM params[]) +{ + struct cmac_data_st *macctx = vmacctx; + const OSSL_PARAM *p; + + if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CIPHER)) != NULL + || ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_ALGORITHM)) + != NULL)) { + if (p->data_type != OSSL_PARAM_UTF8_STRING) + return 0; + + { + const char *algoname = p->data; + const char *propquery = NULL; + +#ifndef FIPS_MODE /* Inside the FIPS module, we don't support engines */ + ENGINE_finish(macctx->tmpengine); + macctx->tmpengine = NULL; + + if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_ENGINE)) + != NULL) { + if (p->data_type != OSSL_PARAM_UTF8_STRING) + return 0; + + macctx->tmpengine = ENGINE_by_id(p->data); + if (macctx->tmpengine == NULL) + return 0; + } +#endif + if ((p = OSSL_PARAM_locate_const(params, + OSSL_MAC_PARAM_PROPERTIES)) + != NULL) { + if (p->data_type != OSSL_PARAM_UTF8_STRING) + return 0; + + propquery = p->data; + } + + EVP_CIPHER_meth_free(macctx->alloc_cipher); + + macctx->tmpcipher = macctx->alloc_cipher = + EVP_CIPHER_fetch(PROV_LIBRARY_CONTEXT_OF(macctx->provctx), + algoname, propquery); + +#ifndef FIPS_MODE /* Inside the FIPS module, we don't support legacy digests */ + /* TODO(3.0) BEGIN legacy stuff, to be removed */ + if (macctx->tmpcipher == NULL) + macctx->tmpcipher = EVP_get_cipherbyname(algoname); + /* TODO(3.0) END of legacy stuff */ +#endif + + if (macctx->tmpcipher == NULL) + return 0; + } + } + if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) { + if (p->data_type != OSSL_PARAM_OCTET_STRING) + return 0; + + if (!CMAC_Init(macctx->ctx, p->data, p->data_size, + macctx->tmpcipher, macctx->tmpengine)) + return 0; + + macctx->tmpcipher = NULL; + macctx->tmpengine = NULL; + } + return 1; +} + +const OSSL_DISPATCH cmac_functions[] = { + { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))cmac_new }, + { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))cmac_dup }, + { OSSL_FUNC_MAC_FREECTX, (void (*)(void))cmac_free }, + { OSSL_FUNC_MAC_INIT, (void (*)(void))cmac_init }, + { OSSL_FUNC_MAC_UPDATE, (void (*)(void))cmac_update }, + { OSSL_FUNC_MAC_FINAL, (void (*)(void))cmac_final }, + { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS, + (void (*)(void))cmac_gettable_ctx_params }, + { OSSL_FUNC_MAC_CTX_GET_PARAMS, (void (*)(void))cmac_ctx_get_params }, + { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS, + (void (*)(void))cmac_settable_ctx_params }, + { OSSL_FUNC_MAC_CTX_SET_PARAMS, (void (*)(void))cmac_ctx_set_params }, + { 0, NULL } +}; + +#endif diff --git a/providers/default/defltprov.c b/providers/default/defltprov.c index f4457a4d90..dc8011c8f7 100644 --- a/providers/default/defltprov.c +++ b/providers/default/defltprov.c @@ -128,6 +128,9 @@ static const OSSL_ALGORITHM deflt_macs[] = { { "BLAKE2BMAC", "default=yes", blake2bmac_functions }, { "BLAKE2SMAC", "default=yes", blake2smac_functions }, #endif +#ifndef OPENSSL_NO_CMAC + { "CMAC", "default=yes", cmac_functions }, +#endif { NULL, NULL, NULL } }; diff --git a/providers/fips/fipsprov.c b/providers/fips/fipsprov.c index a59ebce239..96e5e1dc41 100644 --- a/providers/fips/fipsprov.c +++ b/providers/fips/fipsprov.c @@ -274,6 +274,11 @@ static const OSSL_ALGORITHM fips_ciphers[] = { { NULL, NULL, NULL } }; +static const OSSL_ALGORITHM fips_macs[] = { + { "CMAC", "fips=yes", cmac_functions }, + { NULL, NULL, NULL } +}; + static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov, int operation_id, int *no_cache) @@ -284,6 +289,8 @@ static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov, return fips_digests; case OSSL_OP_CIPHER: return fips_ciphers; + case OSSL_OP_MAC: + return fips_macs; } return NULL; } |