Coverage Report

Created: 2026-10-28 06:28

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