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 #include <openssl/crypto.h>
12 #include <openssl/core_numbers.h>
13 #include <openssl/core_names.h>
14 #include <openssl/evp.h>
15 #include <openssl/params.h>
16 #include "internal/cryptlib.h"
17 #include "internal/provider_algs.h"
18 #include "ciphers_locl.h"
19 #include "internal/providercommonerr.h"
21 static OSSL_OP_cipher_encrypt_init_fn aes_einit;
22 static OSSL_OP_cipher_decrypt_init_fn aes_dinit;
23 static OSSL_OP_cipher_update_fn aes_block_update;
24 static OSSL_OP_cipher_final_fn aes_block_final;
25 static OSSL_OP_cipher_update_fn aes_stream_update;
26 static OSSL_OP_cipher_final_fn aes_stream_final;
27 static OSSL_OP_cipher_cipher_fn aes_cipher;
28 static OSSL_OP_cipher_freectx_fn aes_freectx;
29 static OSSL_OP_cipher_dupctx_fn aes_dupctx;
30 static OSSL_OP_cipher_key_length_fn key_length_256;
31 static OSSL_OP_cipher_key_length_fn key_length_192;
32 static OSSL_OP_cipher_key_length_fn key_length_128;
33 static OSSL_OP_cipher_iv_length_fn iv_length_16;
34 static OSSL_OP_cipher_iv_length_fn iv_length_0;
35 static OSSL_OP_cipher_block_size_fn block_size_16;
36 static OSSL_OP_cipher_block_size_fn block_size_1;
37 static OSSL_OP_cipher_ctx_get_params_fn aes_ctx_get_params;
38 static OSSL_OP_cipher_ctx_set_params_fn aes_ctx_set_params;
40 static int PROV_AES_KEY_generic_init(PROV_AES_KEY *ctx,
41 const unsigned char *iv,
45 if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
46 if (ivlen != AES_BLOCK_SIZE) {
47 PROVerr(PROV_F_PROV_AES_KEY_GENERIC_INIT, ERR_R_INTERNAL_ERROR);
50 memcpy(ctx->iv, iv, AES_BLOCK_SIZE);
57 static int aes_einit(void *vctx, const unsigned char *key, size_t keylen,
58 const unsigned char *iv, size_t ivlen)
60 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
62 if (!PROV_AES_KEY_generic_init(ctx, iv, ivlen, 1)) {
63 /* PROVerr already called */
67 if (keylen != ctx->keylen) {
68 PROVerr(PROV_F_AES_EINIT, PROV_R_INVALID_KEYLEN);
71 return ctx->ciph->init(ctx, key, ctx->keylen);
77 static int aes_dinit(void *vctx, const unsigned char *key, size_t keylen,
78 const unsigned char *iv, size_t ivlen)
80 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
82 if (!PROV_AES_KEY_generic_init(ctx, iv, ivlen, 0)) {
83 /* PROVerr already called */
87 if (keylen != ctx->keylen) {
88 PROVerr(PROV_F_AES_DINIT, PROV_R_INVALID_KEYLEN);
91 return ctx->ciph->init(ctx, key, ctx->keylen);
97 static int aes_block_update(void *vctx, unsigned char *out, size_t *outl,
98 size_t outsize, const unsigned char *in, size_t inl)
100 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
101 size_t nextblocks = fillblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE, &in,
106 * If we're decrypting and we end an update on a block boundary we hold
107 * the last block back in case this is the last update call and the last
110 if (ctx->bufsz == AES_BLOCK_SIZE
111 && (ctx->enc || inl > 0 || !ctx->pad)) {
112 if (outsize < AES_BLOCK_SIZE) {
113 PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
116 if (!ctx->ciph->cipher(ctx, out, ctx->buf, AES_BLOCK_SIZE)) {
117 PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
121 outlint = AES_BLOCK_SIZE;
122 out += AES_BLOCK_SIZE;
124 if (nextblocks > 0) {
125 if (!ctx->enc && ctx->pad && nextblocks == inl) {
126 if (!ossl_assert(inl >= AES_BLOCK_SIZE)) {
127 PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
130 nextblocks -= AES_BLOCK_SIZE;
132 outlint += nextblocks;
133 if (outsize < outlint) {
134 PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
137 if (!ctx->ciph->cipher(ctx, out, in, nextblocks)) {
138 PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
144 if (!trailingdata(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE, &in, &inl)) {
145 /* PROVerr already called */
153 static int aes_block_final(void *vctx, unsigned char *out, size_t *outl,
156 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
160 padblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE);
161 } else if (ctx->bufsz == 0) {
164 } else if (ctx->bufsz != AES_BLOCK_SIZE) {
165 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
169 if (outsize < AES_BLOCK_SIZE) {
170 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
173 if (!ctx->ciph->cipher(ctx, out, ctx->buf, AES_BLOCK_SIZE)) {
174 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_CIPHER_OPERATION_FAILED);
178 *outl = AES_BLOCK_SIZE;
183 if (ctx->bufsz != AES_BLOCK_SIZE) {
184 if (ctx->bufsz == 0 && !ctx->pad) {
188 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
192 if (!ctx->ciph->cipher(ctx, ctx->buf, ctx->buf, AES_BLOCK_SIZE)) {
193 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_CIPHER_OPERATION_FAILED);
197 if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE)) {
198 /* PROVerr already called */
202 if (outsize < ctx->bufsz) {
203 PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
206 memcpy(out, ctx->buf, ctx->bufsz);
212 static int aes_stream_update(void *vctx, unsigned char *out, size_t *outl,
213 size_t outsize, const unsigned char *in,
216 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
219 PROVerr(PROV_F_AES_STREAM_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
223 if (!ctx->ciph->cipher(ctx, out, in, inl)) {
224 PROVerr(PROV_F_AES_STREAM_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
231 static int aes_stream_final(void *vctx, unsigned char *out, size_t *outl,
238 static int aes_cipher(void *vctx,
239 unsigned char *out, size_t *outl, size_t outsize,
240 const unsigned char *in, size_t inl)
242 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
245 PROVerr(PROV_F_AES_CIPHER, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
249 if (!ctx->ciph->cipher(ctx, out, in, inl)) {
250 PROVerr(PROV_F_AES_CIPHER, PROV_R_CIPHER_OPERATION_FAILED);
258 #define IMPLEMENT_new_params(lcmode, UCMODE) \
259 static OSSL_OP_cipher_get_params_fn aes_##lcmode##_get_params; \
260 static int aes_##lcmode##_get_params(OSSL_PARAM params[]) \
264 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE); \
265 if (p != NULL && !OSSL_PARAM_set_int(p, EVP_CIPH_##UCMODE##_MODE)) \
271 #define IMPLEMENT_new_ctx(lcmode, UCMODE, len) \
272 static OSSL_OP_cipher_newctx_fn aes_##len##_##lcmode##_newctx; \
273 static void *aes_##len##_##lcmode##_newctx(void *provctx) \
275 PROV_AES_KEY *ctx = OPENSSL_zalloc(sizeof(*ctx)); \
278 ctx->keylen = (len / 8); \
279 ctx->ciph = PROV_AES_CIPHER_##lcmode(ctx->keylen); \
280 ctx->mode = EVP_CIPH_##UCMODE##_MODE; \
285 IMPLEMENT_new_params(ecb, ECB)
286 IMPLEMENT_new_ctx(ecb, ECB, 256)
287 IMPLEMENT_new_ctx(ecb, ECB, 192)
288 IMPLEMENT_new_ctx(ecb, ECB, 128)
291 IMPLEMENT_new_params(cbc, CBC)
292 IMPLEMENT_new_ctx(cbc, CBC, 256)
293 IMPLEMENT_new_ctx(cbc, CBC, 192)
294 IMPLEMENT_new_ctx(cbc, CBC, 128)
297 IMPLEMENT_new_params(ofb, OFB)
298 IMPLEMENT_new_ctx(ofb, OFB, 256)
299 IMPLEMENT_new_ctx(ofb, OFB, 192)
300 IMPLEMENT_new_ctx(ofb, OFB, 128)
303 IMPLEMENT_new_params(cfb, CFB)
304 IMPLEMENT_new_params(cfb1, CFB)
305 IMPLEMENT_new_params(cfb8, CFB)
306 IMPLEMENT_new_ctx(cfb, CFB, 256)
307 IMPLEMENT_new_ctx(cfb, CFB, 192)
308 IMPLEMENT_new_ctx(cfb, CFB, 128)
309 IMPLEMENT_new_ctx(cfb1, CFB, 256)
310 IMPLEMENT_new_ctx(cfb1, CFB, 192)
311 IMPLEMENT_new_ctx(cfb1, CFB, 128)
312 IMPLEMENT_new_ctx(cfb8, CFB, 256)
313 IMPLEMENT_new_ctx(cfb8, CFB, 192)
314 IMPLEMENT_new_ctx(cfb8, CFB, 128)
317 IMPLEMENT_new_params(ctr, CTR)
318 IMPLEMENT_new_ctx(ctr, CTR, 256)
319 IMPLEMENT_new_ctx(ctr, CTR, 192)
320 IMPLEMENT_new_ctx(ctr, CTR, 128)
322 static void aes_freectx(void *vctx)
324 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
326 OPENSSL_clear_free(ctx, sizeof(*ctx));
329 static void *aes_dupctx(void *ctx)
331 PROV_AES_KEY *in = (PROV_AES_KEY *)ctx;
332 PROV_AES_KEY *ret = OPENSSL_malloc(sizeof(*ret));
335 PROVerr(PROV_F_AES_DUPCTX, ERR_R_MALLOC_FAILURE);
343 static size_t key_length_256(void)
348 static size_t key_length_192(void)
353 static size_t key_length_128(void)
358 static size_t iv_length_16(void)
363 static size_t iv_length_0(void)
368 static size_t block_size_16(void)
373 static size_t block_size_1(void)
378 static int aes_ctx_get_params(void *vctx, OSSL_PARAM params[])
380 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
383 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
384 if (p != NULL && !OSSL_PARAM_set_int(p, ctx->pad)) {
385 PROVerr(PROV_F_AES_CTX_GET_PARAMS, PROV_R_FAILED_TO_SET_PARAMETER);
392 static int aes_ctx_set_params(void *vctx, const OSSL_PARAM params[])
394 PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
397 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
401 if (!OSSL_PARAM_get_int(p, &pad)) {
402 PROVerr(PROV_F_AES_CTX_SET_PARAMS, PROV_R_FAILED_TO_GET_PARAMETER);
405 ctx->pad = pad ? 1 : 0;
410 #define IMPLEMENT_block_funcs(mode, keylen, ivlen) \
411 const OSSL_DISPATCH aes##keylen##mode##_functions[] = { \
412 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))aes_##keylen##_##mode##_newctx }, \
413 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_einit }, \
414 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_dinit }, \
415 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_block_update }, \
416 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_block_final }, \
417 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_cipher }, \
418 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_freectx }, \
419 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_dupctx }, \
420 { OSSL_FUNC_CIPHER_KEY_LENGTH, (void (*)(void))key_length_##keylen }, \
421 { OSSL_FUNC_CIPHER_IV_LENGTH, (void (*)(void))iv_length_##ivlen }, \
422 { OSSL_FUNC_CIPHER_BLOCK_SIZE, (void (*)(void))block_size_16 }, \
423 { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void))aes_##mode##_get_params }, \
424 { OSSL_FUNC_CIPHER_CTX_GET_PARAMS, (void (*)(void))aes_ctx_get_params }, \
425 { OSSL_FUNC_CIPHER_CTX_SET_PARAMS, (void (*)(void))aes_ctx_set_params }, \
429 #define IMPLEMENT_stream_funcs(mode, keylen, ivlen) \
430 const OSSL_DISPATCH aes##keylen##mode##_functions[] = { \
431 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))aes_##keylen##_##mode##_newctx }, \
432 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))aes_einit }, \
433 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))aes_dinit }, \
434 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))aes_stream_update }, \
435 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))aes_stream_final }, \
436 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))aes_cipher }, \
437 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))aes_freectx }, \
438 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))aes_dupctx }, \
439 { OSSL_FUNC_CIPHER_KEY_LENGTH, (void (*)(void))key_length_##keylen }, \
440 { OSSL_FUNC_CIPHER_IV_LENGTH, (void (*)(void))iv_length_##ivlen }, \
441 { OSSL_FUNC_CIPHER_BLOCK_SIZE, (void (*)(void))block_size_1 }, \
442 { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void))aes_##mode##_get_params }, \
443 { OSSL_FUNC_CIPHER_CTX_GET_PARAMS, (void (*)(void))aes_ctx_get_params }, \
444 { OSSL_FUNC_CIPHER_CTX_SET_PARAMS, (void (*)(void))aes_ctx_set_params }, \
449 IMPLEMENT_block_funcs(ecb, 256, 0)
450 IMPLEMENT_block_funcs(ecb, 192, 0)
451 IMPLEMENT_block_funcs(ecb, 128, 0)
454 IMPLEMENT_block_funcs(cbc, 256, 16)
455 IMPLEMENT_block_funcs(cbc, 192, 16)
456 IMPLEMENT_block_funcs(cbc, 128, 16)
459 IMPLEMENT_stream_funcs(ofb, 256, 16)
460 IMPLEMENT_stream_funcs(ofb, 192, 16)
461 IMPLEMENT_stream_funcs(ofb, 128, 16)
464 IMPLEMENT_stream_funcs(cfb, 256, 16)
465 IMPLEMENT_stream_funcs(cfb, 192, 16)
466 IMPLEMENT_stream_funcs(cfb, 128, 16)
467 IMPLEMENT_stream_funcs(cfb1, 256, 16)
468 IMPLEMENT_stream_funcs(cfb1, 192, 16)
469 IMPLEMENT_stream_funcs(cfb1, 128, 16)
470 IMPLEMENT_stream_funcs(cfb8, 256, 16)
471 IMPLEMENT_stream_funcs(cfb8, 192, 16)
472 IMPLEMENT_stream_funcs(cfb8, 128, 16)
475 IMPLEMENT_stream_funcs(ctr, 256, 16)
476 IMPLEMENT_stream_funcs(ctr, 192, 16)
477 IMPLEMENT_stream_funcs(ctr, 128, 16)