Coverage Report

Created: 2026-02-22 06:11

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/evp/evp_pbe.c
Line
Count
Source
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
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
0
{
100
0
    EVP_CIPHER *cipher = NULL;
101
0
    EVP_MD *md = NULL;
102
0
    int ret = 0, cipher_nid, md_nid;
103
0
    EVP_PBE_KEYGEN_EX *keygen_ex;
104
0
    EVP_PBE_KEYGEN *keygen;
105
106
0
    if (!EVP_PBE_find_ex(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
107
0
            &cipher_nid, &md_nid, &keygen, &keygen_ex)) {
108
0
        char obj_tmp[80];
109
110
0
        if (pbe_obj == NULL)
111
0
            OPENSSL_strlcpy(obj_tmp, "NULL", sizeof(obj_tmp));
112
0
        else
113
0
            i2t_ASN1_OBJECT(obj_tmp, sizeof(obj_tmp), pbe_obj);
114
0
        ERR_raise_data(ERR_LIB_EVP, EVP_R_UNKNOWN_PBE_ALGORITHM,
115
0
            "TYPE=%s", obj_tmp);
116
0
        goto err;
117
0
    }
118
119
0
    if (pass == NULL)
120
0
        passlen = 0;
121
0
    else if (passlen == -1)
122
0
        passlen = (int)strlen(pass);
123
124
0
    if (cipher_nid != -1) {
125
0
        cipher = EVP_CIPHER_fetch(libctx, OBJ_nid2sn(cipher_nid), propq);
126
0
        if (cipher == NULL) {
127
0
            ERR_raise_data(ERR_LIB_EVP, EVP_R_UNKNOWN_CIPHER,
128
0
                OBJ_nid2sn(cipher_nid));
129
0
            goto err;
130
0
        }
131
0
    }
132
133
0
    if (md_nid != -1) {
134
0
        md = EVP_MD_fetch(libctx, OBJ_nid2sn(md_nid), propq);
135
136
0
        if (md == NULL) {
137
0
            ERR_raise(ERR_LIB_EVP, EVP_R_UNKNOWN_DIGEST);
138
0
            goto err;
139
0
        }
140
0
    }
141
142
    /* Try extended keygen with libctx/propq first, fall back to legacy keygen */
143
0
    if (keygen_ex != NULL)
144
0
        ret = keygen_ex(ctx, pass, passlen, param, cipher, md, en_de, libctx, propq);
145
0
    else
146
0
        ret = keygen(ctx, pass, passlen, param, cipher, md, en_de);
147
148
0
err:
149
0
    EVP_CIPHER_free(cipher);
150
0
    EVP_MD_free(md);
151
152
0
    return ret;
153
0
}
154
155
int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
156
    ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
157
0
{
158
0
    return EVP_PBE_CipherInit_ex(pbe_obj, pass, passlen, param, ctx, en_de, NULL, NULL);
159
0
}
160
161
DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
162
163
static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
164
0
{
165
0
    int ret = pbe1->pbe_type - pbe2->pbe_type;
166
0
    if (ret)
167
0
        return ret;
168
0
    else
169
0
        return pbe1->pbe_nid - pbe2->pbe_nid;
170
0
}
171
172
IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
173
174
static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
175
0
{
176
0
    int ret = (*a)->pbe_type - (*b)->pbe_type;
177
0
    if (ret)
178
0
        return ret;
179
0
    else
180
0
        return (*a)->pbe_nid - (*b)->pbe_nid;
181
0
}
182
183
/* Add a PBE algorithm */
184
185
int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
186
    int md_nid, EVP_PBE_KEYGEN *keygen)
187
0
{
188
0
    EVP_PBE_CTL *pbe_tmp = NULL;
189
190
0
    if (pbe_algs == NULL) {
191
0
        pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
192
0
        if (pbe_algs == NULL) {
193
0
            ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
194
0
            goto err;
195
0
        }
196
0
    }
197
198
0
    if ((pbe_tmp = OPENSSL_zalloc(sizeof(*pbe_tmp))) == NULL)
199
0
        goto err;
200
201
0
    pbe_tmp->pbe_type = pbe_type;
202
0
    pbe_tmp->pbe_nid = pbe_nid;
203
0
    pbe_tmp->cipher_nid = cipher_nid;
204
0
    pbe_tmp->md_nid = md_nid;
205
0
    pbe_tmp->keygen = keygen;
206
207
0
    if (!sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp)) {
208
0
        ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
209
0
        goto err;
210
0
    }
211
0
    return 1;
212
213
0
err:
214
0
    OPENSSL_free(pbe_tmp);
215
0
    return 0;
216
0
}
217
218
int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
219
    EVP_PBE_KEYGEN *keygen)
220
0
{
221
0
    int cipher_nid, md_nid;
222
223
0
    if (cipher)
224
0
        cipher_nid = EVP_CIPHER_get_nid(cipher);
225
0
    else
226
0
        cipher_nid = -1;
227
0
    if (md)
228
0
        md_nid = EVP_MD_get_type(md);
229
0
    else
230
0
        md_nid = -1;
231
232
0
    return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
233
0
        cipher_nid, md_nid, keygen);
234
0
}
235
236
int EVP_PBE_find_ex(int type, int pbe_nid, int *pcnid, int *pmnid,
237
    EVP_PBE_KEYGEN **pkeygen, EVP_PBE_KEYGEN_EX **pkeygen_ex)
238
0
{
239
0
    EVP_PBE_CTL *pbetmp = NULL, pbelu;
240
0
    int i;
241
0
    if (pbe_nid == NID_undef)
242
0
        return 0;
243
244
0
    pbelu.pbe_type = type;
245
0
    pbelu.pbe_nid = pbe_nid;
246
247
0
    if (pbe_algs != NULL) {
248
        /* Ideally, this would be done under lock */
249
0
        sk_EVP_PBE_CTL_sort(pbe_algs);
250
0
        i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
251
0
        pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
252
0
    }
253
0
    if (pbetmp == NULL) {
254
0
        pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
255
0
    }
256
0
    if (pbetmp == NULL)
257
0
        return 0;
258
0
    if (pcnid != NULL)
259
0
        *pcnid = pbetmp->cipher_nid;
260
0
    if (pmnid != NULL)
261
0
        *pmnid = pbetmp->md_nid;
262
0
    if (pkeygen != NULL)
263
0
        *pkeygen = pbetmp->keygen;
264
0
    if (pkeygen_ex != NULL)
265
0
        *pkeygen_ex = pbetmp->keygen_ex;
266
0
    return 1;
267
0
}
268
269
int EVP_PBE_find(int type, int pbe_nid,
270
    int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
271
0
{
272
0
    return EVP_PBE_find_ex(type, pbe_nid, pcnid, pmnid, pkeygen, NULL);
273
0
}
274
275
static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
276
0
{
277
0
    OPENSSL_free(pbe);
278
0
}
279
280
void EVP_PBE_cleanup(void)
281
0
{
282
0
    sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
283
0
    pbe_algs = NULL;
284
0
}
285
286
int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
287
0
{
288
0
    const EVP_PBE_CTL *tpbe;
289
290
0
    if (num >= OSSL_NELEM(builtin_pbe))
291
0
        return 0;
292
293
0
    tpbe = builtin_pbe + num;
294
0
    if (ptype)
295
0
        *ptype = tpbe->pbe_type;
296
0
    if (ppbe_nid)
297
0
        *ppbe_nid = tpbe->pbe_nid;
298
0
    return 1;
299
0
}