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{-
10use OpenSSL::paramnames qw(produce_param_decoder);
11-}
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
30static OSSL_FUNC_kdf_newctx_fn kdf_pkcs12_new;
31static OSSL_FUNC_kdf_dupctx_fn kdf_pkcs12_dup;
32static OSSL_FUNC_kdf_freectx_fn kdf_pkcs12_free;
33static OSSL_FUNC_kdf_reset_fn kdf_pkcs12_reset;
34static OSSL_FUNC_kdf_derive_fn kdf_pkcs12_derive;
35static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_pkcs12_settable_ctx_params;
36static OSSL_FUNC_kdf_set_ctx_params_fn kdf_pkcs12_set_ctx_params;
37static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_pkcs12_gettable_ctx_params;
38static OSSL_FUNC_kdf_get_ctx_params_fn kdf_pkcs12_get_ctx_params;
39
40typedef 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
53static 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{
58    unsigned char *B = NULL, *D = NULL, *I = NULL, *p = NULL, *Ai = NULL;
59    size_t Slen, Plen, Ilen;
60    size_t i, j, k, u, v;
61    uint64_t iter_cnt;
62    int ret = 0, ui, vi;
63    EVP_MD_CTX *ctx = NULL;
64
65    ctx = EVP_MD_CTX_new();
66    if (ctx == NULL) {
67        ERR_raise(ERR_LIB_PROV, ERR_R_EVP_LIB);
68        goto end;
69    }
70    vi = EVP_MD_get_block_size(md_type);
71    ui = EVP_MD_get_size(md_type);
72    if (ui <= 0 || vi <= 0) {
73        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_SIZE);
74        goto end;
75    }
76    u = (size_t)ui;
77    v = (size_t)vi;
78    D = OPENSSL_malloc(v);
79    Ai = OPENSSL_malloc(u);
80    B = OPENSSL_malloc(v + 1);
81    Slen = v * ((saltlen + v - 1) / v);
82    if (passlen != 0)
83        Plen = v * ((passlen + v - 1) / v);
84    else
85        Plen = 0;
86    Ilen = Slen + Plen;
87    I = OPENSSL_malloc(Ilen);
88    if (D == NULL || Ai == NULL || B == NULL || I == NULL)
89        goto end;
90    for (i = 0; i < v; i++)
91        D[i] = id;
92    p = I;
93    for (i = 0; i < Slen; i++)
94        *p++ = salt[i % saltlen];
95    for (i = 0; i < Plen; i++)
96        *p++ = pass[i % passlen];
97    for (;;) {
98        if (!EVP_DigestInit_ex(ctx, md_type, NULL)
99            || !EVP_DigestUpdate(ctx, D, v)
100            || !EVP_DigestUpdate(ctx, I, Ilen)
101            || !EVP_DigestFinal_ex(ctx, Ai, NULL))
102            goto end;
103        for (iter_cnt = 1; iter_cnt < iter; iter_cnt++) {
104            if (!EVP_DigestInit_ex(ctx, md_type, NULL)
105                || !EVP_DigestUpdate(ctx, Ai, u)
106                || !EVP_DigestFinal_ex(ctx, Ai, NULL))
107                goto end;
108        }
109        memcpy(out, Ai, n < u ? n : u);
110        if (u >= n) {
111            ret = 1;
112            break;
113        }
114        n -= u;
115        out += u;
116        for (j = 0; j < v; j++)
117            B[j] = Ai[j % u];
118        for (j = 0; j < Ilen; j += v) {
119            unsigned char *Ij = I + j;
120            uint16_t c = 1;
121
122            /* Work out Ij = Ij + B + 1 */
123            for (k = v; k > 0;) {
124                k--;
125                c += Ij[k] + B[k];
126                Ij[k] = (unsigned char)c;
127                c >>= 8;
128            }
129        }
130    }
131
132 end:
133    OPENSSL_free(Ai);
134    OPENSSL_free(B);
135    OPENSSL_free(D);
136    OPENSSL_free(I);
137    EVP_MD_CTX_free(ctx);
138    return ret;
139}
140
141static void *kdf_pkcs12_new(void *provctx)
142{
143    KDF_PKCS12 *ctx;
144
145    if (!ossl_prov_is_running())
146        return NULL;
147
148    ctx = OPENSSL_zalloc(sizeof(*ctx));
149    if (ctx == NULL)
150        return NULL;
151    ctx->provctx = provctx;
152    return ctx;
153}
154
155static void kdf_pkcs12_cleanup(KDF_PKCS12 *ctx)
156{
157    ossl_prov_digest_reset(&ctx->digest);
158    OPENSSL_free(ctx->salt);
159    OPENSSL_clear_free(ctx->pass, ctx->pass_len);
160    memset(ctx, 0, sizeof(*ctx));
161}
162
163static void kdf_pkcs12_free(void *vctx)
164{
165    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
166
167    if (ctx != NULL) {
168        kdf_pkcs12_cleanup(ctx);
169        OPENSSL_free(ctx);
170    }
171}
172
173static void kdf_pkcs12_reset(void *vctx)
174{
175    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
176    void *provctx = ctx->provctx;
177
178    kdf_pkcs12_cleanup(ctx);
179    ctx->provctx = provctx;
180}
181
182static void *kdf_pkcs12_dup(void *vctx)
183{
184    const KDF_PKCS12 *src = (const KDF_PKCS12 *)vctx;
185    KDF_PKCS12 *dest;
186
187    dest = kdf_pkcs12_new(src->provctx);
188    if (dest != NULL) {
189        if (!ossl_prov_memdup(src->salt, src->salt_len,
190                              &dest->salt, &dest->salt_len)
191                || !ossl_prov_memdup(src->pass, src->pass_len,
192                                     &dest->pass , &dest->pass_len)
193                || !ossl_prov_digest_copy(&dest->digest, &src->digest))
194            goto err;
195        dest->iter = src->iter;
196        dest->id = src->id;
197    }
198    return dest;
199
200 err:
201    kdf_pkcs12_free(dest);
202    return NULL;
203}
204
205static int pkcs12kdf_set_membuf(unsigned char **buffer, size_t *buflen,
206                             const OSSL_PARAM *p)
207{
208    OPENSSL_clear_free(*buffer, *buflen);
209    *buffer = NULL;
210    *buflen = 0;
211
212    if (p->data_size == 0) {
213        if ((*buffer = OPENSSL_malloc(1)) == NULL)
214            return 0;
215    } else if (p->data != NULL) {
216        if (!OSSL_PARAM_get_octet_string(p, (void **)buffer, 0, buflen))
217            return 0;
218    }
219    return 1;
220}
221
222static int kdf_pkcs12_derive(void *vctx, unsigned char *key, size_t keylen,
223                             const OSSL_PARAM params[])
224{
225    KDF_PKCS12 *ctx = (KDF_PKCS12 *)vctx;
226    const EVP_MD *md;
227
228    if (!ossl_prov_is_running() || !kdf_pkcs12_set_ctx_params(ctx, params))
229        return 0;
230
231    if (ctx->pass == NULL) {
232        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_PASS);
233        return 0;
234    }
235
236    if (ctx->salt == NULL) {
237        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SALT);
238        return 0;
239    }
240
241    md = ossl_prov_digest_md(&ctx->digest);
242    return pkcs12kdf_derive(ctx->pass, ctx->pass_len, ctx->salt, ctx->salt_len,
243                            ctx->id, ctx->iter, md, key, keylen);
244}
245
246{- produce_param_decoder('pkcs12_set_ctx_params',
247                         (['KDF_PARAM_PROPERTIES',  'propq',    'utf8_string'],
248                          ['ALG_PARAM_ENGINE',      'engine',   'utf8_string', 'hidden'],
249                          ['KDF_PARAM_DIGEST',      'digest',   'utf8_string'],
250                          ['KDF_PARAM_PASSWORD',    'pw',       'octet_string'],
251                          ['KDF_PARAM_SALT',        'salt',     'octet_string'],
252                          ['KDF_PARAM_ITER',        'iter',     'uint64'],
253                          ['KDF_PARAM_PKCS12_ID',   'p12id',    'int'],
254                         )); -}
255
256static int kdf_pkcs12_set_ctx_params(void *vctx, const OSSL_PARAM params[])
257{
258    struct pkcs12_set_ctx_params_st p;
259    KDF_PKCS12 *ctx = vctx;
260    OSSL_LIB_CTX *provctx;
261
262    if (ctx == NULL || !pkcs12_set_ctx_params_decoder(params, &p))
263        return 0;
264
265    provctx = PROV_LIBCTX_OF(ctx->provctx);
266
267    if (!ossl_prov_digest_load(&ctx->digest, p.digest,
268                               p.propq, p.engine, provctx))
269        return 0;
270
271    if (p.pw != NULL && !pkcs12kdf_set_membuf(&ctx->pass, &ctx->pass_len, p.pw))
272        return 0;
273
274    if (p.salt != NULL
275            && !pkcs12kdf_set_membuf(&ctx->salt, &ctx->salt_len, p.salt))
276        return 0;
277
278    if (p.p12id != NULL && !OSSL_PARAM_get_int(p.p12id, &ctx->id))
279        return 0;
280
281    if (p.iter != NULL && !OSSL_PARAM_get_uint64(p.iter, &ctx->iter))
282        return 0;
283    return 1;
284}
285
286static const OSSL_PARAM *kdf_pkcs12_settable_ctx_params(
287        ossl_unused void *ctx, ossl_unused void *provctx)
288{
289    return pkcs12_set_ctx_params_list;
290}
291
292{- produce_param_decoder('pkcs12_get_ctx_params',
293                         (['KDF_PARAM_SIZE',                    'size', 'size_t'],
294                         )); -}
295
296static int kdf_pkcs12_get_ctx_params(void *vctx, OSSL_PARAM params[])
297{
298    struct pkcs12_get_ctx_params_st p;
299    KDF_PKCS12 *ctx = vctx;
300
301    if (ctx == NULL || !pkcs12_get_ctx_params_decoder(params, &p))
302        return 0;
303
304    if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, SIZE_MAX))
305        return 0;
306    return 1;
307}
308
309static const OSSL_PARAM *kdf_pkcs12_gettable_ctx_params(
310        ossl_unused void *ctx, ossl_unused void *provctx)
311{
312    return pkcs12_get_ctx_params_list;
313}
314
315const 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};
329