Coverage Report

Created: 2026-04-01 06:39

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/crypto/asn1/p5_scrypt.c
Line
Count
Source
1
/*
2
 * Copyright 2015-2025 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, int 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
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
72
0
        goto err;
73
0
    }
74
75
    /* Setup the AlgorithmIdentifier for the encryption scheme */
76
0
    scheme = pbe2->encryption;
77
78
0
    scheme->algorithm = OBJ_nid2obj(alg_nid);
79
0
    scheme->parameter = ASN1_TYPE_new();
80
0
    if (scheme->parameter == NULL) {
81
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
82
0
        goto err;
83
0
    }
84
85
    /* Create random IV */
86
0
    ivlen = EVP_CIPHER_get_iv_length(cipher);
87
0
    if (ivlen > 0) {
88
0
        if (aiv)
89
0
            memcpy(iv, aiv, ivlen);
90
0
        else if (RAND_bytes(iv, ivlen) <= 0)
91
0
            goto err;
92
0
    }
93
94
0
    ctx = EVP_CIPHER_CTX_new();
95
0
    if (ctx == NULL) {
96
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_EVP_LIB);
97
0
        goto err;
98
0
    }
99
100
    /* Dummy cipherinit to just setup the IV */
101
0
    if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0) == 0)
102
0
        goto err;
103
0
    if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) {
104
0
        ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
105
0
        goto err;
106
0
    }
107
0
    EVP_CIPHER_CTX_free(ctx);
108
0
    ctx = NULL;
109
110
    /* If its RC2 then we'd better setup the key length */
111
112
0
    if (alg_nid == NID_rc2_cbc)
113
0
        keylen = EVP_CIPHER_get_key_length(cipher);
114
115
    /* Setup keyfunc */
116
117
0
    X509_ALGOR_free(pbe2->keyfunc);
118
119
0
    pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);
120
121
0
    if (pbe2->keyfunc == NULL) {
122
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
123
0
        goto err;
124
0
    }
125
126
    /* Now set up top level AlgorithmIdentifier */
127
128
0
    ret = X509_ALGOR_new();
129
0
    if (ret == NULL) {
130
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
131
0
        goto err;
132
0
    }
133
134
0
    ret->algorithm = OBJ_nid2obj(NID_pbes2);
135
136
    /* Encode PBE2PARAM into parameter */
137
138
0
    if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
139
0
            &ret->parameter)
140
0
        == NULL) {
141
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
142
0
        goto err;
143
0
    }
144
145
0
    PBE2PARAM_free(pbe2);
146
0
    pbe2 = NULL;
147
148
0
    return ret;
149
150
0
err:
151
0
    PBE2PARAM_free(pbe2);
152
0
    X509_ALGOR_free(ret);
153
0
    EVP_CIPHER_CTX_free(ctx);
154
155
0
    return NULL;
156
0
}
157
158
static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, int saltlen,
159
    size_t keylen, uint64_t N, uint64_t r,
160
    uint64_t p)
161
0
{
162
0
    X509_ALGOR *keyfunc = NULL;
163
0
    SCRYPT_PARAMS *sparam = SCRYPT_PARAMS_new();
164
165
0
    if (sparam == NULL) {
166
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
167
0
        goto err;
168
0
    }
169
170
0
    if (!saltlen)
171
0
        saltlen = PKCS5_DEFAULT_PBE2_SALT_LEN;
172
173
    /* This will either copy salt or grow the buffer */
174
0
    if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0) {
175
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
176
0
        goto err;
177
0
    }
178
179
0
    if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
180
0
        goto err;
181
182
0
    if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0) {
183
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
184
0
        goto err;
185
0
    }
186
187
0
    if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0) {
188
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
189
0
        goto err;
190
0
    }
191
192
0
    if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0) {
193
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
194
0
        goto err;
195
0
    }
196
197
    /* If have a key len set it up */
198
199
0
    if (keylen > 0) {
200
0
        sparam->keyLength = ASN1_INTEGER_new();
201
0
        if (sparam->keyLength == NULL) {
202
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
203
0
            goto err;
204
0
        }
205
0
        if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0) {
206
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
207
0
            goto err;
208
0
        }
209
0
    }
210
211
    /* Finally setup the keyfunc structure */
212
213
0
    keyfunc = X509_ALGOR_new();
214
0
    if (keyfunc == NULL) {
215
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
216
0
        goto err;
217
0
    }
218
219
0
    keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);
220
221
    /* Encode SCRYPT_PARAMS into parameter of pbe2 */
222
223
0
    if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
224
0
            &keyfunc->parameter)
225
0
        == NULL) {
226
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
227
0
        goto err;
228
0
    }
229
230
0
    SCRYPT_PARAMS_free(sparam);
231
0
    return keyfunc;
232
233
0
err:
234
0
    SCRYPT_PARAMS_free(sparam);
235
0
    X509_ALGOR_free(keyfunc);
236
0
    return NULL;
237
0
}
238
239
int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass,
240
    int passlen, ASN1_TYPE *param,
241
    const EVP_CIPHER *c, const EVP_MD *md, int en_de,
242
    OSSL_LIB_CTX *libctx, const char *propq)
243
0
{
244
0
    unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
245
0
    uint64_t p, r, N;
246
0
    size_t saltlen;
247
0
    size_t keylen = 0;
248
0
    int t, rv = 0;
249
0
    SCRYPT_PARAMS *sparam = NULL;
250
251
0
    if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) {
252
0
        ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
253
0
        goto err;
254
0
    }
255
256
    /* Decode parameter */
257
258
0
    sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);
259
260
0
    if (sparam == NULL) {
261
0
        ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR);
262
0
        goto err;
263
0
    }
264
265
0
    t = EVP_CIPHER_CTX_get_key_length(ctx);
266
0
    if (t < 0) {
267
0
        ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH);
268
0
        goto err;
269
0
    }
270
0
    keylen = t;
271
272
    /* Now check the parameters of sparam */
273
274
0
    if (sparam->keyLength) {
275
0
        uint64_t spkeylen;
276
0
        if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
277
0
            || (spkeylen != keylen)) {
278
0
            ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH);
279
0
            goto err;
280
0
        }
281
0
    }
282
    /* Check all parameters fit in uint64_t and are acceptable to scrypt */
283
0
    if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
284
0
        || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
285
0
        || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
286
0
        || EVP_PBE_scrypt_ex(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0,
287
0
               libctx, propq)
288
0
            == 0) {
289
0
        ERR_raise(ERR_LIB_EVP, EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
290
0
        goto err;
291
0
    }
292
293
    /* it seems that its all OK */
294
295
0
    salt = sparam->salt->data;
296
0
    saltlen = sparam->salt->length;
297
0
    if (EVP_PBE_scrypt_ex(pass, passlen, salt, saltlen, N, r, p, 0, key,
298
0
            keylen, libctx, propq)
299
0
        == 0)
300
0
        goto err;
301
0
    rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
302
0
err:
303
0
    if (keylen)
304
0
        OPENSSL_cleanse(key, keylen);
305
0
    SCRYPT_PARAMS_free(sparam);
306
0
    return rv;
307
0
}
308
309
int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
310
    int passlen, ASN1_TYPE *param,
311
    const EVP_CIPHER *c, const EVP_MD *md, int en_de)
312
0
{
313
0
    return PKCS5_v2_scrypt_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL);
314
0
}
315
316
#endif /* OPENSSL_NO_SCRYPT */