2 * Copyright 2019 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 #include "cipher_aes_ocb.h"
11 #include "prov/providercommonerr.h"
12 #include "prov/cipher_aead.h"
13 #include "prov/implementations.h"
15 #define AES_OCB_FLAGS AEAD_FLAGS
17 #define OCB_DEFAULT_TAG_LEN 16
18 #define OCB_DEFAULT_IV_LEN 12
19 #define OCB_MIN_IV_LEN 1
20 #define OCB_MAX_IV_LEN 15
22 PROV_CIPHER_FUNC(int, ocb_cipher, (PROV_AES_OCB_CTX *ctx,
23 const unsigned char *in, unsigned char *out,
25 /* forward declarations */
26 static OSSL_OP_cipher_encrypt_init_fn aes_ocb_einit;
27 static OSSL_OP_cipher_decrypt_init_fn aes_ocb_dinit;
28 static OSSL_OP_cipher_update_fn aes_ocb_block_update;
29 static OSSL_OP_cipher_final_fn aes_ocb_block_final;
30 static OSSL_OP_cipher_cipher_fn aes_ocb_cipher;
31 static OSSL_OP_cipher_freectx_fn aes_ocb_freectx;
32 static OSSL_OP_cipher_dupctx_fn aes_ocb_dupctx;
33 static OSSL_OP_cipher_get_ctx_params_fn aes_ocb_get_ctx_params;
34 static OSSL_OP_cipher_set_ctx_params_fn aes_ocb_set_ctx_params;
37 * The following methods could be moved into PROV_AES_OCB_HW if
38 * multiple hardware implementations are ever needed.
40 static ossl_inline int aes_generic_ocb_setiv(PROV_AES_OCB_CTX *ctx,
41 const unsigned char *iv,
42 size_t ivlen, size_t taglen)
44 return (CRYPTO_ocb128_setiv(&ctx->ocb, iv, ivlen, taglen) == 1);
47 static ossl_inline int aes_generic_ocb_setaad(PROV_AES_OCB_CTX *ctx,
48 const unsigned char *aad,
51 return CRYPTO_ocb128_aad(&ctx->ocb, aad, alen) == 1;
54 static ossl_inline int aes_generic_ocb_gettag(PROV_AES_OCB_CTX *ctx,
55 unsigned char *tag, size_t tlen)
57 return CRYPTO_ocb128_tag(&ctx->ocb, tag, tlen) > 0;
60 static ossl_inline int aes_generic_ocb_final(PROV_AES_OCB_CTX *ctx)
62 return (CRYPTO_ocb128_finish(&ctx->ocb, ctx->tag, ctx->taglen) == 0);
65 static ossl_inline void aes_generic_ocb_cleanup(PROV_AES_OCB_CTX *ctx)
67 CRYPTO_ocb128_cleanup(&ctx->ocb);
70 static ossl_inline int aes_generic_ocb_cipher(PROV_AES_OCB_CTX *ctx,
71 const unsigned char *in,
72 unsigned char *out, size_t len)
75 if (!CRYPTO_ocb128_encrypt(&ctx->ocb, in, out, len))
78 if (!CRYPTO_ocb128_decrypt(&ctx->ocb, in, out, len))
84 static ossl_inline int aes_generic_ocb_copy_ctx(PROV_AES_OCB_CTX *dst,
85 PROV_AES_OCB_CTX *src)
87 return CRYPTO_ocb128_copy_ctx(&dst->ocb, &src->ocb,
88 &dst->ksenc.ks, &dst->ksdec.ks);
92 * Provider dispatch functions
94 static int aes_ocb_init(void *vctx, const unsigned char *key, size_t keylen,
95 const unsigned char *iv, size_t ivlen, int enc)
97 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
102 if (ivlen != ctx->base.ivlen) {
103 /* IV len must be 1 to 15 */
104 if (ivlen < OCB_MIN_IV_LEN || ivlen > OCB_MAX_IV_LEN) {
105 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
108 ctx->base.ivlen = ivlen;
110 if (!cipher_generic_initiv(&ctx->base, iv, ivlen))
112 ctx->iv_state = IV_STATE_BUFFERED;
115 if (keylen != ctx->base.keylen) {
116 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
119 return ctx->base.hw->init(&ctx->base, key, keylen);
124 static int aes_ocb_einit(void *vctx, const unsigned char *key, size_t keylen,
125 const unsigned char *iv, size_t ivlen)
127 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 1);
130 static int aes_ocb_dinit(void *vctx, const unsigned char *key, size_t keylen,
131 const unsigned char *iv, size_t ivlen)
133 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 0);
137 * Because of the way OCB works, both the AAD and data are buffered in the
138 * same way. Only the last block can be a partial block.
140 static int aes_ocb_block_update_internal(PROV_AES_OCB_CTX *ctx,
141 unsigned char *buf, size_t *bufsz,
142 unsigned char *out, size_t *outl,
143 size_t outsize, const unsigned char *in,
144 size_t inl, OSSL_ocb_cipher_fn ciph)
146 size_t nextblocks = fillblock(buf, bufsz, AES_BLOCK_SIZE, &in, &inl);
149 if (*bufsz == AES_BLOCK_SIZE) {
150 if (outsize < AES_BLOCK_SIZE) {
151 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
154 if (!ciph(ctx, buf, out, AES_BLOCK_SIZE)) {
155 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
159 outlint = AES_BLOCK_SIZE;
160 out += AES_BLOCK_SIZE;
162 if (nextblocks > 0) {
163 outlint += nextblocks;
164 if (outsize < outlint) {
165 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
168 if (!ciph(ctx, in, out, nextblocks)) {
169 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
175 if (!trailingdata(buf, bufsz, AES_BLOCK_SIZE, &in, &inl)) {
176 /* PROVerr already called */
184 /* A wrapper function that has the same signature as cipher */
185 static int cipher_updateaad(PROV_AES_OCB_CTX *ctx, const unsigned char *in,
186 unsigned char *out, size_t len)
188 return aes_generic_ocb_setaad(ctx, in, len);
191 static int update_iv(PROV_AES_OCB_CTX *ctx)
193 if (ctx->iv_state == IV_STATE_FINISHED
194 || ctx->iv_state == IV_STATE_UNINITIALISED)
196 if (ctx->iv_state == IV_STATE_BUFFERED) {
197 if (!aes_generic_ocb_setiv(ctx, ctx->base.iv, ctx->base.ivlen,
200 ctx->iv_state = IV_STATE_COPIED;
205 static int aes_ocb_block_update(void *vctx, unsigned char *out, size_t *outl,
206 size_t outsize, const unsigned char *in,
209 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
212 OSSL_ocb_cipher_fn fn;
214 if (!ctx->key_set || !update_iv(ctx))
222 /* Are we dealing with AAD or normal data here? */
225 buflen = &ctx->aad_buf_len;
226 fn = cipher_updateaad;
229 buflen = &ctx->data_buf_len;
230 fn = aes_generic_ocb_cipher;
232 return aes_ocb_block_update_internal(ctx, buf, buflen, out, outl, outsize,
236 static int aes_ocb_block_final(void *vctx, unsigned char *out, size_t *outl,
239 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
241 /* If no block_update has run then the iv still needs to be set */
242 if (!ctx->key_set || !update_iv(ctx))
246 * Empty the buffer of any partial block that we might have been provided,
247 * both for data and AAD
250 if (ctx->data_buf_len > 0) {
251 if (!aes_generic_ocb_cipher(ctx, ctx->data_buf, out, ctx->data_buf_len))
253 *outl = ctx->data_buf_len;
254 ctx->data_buf_len = 0;
256 if (ctx->aad_buf_len > 0) {
257 if (!aes_generic_ocb_setaad(ctx, ctx->aad_buf, ctx->aad_buf_len))
259 ctx->aad_buf_len = 0;
262 /* If encrypting then just get the tag */
263 if (!aes_generic_ocb_gettag(ctx, ctx->tag, ctx->taglen))
266 /* If decrypting then verify */
267 if (ctx->taglen == 0)
269 if (!aes_generic_ocb_final(ctx))
272 /* Don't reuse the IV */
273 ctx->iv_state = IV_STATE_FINISHED;
277 static void *aes_ocb_newctx(void *provctx, size_t kbits, size_t blkbits,
278 size_t ivbits, unsigned int mode, uint64_t flags)
280 PROV_AES_OCB_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
283 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
284 PROV_CIPHER_HW_aes_ocb(kbits), NULL);
285 ctx->taglen = OCB_DEFAULT_TAG_LEN;
290 static void aes_ocb_freectx(void *vctx)
292 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
295 aes_generic_ocb_cleanup(ctx);
296 OPENSSL_clear_free(ctx, sizeof(*ctx));
300 static void *aes_ocb_dupctx(void *vctx)
302 PROV_AES_OCB_CTX *in = (PROV_AES_OCB_CTX *)vctx;
303 PROV_AES_OCB_CTX *ret = OPENSSL_malloc(sizeof(*ret));
306 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
310 if (!aes_generic_ocb_copy_ctx(ret, in)) {
317 static int aes_ocb_set_ctx_params(void *vctx, const OSSL_PARAM params[])
319 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
323 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
325 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
326 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
329 if (p->data == NULL) {
330 /* Tag len must be 0 to 16 */
331 if (p->data_size > OCB_MAX_TAG_LEN)
333 ctx->taglen = p->data_size;
335 if (p->data_size != ctx->taglen || ctx->base.enc)
337 memcpy(ctx->tag, p->data, p->data_size);
340 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
342 if (!OSSL_PARAM_get_size_t(p, &sz)) {
343 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
346 /* IV len must be 1 to 15 */
347 if (sz < OCB_MIN_IV_LEN || sz > OCB_MAX_IV_LEN)
349 ctx->base.ivlen = sz;
351 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
355 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
356 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
359 if (ctx->base.keylen != keylen) {
360 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
367 static int aes_ocb_get_ctx_params(void *vctx, OSSL_PARAM params[])
369 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
372 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
373 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.ivlen)) {
374 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
377 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
378 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.keylen)) {
379 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
382 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
384 if (!OSSL_PARAM_set_size_t(p, ctx->taglen)) {
385 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
390 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
392 if (ctx->base.ivlen != p->data_size) {
393 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
396 if (!OSSL_PARAM_set_octet_string(p, ctx->base.oiv, ctx->base.ivlen)) {
397 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
401 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
403 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
404 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
407 if (!ctx->base.enc || p->data_size != ctx->taglen) {
408 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
411 memcpy(p->data, ctx->tag, ctx->taglen);
416 static const OSSL_PARAM cipher_ocb_known_gettable_ctx_params[] = {
417 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
418 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
419 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
420 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
421 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
424 static const OSSL_PARAM *cipher_ocb_gettable_ctx_params(void)
426 return cipher_ocb_known_gettable_ctx_params;
429 static const OSSL_PARAM cipher_ocb_known_settable_ctx_params[] = {
430 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
431 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
432 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
435 static const OSSL_PARAM *cipher_ocb_settable_ctx_params(void)
437 return cipher_ocb_known_settable_ctx_params;
440 static int aes_ocb_cipher(void *vctx, unsigned char *out, size_t *outl,
441 size_t outsize, const unsigned char *in, size_t inl)
443 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
446 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
450 if (!aes_generic_ocb_cipher(ctx, in, out, inl)) {
451 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
459 #define IMPLEMENT_cipher(mode, UCMODE, flags, kbits, blkbits, ivbits) \
460 static OSSL_OP_cipher_get_params_fn aes_##kbits##_##mode##_get_params; \
461 static int aes_##kbits##_##mode##_get_params(OSSL_PARAM params[]) \
463 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
464 flags, kbits, blkbits, ivbits); \
466 static OSSL_OP_cipher_newctx_fn aes_##kbits##_##mode##_newctx; \
467 static void *aes_##kbits##_##mode##_newctx(void *provctx) \
469 return aes_##mode##_newctx(provctx, kbits, blkbits, ivbits, \
470 EVP_CIPH_##UCMODE##_MODE, flags); \
472 const OSSL_DISPATCH aes##kbits##mode##_functions[] = { \
473 { OSSL_FUNC_CIPHER_NEWCTX, \
474 (void (*)(void))aes_##kbits##_##mode##_newctx }, \
475 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_##mode##_einit }, \
476 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_##mode##_dinit }, \
477 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_##mode##_block_update }, \
478 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_##mode##_block_final }, \
479 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_ocb_cipher }, \
480 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_##mode##_freectx }, \
481 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_##mode##_dupctx }, \
482 { OSSL_FUNC_CIPHER_GET_PARAMS, \
483 (void (*)(void))aes_##kbits##_##mode##_get_params }, \
484 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
485 (void (*)(void))aes_##mode##_get_ctx_params }, \
486 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
487 (void (*)(void))aes_##mode##_set_ctx_params }, \
488 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
489 (void (*)(void))cipher_generic_gettable_params }, \
490 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
491 (void (*)(void))cipher_ocb_gettable_ctx_params }, \
492 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
493 (void (*)(void))cipher_ocb_settable_ctx_params }, \
497 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 256, 128, OCB_DEFAULT_IV_LEN * 8);
498 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 192, 128, OCB_DEFAULT_IV_LEN * 8);
499 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 128, 128, OCB_DEFAULT_IV_LEN * 8);