wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move KMAC to providers

Browse source 
Instead of using evp_keccak_kmac128() and evp_keccak_kmac256(), we refer
to the hash implementation by name, and fetch it, which should get us the
implementation from providers/common/digests/sha3_prov.c.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8877)
This commit is contained in:
Richard Levitte 2019-06-02 08:46:35 +02:00
parent 5183ebdcf5
commit e23cda000e
8 changed files with 241 additions and 151 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
crypto/build.info
View file

@ -5,7 +5,7 @@ SUBDIRS=objects buffer bio stack lhash rand evp asn1 pem x509 conf \
md2 md4 md5 sha mdc2 hmac ripemd whrlpool poly1305 blake2 \
siphash sm3 des aes rc2 rc4 rc5 idea aria bf cast camellia \
seed sm4 chacha modes bn ec rsa dsa dh sm2 dso engine \
err comp ocsp cms ts srp cmac ct async kmac ess crmf cmp
err comp ocsp cms ts srp cmac ct async ess crmf cmp
LIBS=../libcrypto

1
crypto/err/openssl.txt
View file

@ -1161,6 +1161,7 @@ PROV_F_AES_T4_INIT_KEY:112:aes_t4_init_key
PROV_F_BLAKE2_MAC_INIT:115:blake2_mac_init
PROV_F_BLAKE2_MAC_SET_PARAMS:116:blake2_mac_set_params
PROV_F_GMAC_SET_PARAMS:117:gmac_set_params
PROV_F_KMAC_SET_PARAMS:118:kmac_set_params
PROV_F_PROV_AES_KEY_GENERIC_INIT:113:PROV_AES_KEY_generic_init
PROV_F_TRAILINGDATA:114:trailingdata
PROV_F_UNPADBLOCK:100:unpadblock

3
crypto/kmac/build.info
View file

@ -1,3 +0,0 @@
LIBS=../../libcrypto
SOURCE[../../libcrypto]=kmac.c

2
providers/common/include/internal/provider_algs.h
View file

@ -72,6 +72,8 @@ extern const OSSL_DISPATCH blake2smac_functions[];
extern const OSSL_DISPATCH cmac_functions[];
extern const OSSL_DISPATCH gmac_functions[];
extern const OSSL_DISPATCH hmac_functions[];
extern const OSSL_DISPATCH kmac128_functions[];
extern const OSSL_DISPATCH kmac256_functions[];
/* Key management */
extern const OSSL_DISPATCH dh_keymgmt_functions[];

2
providers/common/macs/build.info
View file

@ -1,4 +1,4 @@
$COMMON=cmac_prov.c gmac_prov.c hmac_prov.c
$COMMON=cmac_prov.c gmac_prov.c hmac_prov.c kmac_prov.c
LIBS=../../../libcrypto
SOURCE[../../../libcrypto]=$COMMON

370
crypto/kmac/kmac.c → providers/common/macs/kmac_prov.c
View file

@ -47,9 +47,34 @@
*/
#include <stdlib.h>
#include <string.h>
#include <openssl/core_numbers.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/evp.h>
#include "internal/cryptlib.h"
#include "internal/evp_int.h"
#include <openssl/err.h>
#include "internal/providercommonerr.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 kmac128_new;
static OSSL_OP_mac_newctx_fn kmac256_new;
static OSSL_OP_mac_dupctx_fn kmac_dup;
static OSSL_OP_mac_freectx_fn kmac_free;
static OSSL_OP_mac_gettable_ctx_params_fn kmac_gettable_ctx_params;
static OSSL_OP_mac_ctx_get_params_fn kmac_ctx_get_params;
static OSSL_OP_mac_settable_ctx_params_fn kmac_settable_ctx_params;
static OSSL_OP_mac_ctx_set_params_fn kmac_ctx_set_params;
static OSSL_OP_mac_size_fn kmac_size;
static OSSL_OP_mac_init_fn kmac_init;
static OSSL_OP_mac_update_fn kmac_update;
static OSSL_OP_mac_final_fn kmac_final;
#define KMAC_MAX_BLOCKSIZE ((1600 - 128*2) / 8) /* 168 */
#define KMAC_MIN_BLOCKSIZE ((1600 - 256*2) / 8) /* 136 */
@ -85,10 +110,19 @@ static const unsigned char kmac_string[] = {
#define KMAC_FLAG_XOF_MODE 1
/* typedef EVP_MAC_IMPL */
struct evp_mac_impl_st {
struct kmac_data_st {
void *provctx;
EVP_MD_CTX *ctx;
const EVP_MD *md;
/*
* References to the underlying keccak_kmac implementation. |md|
* caches the digest, always. |alloc_md| only holds a reference to an
* explicitly fetched digest.
* |md| is cleared after a EVP_DigestInit call.
*/
const EVP_MD *md; /* Cache KMAC digest */
EVP_MD *alloc_md; /* Fetched digest */
size_t out_len;
int key_len;
int custom_len;
@ -109,66 +143,98 @@ static int bytepad(unsigned char *out, int *out_len,
static int kmac_bytepad_encode_key(unsigned char *out, int *out_len,
const unsigned char *in, int in_len,
int w);
static int kmac_ctrl_str(EVP_MAC_IMPL *kctx, const char *type,
const char *value);
static void kmac_free(EVP_MAC_IMPL *kctx)
static void kmac_free(void *vmacctx)
{
struct kmac_data_st *kctx = vmacctx;
if (kctx != NULL) {
EVP_MD_CTX_free(kctx->ctx);
EVP_MD_meth_free(kctx->alloc_md);
OPENSSL_cleanse(kctx->key, kctx->key_len);
OPENSSL_cleanse(kctx->custom, kctx->custom_len);
OPENSSL_free(kctx);
}
}
static EVP_MAC_IMPL *kmac_new(const EVP_MD *md)
/*
* We have KMAC implemented as a hash, which we can use instead of
* reimplementing the EVP functionality with direct use of
* keccak_mac_init() and friends.
*/
static void *kmac_new(void *provctx, EVP_MD *fetched_md, const EVP_MD *md)
{
EVP_MAC_IMPL *kctx = NULL;
struct kmac_data_st *kctx = NULL;
if (md == NULL)
return NULL;
if ((kctx = OPENSSL_zalloc(sizeof(*kctx))) == NULL
|| (kctx->ctx = EVP_MD_CTX_new()) == NULL) {
kmac_free(kctx);
return NULL;
}
kctx->provctx = provctx;
kctx->md = md;
kctx->out_len = md->md_size;
kctx->alloc_md = fetched_md;
kctx->out_len = EVP_MD_size(md);
return kctx;
}
static EVP_MAC_IMPL *kmac128_new(void)
static void *kmac_fetch_new(void *provctx, const char *mdname)
{
return kmac_new(evp_keccak_kmac128());
EVP_MD *fetched_md = EVP_MD_fetch(PROV_LIBRARY_CONTEXT_OF(provctx),
mdname, NULL);
const EVP_MD *md = fetched_md;
void *ret = NULL;
#ifndef FIPS_MODE /* Inside the FIPS module, we don't support legacy digests */
/* TODO(3.0) BEGIN legacy stuff, to be removed */
if (md == NULL)
md = EVP_get_digestbyname(mdname);
/* TODO(3.0) END of legacy stuff */
#endif
ret = kmac_new(provctx, fetched_md, md);
if (ret == NULL)
EVP_MD_meth_free(fetched_md);
return ret;
}
static EVP_MAC_IMPL *kmac256_new(void)
static void *kmac128_new(void *provctx)
{
return kmac_new(evp_keccak_kmac256());
return kmac_fetch_new(provctx, "KMAC128");
}
static EVP_MAC_IMPL *kmac_dup(const EVP_MAC_IMPL *gsrc)
static void *kmac256_new(void *provctx)
{
EVP_MAC_IMPL *gdst;
return kmac_fetch_new(provctx, "KMAC256");
}
gdst = kmac_new(gsrc->md);
if (gdst == NULL)
static void *kmac_dup(void *vsrc)
{
struct kmac_data_st *src = vsrc;
struct kmac_data_st *dst = kmac_new(src->provctx, src->alloc_md, src->md);
if (dst == NULL)
return NULL;
if (!EVP_MD_CTX_copy(gdst->ctx, gsrc->ctx)) {
kmac_free(gdst);
if (!EVP_MD_CTX_copy(dst->ctx, src->ctx)
|| (src->alloc_md != NULL && !EVP_MD_up_ref(src->alloc_md))) {
kmac_free(dst);
return NULL;
}
gdst->md = gsrc->md;
gdst->out_len = gsrc->out_len;
gdst->key_len = gsrc->key_len;
gdst->custom_len = gsrc->custom_len;
gdst->xof_mode = gsrc->xof_mode;
memcpy(gdst->key, gsrc->key, gsrc->key_len);
memcpy(gdst->custom, gsrc->custom, gdst->custom_len);
dst->md = src->md;
dst->alloc_md = src->alloc_md;
dst->out_len = src->out_len;
dst->key_len = src->key_len;
dst->custom_len = src->custom_len;
dst->xof_mode = src->xof_mode;
memcpy(dst->key, src->key, src->key_len);
memcpy(dst->custom, src->custom, dst->custom_len);
return gdst;
return dst;
}
/*
@ -176,12 +242,14 @@ static EVP_MAC_IMPL *kmac_dup(const EVP_MAC_IMPL *gsrc)
* md, key and custom. Setting the fields afterwards will have no
* effect on the output mac.
*/
static int kmac_init(EVP_MAC_IMPL *kctx)
static int kmac_init(void *vmacctx)
{
struct kmac_data_st *kctx = vmacctx;
EVP_MD_CTX *ctx = kctx->ctx;
unsigned char out[KMAC_MAX_BLOCKSIZE];
int out_len, block_len;
/* Check key has been set */
if (kctx->key_len == 0) {
EVPerr(EVP_F_KMAC_INIT, EVP_R_NO_KEY_SET);
@ -193,8 +261,13 @@ static int kmac_init(EVP_MAC_IMPL *kctx)
block_len = EVP_MD_block_size(kctx->md);
/* Set default custom string if it is not already set */
if (kctx->custom_len == 0)
(void)kmac_ctrl_str(kctx, "custom", "");
if (kctx->custom_len == 0) {
const OSSL_PARAM params[] = {
OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, "", 0),
OSSL_PARAM_END
};
(void)kmac_ctx_set_params(kctx, params);
}
return bytepad(out, &out_len, kmac_string, sizeof(kmac_string),
kctx->custom, kctx->custom_len, block_len)
@ -202,120 +275,120 @@ static int kmac_init(EVP_MAC_IMPL *kctx)
&& EVP_DigestUpdate(ctx, kctx->key, kctx->key_len);
}
static size_t kmac_size(EVP_MAC_IMPL *kctx)
static size_t kmac_size(void *vmacctx)
{
struct kmac_data_st *kctx = vmacctx;
return kctx->out_len;
}
static int kmac_update(EVP_MAC_IMPL *kctx, const unsigned char *data,
static int kmac_update(void *vmacctx, const unsigned char *data,
size_t datalen)
{
struct kmac_data_st *kctx = vmacctx;
return EVP_DigestUpdate(kctx->ctx, data, datalen);
}
static int kmac_final(EVP_MAC_IMPL *kctx, unsigned char *out)
static int kmac_final(void *vmacctx, unsigned char *out, size_t *outl,
size_t outsize)
{
struct kmac_data_st *kctx = vmacctx;
EVP_MD_CTX *ctx = kctx->ctx;
int lbits, len;
unsigned char encoded_outlen[KMAC_MAX_ENCODED_HEADER_LEN];
int ok;
/* KMAC XOF mode sets the encoded length to 0 */
lbits = (kctx->xof_mode ? 0 : (kctx->out_len * 8));
return right_encode(encoded_outlen, &len, lbits)
&& EVP_DigestUpdate(ctx, encoded_outlen, len)
&& EVP_DigestFinalXOF(ctx, out, kctx->out_len);
ok = right_encode(encoded_outlen, &len, lbits)
&& EVP_DigestUpdate(ctx, encoded_outlen, len)
&& EVP_DigestFinalXOF(ctx, out, kctx->out_len);
if (ok && outl != NULL)
*outl = kctx->out_len;
return ok;
}
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_size_t(OSSL_MAC_PARAM_DIGESTSIZE, NULL), /* Same as "outlen" */
OSSL_PARAM_END
};
static const OSSL_PARAM *kmac_gettable_ctx_params(void)
{
return known_gettable_ctx_params;
}
static int kmac_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
|| (p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_DIGESTSIZE)) != NULL)
return OSSL_PARAM_set_size_t(p, kmac_size(vmacctx));
return 1;
}
static const OSSL_PARAM known_settable_ctx_params[] = {
OSSL_PARAM_int(OSSL_MAC_PARAM_XOF, NULL),
OSSL_PARAM_size_t(OSSL_MAC_PARAM_OUTLEN, NULL),
OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, NULL, 0),
OSSL_PARAM_END
};
static const OSSL_PARAM *kmac_settable_ctx_params(void)
{
return known_settable_ctx_params;
}
/*
* The following Ctrl functions can be set any time before final():
* - EVP_MAC_CTRL_SET_SIZE: The requested output length.
* - EVP_MAC_CTRL_SET_XOF: If set, this indicates that right_encoded(0) is
* part of the digested data, otherwise it uses
* right_encoded(requested output length).
* All other Ctrl functions should be set before init().
* The following params can be set any time before final():
* - "outlen" or "size": The requested output length.
* - "xof": If set, this indicates that right_encoded(0)
* is part of the digested data, otherwise it
* uses right_encoded(requested output length).
*
* All other params should be set before init().
*/
static int kmac_ctrl(EVP_MAC_IMPL *kctx, int cmd, va_list args)
static int kmac_ctx_set_params(void *vmacctx, const OSSL_PARAM *params)
{
const unsigned char *p;
size_t len;
size_t size;
struct kmac_data_st *kctx = vmacctx;
const OSSL_PARAM *p;
switch (cmd) {
case EVP_MAC_CTRL_SET_XOF:
kctx->xof_mode = va_arg(args, int);
return 1;
case EVP_MAC_CTRL_SET_SIZE:
size = va_arg(args, size_t);
kctx->out_len = size;
return 1;
case EVP_MAC_CTRL_SET_KEY:
p = va_arg(args, const unsigned char *);
len = va_arg(args, size_t);
if (len < 4 || len > KMAC_MAX_KEY) {
EVPerr(EVP_F_KMAC_CTRL, EVP_R_INVALID_KEY_LENGTH);
return 0;
}
return kmac_bytepad_encode_key(kctx->key, &kctx->key_len, p, len,
EVP_MD_block_size(kctx->md));
case EVP_MAC_CTRL_SET_CUSTOM:
p = va_arg(args, const unsigned char *);
len = va_arg(args, size_t);
if (len > KMAC_MAX_CUSTOM) {
EVPerr(EVP_F_KMAC_CTRL, EVP_R_INVALID_CUSTOM_LENGTH);
return 0;
}
return encode_string(kctx->custom, &kctx->custom_len, p, len);
default:
return -2;
}
}
static int kmac_ctrl_int(EVP_MAC_IMPL *kctx, int cmd, ...)
{
int rv;
va_list args;
va_start(args, cmd);
rv = kmac_ctrl(kctx, cmd, args);
va_end(args);
return rv;
}
static int kmac_ctrl_str_cb(void *kctx, int cmd, void *buf, size_t buflen)
{
return kmac_ctrl_int(kctx, cmd, buf, buflen);
}
static int kmac_ctrl_str(EVP_MAC_IMPL *kctx, const char *type,
const char *value)
{
if (value == NULL)
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_XOF)) != NULL
&& !OSSL_PARAM_get_int(p, &kctx->xof_mode))
return 0;
if (strcmp(type, "outlen") == 0)
return kmac_ctrl_int(kctx, EVP_MAC_CTRL_SET_SIZE, (size_t)atoi(value));
if (strcmp(type, "xof") == 0)
return kmac_ctrl_int(kctx, EVP_MAC_CTRL_SET_XOF, atoi(value));
if (strcmp(type, "key") == 0)
return EVP_str2ctrl(kmac_ctrl_str_cb, kctx, EVP_MAC_CTRL_SET_KEY,
value);
if (strcmp(type, "hexkey") == 0)
return EVP_hex2ctrl(kmac_ctrl_str_cb, kctx, EVP_MAC_CTRL_SET_KEY,
value);
if (strcmp(type, "custom") == 0)
return EVP_str2ctrl(kmac_ctrl_str_cb, kctx, EVP_MAC_CTRL_SET_CUSTOM,
value);
if (strcmp(type, "hexcustom") == 0)
return EVP_hex2ctrl(kmac_ctrl_str_cb, kctx, EVP_MAC_CTRL_SET_CUSTOM,
value);
return -2;
if (((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_OUTLEN)) != NULL
||
(p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL)
&& !OSSL_PARAM_get_size_t(p, &kctx->out_len))
return 0;
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
if (p->data_size < 4 || p->data_size > KMAC_MAX_KEY) {
ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
return 0;
}
if (!kmac_bytepad_encode_key(kctx->key, &kctx->key_len,
p->data, p->data_size,
EVP_MD_block_size(kctx->md)))
return 0;
}
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CUSTOM))
!= NULL) {
if (p->data_size > KMAC_MAX_CUSTOM) {
ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
return 0;
}
if (!encode_string(kctx->custom, &kctx->custom_len,
p->data, p->data_size))
return 0;
}
return 1;
}
/*
@ -452,29 +525,34 @@ static int kmac_bytepad_encode_key(unsigned char *out, int *out_len,
return bytepad(out, out_len, tmp, tmp_len, NULL, 0, w);
}
const EVP_MAC kmac128_meth = {
EVP_MAC_KMAC128,
kmac128_new,
kmac_dup,
kmac_free,
kmac_size,
kmac_init,
kmac_update,
kmac_final,
kmac_ctrl,
kmac_ctrl_str
const OSSL_DISPATCH kmac128_functions[] = {
{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))kmac128_new },
{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))kmac_dup },
{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))kmac_free },
{ OSSL_FUNC_MAC_INIT, (void (*)(void))kmac_init },
{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))kmac_update },
{ OSSL_FUNC_MAC_FINAL, (void (*)(void))kmac_final },
{ OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
(void (*)(void))kmac_gettable_ctx_params },
{ OSSL_FUNC_MAC_CTX_GET_PARAMS, (void (*)(void))kmac_ctx_get_params },
{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
(void (*)(void))kmac_settable_ctx_params },
{ OSSL_FUNC_MAC_CTX_SET_PARAMS, (void (*)(void))kmac_ctx_set_params },
{ 0, NULL }
};
const EVP_MAC kmac256_meth = {
EVP_MAC_KMAC256,
kmac256_new,
kmac_dup,
kmac_free,
kmac_size,
kmac_init,
kmac_update,
kmac_final,
kmac_ctrl,
kmac_ctrl_str
const OSSL_DISPATCH kmac256_functions[] = {
{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))kmac256_new },
{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))kmac_dup },
{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))kmac_free },
{ OSSL_FUNC_MAC_INIT, (void (*)(void))kmac_init },
{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))kmac_update },
{ OSSL_FUNC_MAC_FINAL, (void (*)(void))kmac_final },
{ OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
(void (*)(void))kmac_gettable_ctx_params },
{ OSSL_FUNC_MAC_CTX_GET_PARAMS, (void (*)(void))kmac_ctx_get_params },
{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
(void (*)(void))kmac_settable_ctx_params },
{ OSSL_FUNC_MAC_CTX_SET_PARAMS, (void (*)(void))kmac_ctx_set_params },
{ 0, NULL }
};

6
providers/default/defltprov.c
View file

@ -65,6 +65,10 @@ static const OSSL_ALGORITHM deflt_digests[] = {
{ "SHA3-384", "default=yes", sha3_384_functions },
{ "SHA3-512", "default=yes", sha3_512_functions },
/*
* KMAC128 and KMAC256 as hashes are mostly useful for the MACs with the
* same names
*/
{ "KMAC128", "default=yes", keccak_kmac_128_functions },
{ "KMAC256", "default=yes", keccak_kmac_256_functions },
@ -133,6 +137,8 @@ static const OSSL_ALGORITHM deflt_macs[] = {
#endif
{ "GMAC", "default=yes", gmac_functions },
{ "HMAC", "default=yes", hmac_functions },
{ "KMAC128", "default=yes", kmac128_functions },
{ "KMAC256", "default=yes", kmac256_functions },
{ NULL, NULL, NULL }
};

6
providers/fips/fipsprov.c
View file

@ -252,6 +252,10 @@ static const OSSL_ALGORITHM fips_digests[] = {
{ "SHA3-256", "fips=yes", sha3_256_functions },
{ "SHA3-384", "fips=yes", sha3_384_functions },
{ "SHA3-512", "fips=yes", sha3_512_functions },
/*
* KMAC128 and KMAC256 as hashes are mostly useful for the MACs with the
* same names
*/
{ "KMAC128", "fips=yes", keccak_kmac_128_functions },
{ "KMAC256", "fips=yes", keccak_kmac_256_functions },
@ -278,6 +282,8 @@ static const OSSL_ALGORITHM fips_macs[] = {
{ "CMAC", "fips=yes", cmac_functions },
{ "GMAC", "fips=yes", gmac_functions },
{ "HMAC", "fips=yes", hmac_functions },
{ "KMAC128", "fips=yes", kmac128_functions },
{ "KMAC256", "fips=yes", kmac256_functions },
{ NULL, NULL, NULL }
};