Coverage Report

Created: 2026-04-01 06:39

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl33/providers/implementations/kdfs/pkcs12kdf.c
Line
Count
Source
1
/*
2
 * Copyright 1999-2023 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 <openssl/trace.h>
11
#include <stdlib.h>
12
#include <stdarg.h>
13
#include <string.h>
14
#include <openssl/evp.h>
15
#include <openssl/kdf.h>
16
#include <openssl/core_names.h>
17
#include <openssl/proverr.h>
18
#include "internal/cryptlib.h"
19
#include "internal/numbers.h"
20
#include "crypto/evp.h"
21
#include "prov/provider_ctx.h"
22
#include "prov/providercommon.h"
23
#include "prov/implementations.h"
24
#include "prov/provider_util.h"
25
26
static OSSL_FUNC_kdf_newctx_fn kdf_pkcs12_new;
27
static OSSL_FUNC_kdf_dupctx_fn kdf_pkcs12_dup;
28
static OSSL_FUNC_kdf_freectx_fn kdf_pkcs12_free;
29
static OSSL_FUNC_kdf_reset_fn kdf_pkcs12_reset;
30
static OSSL_FUNC_kdf_derive_fn kdf_pkcs12_derive;
31
static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_pkcs12_settable_ctx_params;
32
static OSSL_FUNC_kdf_set_ctx_params_fn kdf_pkcs12_set_ctx_params;
33
static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_pkcs12_gettable_ctx_params;
34
static OSSL_FUNC_kdf_get_ctx_params_fn kdf_pkcs12_get_ctx_params;
35
36
typedef struct {
37
    void *provctx;
38
    PROV_DIGEST digest;
39
    unsigned char *pass;
40
    size_t pass_len;
41
    unsigned char *salt;
42
    size_t salt_len;
43
    uint64_t iter;
44
    int id;
45
} KDF_PKCS12;
46
47
/* PKCS12 compatible key/IV generation */
48
49
static int pkcs12kdf_derive(const unsigned char *pass, size_t passlen,
50
    const unsigned char *salt, size_t saltlen,
51
    int id, uint64_t iter, const EVP_MD *md_type,
52
    unsigned char *out, size_t n)
53
1.89k
{
54
1.89k
    unsigned char *B = NULL, *D = NULL, *I = NULL, *p = NULL, *Ai = NULL;
55
1.89k
    size_t Slen, Plen, Ilen;
56
1.89k
    size_t i, j, k, u, v;
57
1.89k
    uint64_t iter_cnt;
58
1.89k
    int ret = 0, ui, vi;
59
1.89k
    EVP_MD_CTX *ctx = NULL;
60
61
1.89k
    ctx = EVP_MD_CTX_new();
62
1.89k
    if (ctx == NULL) {
63
0
        ERR_raise(ERR_LIB_PROV, ERR_R_EVP_LIB);
64
0
        goto end;
65
0
    }
66
1.89k
    vi = EVP_MD_get_block_size(md_type);
67
1.89k
    ui = EVP_MD_get_size(md_type);
68
1.89k
    if (ui <= 0 || vi <= 0) {
69
7
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_SIZE);
70
7
        goto end;
71
7
    }
72
1.88k
    u = (size_t)ui;
73
1.88k
    v = (size_t)vi;
74
1.88k
    D = OPENSSL_malloc(v);
75
1.88k
    Ai = OPENSSL_malloc(u);
76
1.88k
    B = OPENSSL_malloc(v + 1);
77
1.88k
    Slen = v * ((saltlen + v - 1) / v);
78
1.88k
    if (passlen != 0)
79
1.04k
        Plen = v * ((passlen + v - 1) / v);
80
838
    else
81
838
        Plen = 0;
82
1.88k
    Ilen = Slen + Plen;
83
1.88k
    I = OPENSSL_malloc(Ilen);
84
1.88k
    if (D == NULL || Ai == NULL || B == NULL || I == NULL)
85
245
        goto end;
86
149k
    for (i = 0; i < v; i++)
87
147k
        D[i] = id;
88
1.64k
    p = I;
89
14.4M
    for (i = 0; i < Slen; i++)
90
14.4M
        *p++ = salt[i % saltlen];
91
3.33M
    for (i = 0; i < Plen; i++)
92
3.33M
        *p++ = pass[i % passlen];
93
1.88k
    for (;;) {
94
1.88k
        if (!EVP_DigestInit_ex(ctx, md_type, NULL)
95
1.88k
            || !EVP_DigestUpdate(ctx, D, v)
96
1.88k
            || !EVP_DigestUpdate(ctx, I, Ilen)
97
1.88k
            || !EVP_DigestFinal_ex(ctx, Ai, NULL))
98
0
            goto end;
99
76.9k
        for (iter_cnt = 1; iter_cnt < iter; iter_cnt++) {
100
75.0k
            if (!EVP_DigestInit_ex(ctx, md_type, NULL)
101
75.0k
                || !EVP_DigestUpdate(ctx, Ai, u)
102
75.0k
                || !EVP_DigestFinal_ex(ctx, Ai, NULL))
103
0
                goto end;
104
75.0k
        }
105
1.88k
        memcpy(out, Ai, n < u ? n : u);
106
1.88k
        if (u >= n) {
107
1.64k
            ret = 1;
108
1.64k
            break;
109
1.64k
        }
110
242
        n -= u;
111
242
        out += u;
112
22.7k
        for (j = 0; j < v; j++)
113
22.4k
            B[j] = Ai[j % u];
114
106k
        for (j = 0; j < Ilen; j += v) {
115
106k
            unsigned char *Ij = I + j;
116
106k
            uint16_t c = 1;
117
118
            /* Work out Ij = Ij + B + 1 */
119
12.4M
            for (k = v; k > 0;) {
120
12.3M
                k--;
121
12.3M
                c += Ij[k] + B[k];
122
12.3M
                Ij[k] = (unsigned char)c;
123
12.3M
                c >>= 8;
124
12.3M
            }
125
106k
        }
126
242
    }
127
128
1.89k
end:
129
1.89k
    OPENSSL_free(Ai);
130
1.89k
    OPENSSL_free(B);
131
1.89k
    OPENSSL_free(D);
132
1.89k
    OPENSSL_free(I);
133
1.89k
    EVP_MD_CTX_free(ctx);
134
1.89k
    return ret;
135
1.64k
}
136
137
static void *kdf_pkcs12_new(void *provctx)
138
2.11k
{
139
2.11k
    KDF_PKCS12 *ctx;
140
141
2.11k
    if (!ossl_prov_is_running())
142
0
        return NULL;
143
144
2.11k
    ctx = OPENSSL_zalloc(sizeof(*ctx));
145
2.11k
    if (ctx == NULL)
146
0
        return NULL;
147
2.11k
    ctx->provctx = provctx;
148
2.11k
    return ctx;
149
2.11k
}
150
151
static void kdf_pkcs12_cleanup(KDF_PKCS12 *ctx)
152
2.11k
{
153
2.11k
    ossl_prov_digest_reset(&ctx->digest);
154
2.11k
    OPENSSL_free(ctx->salt);
155
2.11k
    OPENSSL_clear_free(ctx->pass, ctx->pass_len);
156
2.11k
    memset(ctx, 0, sizeof(*ctx));
157
2.11k
}
158
159
static void kdf_pkcs12_free(void *vctx)
160
2.11k
{
161
2.11k
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
162
163
2.11k
    if (ctx != NULL) {
164
2.11k
        kdf_pkcs12_cleanup(ctx);
165
2.11k
        OPENSSL_free(ctx);
166
2.11k
    }
167
2.11k
}
168
169
static void kdf_pkcs12_reset(void *vctx)
170
0
{
171
0
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
172
0
    void *provctx = ctx->provctx;
173
174
0
    kdf_pkcs12_cleanup(ctx);
175
0
    ctx->provctx = provctx;
176
0
}
177
178
static void *kdf_pkcs12_dup(void *vctx)
179
0
{
180
0
    const KDF_PKCS12 *src = (const KDF_PKCS12 *)vctx;
181
0
    KDF_PKCS12 *dest;
182
183
0
    dest = kdf_pkcs12_new(src->provctx);
184
0
    if (dest != NULL) {
185
0
        if (!ossl_prov_memdup(src->salt, src->salt_len,
186
0
                &dest->salt, &dest->salt_len)
187
0
            || !ossl_prov_memdup(src->pass, src->pass_len,
188
0
                &dest->pass, &dest->pass_len)
189
0
            || !ossl_prov_digest_copy(&dest->digest, &src->digest))
190
0
            goto err;
191
0
        dest->iter = src->iter;
192
0
        dest->id = src->id;
193
0
    }
194
0
    return dest;
195
196
0
err:
197
0
    kdf_pkcs12_free(dest);
198
0
    return NULL;
199
0
}
200
201
static int pkcs12kdf_set_membuf(unsigned char **buffer, size_t *buflen,
202
    const OSSL_PARAM *p)
203
4.20k
{
204
4.20k
    OPENSSL_clear_free(*buffer, *buflen);
205
4.20k
    *buffer = NULL;
206
4.20k
    *buflen = 0;
207
208
4.20k
    if (p->data_size == 0) {
209
1.53k
        if ((*buffer = OPENSSL_malloc(1)) == NULL)
210
0
            return 0;
211
2.66k
    } else if (p->data != NULL) {
212
2.66k
        if (!OSSL_PARAM_get_octet_string(p, (void **)buffer, 0, buflen))
213
0
            return 0;
214
2.66k
    }
215
4.20k
    return 1;
216
4.20k
}
217
218
static int kdf_pkcs12_derive(void *vctx, unsigned char *key, size_t keylen,
219
    const OSSL_PARAM params[])
220
2.10k
{
221
2.10k
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
222
2.10k
    const EVP_MD *md;
223
224
2.10k
    if (!ossl_prov_is_running() || !kdf_pkcs12_set_ctx_params(ctx, params))
225
212
        return 0;
226
227
1.89k
    if (ctx->pass == NULL) {
228
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_PASS);
229
0
        return 0;
230
0
    }
231
232
1.89k
    if (ctx->salt == NULL) {
233
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SALT);
234
0
        return 0;
235
0
    }
236
237
1.89k
    md = ossl_prov_digest_md(&ctx->digest);
238
1.89k
    return pkcs12kdf_derive(ctx->pass, ctx->pass_len, ctx->salt, ctx->salt_len,
239
1.89k
        ctx->id, ctx->iter, md, key, keylen);
240
1.89k
}
241
242
static int kdf_pkcs12_set_ctx_params(void *vctx, const OSSL_PARAM params[])
243
221
{
244
221
    const OSSL_PARAM *p;
245
221
    KDF_PKCS12 *ctx = vctx;
246
221
    OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
247
248
221
    if (params == NULL)
249
108
        return 1;
250
251
113
    if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
252
5
        return 0;
253
254
108
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PASSWORD)) != NULL)
255
108
        if (!pkcs12kdf_set_membuf(&ctx->pass, &ctx->pass_len, p))
256
0
            return 0;
257
258
108
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL)
259
108
        if (!pkcs12kdf_set_membuf(&ctx->salt, &ctx->salt_len, p))
260
0
            return 0;
261
262
108
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PKCS12_ID)) != NULL)
263
108
        if (!OSSL_PARAM_get_int(p, &ctx->id))
264
0
            return 0;
265
266
108
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_ITER)) != NULL)
267
108
        if (!OSSL_PARAM_get_uint64(p, &ctx->iter))
268
0
            return 0;
269
108
#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
270
    /*
271
     * If we're running the fuzzer, limit iteration count to
272
     * 100 so we don't time out running the derivation for
273
     * a really long time
274
     */
275
108
    if (getenv("OPENSSL_RUNNING_UNIT_TESTS") == NULL && p != NULL && ctx->iter > 100)
276
0
        ctx->iter = 100;
277
108
#endif
278
108
    return 1;
279
108
}
280
281
static const OSSL_PARAM *kdf_pkcs12_settable_ctx_params(
282
    ossl_unused void *ctx, ossl_unused void *provctx)
283
466
{
284
466
    static const OSSL_PARAM known_settable_ctx_params[] = {
285
466
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
286
466
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
287
466
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PASSWORD, NULL, 0),
288
466
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
289
466
        OSSL_PARAM_uint64(OSSL_KDF_PARAM_ITER, NULL),
290
466
        OSSL_PARAM_int(OSSL_KDF_PARAM_PKCS12_ID, NULL),
291
466
        OSSL_PARAM_END
292
466
    };
293
466
    return known_settable_ctx_params;
294
466
}
295
296
static int kdf_pkcs12_get_ctx_params(void *vctx, OSSL_PARAM params[])
297
0
{
298
0
    OSSL_PARAM *p;
299
300
0
    if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
301
0
        return OSSL_PARAM_set_size_t(p, SIZE_MAX);
302
0
    return -2;
303
0
}
304
305
static const OSSL_PARAM *kdf_pkcs12_gettable_ctx_params(
306
    ossl_unused void *ctx, ossl_unused void *provctx)
307
0
{
308
0
    static const OSSL_PARAM known_gettable_ctx_params[] = {
309
0
        OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
310
        OSSL_PARAM_END
311
0
    };
312
0
    return known_gettable_ctx_params;
313
0
}
314
315
const OSSL_DISPATCH ossl_kdf_pkcs12_functions[] = {
316
    { OSSL_FUNC_KDF_NEWCTX, (void (*)(void))kdf_pkcs12_new },
317
    { OSSL_FUNC_KDF_DUPCTX, (void (*)(void))kdf_pkcs12_dup },
318
    { OSSL_FUNC_KDF_FREECTX, (void (*)(void))kdf_pkcs12_free },
319
    { OSSL_FUNC_KDF_RESET, (void (*)(void))kdf_pkcs12_reset },
320
    { OSSL_FUNC_KDF_DERIVE, (void (*)(void))kdf_pkcs12_derive },
321
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
322
        (void (*)(void))kdf_pkcs12_settable_ctx_params },
323
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void (*)(void))kdf_pkcs12_set_ctx_params },
324
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
325
        (void (*)(void))kdf_pkcs12_gettable_ctx_params },
326
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void (*)(void))kdf_pkcs12_get_ctx_params },
327
    OSSL_DISPATCH_END
328
};