Coverage Report

Created: 2024-11-21 07:03

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