Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/providers/implementations/kdfs/pkcs12kdf.c
Line
Count
Source
1
/*
2
 * Copyright 1999-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
/* clang-format off */
10
11
/* clang-format on */
12
13
#include <openssl/trace.h>
14
#include <stdlib.h>
15
#include <stdarg.h>
16
#include <string.h>
17
#include <openssl/evp.h>
18
#include <openssl/kdf.h>
19
#include <openssl/core_names.h>
20
#include <openssl/proverr.h>
21
#include "internal/common.h"
22
#include "internal/cryptlib.h"
23
#include "internal/numbers.h"
24
#include "crypto/evp.h"
25
#include "prov/provider_ctx.h"
26
#include "prov/providercommon.h"
27
#include "prov/implementations.h"
28
#include "prov/provider_util.h"
29
30
static OSSL_FUNC_kdf_newctx_fn kdf_pkcs12_new;
31
static OSSL_FUNC_kdf_dupctx_fn kdf_pkcs12_dup;
32
static OSSL_FUNC_kdf_freectx_fn kdf_pkcs12_free;
33
static OSSL_FUNC_kdf_reset_fn kdf_pkcs12_reset;
34
static OSSL_FUNC_kdf_derive_fn kdf_pkcs12_derive;
35
static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_pkcs12_settable_ctx_params;
36
static OSSL_FUNC_kdf_set_ctx_params_fn kdf_pkcs12_set_ctx_params;
37
static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_pkcs12_gettable_ctx_params;
38
static OSSL_FUNC_kdf_get_ctx_params_fn kdf_pkcs12_get_ctx_params;
39
40
typedef struct {
41
    void *provctx;
42
    PROV_DIGEST digest;
43
    unsigned char *pass;
44
    size_t pass_len;
45
    unsigned char *salt;
46
    size_t salt_len;
47
    uint64_t iter;
48
    int id;
49
} KDF_PKCS12;
50
51
/* PKCS12 compatible key/IV generation */
52
53
static int pkcs12kdf_derive(const unsigned char *pass, size_t passlen,
54
    const unsigned char *salt, size_t saltlen,
55
    int id, uint64_t iter, const EVP_MD *md_type,
56
    unsigned char *out, size_t n)
57
503
{
58
503
    unsigned char *B = NULL, *D = NULL, *I = NULL, *p = NULL, *Ai = NULL;
59
503
    size_t Slen, Plen, Ilen;
60
503
    size_t i, j, k, u, v;
61
503
    uint64_t iter_cnt;
62
503
    int ret = 0, ui, vi;
63
503
    EVP_MD_CTX *ctx = NULL;
64
65
503
    ctx = EVP_MD_CTX_new();
66
503
    if (ctx == NULL) {
67
0
        ERR_raise(ERR_LIB_PROV, ERR_R_EVP_LIB);
68
0
        goto end;
69
0
    }
70
503
    vi = EVP_MD_get_block_size(md_type);
71
503
    ui = EVP_MD_get_size(md_type);
72
503
    if (ui <= 0 || vi <= 0) {
73
7
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_SIZE);
74
7
        goto end;
75
7
    }
76
496
    u = (size_t)ui;
77
496
    v = (size_t)vi;
78
496
    D = OPENSSL_malloc(v);
79
496
    Ai = OPENSSL_malloc(u);
80
496
    B = OPENSSL_malloc(v + 1);
81
496
    Slen = v * ((saltlen + v - 1) / v);
82
496
    if (passlen != 0)
83
364
        Plen = v * ((passlen + v - 1) / v);
84
132
    else
85
132
        Plen = 0;
86
496
    Ilen = Slen + Plen;
87
496
    I = OPENSSL_malloc(Ilen);
88
496
    if (D == NULL || Ai == NULL || B == NULL || I == NULL)
89
60
        goto end;
90
40.5k
    for (i = 0; i < v; i++)
91
40.0k
        D[i] = id;
92
436
    p = I;
93
5.72M
    for (i = 0; i < Slen; i++)
94
5.72M
        *p++ = salt[i % saltlen];
95
1.72M
    for (i = 0; i < Plen; i++)
96
1.72M
        *p++ = pass[i % passlen];
97
650
    for (;;) {
98
650
        if (!EVP_DigestInit_ex(ctx, md_type, NULL)
99
650
            || !EVP_DigestUpdate(ctx, D, v)
100
650
            || !EVP_DigestUpdate(ctx, I, Ilen)
101
650
            || !EVP_DigestFinal_ex(ctx, Ai, NULL))
102
0
            goto end;
103
650
        for (iter_cnt = 1; iter_cnt < iter; iter_cnt++) {
104
0
            if (!EVP_DigestInit_ex(ctx, md_type, NULL)
105
0
                || !EVP_DigestUpdate(ctx, Ai, u)
106
0
                || !EVP_DigestFinal_ex(ctx, Ai, NULL))
107
0
                goto end;
108
0
        }
109
650
        memcpy(out, Ai, n < u ? n : u);
110
650
        if (u >= n) {
111
436
            ret = 1;
112
436
            break;
113
436
        }
114
214
        n -= u;
115
214
        out += u;
116
20.2k
        for (j = 0; j < v; j++)
117
20.0k
            B[j] = Ai[j % u];
118
59.0k
        for (j = 0; j < Ilen; j += v) {
119
58.7k
            unsigned char *Ij = I + j;
120
58.7k
            uint16_t c = 1;
121
122
            /* Work out Ij = Ij + B + 1 */
123
6.08M
            for (k = v; k > 0;) {
124
6.02M
                k--;
125
6.02M
                c += Ij[k] + B[k];
126
6.02M
                Ij[k] = (unsigned char)c;
127
6.02M
                c >>= 8;
128
6.02M
            }
129
58.7k
        }
130
214
    }
131
132
503
end:
133
503
    OPENSSL_free(Ai);
134
503
    OPENSSL_free(B);
135
503
    OPENSSL_free(D);
136
503
    OPENSSL_free(I);
137
503
    EVP_MD_CTX_free(ctx);
138
503
    return ret;
139
436
}
140
141
static void *kdf_pkcs12_new(void *provctx)
142
526
{
143
526
    KDF_PKCS12 *ctx;
144
145
526
    if (!ossl_prov_is_running())
146
0
        return NULL;
147
148
526
    ctx = OPENSSL_zalloc(sizeof(*ctx));
149
526
    if (ctx == NULL)
150
0
        return NULL;
151
526
    ctx->provctx = provctx;
152
526
    return ctx;
153
526
}
154
155
static void kdf_pkcs12_cleanup(KDF_PKCS12 *ctx)
156
526
{
157
526
    ossl_prov_digest_reset(&ctx->digest);
158
526
    OPENSSL_free(ctx->salt);
159
526
    OPENSSL_clear_free(ctx->pass, ctx->pass_len);
160
526
    memset(ctx, 0, sizeof(*ctx));
161
526
}
162
163
static void kdf_pkcs12_free(void *vctx)
164
526
{
165
526
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
166
167
526
    if (ctx != NULL) {
168
526
        kdf_pkcs12_cleanup(ctx);
169
526
        OPENSSL_free(ctx);
170
526
    }
171
526
}
172
173
static void kdf_pkcs12_reset(void *vctx)
174
0
{
175
0
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
176
0
    void *provctx = ctx->provctx;
177
178
0
    kdf_pkcs12_cleanup(ctx);
179
0
    ctx->provctx = provctx;
180
0
}
181
182
static void *kdf_pkcs12_dup(void *vctx)
183
0
{
184
0
    const KDF_PKCS12 *src = (const KDF_PKCS12 *)vctx;
185
0
    KDF_PKCS12 *dest;
186
187
0
    dest = kdf_pkcs12_new(src->provctx);
188
0
    if (dest != NULL) {
189
0
        if (!ossl_prov_memdup(src->salt, src->salt_len,
190
0
                &dest->salt, &dest->salt_len)
191
0
            || !ossl_prov_memdup(src->pass, src->pass_len,
192
0
                &dest->pass, &dest->pass_len)
193
0
            || !ossl_prov_digest_copy(&dest->digest, &src->digest))
194
0
            goto err;
195
0
        dest->iter = src->iter;
196
0
        dest->id = src->id;
197
0
    }
198
0
    return dest;
199
200
0
err:
201
0
    kdf_pkcs12_free(dest);
202
0
    return NULL;
203
0
}
204
205
static int pkcs12kdf_set_membuf(unsigned char **buffer, size_t *buflen,
206
    const OSSL_PARAM *p)
207
1.00k
{
208
1.00k
    OPENSSL_clear_free(*buffer, *buflen);
209
1.00k
    *buffer = NULL;
210
1.00k
    *buflen = 0;
211
212
1.00k
    if (p->data_size == 0) {
213
310
        if ((*buffer = OPENSSL_malloc(1)) == NULL)
214
0
            return 0;
215
696
    } else if (p->data != NULL) {
216
696
        if (!OSSL_PARAM_get_octet_string(p, (void **)buffer, 0, buflen))
217
0
            return 0;
218
696
    }
219
1.00k
    return 1;
220
1.00k
}
221
222
static int kdf_pkcs12_derive(void *vctx, unsigned char *key, size_t keylen,
223
    const OSSL_PARAM params[])
224
503
{
225
503
    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
226
503
    const EVP_MD *md;
227
228
503
    if (!ossl_prov_is_running() || !kdf_pkcs12_set_ctx_params(ctx, params))
229
0
        return 0;
230
231
503
    if (ctx->pass == NULL) {
232
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_PASS);
233
0
        return 0;
234
0
    }
235
236
503
    if (ctx->salt == NULL) {
237
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SALT);
238
0
        return 0;
239
0
    }
240
241
503
    md = ossl_prov_digest_md(&ctx->digest);
242
503
    return pkcs12kdf_derive(ctx->pass, ctx->pass_len, ctx->salt, ctx->salt_len,
243
503
        ctx->id, ctx->iter, md, key, keylen);
244
503
}
245
246
/* clang-format off */
247
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
248
#ifndef pkcs12_set_ctx_params_list
249
static const OSSL_PARAM pkcs12_set_ctx_params_list[] = {
250
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
251
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
252
    OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PASSWORD, NULL, 0),
253
    OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
254
    OSSL_PARAM_uint64(OSSL_KDF_PARAM_ITER, NULL),
255
    OSSL_PARAM_int(OSSL_KDF_PARAM_PKCS12_ID, NULL),
256
    OSSL_PARAM_END
257
};
258
#endif
259
260
#ifndef pkcs12_set_ctx_params_st
261
struct pkcs12_set_ctx_params_st {
262
    OSSL_PARAM *digest;
263
    OSSL_PARAM *engine;
264
    OSSL_PARAM *iter;
265
    OSSL_PARAM *p12id;
266
    OSSL_PARAM *propq;
267
    OSSL_PARAM *pw;
268
    OSSL_PARAM *salt;
269
};
270
#endif
271
272
#ifndef pkcs12_set_ctx_params_decoder
273
static int pkcs12_set_ctx_params_decoder
274
    (const OSSL_PARAM *p, struct pkcs12_set_ctx_params_st *r)
275
193
{
276
193
    const char *s;
277
278
193
    memset(r, 0, sizeof(*r));
279
193
    if (p != NULL)
280
686
        for (; (s = p->key) != NULL; p++)
281
588
            switch(s[0]) {
282
0
            default:
283
0
                break;
284
98
            case 'd':
285
98
                if (ossl_likely(strcmp("igest", s + 1) == 0)) {
286
                    /* OSSL_KDF_PARAM_DIGEST */
287
98
                    if (ossl_unlikely(r->digest != NULL)) {
288
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
289
0
                                       "param %s is repeated", s);
290
0
                        return 0;
291
0
                    }
292
98
                    r->digest = (OSSL_PARAM *)p;
293
98
                }
294
98
                break;
295
98
            case 'e':
296
0
                if (ossl_likely(strcmp("ngine", s + 1) == 0)) {
297
                    /* OSSL_ALG_PARAM_ENGINE */
298
0
                    if (ossl_unlikely(r->engine != NULL)) {
299
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
300
0
                                       "param %s is repeated", s);
301
0
                        return 0;
302
0
                    }
303
0
                    r->engine = (OSSL_PARAM *)p;
304
0
                }
305
0
                break;
306
196
            case 'i':
307
196
                switch(s[1]) {
308
0
                default:
309
0
                    break;
310
98
                case 'd':
311
98
                    switch(s[2]) {
312
0
                    default:
313
0
                        break;
314
98
                    case '\0':
315
98
                        if (ossl_unlikely(r->p12id != NULL)) {
316
0
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
317
0
                                           "param %s is repeated", s);
318
0
                            return 0;
319
0
                        }
320
98
                        r->p12id = (OSSL_PARAM *)p;
321
98
                    }
322
98
                    break;
323
98
                case 't':
324
98
                    if (ossl_likely(strcmp("er", s + 2) == 0)) {
325
                        /* OSSL_KDF_PARAM_ITER */
326
98
                        if (ossl_unlikely(r->iter != NULL)) {
327
0
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
328
0
                                           "param %s is repeated", s);
329
0
                            return 0;
330
0
                        }
331
98
                        r->iter = (OSSL_PARAM *)p;
332
98
                    }
333
196
                }
334
196
                break;
335
196
            case 'p':
336
196
                switch(s[1]) {
337
0
                default:
338
0
                    break;
339
98
                case 'a':
340
98
                    if (ossl_likely(strcmp("ss", s + 2) == 0)) {
341
                        /* OSSL_KDF_PARAM_PASSWORD */
342
98
                        if (ossl_unlikely(r->pw != NULL)) {
343
0
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
344
0
                                           "param %s is repeated", s);
345
0
                            return 0;
346
0
                        }
347
98
                        r->pw = (OSSL_PARAM *)p;
348
98
                    }
349
98
                    break;
350
98
                case 'r':
351
98
                    if (ossl_likely(strcmp("operties", s + 2) == 0)) {
352
                        /* OSSL_KDF_PARAM_PROPERTIES */
353
98
                        if (ossl_unlikely(r->propq != NULL)) {
354
0
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
355
0
                                           "param %s is repeated", s);
356
0
                            return 0;
357
0
                        }
358
98
                        r->propq = (OSSL_PARAM *)p;
359
98
                    }
360
196
                }
361
196
                break;
362
196
            case 's':
363
98
                if (ossl_likely(strcmp("alt", s + 1) == 0)) {
364
                    /* OSSL_KDF_PARAM_SALT */
365
98
                    if (ossl_unlikely(r->salt != NULL)) {
366
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
367
0
                                       "param %s is repeated", s);
368
0
                        return 0;
369
0
                    }
370
98
                    r->salt = (OSSL_PARAM *)p;
371
98
                }
372
588
            }
373
193
    return 1;
374
193
}
375
#endif
376
/* End of machine generated */
377
/* clang-format on */
378
379
static int kdf_pkcs12_set_ctx_params(void *vctx, const OSSL_PARAM params[])
380
545
{
381
545
    struct pkcs12_set_ctx_params_st p;
382
545
    KDF_PKCS12 *ctx = vctx;
383
545
    OSSL_LIB_CTX *provctx;
384
385
545
    if (ctx == NULL || !pkcs12_set_ctx_params_decoder(params, &p))
386
0
        return 0;
387
388
545
    provctx = PROV_LIBCTX_OF(ctx->provctx);
389
390
545
    if (!ossl_prov_digest_load(&ctx->digest, p.digest,
391
545
            p.propq, p.engine, provctx))
392
15
        return 0;
393
394
530
    if (p.pw != NULL && !pkcs12kdf_set_membuf(&ctx->pass, &ctx->pass_len, p.pw))
395
0
        return 0;
396
397
530
    if (p.salt != NULL
398
265
        && !pkcs12kdf_set_membuf(&ctx->salt, &ctx->salt_len, p.salt))
399
0
        return 0;
400
401
530
    if (p.p12id != NULL && !OSSL_PARAM_get_int(p.p12id, &ctx->id))
402
0
        return 0;
403
404
530
    if (p.iter != NULL && !OSSL_PARAM_get_uint64(p.iter, &ctx->iter))
405
0
        return 0;
406
530
    return 1;
407
530
}
408
409
static const OSSL_PARAM *kdf_pkcs12_settable_ctx_params(
410
    ossl_unused void *ctx, ossl_unused void *provctx)
411
526
{
412
526
    return pkcs12_set_ctx_params_list;
413
526
}
414
415
/* clang-format off */
416
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
417
#ifndef pkcs12_get_ctx_params_list
418
static const OSSL_PARAM pkcs12_get_ctx_params_list[] = {
419
    OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
420
    OSSL_PARAM_END
421
};
422
#endif
423
424
#ifndef pkcs12_get_ctx_params_st
425
struct pkcs12_get_ctx_params_st {
426
    OSSL_PARAM *size;
427
};
428
#endif
429
430
#ifndef pkcs12_get_ctx_params_decoder
431
static int pkcs12_get_ctx_params_decoder
432
    (const OSSL_PARAM *p, struct pkcs12_get_ctx_params_st *r)
433
0
{
434
0
    const char *s;
435
436
0
    memset(r, 0, sizeof(*r));
437
0
    if (p != NULL)
438
0
        for (; (s = p->key) != NULL; p++)
439
0
            if (ossl_likely(strcmp("size", s + 0) == 0)) {
440
                /* OSSL_KDF_PARAM_SIZE */
441
0
                if (ossl_unlikely(r->size != NULL)) {
442
0
                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
443
0
                                   "param %s is repeated", s);
444
0
                    return 0;
445
0
                }
446
0
                r->size = (OSSL_PARAM *)p;
447
0
            }
448
0
    return 1;
449
0
}
450
#endif
451
/* End of machine generated */
452
/* clang-format on */
453
454
static int kdf_pkcs12_get_ctx_params(void *vctx, OSSL_PARAM params[])
455
0
{
456
0
    struct pkcs12_get_ctx_params_st p;
457
0
    KDF_PKCS12 *ctx = vctx;
458
459
0
    if (ctx == NULL || !pkcs12_get_ctx_params_decoder(params, &p))
460
0
        return 0;
461
462
0
    if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, SIZE_MAX))
463
0
        return 0;
464
0
    return 1;
465
0
}
466
467
static const OSSL_PARAM *kdf_pkcs12_gettable_ctx_params(
468
    ossl_unused void *ctx, ossl_unused void *provctx)
469
0
{
470
0
    return pkcs12_get_ctx_params_list;
471
0
}
472
473
const OSSL_DISPATCH ossl_kdf_pkcs12_functions[] = {
474
    { OSSL_FUNC_KDF_NEWCTX, (void (*)(void))kdf_pkcs12_new },
475
    { OSSL_FUNC_KDF_DUPCTX, (void (*)(void))kdf_pkcs12_dup },
476
    { OSSL_FUNC_KDF_FREECTX, (void (*)(void))kdf_pkcs12_free },
477
    { OSSL_FUNC_KDF_RESET, (void (*)(void))kdf_pkcs12_reset },
478
    { OSSL_FUNC_KDF_DERIVE, (void (*)(void))kdf_pkcs12_derive },
479
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
480
        (void (*)(void))kdf_pkcs12_settable_ctx_params },
481
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void (*)(void))kdf_pkcs12_set_ctx_params },
482
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
483
        (void (*)(void))kdf_pkcs12_gettable_ctx_params },
484
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void (*)(void))kdf_pkcs12_get_ctx_params },
485
    OSSL_DISPATCH_END
486
};