2 * Copyright 2019-2021 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
10 /* Dispatch functions for AES SIV mode */
13 * This file uses the low level AES functions (which are deprecated for
14 * non-internal use) in order to implement provider AES ciphers.
16 #include "internal/deprecated.h"
18 #include <openssl/proverr.h>
19 #include "cipher_aes_siv.h"
20 #include "prov/implementations.h"
21 #include "prov/providercommon.h"
22 #include "prov/ciphercommon_aead.h"
23 #include "prov/provider_ctx.h"
25 #define siv_stream_update siv_cipher
26 #define SIV_FLAGS AEAD_FLAGS
28 static OSSL_FUNC_cipher_set_ctx_params_fn aes_siv_set_ctx_params
;
30 static void *aes_siv_newctx(void *provctx
, size_t keybits
, unsigned int mode
,
33 PROV_AES_SIV_CTX
*ctx
;
35 if (!ossl_prov_is_running())
38 ctx
= OPENSSL_zalloc(sizeof(*ctx
));
40 ctx
->taglen
= SIV_LEN
;
42 ctx
->keylen
= keybits
/ 8;
43 ctx
->hw
= ossl_prov_cipher_hw_aes_siv(keybits
);
44 ctx
->libctx
= PROV_LIBCTX_OF(provctx
);
49 static void aes_siv_freectx(void *vctx
)
51 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
54 ctx
->hw
->cleanup(ctx
);
55 OPENSSL_clear_free(ctx
, sizeof(*ctx
));
59 static void *siv_dupctx(void *vctx
)
61 PROV_AES_SIV_CTX
*in
= (PROV_AES_SIV_CTX
*)vctx
;
62 PROV_AES_SIV_CTX
*ret
;
64 if (!ossl_prov_is_running())
67 ret
= OPENSSL_malloc(sizeof(*ret
));
70 if (!in
->hw
->dupctx(in
, ret
)) {
77 static int siv_init(void *vctx
, const unsigned char *key
, size_t keylen
,
78 const unsigned char *iv
, size_t ivlen
,
79 const OSSL_PARAM params
[], int enc
)
81 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
83 if (!ossl_prov_is_running())
89 if (keylen
!= ctx
->keylen
) {
90 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
93 if (!ctx
->hw
->initkey(ctx
, key
, ctx
->keylen
))
96 return aes_siv_set_ctx_params(ctx
, params
);
99 static int siv_einit(void *vctx
, const unsigned char *key
, size_t keylen
,
100 const unsigned char *iv
, size_t ivlen
,
101 const OSSL_PARAM params
[])
103 return siv_init(vctx
, key
, keylen
, iv
, ivlen
, params
, 1);
106 static int siv_dinit(void *vctx
, const unsigned char *key
, size_t keylen
,
107 const unsigned char *iv
, size_t ivlen
,
108 const OSSL_PARAM params
[])
110 return siv_init(vctx
, key
, keylen
, iv
, ivlen
, params
, 0);
113 static int siv_cipher(void *vctx
, unsigned char *out
, size_t *outl
,
114 size_t outsize
, const unsigned char *in
, size_t inl
)
116 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
118 if (!ossl_prov_is_running())
127 ERR_raise(ERR_LIB_PROV
, PROV_R_OUTPUT_BUFFER_TOO_SMALL
);
131 if (ctx
->hw
->cipher(ctx
, out
, in
, inl
) <= 0)
139 static int siv_stream_final(void *vctx
, unsigned char *out
, size_t *outl
,
142 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
144 if (!ossl_prov_is_running())
147 if (!ctx
->hw
->cipher(vctx
, out
, NULL
, 0))
155 static int aes_siv_get_ctx_params(void *vctx
, OSSL_PARAM params
[])
157 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
158 SIV128_CONTEXT
*sctx
= &ctx
->siv
;
161 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_AEAD_TAG
);
162 if (p
!= NULL
&& p
->data_type
== OSSL_PARAM_OCTET_STRING
) {
164 || p
->data_size
!= ctx
->taglen
165 || !OSSL_PARAM_set_octet_string(p
, &sctx
->tag
.byte
, ctx
->taglen
)) {
166 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
170 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_AEAD_TAGLEN
);
171 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->taglen
)) {
172 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
175 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_KEYLEN
);
176 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->keylen
)) {
177 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
183 static const OSSL_PARAM aes_siv_known_gettable_ctx_params
[] = {
184 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN
, NULL
),
185 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN
, NULL
),
186 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
, NULL
, 0),
189 static const OSSL_PARAM
*aes_siv_gettable_ctx_params(ossl_unused
void *cctx
,
190 ossl_unused
void *provctx
)
192 return aes_siv_known_gettable_ctx_params
;
195 static int aes_siv_set_ctx_params(void *vctx
, const OSSL_PARAM params
[])
197 PROV_AES_SIV_CTX
*ctx
= (PROV_AES_SIV_CTX
*)vctx
;
199 unsigned int speed
= 0;
204 p
= OSSL_PARAM_locate_const(params
, OSSL_CIPHER_PARAM_AEAD_TAG
);
208 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
209 || !ctx
->hw
->settag(ctx
, p
->data
, p
->data_size
)) {
210 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
214 p
= OSSL_PARAM_locate_const(params
, OSSL_CIPHER_PARAM_SPEED
);
216 if (!OSSL_PARAM_get_uint(p
, &speed
)) {
217 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
220 ctx
->hw
->setspeed(ctx
, (int)speed
);
222 p
= OSSL_PARAM_locate_const(params
, OSSL_CIPHER_PARAM_KEYLEN
);
226 if (!OSSL_PARAM_get_size_t(p
, &keylen
)) {
227 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
230 /* The key length can not be modified */
231 if (keylen
!= ctx
->keylen
)
237 static const OSSL_PARAM aes_siv_known_settable_ctx_params
[] = {
238 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN
, NULL
),
239 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED
, NULL
),
240 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
, NULL
, 0),
243 static const OSSL_PARAM
*aes_siv_settable_ctx_params(ossl_unused
void *cctx
,
244 ossl_unused
void *provctx
)
246 return aes_siv_known_settable_ctx_params
;
249 #define IMPLEMENT_cipher(alg, lc, UCMODE, flags, kbits, blkbits, ivbits) \
250 static OSSL_FUNC_cipher_newctx_fn alg##kbits##lc##_newctx; \
251 static OSSL_FUNC_cipher_freectx_fn alg##_##lc##_freectx; \
252 static OSSL_FUNC_cipher_dupctx_fn lc##_dupctx; \
253 static OSSL_FUNC_cipher_encrypt_init_fn lc##_einit; \
254 static OSSL_FUNC_cipher_decrypt_init_fn lc##_dinit; \
255 static OSSL_FUNC_cipher_update_fn lc##_stream_update; \
256 static OSSL_FUNC_cipher_final_fn lc##_stream_final; \
257 static OSSL_FUNC_cipher_cipher_fn lc##_cipher; \
258 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lc##_get_params; \
259 static OSSL_FUNC_cipher_get_ctx_params_fn alg##_##lc##_get_ctx_params; \
260 static OSSL_FUNC_cipher_gettable_ctx_params_fn \
261 alg##_##lc##_gettable_ctx_params; \
262 static OSSL_FUNC_cipher_set_ctx_params_fn alg##_##lc##_set_ctx_params; \
263 static OSSL_FUNC_cipher_settable_ctx_params_fn \
264 alg##_##lc##_settable_ctx_params; \
265 static int alg##_##kbits##_##lc##_get_params(OSSL_PARAM params[]) \
267 return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
268 flags, 2*kbits, blkbits, ivbits); \
270 static void * alg##kbits##lc##_newctx(void *provctx) \
272 return alg##_##lc##_newctx(provctx, 2*kbits, EVP_CIPH_##UCMODE##_MODE, \
275 const OSSL_DISPATCH ossl_##alg##kbits##lc##_functions[] = { \
276 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))alg##kbits##lc##_newctx }, \
277 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))alg##_##lc##_freectx }, \
278 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) lc##_dupctx }, \
279 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) lc##_einit }, \
280 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) lc##_dinit }, \
281 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void)) lc##_stream_update }, \
282 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void)) lc##_stream_final }, \
283 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void)) lc##_cipher }, \
284 { OSSL_FUNC_CIPHER_GET_PARAMS, \
285 (void (*)(void)) alg##_##kbits##_##lc##_get_params }, \
286 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
287 (void (*)(void))ossl_cipher_generic_gettable_params }, \
288 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
289 (void (*)(void)) alg##_##lc##_get_ctx_params }, \
290 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
291 (void (*)(void)) alg##_##lc##_gettable_ctx_params }, \
292 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
293 (void (*)(void)) alg##_##lc##_set_ctx_params }, \
294 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
295 (void (*)(void)) alg##_##lc##_settable_ctx_params }, \
299 IMPLEMENT_cipher(aes
, siv
, SIV
, SIV_FLAGS
, 128, 8, 0)
300 IMPLEMENT_cipher(aes
, siv
, SIV
, SIV_FLAGS
, 192, 8, 0)
301 IMPLEMENT_cipher(aes
, siv
, SIV
, SIV_FLAGS
, 256, 8, 0)