crypto/rsa/rsa_oaep.c

   1 /*
   2  * Copyright 1999-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 /* EME-OAEP as defined in RFC 2437 (PKCS #1 v2.0) */
  11
  12 /*
  13  * See Victor Shoup, "OAEP reconsidered," Nov. 2000, <URL:
  14  * http://www.shoup.net/papers/oaep.ps.Z> for problems with the security
  15  * proof for the original OAEP scheme, which EME-OAEP is based on. A new
  16  * proof can be found in E. Fujisaki, T. Okamoto, D. Pointcheval, J. Stern,
  17  * "RSA-OEAP is Still Alive!", Dec. 2000, <URL:
  18  * http://eprint.iacr.org/2000/061/>. The new proof has stronger requirements
  19  * for the underlying permutation: "partial-one-wayness" instead of
  20  * one-wayness.  For the RSA function, this is an equivalent notion.
  21  */
  22
  23 /*
  24  * RSA low level APIs are deprecated for public use, but still ok for
  25  * internal use.
  26  */
  27 #include "internal/deprecated.h"
  28
  29 #include "internal/constant_time.h"
  30
  31 #include <stdio.h>
  32 #include "internal/cryptlib.h"
  33 #include <openssl/bn.h>
  34 #include <openssl/evp.h>
  35 #include <openssl/rand.h>
  36 #include <openssl/sha.h>
  37 #include "rsa_local.h"
  38
  39 int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
  40                                const unsigned char *from, int flen,
  41                                const unsigned char *param, int plen)
  42 {
  43     return ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(NULL, to, tlen, from, flen,
  44                                                    param, plen, NULL, NULL);
  45 }
  46
  47 /*
  48  * Perform ihe padding as per NIST 800-56B 7.2.2.3
  49  *      from (K) is the key material.
  50  *      param (A) is the additional input.
  51  * Step numbers are included here but not in the constant time inverse below
  52  * to avoid complicating an already difficult enough function.
  53  */
  54 int ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(OPENSSL_CTX *libctx,
  55                                             unsigned char *to, int tlen,
  56                                             const unsigned char *from, int flen,
  57                                             const unsigned char *param,
  58                                             int plen, const EVP_MD *md,
  59                                             const EVP_MD *mgf1md)
  60 {
  61     int rv = 0;
  62     int i, emlen = tlen - 1;
  63     unsigned char *db, *seed;
  64     unsigned char *dbmask = NULL;
  65     unsigned char seedmask[EVP_MAX_MD_SIZE];
  66     int mdlen, dbmask_len = 0;
  67
  68     if (md == NULL) {
  69 #ifndef FIPS_MODULE
  70         md = EVP_sha1();
  71 #else
  72         RSAerr(0, ERR_R_PASSED_NULL_PARAMETER);
  73         return 0;
  74 #endif
  75     }
  76     if (mgf1md == NULL)
  77         mgf1md = md;
  78
  79     mdlen = EVP_MD_size(md);
  80
  81     /* step 2b: check KLen > nLen - 2 HLen - 2 */
  82     if (flen > emlen - 2 * mdlen - 1) {
  83         RSAerr(0, RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE);
  84         return 0;
  85     }
  86
  87     if (emlen < 2 * mdlen + 1) {
  88         RSAerr(0, RSA_R_KEY_SIZE_TOO_SMALL);
  89         return 0;
  90     }
  91
  92     /* step 3i: EM = 00000000 || maskedMGF || maskedDB */
  93     to[0] = 0;
  94     seed = to + 1;
  95     db = to + mdlen + 1;
  96
  97     /* step 3a: hash the additional input */
  98     if (!EVP_Digest((void *)param, plen, db, NULL, md, NULL))
  99         goto err;
 100     /* step 3b: zero bytes array of length nLen - KLen - 2 HLen -2 */
 101     memset(db + mdlen, 0, emlen - flen - 2 * mdlen - 1);
 102     /* step 3c: DB = HA || PS || 00000001 || K */
 103     db[emlen - flen - mdlen - 1] = 0x01;
 104     memcpy(db + emlen - flen - mdlen, from, (unsigned int)flen);
 105     /* step 3d: generate random byte string */
 106     if (RAND_bytes_ex(libctx, seed, mdlen) <= 0)
 107         goto err;
 108
 109     dbmask_len = emlen - mdlen;
 110     dbmask = OPENSSL_malloc(dbmask_len);
 111     if (dbmask == NULL) {
 112         RSAerr(0, ERR_R_MALLOC_FAILURE);
 113         goto err;
 114     }
 115
 116     /* step 3e: dbMask = MGF(mgfSeed, nLen - HLen - 1) */
 117     if (PKCS1_MGF1(dbmask, dbmask_len, seed, mdlen, mgf1md) < 0)
 118         goto err;
 119     /* step 3f: maskedDB = DB XOR dbMask */
 120     for (i = 0; i < dbmask_len; i++)
 121         db[i] ^= dbmask[i];
 122
 123     /* step 3g: mgfSeed = MGF(maskedDB, HLen) */
 124     if (PKCS1_MGF1(seedmask, mdlen, db, dbmask_len, mgf1md) < 0)
 125         goto err;
 126     /* stepo 3h: maskedMGFSeed = mgfSeed XOR mgfSeedMask */
 127     for (i = 0; i < mdlen; i++)
 128         seed[i] ^= seedmask[i];
 129     rv = 1;
 130
 131  err:
 132     OPENSSL_cleanse(seedmask, sizeof(seedmask));
 133     OPENSSL_clear_free(dbmask, dbmask_len);
 134     return rv;
 135 }
 136
 137 int RSA_padding_add_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
 138                                     const unsigned char *from, int flen,
 139                                     const unsigned char *param, int plen,
 140                                     const EVP_MD *md, const EVP_MD *mgf1md)
 141 {
 142     return ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(NULL, to, tlen, from, flen,
 143                                                    param, plen, md, mgf1md);
 144 }
 145
 146 int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
 147                                  const unsigned char *from, int flen, int num,
 148                                  const unsigned char *param, int plen)
 149 {
 150     return RSA_padding_check_PKCS1_OAEP_mgf1(to, tlen, from, flen, num,
 151                                              param, plen, NULL, NULL);
 152 }
 153
 154 int RSA_padding_check_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
 155                                       const unsigned char *from, int flen,
 156                                       int num, const unsigned char *param,
 157                                       int plen, const EVP_MD *md,
 158                                       const EVP_MD *mgf1md)
 159 {
 160     int i, dblen = 0, mlen = -1, one_index = 0, msg_index;
 161     unsigned int good = 0, found_one_byte, mask;
 162     const unsigned char *maskedseed, *maskeddb;
 163     /*
 164      * |em| is the encoded message, zero-padded to exactly |num| bytes: em =
 165      * Y || maskedSeed || maskedDB
 166      */
 167     unsigned char *db = NULL, *em = NULL, seed[EVP_MAX_MD_SIZE],
 168         phash[EVP_MAX_MD_SIZE];
 169     int mdlen;
 170
 171     if (md == NULL) {
 172 #ifndef FIPS_MODULE
 173         md = EVP_sha1();
 174 #else
 175         RSAerr(0, ERR_R_PASSED_NULL_PARAMETER);
 176         return -1;
 177 #endif
 178     }
 179
 180     if (mgf1md == NULL)
 181         mgf1md = md;
 182
 183     mdlen = EVP_MD_size(md);
 184
 185     if (tlen <= 0 || flen <= 0)
 186         return -1;
 187     /*
 188      * |num| is the length of the modulus; |flen| is the length of the
 189      * encoded message. Therefore, for any |from| that was obtained by
 190      * decrypting a ciphertext, we must have |flen| <= |num|. Similarly,
 191      * |num| >= 2 * |mdlen| + 2 must hold for the modulus irrespective of
 192      * the ciphertext, see PKCS #1 v2.2, section 7.1.2.
 193      * This does not leak any side-channel information.
 194      */
 195     if (num < flen || num < 2 * mdlen + 2) {
 196         RSAerr(RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP_MGF1,
 197                RSA_R_OAEP_DECODING_ERROR);
 198         return -1;
 199     }
 200
 201     dblen = num - mdlen - 1;
 202     db = OPENSSL_malloc(dblen);
 203     if (db == NULL) {
 204         RSAerr(RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP_MGF1, ERR_R_MALLOC_FAILURE);
 205         goto cleanup;
 206     }
 207
 208     em = OPENSSL_malloc(num);
 209     if (em == NULL) {
 210         RSAerr(RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP_MGF1,
 211                ERR_R_MALLOC_FAILURE);
 212         goto cleanup;
 213     }
 214
 215     /*
 216      * Caller is encouraged to pass zero-padded message created with
 217      * BN_bn2binpad. Trouble is that since we can't read out of |from|'s
 218      * bounds, it's impossible to have an invariant memory access pattern
 219      * in case |from| was not zero-padded in advance.
 220      */
 221     for (from += flen, em += num, i = 0; i < num; i++) {
 222         mask = ~constant_time_is_zero(flen);
 223         flen -= 1 & mask;
 224         from -= 1 & mask;
 225         *--em = *from & mask;
 226     }
 227
 228     /*
 229      * The first byte must be zero, however we must not leak if this is
 230      * true. See James H. Manger, "A Chosen Ciphertext  Attack on RSA
 231      * Optimal Asymmetric Encryption Padding (OAEP) [...]", CRYPTO 2001).
 232      */
 233     good = constant_time_is_zero(em[0]);
 234
 235     maskedseed = em + 1;
 236     maskeddb = em + 1 + mdlen;
 237
 238     if (PKCS1_MGF1(seed, mdlen, maskeddb, dblen, mgf1md))
 239         goto cleanup;
 240     for (i = 0; i < mdlen; i++)
 241         seed[i] ^= maskedseed[i];
 242
 243     if (PKCS1_MGF1(db, dblen, seed, mdlen, mgf1md))
 244         goto cleanup;
 245     for (i = 0; i < dblen; i++)
 246         db[i] ^= maskeddb[i];
 247
 248     if (!EVP_Digest((void *)param, plen, phash, NULL, md, NULL))
 249         goto cleanup;
 250
 251     good &= constant_time_is_zero(CRYPTO_memcmp(db, phash, mdlen));
 252
 253     found_one_byte = 0;
 254     for (i = mdlen; i < dblen; i++) {
 255         /*
 256          * Padding consists of a number of 0-bytes, followed by a 1.
 257          */
 258         unsigned int equals1 = constant_time_eq(db[i], 1);
 259         unsigned int equals0 = constant_time_is_zero(db[i]);
 260         one_index = constant_time_select_int(~found_one_byte & equals1,
 261                                              i, one_index);
 262         found_one_byte |= equals1;
 263         good &= (found_one_byte | equals0);
 264     }
 265
 266     good &= found_one_byte;
 267
 268     /*
 269      * At this point |good| is zero unless the plaintext was valid,
 270      * so plaintext-awareness ensures timing side-channels are no longer a
 271      * concern.
 272      */
 273     msg_index = one_index + 1;
 274     mlen = dblen - msg_index;
 275
 276     /*
 277      * For good measure, do this check in constant time as well.
 278      */
 279     good &= constant_time_ge(tlen, mlen);
 280
 281     /*
 282      * Move the result in-place by |dblen|-|mdlen|-1-|mlen| bytes to the left.
 283      * Then if |good| move |mlen| bytes from |db|+|mdlen|+1 to |to|.
 284      * Otherwise leave |to| unchanged.
 285      * Copy the memory back in a way that does not reveal the size of
 286      * the data being copied via a timing side channel. This requires copying
 287      * parts of the buffer multiple times based on the bits set in the real
 288      * length. Clear bits do a non-copy with identical access pattern.
 289      * The loop below has overall complexity of O(N*log(N)).
 290      */
 291     tlen = constant_time_select_int(constant_time_lt(dblen - mdlen - 1, tlen),
 292                                     dblen - mdlen - 1, tlen);
 293     for (msg_index = 1; msg_index < dblen - mdlen - 1; msg_index <<= 1) {
 294         mask = ~constant_time_eq(msg_index & (dblen - mdlen - 1 - mlen), 0);
 295         for (i = mdlen + 1; i < dblen - msg_index; i++)
 296             db[i] = constant_time_select_8(mask, db[i + msg_index], db[i]);
 297     }
 298     for (i = 0; i < tlen; i++) {
 299         mask = good & constant_time_lt(i, mlen);
 300         to[i] = constant_time_select_8(mask, db[i + mdlen + 1], to[i]);
 301     }
 302
 303 #ifndef FIPS_MODULE
 304     /*
 305      * To avoid chosen ciphertext attacks, the error message should not
 306      * reveal which kind of decoding error happened.
 307      *
 308      * This trick doesn't work in the FIPS provider because libcrypto manages
 309      * the error stack. Instead we opt not to put an error on the stack at all
 310      * in case of padding failure in the FIPS provider.
 311      */
 312     RSAerr(RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP_MGF1,
 313            RSA_R_OAEP_DECODING_ERROR);
 314     err_clear_last_constant_time(1 & good);
 315 #endif
 316  cleanup:
 317     OPENSSL_cleanse(seed, sizeof(seed));
 318     OPENSSL_clear_free(db, dblen);
 319     OPENSSL_clear_free(em, num);
 320
 321     return constant_time_select_int(good, mlen, -1);
 322 }
 323
 324 /*
 325  * Mask Generation Function corresponding to section 7.2.2.2 of NIST SP 800-56B.
 326  * The variables are named differently to NIST:
 327  *      mask (T) and len (maskLen)are the returned mask.
 328  *      seed (mgfSeed).
 329  * The range checking steps inm the process are performed outside.
 330  */
 331 int PKCS1_MGF1(unsigned char *mask, long len,
 332                const unsigned char *seed, long seedlen, const EVP_MD *dgst)
 333 {
 334     long i, outlen = 0;
 335     unsigned char cnt[4];
 336     EVP_MD_CTX *c = EVP_MD_CTX_new();
 337     unsigned char md[EVP_MAX_MD_SIZE];
 338     int mdlen;
 339     int rv = -1;
 340
 341     if (c == NULL)
 342         goto err;
 343     mdlen = EVP_MD_size(dgst);
 344     if (mdlen < 0)
 345         goto err;
 346     /* step 4 */
 347     for (i = 0; outlen < len; i++) {
 348         /* step 4a: D = I2BS(counter, 4) */
 349         cnt[0] = (unsigned char)((i >> 24) & 255);
 350         cnt[1] = (unsigned char)((i >> 16) & 255);
 351         cnt[2] = (unsigned char)((i >> 8)) & 255;
 352         cnt[3] = (unsigned char)(i & 255);
 353         /* step 4b: T =T || hash(mgfSeed || D) */
 354         if (!EVP_DigestInit_ex(c, dgst, NULL)
 355             || !EVP_DigestUpdate(c, seed, seedlen)
 356             || !EVP_DigestUpdate(c, cnt, 4))
 357             goto err;
 358         if (outlen + mdlen <= len) {
 359             if (!EVP_DigestFinal_ex(c, mask + outlen, NULL))
 360                 goto err;
 361             outlen += mdlen;
 362         } else {
 363             if (!EVP_DigestFinal_ex(c, md, NULL))
 364                 goto err;
 365             memcpy(mask + outlen, md, len - outlen);
 366             outlen = len;
 367         }
 368     }
 369     rv = 0;
 370  err:
 371     OPENSSL_cleanse(md, sizeof(md));
 372     EVP_MD_CTX_free(c);
 373     return rv;
 374 }