Coverage Report

Created: 2025-08-25 06:30

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