From c89d9cdab1727553e3cfa964e9f082cbc5a194c2 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Thu, 25 Oct 2018 00:17:45 +0200 Subject: [PATCH] EVP_MAC: Add SipHash implementation Reviewed-by: Paul Dale (Merged from https://github.com/openssl/openssl/pull/7494) --- crypto/evp/c_allm.c | 3 + crypto/include/internal/evp_int.h | 1 + crypto/siphash/build.info | 1 + crypto/siphash/siphash_meth.c | 139 +++++++++++++++++++++++ doc/man3/EVP_MAC.pod | 3 +- doc/man7/EVP_MAC_SIPHASH.pod | 61 ++++++++++ include/openssl/evp.h | 5 +- test/recipes/30-test_evp_data/evpmac.txt | 2 +- 8 files changed, 211 insertions(+), 4 deletions(-) create mode 100644 crypto/siphash/siphash_meth.c create mode 100644 doc/man7/EVP_MAC_SIPHASH.pod diff --git a/crypto/evp/c_allm.c b/crypto/evp/c_allm.c index edf8ba500b..2bcd9dc9b5 100644 --- a/crypto/evp/c_allm.c +++ b/crypto/evp/c_allm.c @@ -16,4 +16,7 @@ void openssl_add_all_macs_int(void) EVP_add_mac(&cmac_meth); #endif EVP_add_mac(&hmac_meth); +#ifndef OPENSSL_NO_SIPHASH + EVP_add_mac(&siphash_meth); +#endif } diff --git a/crypto/include/internal/evp_int.h b/crypto/include/internal/evp_int.h index e84205c3b8..060538e737 100644 --- a/crypto/include/internal/evp_int.h +++ b/crypto/include/internal/evp_int.h @@ -130,6 +130,7 @@ struct evp_mac_st { extern const EVP_MAC cmac_meth; extern const EVP_MAC hmac_meth; +extern const EVP_MAC siphash_meth; /* * This function is internal for now, but can be made external when needed. diff --git a/crypto/siphash/build.info b/crypto/siphash/build.info index 4166344a5b..d63c7397bb 100644 --- a/crypto/siphash/build.info +++ b/crypto/siphash/build.info @@ -1,5 +1,6 @@ LIBS=../../libcrypto SOURCE[../../libcrypto]=\ siphash.c \ + siphash_meth.c \ siphash_pmeth.c \ siphash_ameth.c diff --git a/crypto/siphash/siphash_meth.c b/crypto/siphash/siphash_meth.c new file mode 100644 index 0000000000..7a5457de46 --- /dev/null +++ b/crypto/siphash/siphash_meth.c @@ -0,0 +1,139 @@ +/* + * Copyright 2018 The OpenSSL Project Authors. All Rights Reserved. + * + * Licensed under the OpenSSL license (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 +#include "internal/siphash.h" +#include "siphash_local.h" +#include "internal/evp_int.h" + +/* local SIPHASH structure is actually a SIPHASH */ + +struct evp_mac_impl_st { + SIPHASH ctx; +}; + +static EVP_MAC_IMPL *siphash_new(void) +{ + return OPENSSL_zalloc(sizeof(EVP_MAC_IMPL)); +} + +static void siphash_free(EVP_MAC_IMPL *sctx) +{ + OPENSSL_free(sctx); +} + +static int siphash_copy(EVP_MAC_IMPL *sdst, EVP_MAC_IMPL *ssrc) +{ + *sdst = *ssrc; + return 1; +} + +static size_t siphash_size(EVP_MAC_IMPL *sctx) +{ + return SipHash_hash_size(&sctx->ctx); +} + +static int siphash_init(EVP_MAC_IMPL *sctx) +{ + /* Not much to do here, actual initialization happens through controls */ + return 1; +} + +static int siphash_update(EVP_MAC_IMPL *sctx, const unsigned char *data, + size_t datalen) +{ + SipHash_Update(&sctx->ctx, data, datalen); + return 1; +} + +static int siphash_final(EVP_MAC_IMPL *sctx, unsigned char *out) +{ + size_t hlen = siphash_size(sctx); + + return SipHash_Final(&sctx->ctx, out, hlen); +} + +static int siphash_ctrl(EVP_MAC_IMPL *sctx, int cmd, va_list args) +{ + switch (cmd) { + case EVP_MAC_CTRL_SET_SIZE: + { + size_t size = va_arg(args, size_t); + + return SipHash_set_hash_size(&sctx->ctx, size); + } + break; + case EVP_MAC_CTRL_SET_KEY: + { + const unsigned char *key = va_arg(args, const unsigned char *); + size_t keylen = va_arg(args, size_t); + + if (key == NULL || keylen != SIPHASH_KEY_SIZE) + return 0; + + return SipHash_Init(&sctx->ctx, key, 0, 0); + } + break; + default: + return -2; + } + return 1; +} + +static int siphash_ctrl_int(EVP_MAC_IMPL *sctx, int cmd, ...) +{ + int rv; + va_list args; + + va_start(args, cmd); + rv = siphash_ctrl(sctx, cmd, args); + va_end(args); + + return rv; +} + +static int siphash_ctrl_str_cb(void *ctx, int cmd, void *buf, size_t buflen) +{ + return siphash_ctrl_int(ctx, cmd, buf, buflen); +} + +static int siphash_ctrl_str(EVP_MAC_IMPL *ctx, + const char *type, const char *value) +{ + if (value == NULL) + return 0; + if (strcmp(type, "digestsize") == 0) { + size_t hash_size = atoi(value); + + return siphash_ctrl_int(ctx, EVP_MAC_CTRL_SET_SIZE, hash_size); + } + if (strcmp(type, "key") == 0) + return EVP_str2ctrl(siphash_ctrl_str_cb, ctx, EVP_MAC_CTRL_SET_KEY, + value); + if (strcmp(type, "hexkey") == 0) + return EVP_hex2ctrl(siphash_ctrl_str_cb, ctx, EVP_MAC_CTRL_SET_KEY, + value); + return -2; +} + +const EVP_MAC siphash_meth = { + EVP_MAC_SIPHASH, + siphash_new, + siphash_copy, + siphash_free, + siphash_size, + siphash_init, + siphash_update, + siphash_final, + siphash_ctrl, + siphash_ctrl_str +}; diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 02a48660db..a320181174 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -327,7 +327,8 @@ F<./foo>) =head1 SEE ALSO L, -L +L, +L =head1 COPYRIGHT diff --git a/doc/man7/EVP_MAC_SIPHASH.pod b/doc/man7/EVP_MAC_SIPHASH.pod new file mode 100644 index 0000000000..841cd7d6a8 --- /dev/null +++ b/doc/man7/EVP_MAC_SIPHASH.pod @@ -0,0 +1,61 @@ +=pod + +=head1 NAME + +EVP_MAC_SIPHASH - The SipHash EVP_MAC implementation + +=head1 DESCRIPTION + +Support for computing SipHash MACs through the B API. + +=head2 Numeric identity + +B is the numeric identity for this implementation, +and can be used in functions like EVP_MAC_CTX_new_id() and +EVP_get_macbynid(). + +=head2 Supported controls + +The supported controls are: + +=over 4 + +=item B + +EVP_MAC_ctrl_str() type string: "digestsize" + +The value string is expected to contain a decimal number. + +=item B + +EVP_MAC_ctrl_str() takes to type string for this control: + +=over 4 + +=item "key" + +The value string is used as is. + +=item "hexkey" + +The value string is expected to be a hexadecimal number, which will be +decoded before passing on as control value. + +=back + +=back + +=head1 SEE ALSO + +L, L + +=head1 COPYRIGHT + +Copyright 2018 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (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 +L. + +=cut diff --git a/include/openssl/evp.h b/include/openssl/evp.h index 657bedb34c..cfd6369ab0 100644 --- a/include/openssl/evp.h +++ b/include/openssl/evp.h @@ -987,8 +987,9 @@ void EVP_MD_do_all_sorted(void (*fn) /* MAC stuff */ -# define EVP_MAC_CMAC NID_cmac -# define EVP_MAC_HMAC NID_hmac +# define EVP_MAC_CMAC NID_cmac +# define EVP_MAC_HMAC NID_hmac +# define EVP_MAC_SIPHASH NID_siphash EVP_MAC_CTX *EVP_MAC_CTX_new(const EVP_MAC *mac); EVP_MAC_CTX *EVP_MAC_CTX_new_id(int nid); diff --git a/test/recipes/30-test_evp_data/evpmac.txt b/test/recipes/30-test_evp_data/evpmac.txt index 1d0d5da7c7..7774f414b1 100644 --- a/test/recipes/30-test_evp_data/evpmac.txt +++ b/test/recipes/30-test_evp_data/evpmac.txt @@ -157,7 +157,7 @@ Output = 5150d1772f50834a503e069a973fbd7c MAC = SipHash Ctrl = digestsize:13 Key = 000102030405060708090A0B0C0D0E0F -Result = EVPPKEYCTXCTRL_ERROR +Result = MAC_CTRL_ERROR Title = HMAC tests (from RFC2104 and others) -- 2.25.1