providers/common/ciphers/cipher_common.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  * Generic dispatch table functions for ciphers.
  12  */
  13
  14 #include "cipher_locl.h"
  15 #include "internal/provider_ctx.h"
  16 #include "internal/providercommonerr.h"
  17
  18 /*-
  19  * Generic cipher functions for OSSL_PARAM gettables and settables
  20  */
  21 static const OSSL_PARAM cipher_known_gettable_params[] = {
  22     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_MODE, NULL),
  23     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  24     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
  25     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE, NULL),
  26     OSSL_PARAM_ulong(OSSL_CIPHER_PARAM_FLAGS, NULL),
  27     OSSL_PARAM_END
  28 };
  29 const OSSL_PARAM *cipher_generic_gettable_params(void)
  30 {
  31     return cipher_known_gettable_params;
  32 }
  33
  34 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
  35                               unsigned long flags,
  36                               size_t kbits, size_t blkbits, size_t ivbits)
  37 {
  38     OSSL_PARAM *p;
  39
  40     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE);
  41     if (p != NULL && !OSSL_PARAM_set_uint(p, md)) {
  42         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  43         return 0;
  44     }
  45     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_FLAGS);
  46     if (p != NULL && !OSSL_PARAM_set_ulong(p, flags)) {
  47         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  48         return 0;
  49     }
  50     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
  51     if (p != NULL && !OSSL_PARAM_set_size_t(p, kbits / 8)) {
  52         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  53         return 0;
  54     }
  55     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_BLOCK_SIZE);
  56     if (p != NULL && !OSSL_PARAM_set_size_t(p, blkbits / 8)) {
  57         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  58         return 0;
  59     }
  60     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
  61     if (p != NULL && !OSSL_PARAM_set_size_t(p, ivbits / 8)) {
  62         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  63         return 0;
  64     }
  65     return 1;
  66 }
  67
  68 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(cipher_generic)
  69 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(cipher_generic)
  70
  71 static const OSSL_PARAM cipher_known_settable_ctx_params[] = {
  72     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  73     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL),
  74     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),
  75     OSSL_PARAM_END
  76 };
  77 const OSSL_PARAM *cipher_generic_settable_ctx_params(void)
  78 {
  79     return cipher_known_settable_ctx_params;
  80 }
  81
  82 /*-
  83  * AEAD cipher functions for OSSL_PARAM gettables and settables
  84  */
  85 static const OSSL_PARAM cipher_aead_known_gettable_ctx_params[] = {
  86     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  87     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
  88     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
  89     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
  90     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
  91     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
  92     OSSL_PARAM_END
  93 };
  94 const OSSL_PARAM *cipher_aead_gettable_ctx_params(void)
  95 {
  96     return cipher_aead_known_gettable_ctx_params;
  97 }
  98
  99 static const OSSL_PARAM cipher_aead_known_settable_ctx_params[] = {
 100     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 101     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
 102     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
 103     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
 104     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
 105     OSSL_PARAM_END
 106 };
 107 const OSSL_PARAM *cipher_aead_settable_ctx_params(void)
 108 {
 109     return cipher_aead_known_settable_ctx_params;
 110 }
 111
 112 static int cipher_generic_init_internal(PROV_CIPHER_CTX *ctx,
 113                                         const unsigned char *key, size_t keylen,
 114                                         const unsigned char *iv, size_t ivlen,
 115                                         int enc)
 116 {
 117     ctx->enc = enc ? 1 : 0;
 118
 119     if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
 120         if (ivlen != ctx->ivlen) {
 121             ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
 122             return 0;
 123         }
 124         memcpy(ctx->iv, iv, ctx->ivlen);
 125     }
 126     if (key != NULL) {
 127         if (keylen != ctx->keylen) {
 128             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
 129             return 0;
 130         }
 131         return ctx->hw->init(ctx, key, ctx->keylen);
 132     }
 133     return 1;
 134 }
 135
 136 int cipher_generic_einit(void *vctx, const unsigned char *key, size_t keylen,
 137                          const unsigned char *iv, size_t ivlen)
 138 {
 139     return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
 140                                         iv, ivlen, 1);
 141 }
 142
 143 int cipher_generic_dinit(void *vctx, const unsigned char *key, size_t keylen,
 144                          const unsigned char *iv, size_t ivlen)
 145 {
 146     return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
 147                                         iv, ivlen, 0);
 148 }
 149
 150 int cipher_generic_block_update(void *vctx, unsigned char *out, size_t *outl,
 151                                 size_t outsize, const unsigned char *in,
 152                                 size_t inl)
 153 {
 154     size_t outlint = 0;
 155     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 156     size_t blksz = ctx->blocksize;
 157     size_t nextblocks = fillblock(ctx->buf, &ctx->bufsz, blksz, &in, &inl);
 158
 159     /*
 160      * If we're decrypting and we end an update on a block boundary we hold
 161      * the last block back in case this is the last update call and the last
 162      * block is padded.
 163      */
 164     if (ctx->bufsz == blksz && (ctx->enc || inl > 0 || !ctx->pad)) {
 165         if (outsize < blksz) {
 166             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 167             return 0;
 168         }
 169         if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
 170             ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 171             return 0;
 172         }
 173         ctx->bufsz = 0;
 174         outlint = blksz;
 175         out += blksz;
 176     }
 177     if (nextblocks > 0) {
 178         if (!ctx->enc && ctx->pad && nextblocks == inl) {
 179             if (!ossl_assert(inl >= blksz)) {
 180                 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 181                 return 0;
 182             }
 183             nextblocks -= blksz;
 184         }
 185         outlint += nextblocks;
 186         if (outsize < outlint) {
 187             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 188             return 0;
 189         }
 190         if (!ctx->hw->cipher(ctx, out, in, nextblocks)) {
 191             ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 192             return 0;
 193         }
 194         in += nextblocks;
 195         inl -= nextblocks;
 196     }
 197     if (!trailingdata(ctx->buf, &ctx->bufsz, blksz, &in, &inl)) {
 198         /* ERR_raise already called */
 199         return 0;
 200     }
 201
 202     *outl = outlint;
 203     return inl == 0;
 204 }
 205
 206 int cipher_generic_block_final(void *vctx, unsigned char *out, size_t *outl,
 207                                size_t outsize)
 208 {
 209     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 210     size_t blksz = ctx->blocksize;
 211
 212     if (ctx->enc) {
 213         if (ctx->pad) {
 214             padblock(ctx->buf, &ctx->bufsz, blksz);
 215         } else if (ctx->bufsz == 0) {
 216             *outl = 0;
 217             return 1;
 218         } else if (ctx->bufsz != blksz) {
 219             ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
 220             return 0;
 221         }
 222
 223         if (outsize < blksz) {
 224             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 225             return 0;
 226         }
 227         if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
 228             ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 229             return 0;
 230         }
 231         ctx->bufsz = 0;
 232         *outl = blksz;
 233         return 1;
 234     }
 235
 236     /* Decrypting */
 237     if (ctx->bufsz != blksz) {
 238         if (ctx->bufsz == 0 && !ctx->pad) {
 239             *outl = 0;
 240             return 1;
 241         }
 242         ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
 243         return 0;
 244     }
 245
 246     if (!ctx->hw->cipher(ctx, ctx->buf, ctx->buf, blksz)) {
 247         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 248         return 0;
 249     }
 250
 251     if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, blksz)) {
 252         /* ERR_raise already called */
 253         return 0;
 254     }
 255
 256     if (outsize < ctx->bufsz) {
 257         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 258         return 0;
 259     }
 260     memcpy(out, ctx->buf, ctx->bufsz);
 261     *outl = ctx->bufsz;
 262     ctx->bufsz = 0;
 263     return 1;
 264 }
 265
 266 int cipher_generic_stream_update(void *vctx, unsigned char *out, size_t *outl,
 267                                  size_t outsize, const unsigned char *in,
 268                                  size_t inl)
 269 {
 270     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 271
 272     if (outsize < inl) {
 273         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 274         return 0;
 275     }
 276
 277     if (!ctx->hw->cipher(ctx, out, in, inl)) {
 278         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 279         return 0;
 280     }
 281
 282     *outl = inl;
 283     return 1;
 284 }
 285 int cipher_generic_stream_final(void *vctx, unsigned char *out, size_t *outl,
 286                                 size_t outsize)
 287 {
 288     *outl = 0;
 289     return 1;
 290 }
 291
 292 int cipher_generic_cipher(void *vctx,
 293                           unsigned char *out, size_t *outl, size_t outsize,
 294                           const unsigned char *in, size_t inl)
 295 {
 296     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 297
 298     if (outsize < inl) {
 299         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 300         return 0;
 301     }
 302
 303     if (!ctx->hw->cipher(ctx, out, in, inl)) {
 304         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 305         return 0;
 306     }
 307
 308     *outl = inl;
 309     return 1;
 310 }
 311
 312 int cipher_generic_get_ctx_params(void *vctx, OSSL_PARAM params[])
 313 {
 314     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 315     OSSL_PARAM *p;
 316
 317     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
 318     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
 319         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 320         return 0;
 321     }
 322     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
 323     if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->pad)) {
 324         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 325         return 0;
 326     }
 327     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
 328     if (p != NULL
 329         && !OSSL_PARAM_set_octet_ptr(p, &ctx->iv, ctx->ivlen)
 330         && !OSSL_PARAM_set_octet_string(p, &ctx->iv, ctx->ivlen)) {
 331         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 332         return 0;
 333     }
 334     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_NUM);
 335     if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->num)) {
 336         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 337         return 0;
 338     }
 339     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
 340     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
 341         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 342         return 0;
 343     }
 344
 345     return 1;
 346 }
 347
 348 int cipher_generic_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 349 {
 350     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 351     const OSSL_PARAM *p;
 352
 353     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
 354     if (p != NULL) {
 355         unsigned int pad;
 356
 357         if (!OSSL_PARAM_get_uint(p, &pad)) {
 358             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 359             return 0;
 360         }
 361         ctx->pad = pad ? 1 : 0;
 362     }
 363     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_NUM);
 364     if (p != NULL) {
 365         unsigned int num;
 366
 367         if (!OSSL_PARAM_get_uint(p, &num)) {
 368             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 369             return 0;
 370         }
 371         ctx->num = num;
 372     }
 373     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
 374     if (p != NULL) {
 375         size_t keylen;
 376
 377         if (!OSSL_PARAM_get_size_t(p, &keylen)) {
 378             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 379             return 0;
 380         }
 381         ctx->keylen = keylen;
 382     }
 383     return 1;
 384 }
 385
 386 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
 387                             size_t ivbits, unsigned int mode,
 388                             const PROV_CIPHER_HW *hw, void *provctx)
 389 {
 390     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 391
 392     ctx->pad = 1;
 393     ctx->keylen = ((kbits) / 8);
 394     ctx->ivlen = ((ivbits) / 8);
 395     ctx->hw = hw;
 396     ctx->mode = mode;
 397     ctx->blocksize = blkbits / 8;
 398     if (provctx != NULL)
 399         ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx); /* used for rand */
 400 }