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
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_OP_cipher_encrypt_init_fn aes_ocb_einit;
34 static OSSL_OP_cipher_decrypt_init_fn aes_ocb_dinit;
35 static OSSL_OP_cipher_update_fn aes_ocb_block_update;
36 static OSSL_OP_cipher_final_fn aes_ocb_block_final;
37 static OSSL_OP_cipher_cipher_fn aes_ocb_cipher;
38 static OSSL_OP_cipher_freectx_fn aes_ocb_freectx;
39 static OSSL_OP_cipher_dupctx_fn aes_ocb_dupctx;
40 static OSSL_OP_cipher_get_ctx_params_fn aes_ocb_get_ctx_params;
41 static OSSL_OP_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;
109 if (ivlen != ctx->base.ivlen) {
110 /* IV len must be 1 to 15 */
111 if (ivlen < OCB_MIN_IV_LEN || ivlen > OCB_MAX_IV_LEN) {
112 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
115 ctx->base.ivlen = ivlen;
117 if (!cipher_generic_initiv(&ctx->base, iv, ivlen))
119 ctx->iv_state = IV_STATE_BUFFERED;
122 if (keylen != ctx->base.keylen) {
123 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
126 return ctx->base.hw->init(&ctx->base, key, keylen);
131 static int aes_ocb_einit(void *vctx, const unsigned char *key, size_t keylen,
132 const unsigned char *iv, size_t ivlen)
134 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 1);
137 static int aes_ocb_dinit(void *vctx, const unsigned char *key, size_t keylen,
138 const unsigned char *iv, size_t ivlen)
140 return aes_ocb_init(vctx, key, keylen, iv, ivlen, 0);
144 * Because of the way OCB works, both the AAD and data are buffered in the
145 * same way. Only the last block can be a partial block.
147 static int aes_ocb_block_update_internal(PROV_AES_OCB_CTX *ctx,
148 unsigned char *buf, size_t *bufsz,
149 unsigned char *out, size_t *outl,
150 size_t outsize, const unsigned char *in,
151 size_t inl, OSSL_ocb_cipher_fn ciph)
153 size_t nextblocks = fillblock(buf, bufsz, AES_BLOCK_SIZE, &in, &inl);
156 if (*bufsz == AES_BLOCK_SIZE) {
157 if (outsize < AES_BLOCK_SIZE) {
158 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
161 if (!ciph(ctx, buf, out, AES_BLOCK_SIZE)) {
162 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
166 outlint = AES_BLOCK_SIZE;
167 out += AES_BLOCK_SIZE;
169 if (nextblocks > 0) {
170 outlint += nextblocks;
171 if (outsize < outlint) {
172 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
175 if (!ciph(ctx, in, out, nextblocks)) {
176 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
182 if (!trailingdata(buf, bufsz, AES_BLOCK_SIZE, &in, &inl)) {
183 /* PROVerr already called */
191 /* A wrapper function that has the same signature as cipher */
192 static int cipher_updateaad(PROV_AES_OCB_CTX *ctx, const unsigned char *in,
193 unsigned char *out, size_t len)
195 return aes_generic_ocb_setaad(ctx, in, len);
198 static int update_iv(PROV_AES_OCB_CTX *ctx)
200 if (ctx->iv_state == IV_STATE_FINISHED
201 || ctx->iv_state == IV_STATE_UNINITIALISED)
203 if (ctx->iv_state == IV_STATE_BUFFERED) {
204 if (!aes_generic_ocb_setiv(ctx, ctx->base.iv, ctx->base.ivlen,
207 ctx->iv_state = IV_STATE_COPIED;
212 static int aes_ocb_block_update(void *vctx, unsigned char *out, size_t *outl,
213 size_t outsize, const unsigned char *in,
216 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
219 OSSL_ocb_cipher_fn fn;
221 if (!ctx->key_set || !update_iv(ctx))
229 /* Are we dealing with AAD or normal data here? */
232 buflen = &ctx->aad_buf_len;
233 fn = cipher_updateaad;
236 buflen = &ctx->data_buf_len;
237 fn = aes_generic_ocb_cipher;
239 return aes_ocb_block_update_internal(ctx, buf, buflen, out, outl, outsize,
243 static int aes_ocb_block_final(void *vctx, unsigned char *out, size_t *outl,
246 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
248 /* If no block_update has run then the iv still needs to be set */
249 if (!ctx->key_set || !update_iv(ctx))
253 * Empty the buffer of any partial block that we might have been provided,
254 * both for data and AAD
257 if (ctx->data_buf_len > 0) {
258 if (!aes_generic_ocb_cipher(ctx, ctx->data_buf, out, ctx->data_buf_len))
260 *outl = ctx->data_buf_len;
261 ctx->data_buf_len = 0;
263 if (ctx->aad_buf_len > 0) {
264 if (!aes_generic_ocb_setaad(ctx, ctx->aad_buf, ctx->aad_buf_len))
266 ctx->aad_buf_len = 0;
269 /* If encrypting then just get the tag */
270 if (!aes_generic_ocb_gettag(ctx, ctx->tag, ctx->taglen))
273 /* If decrypting then verify */
274 if (ctx->taglen == 0)
276 if (!aes_generic_ocb_final(ctx))
279 /* Don't reuse the IV */
280 ctx->iv_state = IV_STATE_FINISHED;
284 static void *aes_ocb_newctx(void *provctx, size_t kbits, size_t blkbits,
285 size_t ivbits, unsigned int mode, uint64_t flags)
287 PROV_AES_OCB_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
290 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
291 PROV_CIPHER_HW_aes_ocb(kbits), NULL);
292 ctx->taglen = OCB_DEFAULT_TAG_LEN;
297 static void aes_ocb_freectx(void *vctx)
299 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
302 aes_generic_ocb_cleanup(ctx);
303 OPENSSL_clear_free(ctx, sizeof(*ctx));
307 static void *aes_ocb_dupctx(void *vctx)
309 PROV_AES_OCB_CTX *in = (PROV_AES_OCB_CTX *)vctx;
310 PROV_AES_OCB_CTX *ret = OPENSSL_malloc(sizeof(*ret));
313 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
317 if (!aes_generic_ocb_copy_ctx(ret, in)) {
324 static int aes_ocb_set_ctx_params(void *vctx, const OSSL_PARAM params[])
326 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
330 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
332 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
333 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
336 if (p->data == NULL) {
337 /* Tag len must be 0 to 16 */
338 if (p->data_size > OCB_MAX_TAG_LEN)
340 ctx->taglen = p->data_size;
342 if (p->data_size != ctx->taglen || ctx->base.enc)
344 memcpy(ctx->tag, p->data, p->data_size);
347 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
349 if (!OSSL_PARAM_get_size_t(p, &sz)) {
350 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
353 /* IV len must be 1 to 15 */
354 if (sz < OCB_MIN_IV_LEN || sz > OCB_MAX_IV_LEN)
356 ctx->base.ivlen = sz;
358 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
362 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
363 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
366 if (ctx->base.keylen != keylen) {
367 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
374 static int aes_ocb_get_ctx_params(void *vctx, OSSL_PARAM params[])
376 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
379 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
380 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.ivlen)) {
381 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
384 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
385 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.keylen)) {
386 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
389 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
391 if (!OSSL_PARAM_set_size_t(p, ctx->taglen)) {
392 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
397 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
399 if (ctx->base.ivlen != p->data_size) {
400 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
403 if (!OSSL_PARAM_set_octet_string(p, ctx->base.oiv, ctx->base.ivlen)) {
404 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
408 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
410 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
411 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
414 if (!ctx->base.enc || p->data_size != ctx->taglen) {
415 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
418 memcpy(p->data, ctx->tag, ctx->taglen);
423 static const OSSL_PARAM cipher_ocb_known_gettable_ctx_params[] = {
424 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
425 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
426 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
427 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
428 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
431 static const OSSL_PARAM *cipher_ocb_gettable_ctx_params(void)
433 return cipher_ocb_known_gettable_ctx_params;
436 static const OSSL_PARAM cipher_ocb_known_settable_ctx_params[] = {
437 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
438 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
439 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
442 static const OSSL_PARAM *cipher_ocb_settable_ctx_params(void)
444 return cipher_ocb_known_settable_ctx_params;
447 static int aes_ocb_cipher(void *vctx, unsigned char *out, size_t *outl,
448 size_t outsize, const unsigned char *in, size_t inl)
450 PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
453 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
457 if (!aes_generic_ocb_cipher(ctx, in, out, inl)) {
458 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
466 #define IMPLEMENT_cipher(mode, UCMODE, flags, kbits, blkbits, ivbits) \
467 static OSSL_OP_cipher_get_params_fn aes_##kbits##_##mode##_get_params; \
468 static int aes_##kbits##_##mode##_get_params(OSSL_PARAM params[]) \
470 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
471 flags, kbits, blkbits, ivbits); \
473 static OSSL_OP_cipher_newctx_fn aes_##kbits##_##mode##_newctx; \
474 static void *aes_##kbits##_##mode##_newctx(void *provctx) \
476 return aes_##mode##_newctx(provctx, kbits, blkbits, ivbits, \
477 EVP_CIPH_##UCMODE##_MODE, flags); \
479 const OSSL_DISPATCH aes##kbits##mode##_functions[] = { \
480 { OSSL_FUNC_CIPHER_NEWCTX, \
481 (void (*)(void))aes_##kbits##_##mode##_newctx }, \
482 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_##mode##_einit }, \
483 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_##mode##_dinit }, \
484 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_##mode##_block_update }, \
485 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_##mode##_block_final }, \
486 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_ocb_cipher }, \
487 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_##mode##_freectx }, \
488 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_##mode##_dupctx }, \
489 { OSSL_FUNC_CIPHER_GET_PARAMS, \
490 (void (*)(void))aes_##kbits##_##mode##_get_params }, \
491 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
492 (void (*)(void))aes_##mode##_get_ctx_params }, \
493 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
494 (void (*)(void))aes_##mode##_set_ctx_params }, \
495 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
496 (void (*)(void))cipher_generic_gettable_params }, \
497 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
498 (void (*)(void))cipher_ocb_gettable_ctx_params }, \
499 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
500 (void (*)(void))cipher_ocb_settable_ctx_params }, \
504 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 256, 128, OCB_DEFAULT_IV_LEN * 8);
505 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 192, 128, OCB_DEFAULT_IV_LEN * 8);
506 IMPLEMENT_cipher(ocb, OCB, AES_OCB_FLAGS, 128, 128, OCB_DEFAULT_IV_LEN * 8);