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