crypto/evp/evp_pbe.c

   1 /*
   2  * Copyright 1999-2017 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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/pkcs12.h>
  14 #include <openssl/x509.h>
  15 #include "evp_locl.h"
  16
  17 /* Password based encryption (PBE) functions */
  18
  19 /* Setup a cipher context from a PBE algorithm */
  20
  21 struct evp_pbe_st {
  22     int pbe_type;
  23     int pbe_nid;
  24     int cipher_nid;
  25     int md_nid;
  26     EVP_PBE_KEYGEN *keygen;
  27 };
  28
  29 static STACK_OF(EVP_PBE_CTL) *pbe_algs;
  30
  31 static const EVP_PBE_CTL builtin_pbe[] = {
  32     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
  33      NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen},
  34     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
  35      NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen},
  36     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
  37      NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen},
  38
  39     {EVP_PBE_TYPE_OUTER, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
  40
  41     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
  42      NID_rc4, NID_sha1, PKCS12_PBE_keyivgen},
  43     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
  44      NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen},
  45     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
  46      NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen},
  47     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC,
  48      NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen},
  49     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
  50      NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen},
  51     {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
  52      NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen},
  53
  54     {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen},
  55
  56     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
  57      NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen},
  58     {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
  59      NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen},
  60     {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
  61      NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen},
  62
  63     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
  64     {EVP_PBE_TYPE_PRF, NID_hmac_md5, -1, NID_md5, 0},
  65     {EVP_PBE_TYPE_PRF, NID_hmac_sha1, -1, NID_sha1, 0},
  66     {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
  67     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
  68     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
  69     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
  70     {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
  71     {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
  72     {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_256, -1,
  73      NID_id_GostR3411_2012_256, 0},
  74     {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_512, -1,
  75      NID_id_GostR3411_2012_512, 0},
  76     {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
  77 #ifndef OPENSSL_NO_SCRYPT
  78     {EVP_PBE_TYPE_KDF, NID_id_scrypt, -1, -1, PKCS5_v2_scrypt_keyivgen}
  79 #endif
  80 };
  81
  82 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
  83                        ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
  84 {
  85     const EVP_CIPHER *cipher;
  86     const EVP_MD *md;
  87     int cipher_nid, md_nid;
  88     EVP_PBE_KEYGEN *keygen;
  89
  90     if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
  91                       &cipher_nid, &md_nid, &keygen)) {
  92         char obj_tmp[80];
  93         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
  94         if (!pbe_obj)
  95             OPENSSL_strlcpy(obj_tmp, "NULL", sizeof(obj_tmp));
  96         else
  97             i2t_ASN1_OBJECT(obj_tmp, sizeof(obj_tmp), pbe_obj);
  98         ERR_add_error_data(2, "TYPE=", obj_tmp);
  99         return 0;
 100     }
 101
 102     if (!pass)
 103         passlen = 0;
 104     else if (passlen == -1)
 105         passlen = strlen(pass);
 106
 107     if (cipher_nid == -1)
 108         cipher = NULL;
 109     else {
 110         cipher = EVP_get_cipherbynid(cipher_nid);
 111         if (!cipher) {
 112             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
 113             return 0;
 114         }
 115     }
 116
 117     if (md_nid == -1)
 118         md = NULL;
 119     else {
 120         md = EVP_get_digestbynid(md_nid);
 121         if (!md) {
 122             EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
 123             return 0;
 124         }
 125     }
 126
 127     if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
 128         EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
 129         return 0;
 130     }
 131     return 1;
 132 }
 133
 134 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 135
 136 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
 137 {
 138     int ret = pbe1->pbe_type - pbe2->pbe_type;
 139     if (ret)
 140         return ret;
 141     else
 142         return pbe1->pbe_nid - pbe2->pbe_nid;
 143 }
 144
 145 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
 146
 147 static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
 148 {
 149     int ret = (*a)->pbe_type - (*b)->pbe_type;
 150     if (ret)
 151         return ret;
 152     else
 153         return (*a)->pbe_nid - (*b)->pbe_nid;
 154 }
 155
 156 /* Add a PBE algorithm */
 157
 158 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
 159                          int md_nid, EVP_PBE_KEYGEN *keygen)
 160 {
 161     EVP_PBE_CTL *pbe_tmp;
 162
 163     if (pbe_algs == NULL) {
 164         pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
 165         if (pbe_algs == NULL)
 166             goto err;
 167     }
 168
 169     if ((pbe_tmp = OPENSSL_malloc(sizeof(*pbe_tmp))) == NULL)
 170         goto err;
 171
 172     pbe_tmp->pbe_type = pbe_type;
 173     pbe_tmp->pbe_nid = pbe_nid;
 174     pbe_tmp->cipher_nid = cipher_nid;
 175     pbe_tmp->md_nid = md_nid;
 176     pbe_tmp->keygen = keygen;
 177
 178     if (!sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp)) {
 179         OPENSSL_free(pbe_tmp);
 180         goto err;
 181     }
 182     return 1;
 183
 184  err:
 185     EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
 186     return 0;
 187 }
 188
 189 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
 190                     EVP_PBE_KEYGEN *keygen)
 191 {
 192     int cipher_nid, md_nid;
 193
 194     if (cipher)
 195         cipher_nid = EVP_CIPHER_nid(cipher);
 196     else
 197         cipher_nid = -1;
 198     if (md)
 199         md_nid = EVP_MD_type(md);
 200     else
 201         md_nid = -1;
 202
 203     return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
 204                                 cipher_nid, md_nid, keygen);
 205 }
 206
 207 int EVP_PBE_find(int type, int pbe_nid,
 208                  int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
 209 {
 210     EVP_PBE_CTL *pbetmp = NULL, pbelu;
 211     int i;
 212     if (pbe_nid == NID_undef)
 213         return 0;
 214
 215     pbelu.pbe_type = type;
 216     pbelu.pbe_nid = pbe_nid;
 217
 218     if (pbe_algs) {
 219         i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
 220         if (i != -1)
 221             pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
 222     }
 223     if (pbetmp == NULL) {
 224         pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
 225     }
 226     if (pbetmp == NULL)
 227         return 0;
 228     if (pcnid)
 229         *pcnid = pbetmp->cipher_nid;
 230     if (pmnid)
 231         *pmnid = pbetmp->md_nid;
 232     if (pkeygen)
 233         *pkeygen = pbetmp->keygen;
 234     return 1;
 235 }
 236
 237 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
 238 {
 239     OPENSSL_free(pbe);
 240 }
 241
 242 void EVP_PBE_cleanup(void)
 243 {
 244     sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
 245     pbe_algs = NULL;
 246 }
 247
 248 int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
 249 {
 250     const EVP_PBE_CTL *tpbe;
 251
 252     if (num >= OSSL_NELEM(builtin_pbe))
 253         return 0;
 254
 255     tpbe = builtin_pbe + num;
 256     if (ptype)
 257         *ptype = tpbe->pbe_type;
 258     if (ppbe_nid)
 259         *ppbe_nid = tpbe->pbe_nid;
 260     return 1;
 261 }