providers/common/ciphers/aes.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 #include <string.h>
  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"
  20
  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;
  39
  40 static int PROV_AES_KEY_generic_init(PROV_AES_KEY *ctx,
  41                                       const unsigned char *iv,
  42                                       size_t ivlen,
  43                                       int enc)
  44 {
  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);
  48             return 0;
  49         }
  50         memcpy(ctx->iv, iv, AES_BLOCK_SIZE);
  51     }
  52     ctx->enc = enc;
  53
  54     return 1;
  55 }
  56
  57 static int aes_einit(void *vctx, const unsigned char *key, size_t keylen,
  58                            const unsigned char *iv, size_t ivlen)
  59 {
  60     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
  61
  62     if (!PROV_AES_KEY_generic_init(ctx, iv, ivlen, 1)) {
  63         /* PROVerr already called */
  64         return 0;
  65     }
  66     if (key != NULL) {
  67         if (keylen != ctx->keylen) {
  68             PROVerr(PROV_F_AES_EINIT, PROV_R_INVALID_KEYLEN);
  69             return 0;
  70         }
  71         return ctx->ciph->init(ctx, key, ctx->keylen);
  72     }
  73
  74     return 1;
  75 }
  76
  77 static int aes_dinit(void *vctx, const unsigned char *key, size_t keylen,
  78                      const unsigned char *iv, size_t ivlen)
  79 {
  80     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
  81
  82     if (!PROV_AES_KEY_generic_init(ctx, iv, ivlen, 0)) {
  83         /* PROVerr already called */
  84         return 0;
  85     }
  86     if (key != NULL) {
  87         if (keylen != ctx->keylen) {
  88             PROVerr(PROV_F_AES_DINIT, PROV_R_INVALID_KEYLEN);
  89             return 0;
  90         }
  91         return ctx->ciph->init(ctx, key, ctx->keylen);
  92     }
  93
  94     return 1;
  95 }
  96
  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)
  99 {
 100     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 101     size_t nextblocks = fillblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE, &in,
 102                                   &inl);
 103     size_t outlint = 0;
 104
 105     /*
 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
 108      * block is padded.
 109      */
 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);
 114             return 0;
 115         }
 116         if (!ctx->ciph->cipher(ctx, out, ctx->buf, AES_BLOCK_SIZE)) {
 117             PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
 118             return 0;
 119         }
 120         ctx->bufsz = 0;
 121         outlint = AES_BLOCK_SIZE;
 122         out += AES_BLOCK_SIZE;
 123     }
 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);
 128                 return 0;
 129             }
 130             nextblocks -= AES_BLOCK_SIZE;
 131         }
 132         outlint += nextblocks;
 133         if (outsize < outlint) {
 134             PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 135             return 0;
 136         }
 137         if (!ctx->ciph->cipher(ctx, out, in, nextblocks)) {
 138             PROVerr(PROV_F_AES_BLOCK_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
 139             return 0;
 140         }
 141         in += nextblocks;
 142         inl -= nextblocks;
 143     }
 144     if (!trailingdata(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE, &in, &inl)) {
 145         /* PROVerr already called */
 146         return 0;
 147     }
 148
 149     *outl = outlint;
 150     return inl == 0;
 151 }
 152
 153 static int aes_block_final(void *vctx, unsigned char *out, size_t *outl,
 154                            size_t outsize)
 155 {
 156     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 157
 158     if (ctx->enc) {
 159         if (ctx->pad) {
 160             padblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE);
 161         } else if (ctx->bufsz == 0) {
 162             *outl = 0;
 163             return 1;
 164         } else if (ctx->bufsz != AES_BLOCK_SIZE) {
 165             PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
 166             return 0;
 167         }
 168
 169         if (outsize < AES_BLOCK_SIZE) {
 170             PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 171             return 0;
 172         }
 173         if (!ctx->ciph->cipher(ctx, out, ctx->buf, AES_BLOCK_SIZE)) {
 174             PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_CIPHER_OPERATION_FAILED);
 175             return 0;
 176         }
 177         ctx->bufsz = 0;
 178         *outl = AES_BLOCK_SIZE;
 179         return 1;
 180     }
 181
 182     /* Decrypting */
 183     if (ctx->bufsz != AES_BLOCK_SIZE) {
 184         if (ctx->bufsz == 0 && !ctx->pad) {
 185             *outl = 0;
 186             return 1;
 187         }
 188         PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
 189         return 0;
 190     }
 191
 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);
 194         return 0;
 195     }
 196
 197     if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, AES_BLOCK_SIZE)) {
 198         /* PROVerr already called */
 199         return 0;
 200     }
 201
 202     if (outsize < ctx->bufsz) {
 203         PROVerr(PROV_F_AES_BLOCK_FINAL, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 204         return 0;
 205     }
 206     memcpy(out, ctx->buf, ctx->bufsz);
 207     *outl = ctx->bufsz;
 208     ctx->bufsz = 0;
 209     return 1;
 210 }
 211
 212 static int aes_stream_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_KEY *ctx = (PROV_AES_KEY *)vctx;
 217
 218     if (outsize < inl) {
 219         PROVerr(PROV_F_AES_STREAM_UPDATE, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 220         return 0;
 221     }
 222
 223     if (!ctx->ciph->cipher(ctx, out, in, inl)) {
 224         PROVerr(PROV_F_AES_STREAM_UPDATE, PROV_R_CIPHER_OPERATION_FAILED);
 225         return 0;
 226     }
 227
 228     *outl = inl;
 229     return 1;
 230 }
 231 static int aes_stream_final(void *vctx, unsigned char *out, size_t *outl,
 232                             size_t outsize)
 233 {
 234     *outl = 0;
 235     return 1;
 236 }
 237
 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)
 241 {
 242     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 243
 244     if (outsize < inl) {
 245         PROVerr(PROV_F_AES_CIPHER, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 246         return 0;
 247     }
 248
 249     if (!ctx->ciph->cipher(ctx, out, in, inl)) {
 250         PROVerr(PROV_F_AES_CIPHER, PROV_R_CIPHER_OPERATION_FAILED);
 251         return 0;
 252     }
 253
 254     *outl = inl;
 255     return 1;
 256 }
 257
 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(const OSSL_PARAM params[]) \
 261     { \
 262         const OSSL_PARAM *p; \
 263     \
 264         p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE); \
 265         if (p != NULL && !OSSL_PARAM_set_int(p, EVP_CIPH_##UCMODE##_MODE)) \
 266             return 0; \
 267     \
 268         return 1; \
 269     }
 270
 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) \
 274     { \
 275         PROV_AES_KEY *ctx = OPENSSL_zalloc(sizeof(*ctx)); \
 276     \
 277         ctx->pad = 1; \
 278         ctx->keylen = (len / 8); \
 279         ctx->ciph = PROV_AES_CIPHER_##lcmode(ctx->keylen); \
 280         ctx->mode = EVP_CIPH_##UCMODE##_MODE; \
 281         return ctx; \
 282     }
 283
 284 /* ECB */
 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)
 289
 290 /* CBC */
 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)
 295
 296 /* OFB */
 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)
 301
 302 /* CFB */
 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)
 315
 316 /* CTR */
 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)
 321
 322 static void aes_freectx(void *vctx)
 323 {
 324     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 325
 326     OPENSSL_clear_free(ctx,  sizeof(*ctx));
 327 }
 328
 329 static void *aes_dupctx(void *ctx)
 330 {
 331     PROV_AES_KEY *in = (PROV_AES_KEY *)ctx;
 332     PROV_AES_KEY *ret = OPENSSL_malloc(sizeof(*ret));
 333
 334     if (ret == NULL) {
 335         PROVerr(PROV_F_AES_DUPCTX, ERR_R_MALLOC_FAILURE);
 336         return NULL;
 337     }
 338     *ret = *in;
 339
 340     return ret;
 341 }
 342
 343 static size_t key_length_256(void)
 344 {
 345     return 256 / 8;
 346 }
 347
 348 static size_t key_length_192(void)
 349 {
 350     return 192 / 8;
 351 }
 352
 353 static size_t key_length_128(void)
 354 {
 355     return 128 / 8;
 356 }
 357
 358 static size_t iv_length_16(void)
 359 {
 360     return 16;
 361 }
 362
 363 static size_t iv_length_0(void)
 364 {
 365     return 0;
 366 }
 367
 368 static size_t block_size_16(void)
 369 {
 370     return 16;
 371 }
 372
 373 static size_t block_size_1(void)
 374 {
 375     return 1;
 376 }
 377
 378 static int aes_ctx_get_params(void *vctx, const OSSL_PARAM params[])
 379 {
 380     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 381     const OSSL_PARAM *p;
 382
 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);
 386         return 0;
 387     }
 388
 389     return 1;
 390 }
 391
 392 static int aes_ctx_set_params(void *vctx, const OSSL_PARAM params[])
 393 {
 394     PROV_AES_KEY *ctx = (PROV_AES_KEY *)vctx;
 395     const OSSL_PARAM *p;
 396
 397     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
 398     if (p != NULL) {
 399         int pad;
 400
 401         if (!OSSL_PARAM_get_int(p, &pad)) {
 402         PROVerr(PROV_F_AES_CTX_SET_PARAMS, PROV_R_FAILED_TO_GET_PARAMETER);
 403             return 0;
 404         }
 405         ctx->pad = pad ? 1 : 0;
 406     }
 407     return 1;
 408 }
 409
 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 }, \
 426         { 0, NULL } \
 427     };
 428
 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 }, \
 445         { 0, NULL } \
 446     };
 447
 448 /* ECB */
 449 IMPLEMENT_block_funcs(ecb, 256, 0)
 450 IMPLEMENT_block_funcs(ecb, 192, 0)
 451 IMPLEMENT_block_funcs(ecb, 128, 0)
 452
 453 /* CBC */
 454 IMPLEMENT_block_funcs(cbc, 256, 16)
 455 IMPLEMENT_block_funcs(cbc, 192, 16)
 456 IMPLEMENT_block_funcs(cbc, 128, 16)
 457
 458 /* OFB */
 459 IMPLEMENT_stream_funcs(ofb, 256, 16)
 460 IMPLEMENT_stream_funcs(ofb, 192, 16)
 461 IMPLEMENT_stream_funcs(ofb, 128, 16)
 462
 463 /* CFB */
 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)
 473
 474 /* CTR */
 475 IMPLEMENT_stream_funcs(ctr, 256, 16)
 476 IMPLEMENT_stream_funcs(ctr, 192, 16)
 477 IMPLEMENT_stream_funcs(ctr, 128, 16)