2 * Copyright 2019-2020 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 "cipher_aes_siv.h"
19 #include "prov/implementations.h"
20 #include "prov/providercommonerr.h"
21 #include "prov/ciphercommon_aead.h"
23 #define siv_stream_update siv_cipher
24 #define SIV_FLAGS AEAD_FLAGS
26 static void *aes_siv_newctx(void *provctx, size_t keybits, unsigned int mode,
29 PROV_AES_SIV_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
32 ctx->taglen = SIV_LEN;
35 ctx->keylen = keybits / 8;
36 ctx->hw = PROV_CIPHER_HW_aes_siv(keybits);
41 static void aes_siv_freectx(void *vctx)
43 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
46 ctx->hw->cleanup(ctx);
47 OPENSSL_clear_free(ctx, sizeof(*ctx));
51 static int siv_init(void *vctx, const unsigned char *key, size_t keylen,
52 const unsigned char *iv, size_t ivlen, int enc)
54 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
59 if (keylen != ctx->keylen) {
60 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
63 return ctx->hw->initkey(ctx, key, ctx->keylen);
68 static int siv_einit(void *vctx, const unsigned char *key, size_t keylen,
69 const unsigned char *iv, size_t ivlen)
71 return siv_init(vctx, key, keylen, iv, ivlen, 1);
74 static int siv_dinit(void *vctx, const unsigned char *key, size_t keylen,
75 const unsigned char *iv, size_t ivlen)
77 return siv_init(vctx, key, keylen, iv, ivlen, 0);
80 static int siv_cipher(void *vctx, unsigned char *out, size_t *outl,
81 size_t outsize, const unsigned char *in, size_t inl)
83 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
91 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
95 if (ctx->hw->cipher(ctx, out, in, inl) <= 0)
103 static int siv_stream_final(void *vctx, unsigned char *out, size_t *outl,
106 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
108 if (!ctx->hw->cipher(vctx, out, NULL, 0))
116 static int aes_siv_get_ctx_params(void *vctx, OSSL_PARAM params[])
118 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
119 SIV128_CONTEXT *sctx = &ctx->siv;
122 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
123 if (p != NULL && p->data_type == OSSL_PARAM_OCTET_STRING) {
125 || p->data_size != ctx->taglen
126 || !OSSL_PARAM_set_octet_string(p, &sctx->tag.byte, ctx->taglen)) {
127 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
131 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
132 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->taglen)) {
133 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
136 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
137 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
138 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
144 static const OSSL_PARAM aes_siv_known_gettable_ctx_params[] = {
145 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
146 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
147 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
148 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
151 static const OSSL_PARAM *aes_siv_gettable_ctx_params(void)
153 return aes_siv_known_gettable_ctx_params;
156 static int aes_siv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
158 PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
160 unsigned int speed = 0;
162 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
166 if (p->data_type != OSSL_PARAM_OCTET_STRING
167 || !ctx->hw->settag(ctx, p->data, p->data_size)) {
168 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
172 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_SPEED);
174 if (!OSSL_PARAM_get_uint(p, &speed)) {
175 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
178 ctx->hw->setspeed(ctx, (int)speed);
180 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
184 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
185 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
188 /* The key length can not be modified */
189 if (keylen != ctx->keylen)
195 static const OSSL_PARAM aes_siv_known_settable_ctx_params[] = {
196 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
197 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
198 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
201 static const OSSL_PARAM *aes_siv_settable_ctx_params(void)
203 return aes_siv_known_settable_ctx_params;
206 #define IMPLEMENT_cipher(alg, lc, UCMODE, flags, kbits, blkbits, ivbits) \
207 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lc##_get_params; \
208 static int alg##_##kbits##_##lc##_get_params(OSSL_PARAM params[]) \
210 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
211 flags, 2*kbits, blkbits, ivbits); \
213 static OSSL_FUNC_cipher_newctx_fn alg##kbits##lc##_newctx; \
214 static void * alg##kbits##lc##_newctx(void *provctx) \
216 return alg##_##lc##_newctx(provctx, 2*kbits, EVP_CIPH_##UCMODE##_MODE, \
219 const OSSL_DISPATCH alg##kbits##lc##_functions[] = { \
220 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))alg##kbits##lc##_newctx }, \
221 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))alg##_##lc##_freectx }, \
222 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) lc##_einit }, \
223 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) lc##_dinit }, \
224 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void)) lc##_stream_update }, \
225 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void)) lc##_stream_final }, \
226 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void)) lc##_cipher }, \
227 { OSSL_FUNC_CIPHER_GET_PARAMS, \
228 (void (*)(void)) alg##_##kbits##_##lc##_get_params }, \
229 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
230 (void (*)(void))cipher_generic_gettable_params }, \
231 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
232 (void (*)(void)) alg##_##lc##_get_ctx_params }, \
233 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
234 (void (*)(void)) alg##_##lc##_gettable_ctx_params }, \
235 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
236 (void (*)(void)) alg##_##lc##_set_ctx_params }, \
237 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
238 (void (*)(void)) alg##_##lc##_settable_ctx_params }, \
242 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 128, 8, 0)
243 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 192, 8, 0)
244 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 256, 8, 0)