providers/implementations/macs/siphash_prov.c

   1 /*
   2  * Copyright 2018-2020 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 <string.h>
  11 #include <openssl/core_dispatch.h>
  12 #include <openssl/core_names.h>
  13 #include <openssl/params.h>
  14 #include <openssl/evp.h>
  15 #include <openssl/err.h>
  16
  17 #include "crypto/siphash.h"
  18 /*
  19  * TODO(3.0) when siphash has moved entirely to our providers, this
  20  * header should be moved to the provider include directory.  For the
  21  * moment, crypto/siphash/siphash_ameth.c has us stuck.
  22  */
  23 #include "../../../crypto/siphash/siphash_local.h"
  24
  25 #include "prov/providercommonerr.h"
  26 #include "prov/implementations.h"
  27 #include "prov/providercommon.h"
  28
  29 /*
  30  * Forward declaration of everything implemented here.  This is not strictly
  31  * necessary for the compiler, but provides an assurance that the signatures
  32  * of the functions in the dispatch table are correct.
  33  */
  34 static OSSL_FUNC_mac_newctx_fn siphash_new;
  35 static OSSL_FUNC_mac_dupctx_fn siphash_dup;
  36 static OSSL_FUNC_mac_freectx_fn siphash_free;
  37 static OSSL_FUNC_mac_gettable_ctx_params_fn siphash_gettable_ctx_params;
  38 static OSSL_FUNC_mac_get_ctx_params_fn siphash_get_ctx_params;
  39 static OSSL_FUNC_mac_settable_ctx_params_fn siphash_settable_params;
  40 static OSSL_FUNC_mac_set_ctx_params_fn siphash_set_params;
  41 static OSSL_FUNC_mac_init_fn siphash_init;
  42 static OSSL_FUNC_mac_update_fn siphash_update;
  43 static OSSL_FUNC_mac_final_fn siphash_final;
  44
  45 struct siphash_data_st {
  46     void *provctx;
  47     SIPHASH siphash;             /* Siphash data */
  48 };
  49
  50 static void *siphash_new(void *provctx)
  51 {
  52     struct siphash_data_st *ctx;
  53
  54     if (!ossl_prov_is_running())
  55         return NULL;
  56     ctx = OPENSSL_zalloc(sizeof(*ctx));
  57     if (ctx != NULL)
  58         ctx->provctx = provctx;
  59     return ctx;
  60 }
  61
  62 static void siphash_free(void *vmacctx)
  63 {
  64     OPENSSL_free(vmacctx);
  65 }
  66
  67 static void *siphash_dup(void *vsrc)
  68 {
  69     struct siphash_data_st *ssrc = vsrc;
  70     struct siphash_data_st *sdst;
  71
  72     if (!ossl_prov_is_running())
  73         return NULL;
  74     sdst = siphash_new(ssrc->provctx);
  75     if (sdst == NULL)
  76         return NULL;
  77
  78     sdst->siphash = ssrc->siphash;
  79     return sdst;
  80 }
  81
  82 static size_t siphash_size(void *vmacctx)
  83 {
  84     struct siphash_data_st *ctx = vmacctx;
  85
  86     return SipHash_hash_size(&ctx->siphash);
  87 }
  88
  89 static int siphash_init(void *vmacctx)
  90 {
  91     /* Not much to do here, actual initialization happens through controls */
  92     return ossl_prov_is_running();
  93 }
  94
  95 static int siphash_update(void *vmacctx, const unsigned char *data,
  96                           size_t datalen)
  97 {
  98     struct siphash_data_st *ctx = vmacctx;
  99
 100     if (datalen == 0)
 101         return 1;
 102
 103     SipHash_Update(&ctx->siphash, data, datalen);
 104     return 1;
 105 }
 106
 107 static int siphash_final(void *vmacctx, unsigned char *out, size_t *outl,
 108                          size_t outsize)
 109 {
 110     struct siphash_data_st *ctx = vmacctx;
 111     size_t hlen = siphash_size(ctx);
 112
 113     if (!ossl_prov_is_running() || outsize < hlen)
 114         return 0;
 115
 116     *outl = hlen;
 117     return SipHash_Final(&ctx->siphash, out, hlen);
 118 }
 119
 120 static const OSSL_PARAM known_gettable_ctx_params[] = {
 121     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
 122     OSSL_PARAM_END
 123 };
 124 static const OSSL_PARAM *siphash_gettable_ctx_params(ossl_unused void *provctx)
 125 {
 126     return known_gettable_ctx_params;
 127 }
 128
 129 static int siphash_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
 130 {
 131     OSSL_PARAM *p;
 132
 133     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
 134         return OSSL_PARAM_set_size_t(p, siphash_size(vmacctx));
 135
 136     return 1;
 137 }
 138
 139 static const OSSL_PARAM known_settable_ctx_params[] = {
 140     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
 141     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
 142     OSSL_PARAM_END
 143 };
 144 static const OSSL_PARAM *siphash_settable_params(void *provctx)
 145 {
 146     return known_settable_ctx_params;
 147 }
 148
 149 static int siphash_set_params(void *vmacctx, const OSSL_PARAM *params)
 150 {
 151     struct siphash_data_st *ctx = vmacctx;
 152     const OSSL_PARAM *p = NULL;
 153
 154     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
 155         size_t size;
 156
 157         if (!OSSL_PARAM_get_size_t(p, &size)
 158             || !SipHash_set_hash_size(&ctx->siphash, size))
 159             return 0;
 160     }
 161     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL)
 162         if (p->data_type != OSSL_PARAM_OCTET_STRING
 163             || p->data_size != SIPHASH_KEY_SIZE
 164             || !SipHash_Init(&ctx->siphash, p->data, 0, 0))
 165             return 0;
 166     return 1;
 167 }
 168
 169 const OSSL_DISPATCH ossl_siphash_functions[] = {
 170     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))siphash_new },
 171     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))siphash_dup },
 172     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))siphash_free },
 173     { OSSL_FUNC_MAC_INIT, (void (*)(void))siphash_init },
 174     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))siphash_update },
 175     { OSSL_FUNC_MAC_FINAL, (void (*)(void))siphash_final },
 176     { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
 177       (void (*)(void))siphash_gettable_ctx_params },
 178     { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))siphash_get_ctx_params },
 179     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
 180       (void (*)(void))siphash_settable_params },
 181     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))siphash_set_params },
 182     { 0, NULL }
 183 };