crypto/evp/evp_pbe.c

   1 /*
   2  * Copyright 1999-2021 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 <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include <openssl/evp.h>
  13 #include <openssl/core.h>
  14 #include <openssl/core_names.h>
  15 #include <openssl/pkcs12.h>
  16 #include <openssl/x509.h>
  17 #include "crypto/evp.h"
  18 #include "evp_local.h"
  19
  20 /* Password based encryption (PBE) functions */
  21
  22 /* Setup a cipher context from a PBE algorithm */
  23
  24 struct evp_pbe_st {
  25     int pbe_type;
  26     int pbe_nid;
  27     int cipher_nid;
  28     int md_nid;
  29     EVP_PBE_KEYGEN *keygen;
  30     EVP_PBE_KEYGEN_EX *keygen_ex;
  31 };
  32
  33 static STACK_OF(EVP_PBE_CTL) *pbe_algs;
  34
  35 static const EVP_PBE_CTL builtin_pbe[] = {
  36     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
  37      NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  38     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
  39      NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  40     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
  41      NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  42
  43     {EVP_PBE_TYPE_OUTER, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
  44
  45     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
  46      NID_rc4, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  47     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
  48      NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  49     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
  50      NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  51     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC,
  52      NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  53     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
  54      NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  55     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
  56      NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen, &PKCS12_PBE_keyivgen_ex},
  57
  58     {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen, &PKCS5_v2_PBE_keyivgen_ex},
  59
  60     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
  61      NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  62     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
  63      NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  64     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
  65      NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex},
  66
  67     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
  68     {EVP_PBE_TYPE_PRF, NID_hmac_md5, -1, NID_md5, 0},
  69     {EVP_PBE_TYPE_PRF, NID_hmac_sha1, -1, NID_sha1, 0},
  70     {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
  71     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
  72     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
  73     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
  74     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
  75     {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
  76     {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_256, -1,
  77      NID_id_GostR3411_2012_256, 0},
  78     {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_512, -1,
  79      NID_id_GostR3411_2012_512, 0},
  80     {EVP_PBE_TYPE_PRF, NID_hmac_sha3_224, -1, NID_sha3_224, 0},
  81     {EVP_PBE_TYPE_PRF, NID_hmac_sha3_256, -1, NID_sha3_256, 0},
  82     {EVP_PBE_TYPE_PRF, NID_hmac_sha3_384, -1, NID_sha3_384, 0},
  83     {EVP_PBE_TYPE_PRF, NID_hmac_sha3_512, -1, NID_sha3_512, 0},
  84     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512_224, -1, NID_sha512_224, 0},
  85     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512_256, -1, NID_sha512_256, 0},
  86 #ifndef OPENSSL_NO_SM3
  87     {EVP_PBE_TYPE_PRF, NID_hmacWithSM3, -1, NID_sm3, 0},
  88 #endif
  89     {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen, &PKCS5_v2_PBKDF2_keyivgen_ex},
  90 #ifndef OPENSSL_NO_SCRYPT
  91     {EVP_PBE_TYPE_KDF, NID_id_scrypt, -1, -1, PKCS5_v2_scrypt_keyivgen, &PKCS5_v2_scrypt_keyivgen_ex}
  92 #endif
  93 };
  94
  95
  96 int EVP_PBE_CipherInit_ex(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
  97                           ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de,
  98                           OSSL_LIB_CTX *libctx, const char *propq)
  99 {
 100     const EVP_CIPHER *cipher = NULL;
 101     EVP_CIPHER *cipher_fetch = NULL;
 102     const EVP_MD *md = NULL;
 103     EVP_MD *md_fetch = NULL;
 104     int ret = 0, cipher_nid, md_nid;
 105     EVP_PBE_KEYGEN_EX *keygen_ex;
 106     EVP_PBE_KEYGEN *keygen;
 107
 108     if (!EVP_PBE_find_ex(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
 109                          &cipher_nid, &md_nid, &keygen, &keygen_ex)) {
 110         char obj_tmp[80];
 111
 112         if (pbe_obj == NULL)
 113             OPENSSL_strlcpy(obj_tmp, "NULL", sizeof(obj_tmp));
 114         else
 115             i2t_ASN1_OBJECT(obj_tmp, sizeof(obj_tmp), pbe_obj);
 116         ERR_raise_data(ERR_LIB_EVP, EVP_R_UNKNOWN_PBE_ALGORITHM,
 117                        "TYPE=%s", obj_tmp);
 118         goto err;
 119     }
 120
 121     if (pass == NULL)
 122         passlen = 0;
 123     else if (passlen == -1)
 124         passlen = strlen(pass);
 125
 126     if (cipher_nid != -1) {
 127         (void)ERR_set_mark();
 128         cipher = cipher_fetch = EVP_CIPHER_fetch(libctx, OBJ_nid2sn(cipher_nid), propq);
 129         /* Fallback to legacy method */
 130         if (cipher == NULL)
 131             cipher = EVP_get_cipherbynid(cipher_nid);
 132         if (cipher == NULL) {
 133             (void)ERR_clear_last_mark();
 134             ERR_raise_data(ERR_LIB_EVP, EVP_R_UNKNOWN_CIPHER,
 135                            OBJ_nid2sn(cipher_nid));
 136             goto err;
 137         }
 138         (void)ERR_pop_to_mark();
 139     }
 140
 141     if (md_nid != -1) {
 142         (void)ERR_set_mark();
 143         md = md_fetch = EVP_MD_fetch(libctx, OBJ_nid2sn(md_nid), propq);
 144         /* Fallback to legacy method */
 145         if (md == NULL)
 146             EVP_get_digestbynid(md_nid);
 147
 148         if (md == NULL) {
 149             (void)ERR_clear_last_mark();
 150             ERR_raise(ERR_LIB_EVP, EVP_R_UNKNOWN_DIGEST);
 151             goto err;
 152         }
 153         (void)ERR_pop_to_mark();
 154     }
 155
 156     /* Try extended keygen with libctx/propq first, fall back to legacy keygen */
 157     if (keygen_ex != NULL)
 158         ret = keygen_ex(ctx, pass, passlen, param, cipher, md, en_de, libctx, propq);
 159     else
 160         ret = keygen(ctx, pass, passlen, param, cipher, md, en_de);
 161
 162 err:
 163     EVP_CIPHER_free(cipher_fetch);
 164     EVP_MD_free(md_fetch);
 165
 166     return ret;
 167 }
 168
 169 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
 170                        ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
 171 {
 172     return EVP_PBE_CipherInit_ex(pbe_obj, pass, passlen, param, ctx, en_de, NULL, NULL);
 173 }
 174
 175 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 176
 177 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
 178 {
 179     int ret = pbe1->pbe_type - pbe2->pbe_type;
 180     if (ret)
 181         return ret;
 182     else
 183         return pbe1->pbe_nid - pbe2->pbe_nid;
 184 }
 185
 186 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 187
 188 static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
 189 {
 190     int ret = (*a)->pbe_type - (*b)->pbe_type;
 191     if (ret)
 192         return ret;
 193     else
 194         return (*a)->pbe_nid - (*b)->pbe_nid;
 195 }
 196
 197 /* Add a PBE algorithm */
 198
 199 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
 200                          int md_nid, EVP_PBE_KEYGEN *keygen)
 201 {
 202     EVP_PBE_CTL *pbe_tmp = NULL;
 203
 204     if (pbe_algs == NULL) {
 205         pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
 206         if (pbe_algs == NULL) {
 207             ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
 208             goto err;
 209         }
 210     }
 211
 212     if ((pbe_tmp = OPENSSL_zalloc(sizeof(*pbe_tmp))) == NULL)
 213         goto err;
 214
 215     pbe_tmp->pbe_type = pbe_type;
 216     pbe_tmp->pbe_nid = pbe_nid;
 217     pbe_tmp->cipher_nid = cipher_nid;
 218     pbe_tmp->md_nid = md_nid;
 219     pbe_tmp->keygen = keygen;
 220
 221     if (!sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp)) {
 222         ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
 223         goto err;
 224     }
 225     return 1;
 226
 227  err:
 228     OPENSSL_free(pbe_tmp);
 229     return 0;
 230 }
 231
 232 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
 233                     EVP_PBE_KEYGEN *keygen)
 234 {
 235     int cipher_nid, md_nid;
 236
 237     if (cipher)
 238         cipher_nid = EVP_CIPHER_get_nid(cipher);
 239     else
 240         cipher_nid = -1;
 241     if (md)
 242         md_nid = EVP_MD_get_type(md);
 243     else
 244         md_nid = -1;
 245
 246     return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
 247                                 cipher_nid, md_nid, keygen);
 248 }
 249
 250 int EVP_PBE_find_ex(int type, int pbe_nid, int *pcnid, int *pmnid,
 251                     EVP_PBE_KEYGEN **pkeygen, EVP_PBE_KEYGEN_EX **pkeygen_ex)
 252 {
 253     EVP_PBE_CTL *pbetmp = NULL, pbelu;
 254     int i;
 255     if (pbe_nid == NID_undef)
 256         return 0;
 257
 258     pbelu.pbe_type = type;
 259     pbelu.pbe_nid = pbe_nid;
 260
 261     if (pbe_algs != NULL) {
 262         i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
 263         pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
 264     }
 265     if (pbetmp == NULL) {
 266         pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
 267     }
 268     if (pbetmp == NULL)
 269         return 0;
 270     if (pcnid != NULL)
 271         *pcnid = pbetmp->cipher_nid;
 272     if (pmnid != NULL)
 273         *pmnid = pbetmp->md_nid;
 274     if (pkeygen != NULL)
 275         *pkeygen = pbetmp->keygen;
 276     if (pkeygen_ex != NULL)
 277         *pkeygen_ex = pbetmp->keygen_ex;
 278     return 1;
 279 }
 280
 281 int EVP_PBE_find(int type, int pbe_nid,
 282                  int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
 283 {
 284     return EVP_PBE_find_ex(type, pbe_nid, pcnid, pmnid, pkeygen, NULL);
 285 }
 286
 287 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
 288 {
 289     OPENSSL_free(pbe);
 290 }
 291
 292 void EVP_PBE_cleanup(void)
 293 {
 294     sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
 295     pbe_algs = NULL;
 296 }
 297
 298 int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
 299 {
 300     const EVP_PBE_CTL *tpbe;
 301
 302     if (num >= OSSL_NELEM(builtin_pbe))
 303         return 0;
 304
 305     tpbe = builtin_pbe + num;
 306     if (ptype)
 307         *ptype = tpbe->pbe_type;
 308     if (ppbe_nid)
 309         *ppbe_nid = tpbe->pbe_nid;
 310     return 1;
 311 }