providers/implementations/macs/blake2_mac_impl.c

   1 /*
   2  * Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/core_dispatch.h>
  11 #include <openssl/core_names.h>
  12 #include <openssl/params.h>
  13 #include <openssl/proverr.h>
  14
  15 #include "prov/blake2.h"
  16 #include "internal/cryptlib.h"
  17 #include "prov/implementations.h"
  18 #include "prov/providercommon.h"
  19
  20 /*
  21  * Forward declaration of everything implemented here.  This is not strictly
  22  * necessary for the compiler, but provides an assurance that the signatures
  23  * of the functions in the dispatch table are correct.
  24  */
  25 static OSSL_FUNC_mac_newctx_fn blake2_mac_new;
  26 static OSSL_FUNC_mac_dupctx_fn blake2_mac_dup;
  27 static OSSL_FUNC_mac_freectx_fn blake2_mac_free;
  28 static OSSL_FUNC_mac_gettable_ctx_params_fn blake2_gettable_ctx_params;
  29 static OSSL_FUNC_mac_get_ctx_params_fn blake2_get_ctx_params;
  30 static OSSL_FUNC_mac_settable_ctx_params_fn blake2_mac_settable_ctx_params;
  31 static OSSL_FUNC_mac_set_ctx_params_fn blake2_mac_set_ctx_params;
  32 static OSSL_FUNC_mac_init_fn blake2_mac_init;
  33 static OSSL_FUNC_mac_update_fn blake2_mac_update;
  34 static OSSL_FUNC_mac_final_fn blake2_mac_final;
  35
  36 struct blake2_mac_data_st {
  37     BLAKE2_CTX ctx;
  38     BLAKE2_PARAM params;
  39     unsigned char key[BLAKE2_KEYBYTES];
  40 };
  41
  42 static void *blake2_mac_new(void *unused_provctx)
  43 {
  44     struct blake2_mac_data_st *macctx;
  45
  46     if (!ossl_prov_is_running())
  47         return NULL;
  48
  49     macctx = OPENSSL_zalloc(sizeof(*macctx));
  50     if (macctx != NULL) {
  51         BLAKE2_PARAM_INIT(&macctx->params);
  52         /* ctx initialization is deferred to BLAKE2b_Init() */
  53     }
  54     return macctx;
  55 }
  56
  57 static void *blake2_mac_dup(void *vsrc)
  58 {
  59     struct blake2_mac_data_st *dst;
  60     struct blake2_mac_data_st *src = vsrc;
  61
  62     if (!ossl_prov_is_running())
  63         return NULL;
  64
  65     dst = OPENSSL_zalloc(sizeof(*dst));
  66     if (dst == NULL)
  67         return NULL;
  68
  69     *dst = *src;
  70     return dst;
  71 }
  72
  73 static void blake2_mac_free(void *vmacctx)
  74 {
  75     struct blake2_mac_data_st *macctx = vmacctx;
  76
  77     if (macctx != NULL) {
  78         OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
  79         OPENSSL_free(macctx);
  80     }
  81 }
  82
  83 static size_t blake2_mac_size(void *vmacctx)
  84 {
  85     struct blake2_mac_data_st *macctx = vmacctx;
  86
  87     return macctx->params.digest_length;
  88 }
  89
  90 static int blake2_mac_init(void *vmacctx)
  91 {
  92     struct blake2_mac_data_st *macctx = vmacctx;
  93
  94     if (!ossl_prov_is_running())
  95         return 0;
  96
  97     /* Check key has been set */
  98     if (macctx->params.key_length == 0) {
  99         ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
 100         return 0;
 101     }
 102
 103     return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
 104 }
 105
 106 static int blake2_mac_update(void *vmacctx,
 107                              const unsigned char *data, size_t datalen)
 108 {
 109     struct blake2_mac_data_st *macctx = vmacctx;
 110
 111     if (datalen == 0)
 112         return 1;
 113
 114     return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
 115 }
 116
 117 static int blake2_mac_final(void *vmacctx,
 118                             unsigned char *out, size_t *outl,
 119                             size_t outsize)
 120 {
 121     struct blake2_mac_data_st *macctx = vmacctx;
 122
 123     if (!ossl_prov_is_running())
 124         return 0;
 125
 126     *outl = blake2_mac_size(macctx);
 127     return BLAKE2_FINAL(out, &macctx->ctx);
 128 }
 129
 130 static const OSSL_PARAM known_gettable_ctx_params[] = {
 131     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
 132     OSSL_PARAM_END
 133 };
 134 static const OSSL_PARAM *blake2_gettable_ctx_params(ossl_unused void *ctx,
 135                                                     ossl_unused void *provctx)
 136 {
 137     return known_gettable_ctx_params;
 138 }
 139
 140 static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
 141 {
 142     OSSL_PARAM *p;
 143
 144     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
 145         return OSSL_PARAM_set_size_t(p, blake2_mac_size(vmacctx));
 146
 147     return 1;
 148 }
 149
 150 static const OSSL_PARAM known_settable_ctx_params[] = {
 151     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
 152     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
 153     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, NULL, 0),
 154     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_SALT, NULL, 0),
 155     OSSL_PARAM_END
 156 };
 157 static const OSSL_PARAM *blake2_mac_settable_ctx_params(
 158             ossl_unused void *ctx, ossl_unused void *p_ctx)
 159 {
 160     return known_settable_ctx_params;
 161 }
 162
 163 /*
 164  * ALL parameters should be set before init().
 165  */
 166 static int blake2_mac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
 167 {
 168     struct blake2_mac_data_st *macctx = vmacctx;
 169     const OSSL_PARAM *p;
 170
 171     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
 172         size_t size;
 173
 174         if (!OSSL_PARAM_get_size_t(p, &size)
 175             || size < 1
 176             || size > BLAKE2_OUTBYTES) {
 177             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
 178             return 0;
 179         }
 180         BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
 181     }
 182
 183     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
 184         size_t len;
 185         void *key_p = macctx->key;
 186
 187         if (!OSSL_PARAM_get_octet_string(p, &key_p, BLAKE2_KEYBYTES, &len)) {
 188             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 189             return 0;
 190         }
 191         /* Pad with zeroes at the end */
 192         memset(macctx->key + len, 0, BLAKE2_KEYBYTES - len);
 193
 194         BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)len);
 195     }
 196
 197     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CUSTOM))
 198         != NULL) {
 199         /*
 200          * The OSSL_PARAM API doesn't provide direct pointer use, so we
 201          * must handle the OSSL_PARAM structure ourselves here
 202          */
 203         if (p->data_size > BLAKE2_PERSONALBYTES) {
 204             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
 205             return 0;
 206         }
 207         BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p->data, p->data_size);
 208     }
 209
 210     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SALT)) != NULL) {
 211         /*
 212          * The OSSL_PARAM API doesn't provide direct pointer use, so we
 213          * must handle the OSSL_PARAM structure ourselves here as well
 214          */
 215         if (p->data_size > BLAKE2_SALTBYTES) {
 216             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
 217             return 0;
 218         }
 219         BLAKE2_PARAM_SET_SALT(&macctx->params, p->data, p->data_size);
 220     }
 221     return 1;
 222 }
 223
 224 const OSSL_DISPATCH BLAKE2_FUNCTIONS[] = {
 225     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))blake2_mac_new },
 226     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))blake2_mac_dup },
 227     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))blake2_mac_free },
 228     { OSSL_FUNC_MAC_INIT, (void (*)(void))blake2_mac_init },
 229     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))blake2_mac_update },
 230     { OSSL_FUNC_MAC_FINAL, (void (*)(void))blake2_mac_final },
 231     { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
 232       (void (*)(void))blake2_gettable_ctx_params },
 233     { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))blake2_get_ctx_params },
 234     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
 235       (void (*)(void))blake2_mac_settable_ctx_params },
 236     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))blake2_mac_set_ctx_params },
 237     { 0, NULL }
 238 };