2f85604a871bf7030257d2a680e600425fe269ba
[openssl.git] / providers / implementations / ciphers / cipher_aes_ocb.c
1 /*
2  * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 /*
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
13  * the case here.
14  */
15 #include "internal/deprecated.h"
16
17 #include "cipher_aes_ocb.h"
18 #include "prov/providercommonerr.h"
19 #include "prov/ciphercommon_aead.h"
20 #include "prov/implementations.h"
21
22 #define AES_OCB_FLAGS AEAD_FLAGS
23
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
28
29 PROV_CIPHER_FUNC(int, ocb_cipher, (PROV_AES_OCB_CTX *ctx,
30                                    const unsigned char *in, unsigned char *out,
31                                    size_t nextblock));
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;
42
43 /*
44  * The following methods could be moved into PROV_AES_OCB_HW if
45  * multiple hardware implementations are ever needed.
46  */
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)
50 {
51     return (CRYPTO_ocb128_setiv(&ctx->ocb, iv, ivlen, taglen) == 1);
52 }
53
54 static ossl_inline int aes_generic_ocb_setaad(PROV_AES_OCB_CTX *ctx,
55                                               const unsigned char *aad,
56                                               size_t alen)
57 {
58     return CRYPTO_ocb128_aad(&ctx->ocb, aad, alen) == 1;
59 }
60
61 static ossl_inline int aes_generic_ocb_gettag(PROV_AES_OCB_CTX *ctx,
62                                               unsigned char *tag, size_t tlen)
63 {
64     return CRYPTO_ocb128_tag(&ctx->ocb, tag, tlen) > 0;
65 }
66
67 static ossl_inline int aes_generic_ocb_final(PROV_AES_OCB_CTX *ctx)
68 {
69     return (CRYPTO_ocb128_finish(&ctx->ocb, ctx->tag, ctx->taglen) == 0);
70 }
71
72 static ossl_inline void aes_generic_ocb_cleanup(PROV_AES_OCB_CTX *ctx)
73 {
74     CRYPTO_ocb128_cleanup(&ctx->ocb);
75 }
76
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)
80 {
81     if (ctx->base.enc) {
82         if (!CRYPTO_ocb128_encrypt(&ctx->ocb, in, out, len))
83             return 0;
84     } else {
85         if (!CRYPTO_ocb128_decrypt(&ctx->ocb, in, out, len))
86             return 0;
87     }
88     return 1;
89 }
90
91 static ossl_inline int aes_generic_ocb_copy_ctx(PROV_AES_OCB_CTX *dst,
92                                                 PROV_AES_OCB_CTX *src)
93 {
94     return CRYPTO_ocb128_copy_ctx(&dst->ocb, &src->ocb,
95                                   &dst->ksenc.ks, &dst->ksdec.ks);
96 }
97
98 /*-
99  * Provider dispatch functions
100  */
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)
103 {
104    PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
105
106    ctx->base.enc = enc;
107
108    if (iv != NULL) {
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);
113                return 0;
114            }
115            ctx->base.ivlen = ivlen;
116        }
117        if (!cipher_generic_initiv(&ctx->base, iv, ivlen))
118            return 0;
119        ctx->iv_state = IV_STATE_BUFFERED;
120    }
121    if (key != NULL) {
122        if (keylen != ctx->base.keylen) {
123            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
124            return 0;
125        }
126        return ctx->base.hw->init(&ctx->base, key, keylen);
127    }
128    return 1;
129 }
130
131 static int aes_ocb_einit(void *vctx, const unsigned char *key, size_t keylen,
132                          const unsigned char *iv, size_t ivlen)
133 {
134     return aes_ocb_init(vctx, key, keylen, iv, ivlen, 1);
135 }
136
137 static int aes_ocb_dinit(void *vctx, const unsigned char *key, size_t keylen,
138                          const unsigned char *iv, size_t ivlen)
139 {
140     return aes_ocb_init(vctx, key, keylen, iv, ivlen, 0);
141 }
142
143 /*
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.
146  */
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)
152 {
153     size_t nextblocks = fillblock(buf, bufsz, AES_BLOCK_SIZE, &in, &inl);
154     size_t outlint = 0;
155
156     if (*bufsz == AES_BLOCK_SIZE) {
157         if (outsize < AES_BLOCK_SIZE) {
158             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
159             return 0;
160         }
161         if (!ciph(ctx, buf, out, AES_BLOCK_SIZE)) {
162             ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
163             return 0;
164         }
165         *bufsz = 0;
166         outlint = AES_BLOCK_SIZE;
167         out += AES_BLOCK_SIZE;
168     }
169     if (nextblocks > 0) {
170         outlint += nextblocks;
171         if (outsize < outlint) {
172             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
173             return 0;
174         }
175         if (!ciph(ctx, in, out, nextblocks)) {
176             ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
177             return 0;
178         }
179         in += nextblocks;
180         inl -= nextblocks;
181     }
182     if (!trailingdata(buf, bufsz, AES_BLOCK_SIZE, &in, &inl)) {
183         /* PROVerr already called */
184         return 0;
185     }
186
187     *outl = outlint;
188     return inl == 0;
189 }
190
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)
194 {
195     return aes_generic_ocb_setaad(ctx, in, len);
196 }
197
198 static int update_iv(PROV_AES_OCB_CTX *ctx)
199 {
200     if (ctx->iv_state == IV_STATE_FINISHED
201         || ctx->iv_state == IV_STATE_UNINITIALISED)
202         return 0;
203     if (ctx->iv_state == IV_STATE_BUFFERED) {
204         if (!aes_generic_ocb_setiv(ctx, ctx->base.iv, ctx->base.ivlen,
205                                    ctx->taglen))
206             return 0;
207         ctx->iv_state = IV_STATE_COPIED;
208     }
209     return 1;
210 }
211
212 static int aes_ocb_block_update(void *vctx, unsigned char *out, size_t *outl,
213                                 size_t outsize, const unsigned char *in,
214                                 size_t inl)
215 {
216     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
217     unsigned char *buf;
218     size_t *buflen;
219     OSSL_ocb_cipher_fn fn;
220
221     if (!ctx->key_set || !update_iv(ctx))
222         return 0;
223
224     if (inl == 0) {
225         *outl = 0;
226         return 1;
227     }
228
229     /* Are we dealing with AAD or normal data here? */
230     if (out == NULL) {
231         buf = ctx->aad_buf;
232         buflen = &ctx->aad_buf_len;
233         fn = cipher_updateaad;
234     } else {
235         buf = ctx->data_buf;
236         buflen = &ctx->data_buf_len;
237         fn = aes_generic_ocb_cipher;
238     }
239     return aes_ocb_block_update_internal(ctx, buf, buflen, out, outl, outsize,
240                                          in, inl, fn);
241 }
242
243 static int aes_ocb_block_final(void *vctx, unsigned char *out, size_t *outl,
244                                size_t outsize)
245 {
246     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
247
248     /* If no block_update has run then the iv still needs to be set */
249     if (!ctx->key_set || !update_iv(ctx))
250         return 0;
251
252     /*
253      * Empty the buffer of any partial block that we might have been provided,
254      * both for data and AAD
255      */
256     *outl = 0;
257     if (ctx->data_buf_len > 0) {
258         if (!aes_generic_ocb_cipher(ctx, ctx->data_buf, out, ctx->data_buf_len))
259             return 0;
260         *outl = ctx->data_buf_len;
261         ctx->data_buf_len = 0;
262     }
263     if (ctx->aad_buf_len > 0) {
264         if (!aes_generic_ocb_setaad(ctx, ctx->aad_buf, ctx->aad_buf_len))
265             return 0;
266         ctx->aad_buf_len = 0;
267     }
268     if (ctx->base.enc) {
269         /* If encrypting then just get the tag */
270         if (!aes_generic_ocb_gettag(ctx, ctx->tag, ctx->taglen))
271             return 0;
272     } else {
273         /* If decrypting then verify */
274         if (ctx->taglen == 0)
275             return 0;
276         if (!aes_generic_ocb_final(ctx))
277             return 0;
278     }
279     /* Don't reuse the IV */
280     ctx->iv_state = IV_STATE_FINISHED;
281     return 1;
282 }
283
284 static void *aes_ocb_newctx(void *provctx, size_t kbits, size_t blkbits,
285                             size_t ivbits, unsigned int mode, uint64_t flags)
286 {
287     PROV_AES_OCB_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
288
289     if (ctx != NULL) {
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;
293     }
294     return ctx;
295 }
296
297 static void aes_ocb_freectx(void *vctx)
298 {
299     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
300
301     if (ctx != NULL) {
302         aes_generic_ocb_cleanup(ctx);
303         OPENSSL_clear_free(ctx,  sizeof(*ctx));
304     }
305 }
306
307 static void *aes_ocb_dupctx(void *vctx)
308 {
309     PROV_AES_OCB_CTX *in = (PROV_AES_OCB_CTX *)vctx;
310     PROV_AES_OCB_CTX *ret = OPENSSL_malloc(sizeof(*ret));
311
312     if (ret == NULL) {
313         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
314         return NULL;
315     }
316     *ret = *in;
317     if (!aes_generic_ocb_copy_ctx(ret, in)) {
318         OPENSSL_free(ret);
319         ret = NULL;
320     }
321     return ret;
322 }
323
324 static int aes_ocb_set_ctx_params(void *vctx, const OSSL_PARAM params[])
325 {
326     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
327     const OSSL_PARAM *p;
328     size_t sz;
329
330     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
331     if (p != NULL) {
332         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
333             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
334             return 0;
335         }
336         if (p->data == NULL) {
337             /* Tag len must be 0 to 16 */
338             if (p->data_size > OCB_MAX_TAG_LEN)
339                 return 0;
340             ctx->taglen = p->data_size;
341         } else {
342             if (p->data_size != ctx->taglen || ctx->base.enc)
343                 return 0;
344             memcpy(ctx->tag, p->data, p->data_size);
345         }
346      }
347     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
348     if (p != NULL) {
349         if (!OSSL_PARAM_get_size_t(p, &sz)) {
350             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
351             return 0;
352         }
353         /* IV len must be 1 to 15 */
354         if (sz < OCB_MIN_IV_LEN || sz > OCB_MAX_IV_LEN)
355             return 0;
356         ctx->base.ivlen = sz;
357     }
358     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
359     if (p != NULL) {
360         size_t keylen;
361
362         if (!OSSL_PARAM_get_size_t(p, &keylen)) {
363             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
364             return 0;
365         }
366         if (ctx->base.keylen != keylen) {
367             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
368             return 0;
369         }
370     }
371     return 1;
372 }
373
374 static int aes_ocb_get_ctx_params(void *vctx, OSSL_PARAM params[])
375 {
376     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
377     OSSL_PARAM *p;
378
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);
382         return 0;
383     }
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);
387         return 0;
388     }
389     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
390     if (p != NULL) {
391         if (!OSSL_PARAM_set_size_t(p, ctx->taglen)) {
392             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
393             return 0;
394         }
395     }
396
397     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
398     if (p != NULL) {
399         if (ctx->base.ivlen != p->data_size) {
400             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
401             return 0;
402         }
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);
405             return 0;
406         }
407     }
408     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
409     if (p != NULL) {
410         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
411             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
412             return 0;
413         }
414         if (!ctx->base.enc || p->data_size != ctx->taglen) {
415             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
416             return 0;
417         }
418         memcpy(p->data, ctx->tag, ctx->taglen);
419     }
420     return 1;
421 }
422
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),
429     OSSL_PARAM_END
430 };
431 static const OSSL_PARAM *cipher_ocb_gettable_ctx_params(void)
432 {
433     return cipher_ocb_known_gettable_ctx_params;
434 }
435
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),
440     OSSL_PARAM_END
441 };
442 static const OSSL_PARAM *cipher_ocb_settable_ctx_params(void)
443 {
444     return cipher_ocb_known_settable_ctx_params;
445 }
446
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)
449 {
450     PROV_AES_OCB_CTX *ctx = (PROV_AES_OCB_CTX *)vctx;
451
452     if (outsize < inl) {
453         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
454         return 0;
455     }
456
457     if (!aes_generic_ocb_cipher(ctx, in, out, inl)) {
458         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
459         return 0;
460     }
461
462     *outl = inl;
463     return 1;
464 }
465
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[])              \
469 {                                                                              \
470     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,         \
471                                      flags, kbits, blkbits, ivbits);           \
472 }                                                                              \
473 static OSSL_OP_cipher_newctx_fn aes_##kbits##_##mode##_newctx;                 \
474 static void *aes_##kbits##_##mode##_newctx(void *provctx)                      \
475 {                                                                              \
476     return aes_##mode##_newctx(provctx, kbits, blkbits, ivbits,                \
477                                EVP_CIPH_##UCMODE##_MODE, flags);               \
478 }                                                                              \
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 },                      \
501     { 0, NULL }                                                                \
502 }
503
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);
507