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 /* PKCS#5 scrypt password based encryption structures */
71 ASN1_OCTET_STRING *salt;
72 ASN1_INTEGER *costParameter;
73 ASN1_INTEGER *blockSize;
74 ASN1_INTEGER *parallelizationParameter;
75 ASN1_INTEGER *keyLength;
78 ASN1_SEQUENCE(SCRYPT_PARAMS) = {
79 ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING),
80 ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER),
81 ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER),
82 ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER),
83 ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER),
84 } ASN1_SEQUENCE_END(SCRYPT_PARAMS)
86 DECLARE_ASN1_ALLOC_FUNCTIONS(SCRYPT_PARAMS)
87 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(SCRYPT_PARAMS)
89 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
90 size_t keylen, uint64_t N, uint64_t r,
94 * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt
97 X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher,
98 const unsigned char *salt, int saltlen,
99 unsigned char *aiv, uint64_t N, uint64_t r,
102 X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
106 unsigned char iv[EVP_MAX_IV_LENGTH];
107 PBE2PARAM *pbe2 = NULL;
111 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT, ERR_R_PASSED_NULL_PARAMETER);
115 if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
116 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
117 ASN1_R_INVALID_SCRYPT_PARAMETERS);
121 alg_nid = EVP_CIPHER_type(cipher);
122 if (alg_nid == NID_undef) {
123 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
124 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
127 obj = OBJ_nid2obj(alg_nid);
128 pbe2 = PBE2PARAM_new();
132 /* Setup the AlgorithmIdentifier for the encryption scheme */
133 scheme = pbe2->encryption;
135 scheme->algorithm = obj;
136 scheme->parameter = ASN1_TYPE_new();
137 if (scheme->parameter == NULL)
140 /* Create random IV */
141 if (EVP_CIPHER_iv_length(cipher)) {
143 memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
144 else if (RAND_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
148 EVP_CIPHER_CTX_init(&ctx);
150 /* Dummy cipherinit to just setup the IV */
151 if (EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0) == 0)
153 if (EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
154 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT,
155 ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
156 EVP_CIPHER_CTX_cleanup(&ctx);
159 EVP_CIPHER_CTX_cleanup(&ctx);
161 /* If its RC2 then we'd better setup the key length */
163 if (alg_nid == NID_rc2_cbc)
164 keylen = EVP_CIPHER_key_length(cipher);
168 X509_ALGOR_free(pbe2->keyfunc);
170 pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);
172 if (pbe2->keyfunc == NULL)
175 /* Now set up top level AlgorithmIdentifier */
177 ret = X509_ALGOR_new();
181 ret->algorithm = OBJ_nid2obj(NID_pbes2);
183 /* Encode PBE2PARAM into parameter */
185 if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
186 &ret->parameter) == NULL)
189 PBE2PARAM_free(pbe2);
195 ASN1err(ASN1_F_PKCS5_PBE2_SET_SCRYPT, ERR_R_MALLOC_FAILURE);
198 PBE2PARAM_free(pbe2);
199 X509_ALGOR_free(kalg);
200 X509_ALGOR_free(ret);
206 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
207 size_t keylen, uint64_t N, uint64_t r,
210 X509_ALGOR *keyfunc = NULL;
211 SCRYPT_PARAMS *sparam = NULL;
213 sparam = SCRYPT_PARAMS_new();
218 saltlen = PKCS5_SALT_LEN;
220 /* This will either copy salt or grow the buffer */
221 if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0)
224 if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
227 if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0)
230 if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0)
233 if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0)
236 /* If have a key len set it up */
239 sparam->keyLength = ASN1_INTEGER_new();
240 if (sparam->keyLength == NULL)
242 if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0)
246 /* Finally setup the keyfunc structure */
248 keyfunc = X509_ALGOR_new();
252 keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);
254 /* Encode SCRYPT_PARAMS into parameter of pbe2 */
256 if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
257 &keyfunc->parameter) == NULL)
260 SCRYPT_PARAMS_free(sparam);
264 ASN1err(ASN1_F_PKCS5_SCRYPT_SET, ERR_R_MALLOC_FAILURE);
266 SCRYPT_PARAMS_free(sparam);
267 X509_ALGOR_free(keyfunc);
271 int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
272 int passlen, ASN1_TYPE *param,
273 const EVP_CIPHER *c, const EVP_MD *md, int en_de)
275 unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
280 SCRYPT_PARAMS *sparam = NULL;
282 if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
283 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN, EVP_R_NO_CIPHER_SET);
287 /* Decode parameter */
289 sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);
291 if (sparam == NULL) {
292 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN, EVP_R_DECODE_ERROR);
296 keylen = EVP_CIPHER_CTX_key_length(ctx);
298 /* Now check the parameters of sparam */
300 if (sparam->keyLength) {
302 if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
303 || (spkeylen != keylen)) {
304 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN,
305 EVP_R_UNSUPPORTED_KEYLENGTH);
309 /* Check all parameters fit in uint64_t and are acceptable to scrypt */
310 if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
311 || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
312 || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
313 || EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
314 EVPerr(EVP_F_PKCS5_V2_SCRYPT_KEYIVGEN,
315 EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
319 /* it seems that its all OK */
321 salt = sparam->salt->data;
322 saltlen = sparam->salt->length;
323 if (EVP_PBE_scrypt(pass, passlen, salt, saltlen, N, r, p, 0, key, keylen)
326 rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
329 OPENSSL_cleanse(key, keylen);
330 SCRYPT_PARAMS_free(sparam);