/src/openssl/crypto/evp/p5_crpt2.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 <stdlib.h> |
12 | | #include "internal/cryptlib.h" |
13 | | #include <openssl/x509.h> |
14 | | #include <openssl/evp.h> |
15 | | #include <openssl/kdf.h> |
16 | | #include <openssl/hmac.h> |
17 | | #include <openssl/trace.h> |
18 | | #include <openssl/core_names.h> |
19 | | #include "crypto/evp.h" |
20 | | #include "evp_local.h" |
21 | | |
22 | | int ossl_pkcs5_pbkdf2_hmac_ex(const char *pass, int passlen, |
23 | | const unsigned char *salt, int saltlen, int iter, |
24 | | const EVP_MD *digest, int keylen, unsigned char *out, |
25 | | OSSL_LIB_CTX *libctx, const char *propq) |
26 | 160 | { |
27 | 160 | const char *empty = ""; |
28 | 160 | int rv = 1, mode = 1; |
29 | 160 | EVP_KDF *kdf; |
30 | 160 | EVP_KDF_CTX *kctx; |
31 | 160 | const char *mdname = EVP_MD_get0_name(digest); |
32 | 160 | OSSL_PARAM params[6], *p = params; |
33 | | |
34 | | /* Keep documented behaviour. */ |
35 | 160 | if (pass == NULL) { |
36 | 0 | pass = empty; |
37 | 0 | passlen = 0; |
38 | 160 | } else if (passlen == -1) { |
39 | 0 | passlen = strlen(pass); |
40 | 0 | } |
41 | 160 | if (salt == NULL && saltlen == 0) |
42 | 0 | salt = (unsigned char *)empty; |
43 | | |
44 | 160 | kdf = EVP_KDF_fetch(libctx, OSSL_KDF_NAME_PBKDF2, propq); |
45 | 160 | if (kdf == NULL) |
46 | 0 | return 0; |
47 | 160 | kctx = EVP_KDF_CTX_new(kdf); |
48 | 160 | EVP_KDF_free(kdf); |
49 | 160 | if (kctx == NULL) |
50 | 0 | return 0; |
51 | 160 | *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PASSWORD, |
52 | 160 | (char *)pass, (size_t)passlen); |
53 | 160 | *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_PKCS5, &mode); |
54 | 160 | *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT, |
55 | 160 | (unsigned char *)salt, saltlen); |
56 | 160 | *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_ITER, &iter); |
57 | 160 | *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST, |
58 | 160 | (char *)mdname, 0); |
59 | 160 | *p = OSSL_PARAM_construct_end(); |
60 | 160 | if (EVP_KDF_derive(kctx, out, keylen, params) != 1) |
61 | 0 | rv = 0; |
62 | | |
63 | 160 | EVP_KDF_CTX_free(kctx); |
64 | | |
65 | 160 | OSSL_TRACE_BEGIN(PKCS5V2) { |
66 | 0 | BIO_printf(trc_out, "Password:\n"); |
67 | 0 | BIO_hex_string(trc_out, |
68 | 0 | 0, passlen, pass, passlen); |
69 | 0 | BIO_printf(trc_out, "\n"); |
70 | 0 | BIO_printf(trc_out, "Salt:\n"); |
71 | 0 | BIO_hex_string(trc_out, |
72 | 0 | 0, saltlen, salt, saltlen); |
73 | 0 | BIO_printf(trc_out, "\n"); |
74 | 0 | BIO_printf(trc_out, "Iteration count %d\n", iter); |
75 | 0 | BIO_printf(trc_out, "Key:\n"); |
76 | 0 | BIO_hex_string(trc_out, |
77 | 0 | 0, keylen, out, keylen); |
78 | 0 | BIO_printf(trc_out, "\n"); |
79 | 160 | } OSSL_TRACE_END(PKCS5V2); |
80 | 160 | return rv; |
81 | 160 | } |
82 | | |
83 | | int PKCS5_PBKDF2_HMAC(const char *pass, int passlen, const unsigned char *salt, |
84 | | int saltlen, int iter, const EVP_MD *digest, int keylen, |
85 | | unsigned char *out) |
86 | | { |
87 | | return ossl_pkcs5_pbkdf2_hmac_ex(pass, passlen, salt, saltlen, iter, digest, |
88 | | keylen, out, NULL, NULL); |
89 | | } |
90 | | |
91 | | |
92 | | int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen, |
93 | | const unsigned char *salt, int saltlen, int iter, |
94 | | int keylen, unsigned char *out) |
95 | 0 | { |
96 | 0 | EVP_MD *digest; |
97 | 0 | int r = 0; |
98 | |
|
99 | 0 | if ((digest = EVP_MD_fetch(NULL, SN_sha1, NULL)) != NULL) |
100 | 0 | r = ossl_pkcs5_pbkdf2_hmac_ex(pass, passlen, salt, saltlen, iter, |
101 | 0 | digest, keylen, out, NULL, NULL); |
102 | 0 | EVP_MD_free(digest); |
103 | 0 | return r; |
104 | 0 | } |
105 | | |
106 | | /* |
107 | | * Now the key derivation function itself. This is a bit evil because it has |
108 | | * to check the ASN1 parameters are valid: and there are quite a few of |
109 | | * them... |
110 | | */ |
111 | | |
112 | | int PKCS5_v2_PBE_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, |
113 | | ASN1_TYPE *param, const EVP_CIPHER *c, |
114 | | const EVP_MD *md, int en_de, |
115 | | OSSL_LIB_CTX *libctx, const char *propq) |
116 | 0 | { |
117 | 0 | PBE2PARAM *pbe2 = NULL; |
118 | 0 | char ciph_name[80]; |
119 | 0 | const EVP_CIPHER *cipher = NULL; |
120 | 0 | EVP_CIPHER *cipher_fetch = NULL; |
121 | 0 | EVP_PBE_KEYGEN_EX *kdf; |
122 | |
|
123 | 0 | int rv = 0; |
124 | |
|
125 | 0 | pbe2 = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBE2PARAM), param); |
126 | 0 | if (pbe2 == NULL) { |
127 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR); |
128 | 0 | goto err; |
129 | 0 | } |
130 | | |
131 | | /* See if we recognise the key derivation function */ |
132 | 0 | if (!EVP_PBE_find_ex(EVP_PBE_TYPE_KDF, OBJ_obj2nid(pbe2->keyfunc->algorithm), |
133 | 0 | NULL, NULL, NULL, &kdf)) { |
134 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION); |
135 | 0 | goto err; |
136 | 0 | } |
137 | | |
138 | | /* |
139 | | * lets see if we recognise the encryption algorithm. |
140 | | */ |
141 | 0 | if (OBJ_obj2txt(ciph_name, sizeof(ciph_name), pbe2->encryption->algorithm, 0) <= 0) { |
142 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_CIPHER); |
143 | 0 | goto err; |
144 | 0 | } |
145 | | |
146 | 0 | (void)ERR_set_mark(); |
147 | 0 | cipher = cipher_fetch = EVP_CIPHER_fetch(libctx, ciph_name, propq); |
148 | | /* Fallback to legacy method */ |
149 | 0 | if (cipher == NULL) |
150 | 0 | cipher = EVP_get_cipherbyname(ciph_name); |
151 | |
|
152 | 0 | if (cipher == NULL) { |
153 | 0 | (void)ERR_clear_last_mark(); |
154 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_CIPHER); |
155 | 0 | goto err; |
156 | 0 | } |
157 | 0 | (void)ERR_pop_to_mark(); |
158 | | |
159 | | /* Fixup cipher based on AlgorithmIdentifier */ |
160 | 0 | if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de)) |
161 | 0 | goto err; |
162 | 0 | if (EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) <= 0) { |
163 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_CIPHER_PARAMETER_ERROR); |
164 | 0 | goto err; |
165 | 0 | } |
166 | 0 | rv = kdf(ctx, pass, passlen, pbe2->keyfunc->parameter, NULL, NULL, en_de, libctx, propq); |
167 | 0 | err: |
168 | 0 | EVP_CIPHER_free(cipher_fetch); |
169 | 0 | PBE2PARAM_free(pbe2); |
170 | 0 | return rv; |
171 | 0 | } |
172 | | |
173 | | int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, |
174 | | ASN1_TYPE *param, const EVP_CIPHER *c, |
175 | | const EVP_MD *md, int en_de) |
176 | 0 | { |
177 | 0 | return PKCS5_v2_PBE_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL); |
178 | 0 | } |
179 | | |
180 | | int PKCS5_v2_PBKDF2_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, |
181 | | int passlen, ASN1_TYPE *param, |
182 | | const EVP_CIPHER *c, const EVP_MD *md, int en_de, |
183 | | OSSL_LIB_CTX *libctx, const char *propq) |
184 | 0 | { |
185 | 0 | unsigned char *salt, key[EVP_MAX_KEY_LENGTH]; |
186 | 0 | int saltlen, iter, t; |
187 | 0 | int rv = 0; |
188 | 0 | unsigned int keylen = 0; |
189 | 0 | int prf_nid, hmac_md_nid; |
190 | 0 | PBKDF2PARAM *kdf = NULL; |
191 | 0 | const EVP_MD *prfmd = NULL; |
192 | 0 | EVP_MD *prfmd_fetch = NULL; |
193 | |
|
194 | 0 | if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) { |
195 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET); |
196 | 0 | goto err; |
197 | 0 | } |
198 | 0 | keylen = EVP_CIPHER_CTX_get_key_length(ctx); |
199 | 0 | OPENSSL_assert(keylen <= sizeof(key)); |
200 | | |
201 | | /* Decode parameter */ |
202 | |
|
203 | 0 | kdf = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), param); |
204 | |
|
205 | 0 | if (kdf == NULL) { |
206 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR); |
207 | 0 | goto err; |
208 | 0 | } |
209 | | |
210 | 0 | t = EVP_CIPHER_CTX_get_key_length(ctx); |
211 | 0 | if (t < 0) { |
212 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH); |
213 | 0 | goto err; |
214 | 0 | } |
215 | 0 | keylen = t; |
216 | | |
217 | | /* Now check the parameters of the kdf */ |
218 | |
|
219 | 0 | if (kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)) { |
220 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH); |
221 | 0 | goto err; |
222 | 0 | } |
223 | | |
224 | 0 | if (kdf->prf) |
225 | 0 | prf_nid = OBJ_obj2nid(kdf->prf->algorithm); |
226 | 0 | else |
227 | 0 | prf_nid = NID_hmacWithSHA1; |
228 | |
|
229 | 0 | if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0)) { |
230 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_PRF); |
231 | 0 | goto err; |
232 | 0 | } |
233 | | |
234 | 0 | (void)ERR_set_mark(); |
235 | 0 | prfmd = prfmd_fetch = EVP_MD_fetch(libctx, OBJ_nid2sn(hmac_md_nid), propq); |
236 | 0 | if (prfmd == NULL) |
237 | 0 | prfmd = EVP_get_digestbynid(hmac_md_nid); |
238 | 0 | if (prfmd == NULL) { |
239 | 0 | (void)ERR_clear_last_mark(); |
240 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_PRF); |
241 | 0 | goto err; |
242 | 0 | } |
243 | 0 | (void)ERR_pop_to_mark(); |
244 | |
|
245 | 0 | if (kdf->salt->type != V_ASN1_OCTET_STRING) { |
246 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_SALT_TYPE); |
247 | 0 | goto err; |
248 | 0 | } |
249 | | |
250 | | /* it seems that its all OK */ |
251 | 0 | salt = kdf->salt->value.octet_string->data; |
252 | 0 | saltlen = kdf->salt->value.octet_string->length; |
253 | 0 | iter = ASN1_INTEGER_get(kdf->iter); |
254 | 0 | if (!ossl_pkcs5_pbkdf2_hmac_ex(pass, passlen, salt, saltlen, iter, prfmd, |
255 | 0 | keylen, key, libctx, propq)) |
256 | 0 | goto err; |
257 | 0 | rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de); |
258 | 0 | err: |
259 | 0 | OPENSSL_cleanse(key, keylen); |
260 | 0 | PBKDF2PARAM_free(kdf); |
261 | 0 | EVP_MD_free(prfmd_fetch); |
262 | 0 | return rv; |
263 | 0 | } |
264 | | |
265 | | int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, |
266 | | int passlen, ASN1_TYPE *param, |
267 | | const EVP_CIPHER *c, const EVP_MD *md, int en_de) |
268 | 0 | { |
269 | 0 | return PKCS5_v2_PBKDF2_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, |
270 | 0 | NULL, NULL); |
271 | 0 | } |