providers/implementations/ciphers/ciphercommon_gcm.c

   1 /*
   2  * Copyright 2019-2020 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 /* Dispatch functions for gcm mode */
  11
  12 #include "prov/ciphercommon.h"
  13 #include "prov/ciphercommon_gcm.h"
  14 #include "prov/providercommonerr.h"
  15 #include <openssl/rand.h>
  16 #include "prov/provider_ctx.h"
  17
  18 static int gcm_tls_init(PROV_GCM_CTX *dat, unsigned char *aad, size_t aad_len);
  19 static int gcm_tls_iv_set_fixed(PROV_GCM_CTX *ctx, unsigned char *iv,
  20                                 size_t len);
  21 static int gcm_tls_cipher(PROV_GCM_CTX *ctx, unsigned char *out, size_t *padlen,
  22                           const unsigned char *in, size_t len);
  23 static int gcm_cipher_internal(PROV_GCM_CTX *ctx, unsigned char *out,
  24                                size_t *padlen, const unsigned char *in,
  25                                size_t len);
  26
  27 void gcm_initctx(void *provctx, PROV_GCM_CTX *ctx, size_t keybits,
  28                  const PROV_GCM_HW *hw, size_t ivlen_min)
  29 {
  30     ctx->pad = 1;
  31     ctx->mode = EVP_CIPH_GCM_MODE;
  32     ctx->taglen = UNINITIALISED_SIZET;
  33     ctx->tls_aad_len = UNINITIALISED_SIZET;
  34     ctx->ivlen_min = ivlen_min;
  35     ctx->ivlen = (EVP_GCM_TLS_FIXED_IV_LEN + EVP_GCM_TLS_EXPLICIT_IV_LEN);
  36     ctx->keylen = keybits / 8;
  37     ctx->hw = hw;
  38     ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
  39 }
  40
  41 static int gcm_init(void *vctx, const unsigned char *key, size_t keylen,
  42                     const unsigned char *iv, size_t ivlen, int enc)
  43 {
  44     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
  45
  46     ctx->enc = enc;
  47
  48     if (iv != NULL) {
  49         if (ivlen < ctx->ivlen_min || ivlen > sizeof(ctx->iv)) {
  50             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
  51             return 0;
  52         }
  53         ctx->ivlen = ivlen;
  54         memcpy(ctx->iv, iv, ivlen);
  55         ctx->iv_state = IV_STATE_BUFFERED;
  56     }
  57
  58     if (key != NULL) {
  59         if (keylen != ctx->keylen) {
  60             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
  61             return 0;
  62         }
  63         return ctx->hw->setkey(ctx, key, ctx->keylen);
  64     }
  65     return 1;
  66 }
  67
  68 int gcm_einit(void *vctx, const unsigned char *key, size_t keylen,
  69               const unsigned char *iv, size_t ivlen)
  70 {
  71     return gcm_init(vctx, key, keylen, iv, ivlen, 1);
  72 }
  73
  74 int gcm_dinit(void *vctx, const unsigned char *key, size_t keylen,
  75               const unsigned char *iv, size_t ivlen)
  76 {
  77     return gcm_init(vctx, key, keylen, iv, ivlen, 0);
  78 }
  79
  80 /* increment counter (64-bit int) by 1 */
  81 static void ctr64_inc(unsigned char *counter)
  82 {
  83     int n = 8;
  84     unsigned char c;
  85
  86     do {
  87         --n;
  88         c = counter[n];
  89         ++c;
  90         counter[n] = c;
  91         if (c > 0)
  92             return;
  93     } while (n > 0);
  94 }
  95
  96 static int getivgen(PROV_GCM_CTX *ctx, unsigned char *out, size_t olen)
  97 {
  98     if (!ctx->iv_gen
  99         || !ctx->key_set
 100         || !ctx->hw->setiv(ctx, ctx->iv, ctx->ivlen))
 101         return 0;
 102     if (olen == 0 || olen > ctx->ivlen)
 103         olen = ctx->ivlen;
 104     memcpy(out, ctx->iv + ctx->ivlen - olen, olen);
 105     /*
 106      * Invocation field will be at least 8 bytes in size and so no need
 107      * to check wrap around or increment more than last 8 bytes.
 108      */
 109     ctr64_inc(ctx->iv + ctx->ivlen - 8);
 110     ctx->iv_state = IV_STATE_COPIED;
 111     return 1;
 112 }
 113
 114 static int setivinv(PROV_GCM_CTX *ctx, unsigned char *in, size_t inl)
 115 {
 116     if (!ctx->iv_gen
 117         || !ctx->key_set
 118         || ctx->enc)
 119         return 0;
 120
 121     memcpy(ctx->iv + ctx->ivlen - inl, in, inl);
 122     if (!ctx->hw->setiv(ctx, ctx->iv, ctx->ivlen))
 123         return 0;
 124     ctx->iv_state = IV_STATE_COPIED;
 125     return 1;
 126 }
 127
 128 int gcm_get_ctx_params(void *vctx, OSSL_PARAM params[])
 129 {
 130     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
 131     OSSL_PARAM *p;
 132     size_t sz;
 133
 134     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
 135     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
 136         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 137         return 0;
 138     }
 139     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
 140     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
 141         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 142         return 0;
 143     }
 144     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
 145     if (p != NULL) {
 146         size_t taglen = (ctx->taglen != UNINITIALISED_SIZET) ? ctx->taglen :
 147                          GCM_TAG_MAX_SIZE;
 148
 149         if (!OSSL_PARAM_set_size_t(p, taglen)) {
 150             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 151             return 0;
 152         }
 153     }
 154
 155     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
 156     if (p != NULL) {
 157         if (ctx->iv_gen != 1 && ctx->iv_gen_rand != 1)
 158             return 0;
 159         if (ctx->ivlen != p->data_size) {
 160             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
 161             return 0;
 162         }
 163         if (!OSSL_PARAM_set_octet_string(p, ctx->iv, ctx->ivlen)) {
 164             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 165             return 0;
 166         }
 167     }
 168
 169     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD);
 170     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) {
 171         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 172         return 0;
 173     }
 174     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 175     if (p != NULL) {
 176         sz = p->data_size;
 177         if (sz == 0
 178             || sz > EVP_GCM_TLS_TAG_LEN
 179             || !ctx->enc
 180             || ctx->taglen == UNINITIALISED_SIZET) {
 181             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG);
 182             return 0;
 183         }
 184         if (!OSSL_PARAM_set_octet_string(p, ctx->buf, sz)) {
 185             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 186             return 0;
 187         }
 188     }
 189     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN);
 190     if (p != NULL) {
 191         if (p->data == NULL
 192             || p->data_type != OSSL_PARAM_OCTET_STRING
 193             || !getivgen(ctx, p->data, p->data_size))
 194             return 0;
 195     }
 196     return 1;
 197 }
 198
 199 int gcm_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 200 {
 201     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
 202     const OSSL_PARAM *p;
 203     size_t sz;
 204     void *vp;
 205
 206     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 207     if (p != NULL) {
 208         vp = ctx->buf;
 209         if (!OSSL_PARAM_get_octet_string(p, &vp, EVP_GCM_TLS_TAG_LEN, &sz)) {
 210             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 211             return 0;
 212         }
 213         if (sz == 0 || ctx->enc) {
 214             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG);
 215             return 0;
 216         }
 217         ctx->taglen = sz;
 218     }
 219
 220     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_IVLEN);
 221     if (p != NULL) {
 222         if (!OSSL_PARAM_get_size_t(p, &sz)) {
 223             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 224             return 0;
 225         }
 226         if (sz == 0 || sz > sizeof(ctx->iv)) {
 227             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
 228             return 0;
 229         }
 230         ctx->ivlen = sz;
 231     }
 232
 233     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
 234     if (p != NULL) {
 235         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 236             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 237             return 0;
 238         }
 239         sz = gcm_tls_init(ctx, p->data, p->data_size);
 240         if (sz == 0) {
 241             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_AAD);
 242             return 0;
 243         }
 244         ctx->tls_aad_pad_sz = sz;
 245     }
 246
 247     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED);
 248     if (p != NULL) {
 249         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 250             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 251             return 0;
 252         }
 253         if (gcm_tls_iv_set_fixed(ctx, p->data, p->data_size) == 0) {
 254             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 255             return 0;
 256         }
 257     }
 258     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV);
 259     if (p != NULL) {
 260         if (p->data == NULL
 261             || p->data_type != OSSL_PARAM_OCTET_STRING
 262             || !setivinv(ctx, p->data, p->data_size))
 263             return 0;
 264     }
 265
 266
 267     return 1;
 268 }
 269
 270 int gcm_stream_update(void *vctx, unsigned char *out, size_t *outl,
 271                       size_t outsize, const unsigned char *in, size_t inl)
 272 {
 273     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
 274
 275     if (inl == 0) {
 276         *outl = 0;
 277         return 1;
 278     }
 279
 280     if (outsize < inl) {
 281         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 282         return -1;
 283     }
 284
 285     if (gcm_cipher_internal(ctx, out, outl, in, inl) <= 0) {
 286         ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
 287         return -1;
 288     }
 289     return 1;
 290 }
 291
 292 int gcm_stream_final(void *vctx, unsigned char *out, size_t *outl,
 293                      size_t outsize)
 294 {
 295     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
 296     int i;
 297
 298     i = gcm_cipher_internal(ctx, out, outl, NULL, 0);
 299     if (i <= 0)
 300         return 0;
 301
 302     *outl = 0;
 303     return 1;
 304 }
 305
 306 int gcm_cipher(void *vctx,
 307                unsigned char *out, size_t *outl, size_t outsize,
 308                const unsigned char *in, size_t inl)
 309 {
 310     PROV_GCM_CTX *ctx = (PROV_GCM_CTX *)vctx;
 311
 312     if (outsize < inl) {
 313         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 314         return 0;
 315     }
 316
 317     if (gcm_cipher_internal(ctx, out, outl, in, inl) <= 0)
 318         return 0;
 319
 320     *outl = inl;
 321     return 1;
 322 }
 323
 324 /*
 325  * See SP800-38D (GCM) Section 8 "Uniqueness requirement on IVS and keys"
 326  *
 327  * See also 8.2.2 RBG-based construction.
 328  * Random construction consists of a free field (which can be NULL) and a
 329  * random field which will use a DRBG that can return at least 96 bits of
 330  * entropy strength. (The DRBG must be seeded by the FIPS module).
 331  */
 332 static int gcm_iv_generate(PROV_GCM_CTX *ctx, int offset)
 333 {
 334     int sz = ctx->ivlen - offset;
 335
 336     /* Must be at least 96 bits */
 337     if (sz <= 0 || ctx->ivlen < GCM_IV_DEFAULT_SIZE)
 338         return 0;
 339
 340     /* Use DRBG to generate random iv */
 341     if (RAND_bytes_ex(ctx->libctx, ctx->iv + offset, sz) <= 0)
 342         return 0;
 343     ctx->iv_state = IV_STATE_BUFFERED;
 344     ctx->iv_gen_rand = 1;
 345     return 1;
 346 }
 347
 348 static int gcm_cipher_internal(PROV_GCM_CTX *ctx, unsigned char *out,
 349                                size_t *padlen, const unsigned char *in,
 350                                size_t len)
 351 {
 352     size_t olen = 0;
 353     int rv = 0;
 354     const PROV_GCM_HW *hw = ctx->hw;
 355
 356     if (ctx->tls_aad_len != UNINITIALISED_SIZET)
 357         return gcm_tls_cipher(ctx, out, padlen, in, len);
 358
 359     if (!ctx->key_set || ctx->iv_state == IV_STATE_FINISHED)
 360         goto err;
 361
 362     /*
 363      * FIPS requires generation of AES-GCM IV's inside the FIPS module.
 364      * The IV can still be set externally (the security policy will state that
 365      * this is not FIPS compliant). There are some applications
 366      * where setting the IV externally is the only option available.
 367      */
 368     if (ctx->iv_state == IV_STATE_UNINITIALISED) {
 369         if (!ctx->enc || !gcm_iv_generate(ctx, 0))
 370             goto err;
 371     }
 372
 373     if (ctx->iv_state == IV_STATE_BUFFERED) {
 374         if (!hw->setiv(ctx, ctx->iv, ctx->ivlen))
 375             goto err;
 376         ctx->iv_state = IV_STATE_COPIED;
 377     }
 378
 379     if (in != NULL) {
 380         /*  The input is AAD if out is NULL */
 381         if (out == NULL) {
 382             if (!hw->aadupdate(ctx, in, len))
 383                 goto err;
 384         } else {
 385             /* The input is ciphertext OR plaintext */
 386             if (!hw->cipherupdate(ctx, in, len, out))
 387                 goto err;
 388         }
 389     } else {
 390         /* The tag must be set before actually decrypting data */
 391         if (!ctx->enc && ctx->taglen == UNINITIALISED_SIZET)
 392             goto err;
 393         if (!hw->cipherfinal(ctx, ctx->buf))
 394             goto err;
 395         ctx->iv_state = IV_STATE_FINISHED; /* Don't reuse the IV */
 396         goto finish;
 397     }
 398     olen = len;
 399 finish:
 400     rv = 1;
 401 err:
 402     *padlen = olen;
 403     return rv;
 404 }
 405
 406 static int gcm_tls_init(PROV_GCM_CTX *dat, unsigned char *aad, size_t aad_len)
 407 {
 408     unsigned char *buf;
 409     size_t len;
 410
 411     if (aad_len != EVP_AEAD_TLS1_AAD_LEN)
 412        return 0;
 413
 414     /* Save the aad for later use. */
 415     buf = dat->buf;
 416     memcpy(buf, aad, aad_len);
 417     dat->tls_aad_len = aad_len;
 418     dat->tls_enc_records = 0;
 419
 420     len = buf[aad_len - 2] << 8 | buf[aad_len - 1];
 421     /* Correct length for explicit iv. */
 422     if (len < EVP_GCM_TLS_EXPLICIT_IV_LEN)
 423         return 0;
 424     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
 425
 426     /* If decrypting correct for tag too. */
 427     if (!dat->enc) {
 428         if (len < EVP_GCM_TLS_TAG_LEN)
 429             return 0;
 430         len -= EVP_GCM_TLS_TAG_LEN;
 431     }
 432     buf[aad_len - 2] = (unsigned char)(len >> 8);
 433     buf[aad_len - 1] = (unsigned char)(len & 0xff);
 434     /* Extra padding: tag appended to record. */
 435     return EVP_GCM_TLS_TAG_LEN;
 436 }
 437
 438 static int gcm_tls_iv_set_fixed(PROV_GCM_CTX *ctx, unsigned char *iv,
 439                                 size_t len)
 440 {
 441     /* Special case: -1 length restores whole IV */
 442     if (len == (size_t)-1) {
 443         memcpy(ctx->iv, iv, ctx->ivlen);
 444         ctx->iv_gen = 1;
 445         ctx->iv_state = IV_STATE_BUFFERED;
 446         return 1;
 447     }
 448     /* Fixed field must be at least 4 bytes and invocation field at least 8 */
 449     if ((len < EVP_GCM_TLS_FIXED_IV_LEN)
 450         || (ctx->ivlen - (int)len) < EVP_GCM_TLS_EXPLICIT_IV_LEN)
 451             return 0;
 452     if (len > 0)
 453         memcpy(ctx->iv, iv, len);
 454     if (ctx->enc
 455         && RAND_bytes_ex(ctx->libctx, ctx->iv + len, ctx->ivlen - len) <= 0)
 456             return 0;
 457     ctx->iv_gen = 1;
 458     ctx->iv_state = IV_STATE_BUFFERED;
 459     return 1;
 460 }
 461
 462 /*
 463  * Handle TLS GCM packet format. This consists of the last portion of the IV
 464  * followed by the payload and finally the tag. On encrypt generate IV,
 465  * encrypt payload and write the tag. On verify retrieve IV, decrypt payload
 466  * and verify tag.
 467  */
 468 static int gcm_tls_cipher(PROV_GCM_CTX *ctx, unsigned char *out, size_t *padlen,
 469                           const unsigned char *in, size_t len)
 470 {
 471     int rv = 0;
 472     size_t arg = EVP_GCM_TLS_EXPLICIT_IV_LEN;
 473     size_t plen = 0;
 474     unsigned char *tag = NULL;
 475
 476     if (!ctx->key_set)
 477         goto err;
 478
 479     /* Encrypt/decrypt must be performed in place */
 480     if (out != in || len < (EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN))
 481         goto err;
 482
 483     /*
 484      * Check for too many keys as per FIPS 140-2 IG A.5 "Key/IV Pair Uniqueness
 485      * Requirements from SP 800-38D".  The requirements is for one party to the
 486      * communication to fail after 2^64 - 1 keys.  We do this on the encrypting
 487      * side only.
 488      */
 489     if (ctx->enc && ++ctx->tls_enc_records == 0) {
 490         ERR_raise(ERR_LIB_PROV, EVP_R_TOO_MANY_RECORDS);
 491         goto err;
 492     }
 493
 494     /*
 495      * Set IV from start of buffer or generate IV and write to start of
 496      * buffer.
 497      */
 498     if (ctx->enc) {
 499         if (!getivgen(ctx, out, arg))
 500             goto err;
 501     } else {
 502         if (!setivinv(ctx, out, arg))
 503             goto err;
 504     }
 505
 506     /* Fix buffer and length to point to payload */
 507     in += EVP_GCM_TLS_EXPLICIT_IV_LEN;
 508     out += EVP_GCM_TLS_EXPLICIT_IV_LEN;
 509     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
 510
 511     tag = ctx->enc ? out + len : (unsigned char *)in + len;
 512     if (!ctx->hw->oneshot(ctx, ctx->buf, ctx->tls_aad_len, in, len, out, tag,
 513                           EVP_GCM_TLS_TAG_LEN)) {
 514         if (!ctx->enc)
 515             OPENSSL_cleanse(out, len);
 516         goto err;
 517     }
 518     if (ctx->enc)
 519         plen =  len + EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
 520     else
 521         plen = len;
 522
 523     rv = 1;
 524 err:
 525     ctx->iv_state = IV_STATE_FINISHED;
 526     ctx->tls_aad_len = UNINITIALISED_SIZET;
 527     *padlen = plen;
 528     return rv;
 529 }
 530