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 void *aes_siv_newctx(void *provctx, size_t keybits, unsigned int mode,
31 PROV_AES_SIV_CTX *ctx;
33 if (!ossl_prov_is_running())
36 ctx = OPENSSL_zalloc(sizeof(*ctx));
38 ctx->taglen = SIV_LEN;
40 ctx->keylen = keybits / 8;
41 ctx->hw = ossl_prov_cipher_hw_aes_siv(keybits);
42 ctx->libctx = PROV_LIBCTX_OF(provctx);
47 static void aes_siv_freectx(void *vctx)
49 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
52 ctx->hw->cleanup(ctx);
53 OPENSSL_clear_free(ctx, sizeof(*ctx));
57 static void *siv_dupctx(void *vctx)
59 PROV_AES_SIV_CTX *in = (PROV_AES_SIV_CTX *)vctx;
60 PROV_AES_SIV_CTX *ret;
62 if (!ossl_prov_is_running())
65 ret = OPENSSL_malloc(sizeof(*ret));
67 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
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, int enc)
80 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
82 if (!ossl_prov_is_running())
88 if (keylen != ctx->keylen) {
89 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
92 return ctx->hw->initkey(ctx, key, ctx->keylen);
97 static int siv_einit(void *vctx, const unsigned char *key, size_t keylen,
98 const unsigned char *iv, size_t ivlen)
100 return siv_init(vctx, key, keylen, iv, ivlen, 1);
103 static int siv_dinit(void *vctx, const unsigned char *key, size_t keylen,
104 const unsigned char *iv, size_t ivlen)
106 return siv_init(vctx, key, keylen, iv, ivlen, 0);
109 static int siv_cipher(void *vctx, unsigned char *out, size_t *outl,
110 size_t outsize, const unsigned char *in, size_t inl)
112 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
114 if (!ossl_prov_is_running())
123 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
127 if (ctx->hw->cipher(ctx, out, in, inl) <= 0)
135 static int siv_stream_final(void *vctx, unsigned char *out, size_t *outl,
138 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
140 if (!ossl_prov_is_running())
143 if (!ctx->hw->cipher(vctx, out, NULL, 0))
151 static int aes_siv_get_ctx_params(void *vctx, OSSL_PARAM params[])
153 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
154 SIV128_CONTEXT *sctx = &ctx->siv;
157 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
158 if (p != NULL && p->data_type == OSSL_PARAM_OCTET_STRING) {
160 || p->data_size != ctx->taglen
161 || !OSSL_PARAM_set_octet_string(p, &sctx->tag.byte, ctx->taglen)) {
162 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
166 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
167 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->taglen)) {
168 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
171 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
172 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
173 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
179 static const OSSL_PARAM aes_siv_known_gettable_ctx_params[] = {
180 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
181 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
182 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
183 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
186 static const OSSL_PARAM *aes_siv_gettable_ctx_params(ossl_unused void *provctx)
188 return aes_siv_known_gettable_ctx_params;
191 static int aes_siv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
193 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
195 unsigned int speed = 0;
197 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
201 if (p->data_type != OSSL_PARAM_OCTET_STRING
202 || !ctx->hw->settag(ctx, p->data, p->data_size)) {
203 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
207 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_SPEED);
209 if (!OSSL_PARAM_get_uint(p, &speed)) {
210 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
213 ctx->hw->setspeed(ctx, (int)speed);
215 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
219 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
220 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
223 /* The key length can not be modified */
224 if (keylen != ctx->keylen)
230 static const OSSL_PARAM aes_siv_known_settable_ctx_params[] = {
231 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
232 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
233 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
236 static const OSSL_PARAM *aes_siv_settable_ctx_params(ossl_unused void *provctx)
238 return aes_siv_known_settable_ctx_params;
241 #define IMPLEMENT_cipher(alg, lc, UCMODE, flags, kbits, blkbits, ivbits) \
242 static OSSL_FUNC_cipher_newctx_fn alg##kbits##lc##_newctx; \
243 static OSSL_FUNC_cipher_freectx_fn alg##_##lc##_freectx; \
244 static OSSL_FUNC_cipher_dupctx_fn lc##_dupctx; \
245 static OSSL_FUNC_cipher_encrypt_init_fn lc##_einit; \
246 static OSSL_FUNC_cipher_decrypt_init_fn lc##_dinit; \
247 static OSSL_FUNC_cipher_update_fn lc##_stream_update; \
248 static OSSL_FUNC_cipher_final_fn lc##_stream_final; \
249 static OSSL_FUNC_cipher_cipher_fn lc##_cipher; \
250 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lc##_get_params; \
251 static OSSL_FUNC_cipher_gettable_params_fn alg##_##lc##_gettable_ctx_params; \
252 static OSSL_FUNC_cipher_get_ctx_params_fn alg##_##lc##_get_ctx_params; \
253 static OSSL_FUNC_cipher_gettable_ctx_params_fn \
254 alg##_##lc##_gettable_ctx_params; \
255 static OSSL_FUNC_cipher_set_ctx_params_fn alg##_##lc##_set_ctx_params; \
256 static OSSL_FUNC_cipher_settable_ctx_params_fn \
257 alg##_##lc##_settable_ctx_params; \
258 static int alg##_##kbits##_##lc##_get_params(OSSL_PARAM params[]) \
260 return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
261 flags, 2*kbits, blkbits, ivbits); \
263 static void * alg##kbits##lc##_newctx(void *provctx) \
265 return alg##_##lc##_newctx(provctx, 2*kbits, EVP_CIPH_##UCMODE##_MODE, \
268 const OSSL_DISPATCH ossl_##alg##kbits##lc##_functions[] = { \
269 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))alg##kbits##lc##_newctx }, \
270 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))alg##_##lc##_freectx }, \
271 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) lc##_dupctx }, \
272 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) lc##_einit }, \
273 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) lc##_dinit }, \
274 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void)) lc##_stream_update }, \
275 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void)) lc##_stream_final }, \
276 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void)) lc##_cipher }, \
277 { OSSL_FUNC_CIPHER_GET_PARAMS, \
278 (void (*)(void)) alg##_##kbits##_##lc##_get_params }, \
279 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
280 (void (*)(void))ossl_cipher_generic_gettable_params }, \
281 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
282 (void (*)(void)) alg##_##lc##_get_ctx_params }, \
283 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
284 (void (*)(void)) alg##_##lc##_gettable_ctx_params }, \
285 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
286 (void (*)(void)) alg##_##lc##_set_ctx_params }, \
287 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
288 (void (*)(void)) alg##_##lc##_settable_ctx_params }, \
292 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 128, 8, 0)
293 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 192, 8, 0)
294 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 256, 8, 0)