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
11 * AES low level APIs are deprecated for public use, but still ok for internal
12 * use where we're using them to implement the higher level EVP interface, as is
15 #include "internal/deprecated.h"
17 #include "cipher_aes_ocb.h"
18 #include "prov/providercommonerr.h"
19 #include "prov/ciphercommon_aead.h"
20 #include "prov/implementations.h"
22 #define AES_OCB_FLAGS AEAD_FLAGS
24 #define OCB_DEFAULT_TAG_LEN 16
25 #define OCB_DEFAULT_IV_LEN 12
26 #define OCB_MIN_IV_LEN 1
27 #define OCB_MAX_IV_LEN 15
29 PROV_CIPHER_FUNC(int, ocb_cipher, (PROV_AES_OCB_CTX *ctx,
30 const unsigned char *in, unsigned char *out,
32 /* forward declarations */
33 static OSSL_FUNC_cipher_encrypt_init_fn aes_ocb_einit;
34 static OSSL_FUNC_cipher_decrypt_init_fn aes_ocb_dinit;
35 static OSSL_FUNC_cipher_update_fn aes_ocb_block_update;
36 static OSSL_FUNC_cipher_final_fn aes_ocb_block_final;
37 static OSSL_FUNC_cipher_cipher_fn aes_ocb_cipher;
38 static OSSL_FUNC_cipher_freectx_fn aes_ocb_freectx;
39 static OSSL_FUNC_cipher_dupctx_fn aes_ocb_dupctx;
40 static OSSL_FUNC_cipher_get_ctx_params_fn aes_ocb_get_ctx_params;
41 static OSSL_FUNC_cipher_set_ctx_params_fn aes_ocb_set_ctx_params;
44 * The following methods could be moved into PROV_AES_OCB_HW if
45 * multiple hardware implementations are ever needed.
47 static ossl_inline int aes_generic_ocb_setiv(PROV_AES_OCB_CTX *ctx,
48 const unsigned char *iv,
49 size_t ivlen, size_t taglen)
51 return (CRYPTO_ocb128_setiv(&ctx->ocb, iv, ivlen, taglen) == 1);
54 static ossl_inline int aes_generic_ocb_setaad(PROV_AES_OCB_CTX *ctx,
55 const unsigned char *aad,
58 return CRYPTO_ocb128_aad(&ctx->ocb, aad, alen) == 1;
61 static ossl_inline int aes_generic_ocb_gettag(PROV_AES_OCB_CTX *ctx,
62 unsigned char *tag, size_t tlen)
64 return CRYPTO_ocb128_tag(&ctx->ocb, tag, tlen) > 0;
67 static ossl_inline int aes_generic_ocb_final(PROV_AES_OCB_CTX *ctx)
69 return (CRYPTO_ocb128_finish(&ctx->ocb, ctx->tag, ctx->taglen) == 0);
72 static ossl_inline void aes_generic_ocb_cleanup(PROV_AES_OCB_CTX *ctx)
74 CRYPTO_ocb128_cleanup(&ctx->ocb);
77 static ossl_inline int aes_generic_ocb_cipher(PROV_AES_OCB_CTX *ctx,
78 const unsigned char *in,
79 unsigned char *out, size_t len)
82 if (!CRYPTO_ocb128_encrypt(&ctx->ocb, in, out, len))
85 if (!CRYPTO_ocb128_decrypt(&ctx->ocb, in, out, len))
91 static ossl_inline int aes_generic_ocb_copy_ctx(PROV_AES_OCB_CTX *dst,
92 PROV_AES_OCB_CTX *src)
94 return CRYPTO_ocb128_copy_ctx(&dst->ocb, &src->ocb,
95 &dst->ksenc.ks, &dst->ksdec.ks);
99 * Provider dispatch functions
101 static int aes_ocb_init(void *vctx, const unsigned char *key, size_t keylen,
102 const unsigned char *iv, size_t ivlen, int enc)
104 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
106 ctx->aad_buf_len = 0;
107 ctx->data_buf_len = 0;
111 if (ivlen != ctx->base.ivlen) {
112 /* IV len must be 1 to 15 */
113 if (ivlen < OCB_MIN_IV_LEN || ivlen > OCB_MAX_IV_LEN) {
114 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
117 ctx->base.ivlen = ivlen;
119 if (!cipher_generic_initiv(&ctx->base, iv, ivlen))
121 ctx->iv_state = IV_STATE_BUFFERED;
124 if (keylen != ctx->base.keylen) {
125 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
128 return ctx->base.hw->init(&ctx->base, key, keylen);
133 static int aes_ocb_einit(void *vctx, const unsigned char *key, size_t keylen,
134 const unsigned char *iv, size_t ivlen)
136 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 1);
139 static int aes_ocb_dinit(void *vctx, const unsigned char *key, size_t keylen,
140 const unsigned char *iv, size_t ivlen)
142 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 0);
146 * Because of the way OCB works, both the AAD and data are buffered in the
147 * same way. Only the last block can be a partial block.
149 static int aes_ocb_block_update_internal(PROV_AES_OCB_CTX *ctx,
150 unsigned char *buf, size_t *bufsz,
151 unsigned char *out, size_t *outl,
152 size_t outsize, const unsigned char *in,
153 size_t inl, OSSL_ocb_cipher_fn ciph)
159 nextblocks = fillblock(buf, bufsz, AES_BLOCK_SIZE, &in, &inl);
161 nextblocks = inl & ~(AES_BLOCK_SIZE-1);
163 if (*bufsz == AES_BLOCK_SIZE) {
164 if (outsize < AES_BLOCK_SIZE) {
165 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
168 if (!ciph(ctx, buf, out, AES_BLOCK_SIZE)) {
169 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
173 outlint = AES_BLOCK_SIZE;
174 out += AES_BLOCK_SIZE;
176 if (nextblocks > 0) {
177 outlint += nextblocks;
178 if (outsize < outlint) {
179 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
182 if (!ciph(ctx, in, out, nextblocks)) {
183 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
189 if (inl != 0 && !trailingdata(buf, bufsz, AES_BLOCK_SIZE, &in, &inl)) {
190 /* PROVerr already called */
198 /* A wrapper function that has the same signature as cipher */
199 static int cipher_updateaad(PROV_AES_OCB_CTX *ctx, const unsigned char *in,
200 unsigned char *out, size_t len)
202 return aes_generic_ocb_setaad(ctx, in, len);
205 static int update_iv(PROV_AES_OCB_CTX *ctx)
207 if (ctx->iv_state == IV_STATE_FINISHED
208 || ctx->iv_state == IV_STATE_UNINITIALISED)
210 if (ctx->iv_state == IV_STATE_BUFFERED) {
211 if (!aes_generic_ocb_setiv(ctx, ctx->base.iv, ctx->base.ivlen,
214 ctx->iv_state = IV_STATE_COPIED;
219 static int aes_ocb_block_update(void *vctx, unsigned char *out, size_t *outl,
220 size_t outsize, const unsigned char *in,
223 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
226 OSSL_ocb_cipher_fn fn;
228 if (!ctx->key_set || !update_iv(ctx))
236 /* Are we dealing with AAD or normal data here? */
239 buflen = &ctx->aad_buf_len;
240 fn = cipher_updateaad;
243 buflen = &ctx->data_buf_len;
244 fn = aes_generic_ocb_cipher;
246 return aes_ocb_block_update_internal(ctx, buf, buflen, out, outl, outsize,
250 static int aes_ocb_block_final(void *vctx, unsigned char *out, size_t *outl,
253 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
255 /* If no block_update has run then the iv still needs to be set */
256 if (!ctx->key_set || !update_iv(ctx))
260 * Empty the buffer of any partial block that we might have been provided,
261 * both for data and AAD
264 if (ctx->data_buf_len > 0) {
265 if (!aes_generic_ocb_cipher(ctx, ctx->data_buf, out, ctx->data_buf_len))
267 *outl = ctx->data_buf_len;
268 ctx->data_buf_len = 0;
270 if (ctx->aad_buf_len > 0) {
271 if (!aes_generic_ocb_setaad(ctx, ctx->aad_buf, ctx->aad_buf_len))
273 ctx->aad_buf_len = 0;
276 /* If encrypting then just get the tag */
277 if (!aes_generic_ocb_gettag(ctx, ctx->tag, ctx->taglen))
280 /* If decrypting then verify */
281 if (ctx->taglen == 0)
283 if (!aes_generic_ocb_final(ctx))
286 /* Don't reuse the IV */
287 ctx->iv_state = IV_STATE_FINISHED;
291 static void *aes_ocb_newctx(void *provctx, size_t kbits, size_t blkbits,
292 size_t ivbits, unsigned int mode, uint64_t flags)
294 PROV_AES_OCB_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
297 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
298 PROV_CIPHER_HW_aes_ocb(kbits), NULL);
299 ctx->taglen = OCB_DEFAULT_TAG_LEN;
304 static void aes_ocb_freectx(void *vctx)
306 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
309 aes_generic_ocb_cleanup(ctx);
310 cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
311 OPENSSL_clear_free(ctx, sizeof(*ctx));
315 static void *aes_ocb_dupctx(void *vctx)
317 PROV_AES_OCB_CTX *in = (PROV_AES_OCB_CTX *)vctx;
318 PROV_AES_OCB_CTX *ret = OPENSSL_malloc(sizeof(*ret));
321 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
325 if (!aes_generic_ocb_copy_ctx(ret, in)) {
332 static int aes_ocb_set_ctx_params(void *vctx, const OSSL_PARAM params[])
334 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
338 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
340 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
341 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
344 if (p->data == NULL) {
345 /* Tag len must be 0 to 16 */
346 if (p->data_size > OCB_MAX_TAG_LEN)
348 ctx->taglen = p->data_size;
350 if (p->data_size != ctx->taglen || ctx->base.enc)
352 memcpy(ctx->tag, p->data, p->data_size);
355 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
357 if (!OSSL_PARAM_get_size_t(p, &sz)) {
358 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
361 /* IV len must be 1 to 15 */
362 if (sz < OCB_MIN_IV_LEN || sz > OCB_MAX_IV_LEN)
364 ctx->base.ivlen = sz;
366 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
370 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
371 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
374 if (ctx->base.keylen != keylen) {
375 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
382 static int aes_ocb_get_ctx_params(void *vctx, OSSL_PARAM params[])
384 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
387 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
388 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.ivlen)) {
389 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
392 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
393 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.keylen)) {
394 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
397 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
399 if (!OSSL_PARAM_set_size_t(p, ctx->taglen)) {
400 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
405 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
407 if (ctx->base.ivlen > p->data_size) {
408 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
411 if (!OSSL_PARAM_set_octet_string(p, ctx->base.oiv, ctx->base.ivlen)
412 && !OSSL_PARAM_set_octet_ptr(p, &ctx->base.oiv, ctx->base.ivlen)) {
413 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
417 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
419 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
420 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
423 if (!ctx->base.enc || p->data_size != ctx->taglen) {
424 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
427 memcpy(p->data, ctx->tag, ctx->taglen);
432 static const OSSL_PARAM cipher_ocb_known_gettable_ctx_params[] = {
433 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
434 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
435 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
436 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
437 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
440 static const OSSL_PARAM *cipher_ocb_gettable_ctx_params(void)
442 return cipher_ocb_known_gettable_ctx_params;
445 static const OSSL_PARAM cipher_ocb_known_settable_ctx_params[] = {
446 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
447 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
448 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
451 static const OSSL_PARAM *cipher_ocb_settable_ctx_params(void)
453 return cipher_ocb_known_settable_ctx_params;
456 static int aes_ocb_cipher(void *vctx, unsigned char *out, size_t *outl,
457 size_t outsize, const unsigned char *in, size_t inl)
459 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
462 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
466 if (!aes_generic_ocb_cipher(ctx, in, out, inl)) {
467 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
475 #define IMPLEMENT_cipher(mode, UCMODE, flags, kbits, blkbits, ivbits) \
476 static OSSL_FUNC_cipher_get_params_fn aes_##kbits##_##mode##_get_params; \
477 static int aes_##kbits##_##mode##_get_params(OSSL_PARAM params[]) \
479 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
480 flags, kbits, blkbits, ivbits); \
482 static OSSL_FUNC_cipher_newctx_fn aes_##kbits##_##mode##_newctx; \
483 static void *aes_##kbits##_##mode##_newctx(void *provctx) \
485 return aes_##mode##_newctx(provctx, kbits, blkbits, ivbits, \
486 EVP_CIPH_##UCMODE##_MODE, flags); \
488 const OSSL_DISPATCH aes##kbits##mode##_functions[] = { \
489 { OSSL_FUNC_CIPHER_NEWCTX, \
490 (void (*)(void))aes_##kbits##_##mode##_newctx }, \
491 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_##mode##_einit }, \
492 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_##mode##_dinit }, \
493 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_##mode##_block_update }, \
494 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_##mode##_block_final }, \
495 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_ocb_cipher }, \
496 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_##mode##_freectx }, \
497 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_##mode##_dupctx }, \
498 { OSSL_FUNC_CIPHER_GET_PARAMS, \
499 (void (*)(void))aes_##kbits##_##mode##_get_params }, \
500 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
501 (void (*)(void))aes_##mode##_get_ctx_params }, \
502 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
503 (void (*)(void))aes_##mode##_set_ctx_params }, \
504 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
505 (void (*)(void))cipher_generic_gettable_params }, \
506 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
507 (void (*)(void))cipher_ocb_gettable_ctx_params }, \
508 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
509 (void (*)(void))cipher_ocb_settable_ctx_params }, \
513 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 256, 128, OCB_DEFAULT_IV_LEN * 8);
514 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 192, 128, OCB_DEFAULT_IV_LEN * 8);
515 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 128, 128, OCB_DEFAULT_IV_LEN * 8);