3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
61 #include "internal/cryptlib.h"
62 #include <openssl/asn1t.h>
63 #include <openssl/err.h>
64 #include <openssl/evp.h>
65 #include <openssl/x509.h>
66 #include <openssl/rand.h>
68 #ifndef OPENSSL_NO_SCRYPT
69 /* PKCS#5 scrypt password based encryption structures */
72 ASN1_OCTET_STRING *salt;
73 ASN1_INTEGER *costParameter;
74 ASN1_INTEGER *blockSize;
75 ASN1_INTEGER *parallelizationParameter;
76 ASN1_INTEGER *keyLength;
79 ASN1_SEQUENCE(SCRYPT_PARAMS) = {
80 ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING),
81 ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER),
82 ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER),
83 ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER),
84 ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER),
85 } static_ASN1_SEQUENCE_END(SCRYPT_PARAMS)
87 DECLARE_ASN1_ALLOC_FUNCTIONS(SCRYPT_PARAMS)
88 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(SCRYPT_PARAMS)
90 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
91 size_t keylen, uint64_t N, uint64_t r,
95 * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt
98 X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher,
99 const unsigned char *salt, int saltlen,
100 unsigned char *aiv, uint64_t N, uint64_t r,
103 X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
107 unsigned char iv[EVP_MAX_IV_LENGTH];
108 PBE2PARAM *pbe2 = NULL;
112 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT, ERR_R_PASSED_NULL_PARAMETER);
116 if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
117 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
118 ASN1_R_INVALID_SCRYPT_PARAMETERS);
122 alg_nid = EVP_CIPHER_type(cipher);
123 if (alg_nid == NID_undef) {
124 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
125 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
128 obj = OBJ_nid2obj(alg_nid);
129 pbe2 = PBE2PARAM_new();
133 /* Setup the AlgorithmIdentifier for the encryption scheme */
134 scheme = pbe2->encryption;
136 scheme->algorithm = obj;
137 scheme->parameter = ASN1_TYPE_new();
138 if (scheme->parameter == NULL)
141 /* Create random IV */
142 if (EVP_CIPHER_iv_length(cipher)) {
144 memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
145 else if (RAND_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
149 EVP_CIPHER_CTX_init(&ctx);
151 /* Dummy cipherinit to just setup the IV */
152 if (EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0) == 0)
154 if (EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
155 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
156 ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
157 EVP_CIPHER_CTX_cleanup(&ctx);
160 EVP_CIPHER_CTX_cleanup(&ctx);
162 /* If its RC2 then we'd better setup the key length */
164 if (alg_nid == NID_rc2_cbc)
165 keylen = EVP_CIPHER_key_length(cipher);
169 X509_ALGOR_free(pbe2->keyfunc);
171 pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);
173 if (pbe2->keyfunc == NULL)
176 /* Now set up top level AlgorithmIdentifier */
178 ret = X509_ALGOR_new();
182 ret->algorithm = OBJ_nid2obj(NID_pbes2);
184 /* Encode PBE2PARAM into parameter */
186 if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
187 &ret->parameter) == NULL)
190 PBE2PARAM_free(pbe2);
196 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT, ERR_R_MALLOC_FAILURE);
199 PBE2PARAM_free(pbe2);
200 X509_ALGOR_free(kalg);
201 X509_ALGOR_free(ret);
207 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
208 size_t keylen, uint64_t N, uint64_t r,
211 X509_ALGOR *keyfunc = NULL;
212 SCRYPT_PARAMS *sparam = NULL;
214 sparam = SCRYPT_PARAMS_new();
219 saltlen = PKCS5_SALT_LEN;
221 /* This will either copy salt or grow the buffer */
222 if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0)
225 if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
228 if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0)
231 if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0)
234 if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0)
237 /* If have a key len set it up */
240 sparam->keyLength = ASN1_INTEGER_new();
241 if (sparam->keyLength == NULL)
243 if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0)
247 /* Finally setup the keyfunc structure */
249 keyfunc = X509_ALGOR_new();
253 keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);
255 /* Encode SCRYPT_PARAMS into parameter of pbe2 */
257 if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
258 &keyfunc->parameter) == NULL)
261 SCRYPT_PARAMS_free(sparam);
265 ASN1err(ASN1_F_PKCS5_SCRYPT_SET, ERR_R_MALLOC_FAILURE);
267 SCRYPT_PARAMS_free(sparam);
268 X509_ALGOR_free(keyfunc);
272 int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
273 int passlen, ASN1_TYPE *param,
274 const EVP_CIPHER *c, const EVP_MD *md, int en_de)
276 unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
281 SCRYPT_PARAMS *sparam = NULL;
283 if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
284 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN, EVP_R_NO_CIPHER_SET);
288 /* Decode parameter */
290 sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);
292 if (sparam == NULL) {
293 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN, EVP_R_DECODE_ERROR);
297 keylen = EVP_CIPHER_CTX_key_length(ctx);
299 /* Now check the parameters of sparam */
301 if (sparam->keyLength) {
303 if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
304 || (spkeylen != keylen)) {
305 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN,
306 EVP_R_UNSUPPORTED_KEYLENGTH);
310 /* Check all parameters fit in uint64_t and are acceptable to scrypt */
311 if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
312 || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
313 || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
314 || EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
315 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN,
316 EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
320 /* it seems that its all OK */
322 salt = sparam->salt->data;
323 saltlen = sparam->salt->length;
324 if (EVP_PBE_scrypt(pass, passlen, salt, saltlen, N, r, p, 0, key, keylen)
327 rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
330 OPENSSL_cleanse(key, keylen);
331 SCRYPT_PARAMS_free(sparam);
334 #endif /* OPENSSL_NO_SCRYPT */