/src/openssl30/crypto/asn1/p5_scrypt.c
Line | Count | Source |
1 | | /* |
2 | | * Copyright 2015-2021 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/asn1t.h> |
13 | | #include <openssl/core_names.h> |
14 | | #include <openssl/err.h> |
15 | | #include <openssl/evp.h> |
16 | | #include <openssl/x509.h> |
17 | | #include <openssl/rand.h> |
18 | | #include "crypto/evp.h" |
19 | | |
20 | | #ifndef OPENSSL_NO_SCRYPT |
21 | | /* PKCS#5 scrypt password based encryption structures */ |
22 | | |
23 | | ASN1_SEQUENCE(SCRYPT_PARAMS) = { |
24 | | ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING), |
25 | | ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER), |
26 | | ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER), |
27 | | ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER), |
28 | | ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER), |
29 | 0 | } ASN1_SEQUENCE_END(SCRYPT_PARAMS) |
30 | 0 |
|
31 | 0 | IMPLEMENT_ASN1_FUNCTIONS(SCRYPT_PARAMS) |
32 | 0 |
|
33 | 0 | static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen, |
34 | 0 | size_t keylen, uint64_t N, uint64_t r, |
35 | 0 | uint64_t p); |
36 | 0 |
|
37 | 0 | /* |
38 | 0 | * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt |
39 | 0 | */ |
40 | 0 |
|
41 | 0 | X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher, |
42 | 0 | const unsigned char *salt, int saltlen, |
43 | 0 | unsigned char *aiv, uint64_t N, uint64_t r, |
44 | 0 | uint64_t p) |
45 | 0 | { |
46 | 0 | X509_ALGOR *scheme = NULL, *ret = NULL; |
47 | 0 | int alg_nid, ivlen; |
48 | 0 | size_t keylen = 0; |
49 | 0 | EVP_CIPHER_CTX *ctx = NULL; |
50 | 0 | unsigned char iv[EVP_MAX_IV_LENGTH]; |
51 | 0 | PBE2PARAM *pbe2 = NULL; |
52 | |
|
53 | 0 | if (!cipher) { |
54 | 0 | ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER); |
55 | 0 | goto err; |
56 | 0 | } |
57 | | |
58 | 0 | if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) { |
59 | 0 | ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_SCRYPT_PARAMETERS); |
60 | 0 | goto err; |
61 | 0 | } |
62 | | |
63 | 0 | alg_nid = EVP_CIPHER_get_type(cipher); |
64 | 0 | if (alg_nid == NID_undef) { |
65 | 0 | ERR_raise(ERR_LIB_ASN1, ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER); |
66 | 0 | goto err; |
67 | 0 | } |
68 | | |
69 | 0 | pbe2 = PBE2PARAM_new(); |
70 | 0 | if (pbe2 == NULL) |
71 | 0 | goto merr; |
72 | | |
73 | | /* Setup the AlgorithmIdentifier for the encryption scheme */ |
74 | 0 | scheme = pbe2->encryption; |
75 | |
|
76 | 0 | scheme->algorithm = OBJ_nid2obj(alg_nid); |
77 | 0 | scheme->parameter = ASN1_TYPE_new(); |
78 | 0 | if (scheme->parameter == NULL) |
79 | 0 | goto merr; |
80 | | |
81 | | /* Create random IV */ |
82 | 0 | ivlen = EVP_CIPHER_get_iv_length(cipher); |
83 | 0 | if (ivlen > 0) { |
84 | 0 | if (aiv) |
85 | 0 | memcpy(iv, aiv, ivlen); |
86 | 0 | else if (RAND_bytes(iv, ivlen) <= 0) |
87 | 0 | goto err; |
88 | 0 | } |
89 | | |
90 | 0 | ctx = EVP_CIPHER_CTX_new(); |
91 | 0 | if (ctx == NULL) |
92 | 0 | goto merr; |
93 | | |
94 | | /* Dummy cipherinit to just setup the IV */ |
95 | 0 | if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0) == 0) |
96 | 0 | goto err; |
97 | 0 | if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) { |
98 | 0 | ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS); |
99 | 0 | goto err; |
100 | 0 | } |
101 | 0 | EVP_CIPHER_CTX_free(ctx); |
102 | 0 | ctx = NULL; |
103 | | |
104 | | /* If its RC2 then we'd better setup the key length */ |
105 | |
|
106 | 0 | if (alg_nid == NID_rc2_cbc) |
107 | 0 | keylen = EVP_CIPHER_get_key_length(cipher); |
108 | | |
109 | | /* Setup keyfunc */ |
110 | |
|
111 | 0 | X509_ALGOR_free(pbe2->keyfunc); |
112 | |
|
113 | 0 | pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p); |
114 | |
|
115 | 0 | if (pbe2->keyfunc == NULL) |
116 | 0 | goto merr; |
117 | | |
118 | | /* Now set up top level AlgorithmIdentifier */ |
119 | | |
120 | 0 | ret = X509_ALGOR_new(); |
121 | 0 | if (ret == NULL) |
122 | 0 | goto merr; |
123 | | |
124 | 0 | ret->algorithm = OBJ_nid2obj(NID_pbes2); |
125 | | |
126 | | /* Encode PBE2PARAM into parameter */ |
127 | |
|
128 | 0 | if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2, |
129 | 0 | &ret->parameter) |
130 | 0 | == NULL) |
131 | 0 | goto merr; |
132 | | |
133 | 0 | PBE2PARAM_free(pbe2); |
134 | 0 | pbe2 = NULL; |
135 | |
|
136 | 0 | return ret; |
137 | | |
138 | 0 | merr: |
139 | 0 | ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE); |
140 | |
|
141 | 0 | err: |
142 | 0 | PBE2PARAM_free(pbe2); |
143 | 0 | X509_ALGOR_free(ret); |
144 | 0 | EVP_CIPHER_CTX_free(ctx); |
145 | |
|
146 | 0 | return NULL; |
147 | 0 | } |
148 | | |
149 | | static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen, |
150 | | size_t keylen, uint64_t N, uint64_t r, |
151 | | uint64_t p) |
152 | 0 | { |
153 | 0 | X509_ALGOR *keyfunc = NULL; |
154 | 0 | SCRYPT_PARAMS *sparam = SCRYPT_PARAMS_new(); |
155 | |
|
156 | 0 | if (sparam == NULL) |
157 | 0 | goto merr; |
158 | | |
159 | 0 | if (!saltlen) |
160 | 0 | saltlen = PKCS5_SALT_LEN; |
161 | | |
162 | | /* This will either copy salt or grow the buffer */ |
163 | 0 | if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0) |
164 | 0 | goto merr; |
165 | | |
166 | 0 | if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0) |
167 | 0 | goto err; |
168 | | |
169 | 0 | if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0) |
170 | 0 | goto merr; |
171 | | |
172 | 0 | if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0) |
173 | 0 | goto merr; |
174 | | |
175 | 0 | if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0) |
176 | 0 | goto merr; |
177 | | |
178 | | /* If have a key len set it up */ |
179 | | |
180 | 0 | if (keylen > 0) { |
181 | 0 | sparam->keyLength = ASN1_INTEGER_new(); |
182 | 0 | if (sparam->keyLength == NULL) |
183 | 0 | goto merr; |
184 | 0 | if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0) |
185 | 0 | goto merr; |
186 | 0 | } |
187 | | |
188 | | /* Finally setup the keyfunc structure */ |
189 | | |
190 | 0 | keyfunc = X509_ALGOR_new(); |
191 | 0 | if (keyfunc == NULL) |
192 | 0 | goto merr; |
193 | | |
194 | 0 | keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt); |
195 | | |
196 | | /* Encode SCRYPT_PARAMS into parameter of pbe2 */ |
197 | |
|
198 | 0 | if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam, |
199 | 0 | &keyfunc->parameter) |
200 | 0 | == NULL) |
201 | 0 | goto merr; |
202 | | |
203 | 0 | SCRYPT_PARAMS_free(sparam); |
204 | 0 | return keyfunc; |
205 | | |
206 | 0 | merr: |
207 | 0 | ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE); |
208 | 0 | err: |
209 | 0 | SCRYPT_PARAMS_free(sparam); |
210 | 0 | X509_ALGOR_free(keyfunc); |
211 | 0 | return NULL; |
212 | 0 | } |
213 | | |
214 | | int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, |
215 | | int passlen, ASN1_TYPE *param, |
216 | | const EVP_CIPHER *c, const EVP_MD *md, int en_de, |
217 | | OSSL_LIB_CTX *libctx, const char *propq) |
218 | 0 | { |
219 | 0 | unsigned char *salt, key[EVP_MAX_KEY_LENGTH]; |
220 | 0 | uint64_t p, r, N; |
221 | 0 | size_t saltlen; |
222 | 0 | size_t keylen = 0; |
223 | 0 | int t, rv = 0; |
224 | 0 | SCRYPT_PARAMS *sparam = NULL; |
225 | |
|
226 | 0 | if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) { |
227 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET); |
228 | 0 | goto err; |
229 | 0 | } |
230 | | |
231 | | /* Decode parameter */ |
232 | | |
233 | 0 | sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param); |
234 | |
|
235 | 0 | if (sparam == NULL) { |
236 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR); |
237 | 0 | goto err; |
238 | 0 | } |
239 | | |
240 | 0 | t = EVP_CIPHER_CTX_get_key_length(ctx); |
241 | 0 | if (t < 0) { |
242 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH); |
243 | 0 | goto err; |
244 | 0 | } |
245 | 0 | keylen = t; |
246 | | |
247 | | /* Now check the parameters of sparam */ |
248 | |
|
249 | 0 | if (sparam->keyLength) { |
250 | 0 | uint64_t spkeylen; |
251 | 0 | if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0) |
252 | 0 | || (spkeylen != keylen)) { |
253 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH); |
254 | 0 | goto err; |
255 | 0 | } |
256 | 0 | } |
257 | | /* Check all parameters fit in uint64_t and are acceptable to scrypt */ |
258 | 0 | if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0 |
259 | 0 | || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0 |
260 | 0 | || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0 |
261 | 0 | || EVP_PBE_scrypt_ex(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0, |
262 | 0 | libctx, propq) |
263 | 0 | == 0) { |
264 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_ILLEGAL_SCRYPT_PARAMETERS); |
265 | 0 | goto err; |
266 | 0 | } |
267 | | |
268 | | /* it seems that its all OK */ |
269 | | |
270 | 0 | salt = sparam->salt->data; |
271 | 0 | saltlen = sparam->salt->length; |
272 | 0 | if (EVP_PBE_scrypt_ex(pass, passlen, salt, saltlen, N, r, p, 0, key, |
273 | 0 | keylen, libctx, propq) |
274 | 0 | == 0) |
275 | 0 | goto err; |
276 | 0 | rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de); |
277 | 0 | err: |
278 | 0 | if (keylen) |
279 | 0 | OPENSSL_cleanse(key, keylen); |
280 | 0 | SCRYPT_PARAMS_free(sparam); |
281 | 0 | return rv; |
282 | 0 | } |
283 | | |
284 | | int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, |
285 | | int passlen, ASN1_TYPE *param, |
286 | | const EVP_CIPHER *c, const EVP_MD *md, int en_de) |
287 | 0 | { |
288 | 0 | return PKCS5_v2_scrypt_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL); |
289 | 0 | } |
290 | | |
291 | | #endif /* OPENSSL_NO_SCRYPT */ |