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/providercommon.h"
19 #include "prov/providercommonerr.h"
20 #include "prov/ciphercommon_aead.h"
21 #include "prov/implementations.h"
23 #define AES_OCB_FLAGS AEAD_FLAGS
25 #define OCB_DEFAULT_TAG_LEN 16
26 #define OCB_DEFAULT_IV_LEN 12
27 #define OCB_MIN_IV_LEN 1
28 #define OCB_MAX_IV_LEN 15
30 PROV_CIPHER_FUNC(int, ocb_cipher, (PROV_AES_OCB_CTX *ctx,
31 const unsigned char *in, unsigned char *out,
33 /* forward declarations */
34 static OSSL_FUNC_cipher_encrypt_init_fn aes_ocb_einit;
35 static OSSL_FUNC_cipher_decrypt_init_fn aes_ocb_dinit;
36 static OSSL_FUNC_cipher_update_fn aes_ocb_block_update;
37 static OSSL_FUNC_cipher_final_fn aes_ocb_block_final;
38 static OSSL_FUNC_cipher_cipher_fn aes_ocb_cipher;
39 static OSSL_FUNC_cipher_freectx_fn aes_ocb_freectx;
40 static OSSL_FUNC_cipher_dupctx_fn aes_ocb_dupctx;
41 static OSSL_FUNC_cipher_get_ctx_params_fn aes_ocb_get_ctx_params;
42 static OSSL_FUNC_cipher_set_ctx_params_fn aes_ocb_set_ctx_params;
43 static OSSL_FUNC_cipher_gettable_ctx_params_fn cipher_ocb_gettable_ctx_params;
44 static OSSL_FUNC_cipher_settable_ctx_params_fn cipher_ocb_settable_ctx_params;
47 * The following methods could be moved into PROV_AES_OCB_HW if
48 * multiple hardware implementations are ever needed.
50 static ossl_inline int aes_generic_ocb_setiv(PROV_AES_OCB_CTX *ctx,
51 const unsigned char *iv,
52 size_t ivlen, size_t taglen)
54 return (CRYPTO_ocb128_setiv(&ctx->ocb, iv, ivlen, taglen) == 1);
57 static ossl_inline int aes_generic_ocb_setaad(PROV_AES_OCB_CTX *ctx,
58 const unsigned char *aad,
61 return CRYPTO_ocb128_aad(&ctx->ocb, aad, alen) == 1;
64 static ossl_inline int aes_generic_ocb_gettag(PROV_AES_OCB_CTX *ctx,
65 unsigned char *tag, size_t tlen)
67 return CRYPTO_ocb128_tag(&ctx->ocb, tag, tlen) > 0;
70 static ossl_inline int aes_generic_ocb_final(PROV_AES_OCB_CTX *ctx)
72 return (CRYPTO_ocb128_finish(&ctx->ocb, ctx->tag, ctx->taglen) == 0);
75 static ossl_inline void aes_generic_ocb_cleanup(PROV_AES_OCB_CTX *ctx)
77 CRYPTO_ocb128_cleanup(&ctx->ocb);
80 static ossl_inline int aes_generic_ocb_cipher(PROV_AES_OCB_CTX *ctx,
81 const unsigned char *in,
82 unsigned char *out, size_t len)
85 if (!CRYPTO_ocb128_encrypt(&ctx->ocb, in, out, len))
88 if (!CRYPTO_ocb128_decrypt(&ctx->ocb, in, out, len))
94 static ossl_inline int aes_generic_ocb_copy_ctx(PROV_AES_OCB_CTX *dst,
95 PROV_AES_OCB_CTX *src)
97 return CRYPTO_ocb128_copy_ctx(&dst->ocb, &src->ocb,
98 &dst->ksenc.ks, &dst->ksdec.ks);
102 * Provider dispatch functions
104 static int aes_ocb_init(void *vctx, const unsigned char *key, size_t keylen,
105 const unsigned char *iv, size_t ivlen, int enc)
107 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
109 if (!ossl_prov_is_running())
112 ctx->aad_buf_len = 0;
113 ctx->data_buf_len = 0;
117 if (ivlen != ctx->base.ivlen) {
118 /* IV len must be 1 to 15 */
119 if (ivlen < OCB_MIN_IV_LEN || ivlen > OCB_MAX_IV_LEN) {
120 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
123 ctx->base.ivlen = ivlen;
125 if (!ossl_cipher_generic_initiv(&ctx->base, iv, ivlen))
127 ctx->iv_state = IV_STATE_BUFFERED;
130 if (keylen != ctx->base.keylen) {
131 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
134 return ctx->base.hw->init(&ctx->base, key, keylen);
139 static int aes_ocb_einit(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, 1);
145 static int aes_ocb_dinit(void *vctx, const unsigned char *key, size_t keylen,
146 const unsigned char *iv, size_t ivlen)
148 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 0);
152 * Because of the way OCB works, both the AAD and data are buffered in the
153 * same way. Only the last block can be a partial block.
155 static int aes_ocb_block_update_internal(PROV_AES_OCB_CTX *ctx,
156 unsigned char *buf, size_t *bufsz,
157 unsigned char *out, size_t *outl,
158 size_t outsize, const unsigned char *in,
159 size_t inl, OSSL_ocb_cipher_fn ciph)
165 nextblocks = fillblock(buf, bufsz, AES_BLOCK_SIZE, &in, &inl);
167 nextblocks = inl & ~(AES_BLOCK_SIZE-1);
169 if (*bufsz == AES_BLOCK_SIZE) {
170 if (outsize < AES_BLOCK_SIZE) {
171 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
174 if (!ciph(ctx, buf, out, AES_BLOCK_SIZE)) {
175 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
179 outlint = AES_BLOCK_SIZE;
181 out += AES_BLOCK_SIZE;
183 if (nextblocks > 0) {
184 outlint += nextblocks;
185 if (outsize < outlint) {
186 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
189 if (!ciph(ctx, in, out, nextblocks)) {
190 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
196 if (inl != 0 && !trailingdata(buf, bufsz, AES_BLOCK_SIZE, &in, &inl)) {
197 /* PROVerr already called */
205 /* A wrapper function that has the same signature as cipher */
206 static int cipher_updateaad(PROV_AES_OCB_CTX *ctx, const unsigned char *in,
207 unsigned char *out, size_t len)
209 return aes_generic_ocb_setaad(ctx, in, len);
212 static int update_iv(PROV_AES_OCB_CTX *ctx)
214 if (ctx->iv_state == IV_STATE_FINISHED
215 || ctx->iv_state == IV_STATE_UNINITIALISED)
217 if (ctx->iv_state == IV_STATE_BUFFERED) {
218 if (!aes_generic_ocb_setiv(ctx, ctx->base.iv, ctx->base.ivlen,
221 ctx->iv_state = IV_STATE_COPIED;
226 static int aes_ocb_block_update(void *vctx, unsigned char *out, size_t *outl,
227 size_t outsize, const unsigned char *in,
230 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
233 OSSL_ocb_cipher_fn fn;
235 if (!ctx->key_set || !update_iv(ctx))
243 /* Are we dealing with AAD or normal data here? */
246 buflen = &ctx->aad_buf_len;
247 fn = cipher_updateaad;
250 buflen = &ctx->data_buf_len;
251 fn = aes_generic_ocb_cipher;
253 return aes_ocb_block_update_internal(ctx, buf, buflen, out, outl, outsize,
257 static int aes_ocb_block_final(void *vctx, unsigned char *out, size_t *outl,
260 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
262 if (!ossl_prov_is_running())
265 /* If no block_update has run then the iv still needs to be set */
266 if (!ctx->key_set || !update_iv(ctx))
270 * Empty the buffer of any partial block that we might have been provided,
271 * both for data and AAD
274 if (ctx->data_buf_len > 0) {
275 if (!aes_generic_ocb_cipher(ctx, ctx->data_buf, out, ctx->data_buf_len))
277 *outl = ctx->data_buf_len;
278 ctx->data_buf_len = 0;
280 if (ctx->aad_buf_len > 0) {
281 if (!aes_generic_ocb_setaad(ctx, ctx->aad_buf, ctx->aad_buf_len))
283 ctx->aad_buf_len = 0;
286 /* If encrypting then just get the tag */
287 if (!aes_generic_ocb_gettag(ctx, ctx->tag, ctx->taglen))
290 /* If decrypting then verify */
291 if (ctx->taglen == 0)
293 if (!aes_generic_ocb_final(ctx))
296 /* Don't reuse the IV */
297 ctx->iv_state = IV_STATE_FINISHED;
301 static void *aes_ocb_newctx(void *provctx, size_t kbits, size_t blkbits,
302 size_t ivbits, unsigned int mode, uint64_t flags)
304 PROV_AES_OCB_CTX *ctx;
306 if (!ossl_prov_is_running())
309 ctx = OPENSSL_zalloc(sizeof(*ctx));
311 ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
312 ossl_prov_cipher_hw_aes_ocb(kbits), NULL);
313 ctx->taglen = OCB_DEFAULT_TAG_LEN;
318 static void aes_ocb_freectx(void *vctx)
320 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
323 aes_generic_ocb_cleanup(ctx);
324 ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
325 OPENSSL_clear_free(ctx, sizeof(*ctx));
329 static void *aes_ocb_dupctx(void *vctx)
331 PROV_AES_OCB_CTX *in = (PROV_AES_OCB_CTX *)vctx;
332 PROV_AES_OCB_CTX *ret;
334 if (!ossl_prov_is_running())
337 ret = OPENSSL_malloc(sizeof(*ret));
339 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
343 if (!aes_generic_ocb_copy_ctx(ret, in)) {
350 static int aes_ocb_set_ctx_params(void *vctx, const OSSL_PARAM params[])
352 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
356 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
358 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
359 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
362 if (p->data == NULL) {
363 /* Tag len must be 0 to 16 */
364 if (p->data_size > OCB_MAX_TAG_LEN)
366 ctx->taglen = p->data_size;
368 if (p->data_size != ctx->taglen || ctx->base.enc)
370 memcpy(ctx->tag, p->data, p->data_size);
373 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
375 if (!OSSL_PARAM_get_size_t(p, &sz)) {
376 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
379 /* IV len must be 1 to 15 */
380 if (sz < OCB_MIN_IV_LEN || sz > OCB_MAX_IV_LEN)
382 ctx->base.ivlen = sz;
384 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
388 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
389 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
392 if (ctx->base.keylen != keylen) {
393 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
400 static int aes_ocb_get_ctx_params(void *vctx, OSSL_PARAM params[])
402 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
405 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
406 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.ivlen)) {
407 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
410 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
411 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.keylen)) {
412 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
415 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
417 if (!OSSL_PARAM_set_size_t(p, ctx->taglen)) {
418 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
423 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
425 if (ctx->base.ivlen > p->data_size) {
426 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
429 if (!OSSL_PARAM_set_octet_string(p, ctx->base.oiv, ctx->base.ivlen)
430 && !OSSL_PARAM_set_octet_ptr(p, &ctx->base.oiv, ctx->base.ivlen)) {
431 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
435 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV_STATE);
437 if (ctx->base.ivlen > p->data_size) {
438 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
441 if (!OSSL_PARAM_set_octet_string(p, ctx->base.iv, ctx->base.ivlen)
442 && !OSSL_PARAM_set_octet_ptr(p, &ctx->base.iv, ctx->base.ivlen)) {
443 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
447 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
449 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
450 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
453 if (!ctx->base.enc || p->data_size != ctx->taglen) {
454 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
457 memcpy(p->data, ctx->tag, ctx->taglen);
462 static const OSSL_PARAM cipher_ocb_known_gettable_ctx_params[] = {
463 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
464 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
465 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
466 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
467 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV_STATE, NULL, 0),
468 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
471 static const OSSL_PARAM *cipher_ocb_gettable_ctx_params(ossl_unused void *p_ctx)
473 return cipher_ocb_known_gettable_ctx_params;
476 static const OSSL_PARAM cipher_ocb_known_settable_ctx_params[] = {
477 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
478 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
479 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
482 static const OSSL_PARAM *cipher_ocb_settable_ctx_params(ossl_unused void *p_ctx)
484 return cipher_ocb_known_settable_ctx_params;
487 static int aes_ocb_cipher(void *vctx, unsigned char *out, size_t *outl,
488 size_t outsize, const unsigned char *in, size_t inl)
490 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
492 if (!ossl_prov_is_running())
496 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
500 if (!aes_generic_ocb_cipher(ctx, in, out, inl)) {
501 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
509 #define IMPLEMENT_cipher(mode, UCMODE, flags, kbits, blkbits, ivbits) \
510 static OSSL_FUNC_cipher_get_params_fn aes_##kbits##_##mode##_get_params; \
511 static int aes_##kbits##_##mode##_get_params(OSSL_PARAM params[]) \
513 return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
514 flags, kbits, blkbits, ivbits); \
516 static OSSL_FUNC_cipher_newctx_fn aes_##kbits##_##mode##_newctx; \
517 static void *aes_##kbits##_##mode##_newctx(void *provctx) \
519 return aes_##mode##_newctx(provctx, kbits, blkbits, ivbits, \
520 EVP_CIPH_##UCMODE##_MODE, flags); \
522 const OSSL_DISPATCH ossl_##aes##kbits##mode##_functions[] = { \
523 { OSSL_FUNC_CIPHER_NEWCTX, \
524 (void (*)(void))aes_##kbits##_##mode##_newctx }, \
525 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_##mode##_einit }, \
526 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_##mode##_dinit }, \
527 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_##mode##_block_update }, \
528 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_##mode##_block_final }, \
529 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_ocb_cipher }, \
530 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_##mode##_freectx }, \
531 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_##mode##_dupctx }, \
532 { OSSL_FUNC_CIPHER_GET_PARAMS, \
533 (void (*)(void))aes_##kbits##_##mode##_get_params }, \
534 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
535 (void (*)(void))aes_##mode##_get_ctx_params }, \
536 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
537 (void (*)(void))aes_##mode##_set_ctx_params }, \
538 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
539 (void (*)(void))ossl_cipher_generic_gettable_params }, \
540 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
541 (void (*)(void))cipher_ocb_gettable_ctx_params }, \
542 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
543 (void (*)(void))cipher_ocb_settable_ctx_params }, \
547 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 256, 128, OCB_DEFAULT_IV_LEN * 8);
548 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 192, 128, OCB_DEFAULT_IV_LEN * 8);
549 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 128, 128, OCB_DEFAULT_IV_LEN * 8);