/src/openssl31/crypto/asn1/p5_scrypt.c

Source (jump to first uncovered line)
/*
 * Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdio.h>
#include "internal/cryptlib.h"
#include <openssl/asn1t.h>
#include <openssl/core_names.h>
#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/x509.h>
#include <openssl/rand.h>
#include "crypto/evp.h"

#ifndef OPENSSL_NO_SCRYPT
/* PKCS#5 scrypt password based encryption structures */

ASN1_SEQUENCE(SCRYPT_PARAMS) = {
        ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING),
        ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER),
        ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER),
        ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER),
        ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER),
} ASN1_SEQUENCE_END(SCRYPT_PARAMS)

IMPLEMENT_ASN1_FUNCTIONS(SCRYPT_PARAMS)

static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
                                    size_t keylen, uint64_t N, uint64_t r,
                                    uint64_t p);

/*
 * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt
 */

X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher,
                                  const unsigned char *salt, int saltlen,
                                  unsigned char *aiv, uint64_t N, uint64_t r,
                                  uint64_t p)
{
    X509_ALGOR *scheme = NULL, *ret = NULL;
    int alg_nid;
    size_t keylen = 0;
    EVP_CIPHER_CTX *ctx = NULL;
    unsigned char iv[EVP_MAX_IV_LENGTH];
    PBE2PARAM *pbe2 = NULL;

    if (!cipher) {
        ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER);
        goto err;
    }

    if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
        ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_SCRYPT_PARAMETERS);
        goto err;
    }

    alg_nid = EVP_CIPHER_get_type(cipher);
    if (alg_nid == NID_undef) {
        ERR_raise(ERR_LIB_ASN1, ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
        goto err;
    }

    pbe2 = PBE2PARAM_new();
    if (pbe2 == NULL)
        goto merr;

    /* Setup the AlgorithmIdentifier for the encryption scheme */
    scheme = pbe2->encryption;

    scheme->algorithm = OBJ_nid2obj(alg_nid);
    scheme->parameter = ASN1_TYPE_new();
    if (scheme->parameter == NULL)
        goto merr;

    /* Create random IV */
    if (EVP_CIPHER_get_iv_length(cipher)) {
        if (aiv)
            memcpy(iv, aiv, EVP_CIPHER_get_iv_length(cipher));
        else if (RAND_bytes(iv, EVP_CIPHER_get_iv_length(cipher)) <= 0)
            goto err;
    }

    ctx = EVP_CIPHER_CTX_new();
    if (ctx == NULL)
        goto merr;

    /* Dummy cipherinit to just setup the IV */
    if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0) == 0)
        goto err;
    if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) {
        ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
        goto err;
    }
    EVP_CIPHER_CTX_free(ctx);
    ctx = NULL;

    /* If its RC2 then we'd better setup the key length */

    if (alg_nid == NID_rc2_cbc)
        keylen = EVP_CIPHER_get_key_length(cipher);

    /* Setup keyfunc */

    X509_ALGOR_free(pbe2->keyfunc);

    pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);

    if (pbe2->keyfunc == NULL)
        goto merr;

    /* Now set up top level AlgorithmIdentifier */

    ret = X509_ALGOR_new();
    if (ret == NULL)
        goto merr;

    ret->algorithm = OBJ_nid2obj(NID_pbes2);

    /* Encode PBE2PARAM into parameter */

    if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
                                &ret->parameter) == NULL)
        goto merr;

    PBE2PARAM_free(pbe2);
    pbe2 = NULL;

    return ret;

 merr:
    ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);

 err:
    PBE2PARAM_free(pbe2);
    X509_ALGOR_free(ret);
    EVP_CIPHER_CTX_free(ctx);

    return NULL;
}

static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
                                    size_t keylen, uint64_t N, uint64_t r,
                                    uint64_t p)
{
    X509_ALGOR *keyfunc = NULL;
    SCRYPT_PARAMS *sparam = SCRYPT_PARAMS_new();

    if (sparam == NULL)
        goto merr;

    if (!saltlen)
        saltlen = PKCS5_SALT_LEN;

    /* This will either copy salt or grow the buffer */
    if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0)
        goto merr;

    if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
        goto err;

    if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0)
        goto merr;

    if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0)
        goto merr;

    if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0)
        goto merr;

    /* If have a key len set it up */

    if (keylen > 0) {
        sparam->keyLength = ASN1_INTEGER_new();
        if (sparam->keyLength == NULL)
            goto merr;
        if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0)
            goto merr;
    }

    /* Finally setup the keyfunc structure */

    keyfunc = X509_ALGOR_new();
    if (keyfunc == NULL)
        goto merr;

    keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);

    /* Encode SCRYPT_PARAMS into parameter of pbe2 */

    if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
                                &keyfunc->parameter) == NULL)
        goto merr;

    SCRYPT_PARAMS_free(sparam);
    return keyfunc;

 merr:
    ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
 err:
    SCRYPT_PARAMS_free(sparam);
    X509_ALGOR_free(keyfunc);
    return NULL;
}

int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass,
                                int passlen, ASN1_TYPE *param,
                                const EVP_CIPHER *c, const EVP_MD *md, int en_de,
                                OSSL_LIB_CTX *libctx, const char *propq)
{
    unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
    uint64_t p, r, N;
    size_t saltlen;
    size_t keylen = 0;
    int t, rv = 0;
    SCRYPT_PARAMS *sparam = NULL;

    if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
        goto err;
    }

    /* Decode parameter */

    sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);

    if (sparam == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR);
        goto err;
    }

    t = EVP_CIPHER_CTX_get_key_length(ctx);
    if (t < 0) {
        ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH);
        goto err;
    }
    keylen = t;

    /* Now check the parameters of sparam */

    if (sparam->keyLength) {
        uint64_t spkeylen;
        if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
            || (spkeylen != keylen)) {
            ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH);
            goto err;
        }
    }
    /* Check all parameters fit in uint64_t and are acceptable to scrypt */
    if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
        || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
        || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
        || EVP_PBE_scrypt_ex(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0,
                             libctx, propq) == 0) {
        ERR_raise(ERR_LIB_EVP, EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
        goto err;
    }

    /* it seems that its all OK */

    salt = sparam->salt->data;
    saltlen = sparam->salt->length;
    if (EVP_PBE_scrypt_ex(pass, passlen, salt, saltlen, N, r, p, 0, key,
                          keylen, libctx, propq) == 0)
        goto err;
    rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
 err:
    if (keylen)
        OPENSSL_cleanse(key, keylen);
    SCRYPT_PARAMS_free(sparam);
    return rv;
}

int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
                             int passlen, ASN1_TYPE *param,
                             const EVP_CIPHER *c, const EVP_MD *md, int en_de)
{
    return PKCS5_v2_scrypt_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL);
}

#endif /* OPENSSL_NO_SCRYPT */

Coverage Report

Created: 2025-06-13 06:58

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