1/*
2 * Copyright 1999-2018 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_local.h"
16
17/* Password based encryption (PBE) functions */
18
19/* Setup a cipher context from a PBE algorithm */
20
21struct 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
29static STACK_OF(EVP_PBE_CTL) *pbe_algs;
30
31static 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_PRF, NID_hmacWithSHA512_224, -1, NID_sha512_224, 0},
77    {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512_256, -1, NID_sha512_256, 0},
78    {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
79#ifndef OPENSSL_NO_SCRYPT
80    {EVP_PBE_TYPE_KDF, NID_id_scrypt, -1, -1, PKCS5_v2_scrypt_keyivgen}
81#endif
82};
83
84int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
85                       ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
86{
87    const EVP_CIPHER *cipher;
88    const EVP_MD *md;
89    int cipher_nid, md_nid;
90    EVP_PBE_KEYGEN *keygen;
91
92    if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
93                      &cipher_nid, &md_nid, &keygen)) {
94        char obj_tmp[80];
95        EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
96        if (!pbe_obj)
97            OPENSSL_strlcpy(obj_tmp, "NULL", sizeof(obj_tmp));
98        else
99            i2t_ASN1_OBJECT(obj_tmp, sizeof(obj_tmp), pbe_obj);
100        ERR_add_error_data(2, "TYPE=", obj_tmp);
101        return 0;
102    }
103
104    if (!pass)
105        passlen = 0;
106    else if (passlen == -1)
107        passlen = strlen(pass);
108
109    if (cipher_nid == -1)
110        cipher = NULL;
111    else {
112        cipher = EVP_get_cipherbynid(cipher_nid);
113        if (!cipher) {
114            EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
115            return 0;
116        }
117    }
118
119    if (md_nid == -1)
120        md = NULL;
121    else {
122        md = EVP_get_digestbynid(md_nid);
123        if (!md) {
124            EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
125            return 0;
126        }
127    }
128
129    if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
130        EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
131        return 0;
132    }
133    return 1;
134}
135
136DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
137
138static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
139{
140    int ret = pbe1->pbe_type - pbe2->pbe_type;
141    if (ret)
142        return ret;
143    else
144        return pbe1->pbe_nid - pbe2->pbe_nid;
145}
146
147IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
148
149static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
150{
151    int ret = (*a)->pbe_type - (*b)->pbe_type;
152    if (ret)
153        return ret;
154    else
155        return (*a)->pbe_nid - (*b)->pbe_nid;
156}
157
158/* Add a PBE algorithm */
159
160int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
161                         int md_nid, EVP_PBE_KEYGEN *keygen)
162{
163    EVP_PBE_CTL *pbe_tmp;
164
165    if (pbe_algs == NULL) {
166        pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
167        if (pbe_algs == NULL)
168            goto err;
169    }
170
171    if ((pbe_tmp = OPENSSL_malloc(sizeof(*pbe_tmp))) == NULL)
172        goto err;
173
174    pbe_tmp->pbe_type = pbe_type;
175    pbe_tmp->pbe_nid = pbe_nid;
176    pbe_tmp->cipher_nid = cipher_nid;
177    pbe_tmp->md_nid = md_nid;
178    pbe_tmp->keygen = keygen;
179
180    if (!sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp)) {
181        OPENSSL_free(pbe_tmp);
182        goto err;
183    }
184    return 1;
185
186 err:
187    EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
188    return 0;
189}
190
191int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
192                    EVP_PBE_KEYGEN *keygen)
193{
194    int cipher_nid, md_nid;
195
196    if (cipher)
197        cipher_nid = EVP_CIPHER_nid(cipher);
198    else
199        cipher_nid = -1;
200    if (md)
201        md_nid = EVP_MD_type(md);
202    else
203        md_nid = -1;
204
205    return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
206                                cipher_nid, md_nid, keygen);
207}
208
209int EVP_PBE_find(int type, int pbe_nid,
210                 int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
211{
212    EVP_PBE_CTL *pbetmp = NULL, pbelu;
213    int i;
214    if (pbe_nid == NID_undef)
215        return 0;
216
217    pbelu.pbe_type = type;
218    pbelu.pbe_nid = pbe_nid;
219
220    if (pbe_algs != NULL) {
221        i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
222        pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
223    }
224    if (pbetmp == NULL) {
225        pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
226    }
227    if (pbetmp == NULL)
228        return 0;
229    if (pcnid)
230        *pcnid = pbetmp->cipher_nid;
231    if (pmnid)
232        *pmnid = pbetmp->md_nid;
233    if (pkeygen)
234        *pkeygen = pbetmp->keygen;
235    return 1;
236}
237
238static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
239{
240    OPENSSL_free(pbe);
241}
242
243void EVP_PBE_cleanup(void)
244{
245    sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
246    pbe_algs = NULL;
247}
248
249int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
250{
251    const EVP_PBE_CTL *tpbe;
252
253    if (num >= OSSL_NELEM(builtin_pbe))
254        return 0;
255
256    tpbe = builtin_pbe + num;
257    if (ptype)
258        *ptype = tpbe->pbe_type;
259    if (ppbe_nid)
260        *ppbe_nid = tpbe->pbe_nid;
261    return 1;
262}
263