1/*
2 * Copyright 2018 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_numbers.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
28/*
29 * Forward declaration of everything implemented here. This is not strictly
30 * necessary for the compiler, but provides an assurance that the signatures
31 * of the functions in the dispatch table are correct.
32 */
33static OSSL_OP_mac_newctx_fn siphash_new;
34static OSSL_OP_mac_dupctx_fn siphash_dup;
35static OSSL_OP_mac_freectx_fn siphash_free;
36static OSSL_OP_mac_gettable_ctx_params_fn siphash_gettable_ctx_params;
37static OSSL_OP_mac_get_ctx_params_fn siphash_get_ctx_params;
38static OSSL_OP_mac_settable_ctx_params_fn siphash_settable_params;
39static OSSL_OP_mac_set_ctx_params_fn siphash_set_params;
40static OSSL_OP_mac_size_fn siphash_size;
41static OSSL_OP_mac_init_fn siphash_init;
42static OSSL_OP_mac_update_fn siphash_update;
43static OSSL_OP_mac_final_fn siphash_final;
44
45struct siphash_data_st {
46 void *provctx;
47 SIPHASH siphash; /* Siphash data */
48};
49
50static void *siphash_new(void *provctx)
51{
52 struct siphash_data_st *ctx = OPENSSL_zalloc(sizeof(*ctx));
53
54 if (ctx != NULL)
55 ctx->provctx = provctx;
56 return ctx;
57}
58
59static void siphash_free(void *vmacctx)
60{
61 OPENSSL_free(vmacctx);
62}
63
64static void *siphash_dup(void *vsrc)
65{
66 struct siphash_data_st *ssrc = vsrc;
67 struct siphash_data_st *sdst = siphash_new(ssrc->provctx);
68
69 if (sdst == NULL)
70 return NULL;
71
72 sdst->siphash = ssrc->siphash;
73 return sdst;
74}
75
76static size_t siphash_size(void *vmacctx)
77{
78 struct siphash_data_st *ctx = vmacctx;
79
80 return SipHash_hash_size(&ctx->siphash);
81}
82
83static int siphash_init(void *vmacctx)
84{
85 /* Not much to do here, actual initialization happens through controls */
86 return 1;
87}
88
89static int siphash_update(void *vmacctx, const unsigned char *data,
90 size_t datalen)
91{
92 struct siphash_data_st *ctx = vmacctx;
93
94 SipHash_Update(&ctx->siphash, data, datalen);
95 return 1;
96}
97
98static int siphash_final(void *vmacctx, unsigned char *out, size_t *outl,
99 size_t outsize)
100{
101 struct siphash_data_st *ctx = vmacctx;
102 size_t hlen = siphash_size(ctx);
103
104 if (outsize < hlen)
105 return 0;
106
107 *outl = hlen;
108 return SipHash_Final(&ctx->siphash, out, hlen);
109}
110
111static const OSSL_PARAM known_gettable_ctx_params[] = {
112 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
113 OSSL_PARAM_END
114};
115static const OSSL_PARAM *siphash_gettable_ctx_params(void)
116{
117 return known_gettable_ctx_params;
118}
119
120static int siphash_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
121{
122 OSSL_PARAM *p;
123
124 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
125 return OSSL_PARAM_set_size_t(p, siphash_size(vmacctx));
126
127 return 1;
128}
129
130static const OSSL_PARAM known_settable_ctx_params[] = {
131 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
132 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
133 OSSL_PARAM_END
134};
135static const OSSL_PARAM *siphash_settable_params(void)
136{
137 return known_settable_ctx_params;
138}
139
140static int siphash_set_params(void *vmacctx, const OSSL_PARAM *params)
141{
142 struct siphash_data_st *ctx = vmacctx;
143 const OSSL_PARAM *p = NULL;
144
145 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
146 size_t size;
147
148 if (!OSSL_PARAM_get_size_t(p, &size)
149 || !SipHash_set_hash_size(&ctx->siphash, size))
150 return 0;
151 }
152 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL)
153 if (p->data_type != OSSL_PARAM_OCTET_STRING
154 || p->data_size != SIPHASH_KEY_SIZE
155 || !SipHash_Init(&ctx->siphash, p->data, 0, 0))
156 return 0;
157 return 1;
158}
159
160const OSSL_DISPATCH siphash_functions[] = {
161 { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))siphash_new },
162 { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))siphash_dup },
163 { OSSL_FUNC_MAC_FREECTX, (void (*)(void))siphash_free },
164 { OSSL_FUNC_MAC_INIT, (void (*)(void))siphash_init },
165 { OSSL_FUNC_MAC_UPDATE, (void (*)(void))siphash_update },
166 { OSSL_FUNC_MAC_FINAL, (void (*)(void))siphash_final },
167 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
168 (void (*)(void))siphash_gettable_ctx_params },
169 { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))siphash_get_ctx_params },
170 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
171 (void (*)(void))siphash_settable_params },
172 { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))siphash_set_params },
173 { 0, NULL }
174};
175