2 * Copyright 2018-2023 The OpenSSL Project Authors. All Rights Reserved.
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
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 #include <openssl/proverr.h>
18 #include "crypto/siphash.h"
20 #include "prov/implementations.h"
21 #include "prov/providercommon.h"
24 * Forward declaration of everything implemented here. This is not strictly
25 * necessary for the compiler, but provides an assurance that the signatures
26 * of the functions in the dispatch table are correct.
28 static OSSL_FUNC_mac_newctx_fn siphash_new
;
29 static OSSL_FUNC_mac_dupctx_fn siphash_dup
;
30 static OSSL_FUNC_mac_freectx_fn siphash_free
;
31 static OSSL_FUNC_mac_gettable_ctx_params_fn siphash_gettable_ctx_params
;
32 static OSSL_FUNC_mac_get_ctx_params_fn siphash_get_ctx_params
;
33 static OSSL_FUNC_mac_settable_ctx_params_fn siphash_settable_ctx_params
;
34 static OSSL_FUNC_mac_set_ctx_params_fn siphash_set_params
;
35 static OSSL_FUNC_mac_init_fn siphash_init
;
36 static OSSL_FUNC_mac_update_fn siphash_update
;
37 static OSSL_FUNC_mac_final_fn siphash_final
;
39 struct siphash_data_st
{
41 SIPHASH siphash
; /* Siphash data */
42 SIPHASH sipcopy
; /* Siphash data copy for reinitialization */
43 unsigned int crounds
, drounds
;
46 static unsigned int crounds(struct siphash_data_st
*ctx
)
48 return ctx
->crounds
!= 0 ? ctx
->crounds
: SIPHASH_C_ROUNDS
;
51 static unsigned int drounds(struct siphash_data_st
*ctx
)
53 return ctx
->drounds
!= 0 ? ctx
->drounds
: SIPHASH_D_ROUNDS
;
56 static void *siphash_new(void *provctx
)
58 struct siphash_data_st
*ctx
;
60 if (!ossl_prov_is_running())
62 ctx
= OPENSSL_zalloc(sizeof(*ctx
));
64 ctx
->provctx
= provctx
;
68 static void siphash_free(void *vmacctx
)
70 OPENSSL_free(vmacctx
);
73 static void *siphash_dup(void *vsrc
)
75 struct siphash_data_st
*ssrc
= vsrc
;
76 struct siphash_data_st
*sdst
;
78 if (!ossl_prov_is_running())
80 sdst
= OPENSSL_malloc(sizeof(*sdst
));
88 static size_t siphash_size(void *vmacctx
)
90 struct siphash_data_st
*ctx
= vmacctx
;
92 return SipHash_hash_size(&ctx
->siphash
);
95 static int siphash_setkey(struct siphash_data_st
*ctx
,
96 const unsigned char *key
, size_t keylen
)
100 if (keylen
!= SIPHASH_KEY_SIZE
)
102 ret
= SipHash_Init(&ctx
->siphash
, key
, crounds(ctx
), drounds(ctx
));
104 ctx
->sipcopy
= ctx
->siphash
;
108 static int siphash_init(void *vmacctx
, const unsigned char *key
, size_t keylen
,
109 const OSSL_PARAM params
[])
111 struct siphash_data_st
*ctx
= vmacctx
;
113 if (!ossl_prov_is_running() || !siphash_set_params(ctx
, params
))
116 * Without a key, there is not much to do here,
117 * The actual initialization happens through controls.
120 ctx
->siphash
= ctx
->sipcopy
;
123 return siphash_setkey(ctx
, key
, keylen
);
126 static int siphash_update(void *vmacctx
, const unsigned char *data
,
129 struct siphash_data_st
*ctx
= vmacctx
;
134 SipHash_Update(&ctx
->siphash
, data
, datalen
);
138 static int siphash_final(void *vmacctx
, unsigned char *out
, size_t *outl
,
141 struct siphash_data_st
*ctx
= vmacctx
;
142 size_t hlen
= siphash_size(ctx
);
144 if (!ossl_prov_is_running() || outsize
< hlen
)
148 return SipHash_Final(&ctx
->siphash
, out
, hlen
);
151 static const OSSL_PARAM
*siphash_gettable_ctx_params(ossl_unused
void *ctx
,
152 ossl_unused
void *provctx
)
154 static const OSSL_PARAM known_gettable_ctx_params
[] = {
155 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
156 OSSL_PARAM_uint(OSSL_MAC_PARAM_C_ROUNDS
, NULL
),
157 OSSL_PARAM_uint(OSSL_MAC_PARAM_D_ROUNDS
, NULL
),
161 return known_gettable_ctx_params
;
164 static int siphash_get_ctx_params(void *vmacctx
, OSSL_PARAM params
[])
166 struct siphash_data_st
*ctx
= vmacctx
;
169 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
170 && !OSSL_PARAM_set_size_t(p
, siphash_size(vmacctx
)))
172 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_C_ROUNDS
)) != NULL
173 && !OSSL_PARAM_set_uint(p
, crounds(ctx
)))
175 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_D_ROUNDS
)) != NULL
176 && !OSSL_PARAM_set_uint(p
, drounds(ctx
)))
181 static const OSSL_PARAM
*siphash_settable_ctx_params(ossl_unused
void *ctx
,
184 static const OSSL_PARAM known_settable_ctx_params
[] = {
185 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
186 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY
, NULL
, 0),
187 OSSL_PARAM_uint(OSSL_MAC_PARAM_C_ROUNDS
, NULL
),
188 OSSL_PARAM_uint(OSSL_MAC_PARAM_D_ROUNDS
, NULL
),
192 return known_settable_ctx_params
;
195 static int siphash_set_params(void *vmacctx
, const OSSL_PARAM
*params
)
197 struct siphash_data_st
*ctx
= vmacctx
;
198 const OSSL_PARAM
*p
= NULL
;
204 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
) {
205 if (!OSSL_PARAM_get_size_t(p
, &size
)
206 || !SipHash_set_hash_size(&ctx
->siphash
, size
)
207 || !SipHash_set_hash_size(&ctx
->sipcopy
, size
))
210 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_C_ROUNDS
)) != NULL
211 && !OSSL_PARAM_get_uint(p
, &ctx
->crounds
))
213 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_D_ROUNDS
)) != NULL
214 && !OSSL_PARAM_get_uint(p
, &ctx
->drounds
))
216 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_KEY
)) != NULL
)
217 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
218 || !siphash_setkey(ctx
, p
->data
, p
->data_size
))
223 const OSSL_DISPATCH ossl_siphash_functions
[] = {
224 { OSSL_FUNC_MAC_NEWCTX
, (void (*)(void))siphash_new
},
225 { OSSL_FUNC_MAC_DUPCTX
, (void (*)(void))siphash_dup
},
226 { OSSL_FUNC_MAC_FREECTX
, (void (*)(void))siphash_free
},
227 { OSSL_FUNC_MAC_INIT
, (void (*)(void))siphash_init
},
228 { OSSL_FUNC_MAC_UPDATE
, (void (*)(void))siphash_update
},
229 { OSSL_FUNC_MAC_FINAL
, (void (*)(void))siphash_final
},
230 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS
,
231 (void (*)(void))siphash_gettable_ctx_params
},
232 { OSSL_FUNC_MAC_GET_CTX_PARAMS
, (void (*)(void))siphash_get_ctx_params
},
233 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS
,
234 (void (*)(void))siphash_settable_ctx_params
},
235 { OSSL_FUNC_MAC_SET_CTX_PARAMS
, (void (*)(void))siphash_set_params
},