1*e7be843bSPierre Pronchery /*
2*e7be843bSPierre Pronchery * Copyright 2018-2023 The OpenSSL Project Authors. All Rights Reserved.
3*e7be843bSPierre Pronchery *
4*e7be843bSPierre Pronchery * Licensed under the Apache License 2.0 (the "License"). You may not use
5*e7be843bSPierre Pronchery * this file except in compliance with the License. You can obtain a copy
6*e7be843bSPierre Pronchery * in the file LICENSE in the source distribution or at
7*e7be843bSPierre Pronchery * https://www.openssl.org/source/license.html
8*e7be843bSPierre Pronchery */
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #include <openssl/evp.h>
11*e7be843bSPierre Pronchery #include <openssl/core_names.h>
12*e7be843bSPierre Pronchery #include <openssl/proverr.h>
13*e7be843bSPierre Pronchery #include <openssl/err.h>
14*e7be843bSPierre Pronchery #include "internal/numbers.h" /* SIZE_MAX */
15*e7be843bSPierre Pronchery #include "prov/provider_ctx.h"
16*e7be843bSPierre Pronchery #include "prov/providercommon.h"
17*e7be843bSPierre Pronchery #include "prov/implementations.h"
18*e7be843bSPierre Pronchery #include "prov/provider_util.h"
19*e7be843bSPierre Pronchery
20*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_newctx_fn kdf_pvk_new;
21*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_dupctx_fn kdf_pvk_dup;
22*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_freectx_fn kdf_pvk_free;
23*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_reset_fn kdf_pvk_reset;
24*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_derive_fn kdf_pvk_derive;
25*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_pvk_settable_ctx_params;
26*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_set_ctx_params_fn kdf_pvk_set_ctx_params;
27*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_pvk_gettable_ctx_params;
28*e7be843bSPierre Pronchery static OSSL_FUNC_kdf_get_ctx_params_fn kdf_pvk_get_ctx_params;
29*e7be843bSPierre Pronchery
30*e7be843bSPierre Pronchery typedef struct {
31*e7be843bSPierre Pronchery void *provctx;
32*e7be843bSPierre Pronchery unsigned char *pass;
33*e7be843bSPierre Pronchery size_t pass_len;
34*e7be843bSPierre Pronchery unsigned char *salt;
35*e7be843bSPierre Pronchery size_t salt_len;
36*e7be843bSPierre Pronchery PROV_DIGEST digest;
37*e7be843bSPierre Pronchery } KDF_PVK;
38*e7be843bSPierre Pronchery
39*e7be843bSPierre Pronchery static void kdf_pvk_init(KDF_PVK *ctx);
40*e7be843bSPierre Pronchery
kdf_pvk_new(void * provctx)41*e7be843bSPierre Pronchery static void *kdf_pvk_new(void *provctx)
42*e7be843bSPierre Pronchery {
43*e7be843bSPierre Pronchery KDF_PVK *ctx;
44*e7be843bSPierre Pronchery
45*e7be843bSPierre Pronchery if (!ossl_prov_is_running())
46*e7be843bSPierre Pronchery return NULL;
47*e7be843bSPierre Pronchery
48*e7be843bSPierre Pronchery ctx = OPENSSL_zalloc(sizeof(*ctx));
49*e7be843bSPierre Pronchery if (ctx == NULL)
50*e7be843bSPierre Pronchery return NULL;
51*e7be843bSPierre Pronchery ctx->provctx = provctx;
52*e7be843bSPierre Pronchery kdf_pvk_init(ctx);
53*e7be843bSPierre Pronchery return ctx;
54*e7be843bSPierre Pronchery }
55*e7be843bSPierre Pronchery
kdf_pvk_cleanup(KDF_PVK * ctx)56*e7be843bSPierre Pronchery static void kdf_pvk_cleanup(KDF_PVK *ctx)
57*e7be843bSPierre Pronchery {
58*e7be843bSPierre Pronchery ossl_prov_digest_reset(&ctx->digest);
59*e7be843bSPierre Pronchery OPENSSL_free(ctx->salt);
60*e7be843bSPierre Pronchery OPENSSL_clear_free(ctx->pass, ctx->pass_len);
61*e7be843bSPierre Pronchery OPENSSL_cleanse(ctx, sizeof(*ctx));
62*e7be843bSPierre Pronchery }
63*e7be843bSPierre Pronchery
kdf_pvk_free(void * vctx)64*e7be843bSPierre Pronchery static void kdf_pvk_free(void *vctx)
65*e7be843bSPierre Pronchery {
66*e7be843bSPierre Pronchery KDF_PVK *ctx = (KDF_PVK *)vctx;
67*e7be843bSPierre Pronchery
68*e7be843bSPierre Pronchery if (ctx != NULL) {
69*e7be843bSPierre Pronchery kdf_pvk_cleanup(ctx);
70*e7be843bSPierre Pronchery OPENSSL_free(ctx);
71*e7be843bSPierre Pronchery }
72*e7be843bSPierre Pronchery }
73*e7be843bSPierre Pronchery
kdf_pvk_dup(void * vctx)74*e7be843bSPierre Pronchery static void *kdf_pvk_dup(void *vctx)
75*e7be843bSPierre Pronchery {
76*e7be843bSPierre Pronchery const KDF_PVK *src = (const KDF_PVK *)vctx;
77*e7be843bSPierre Pronchery KDF_PVK *dest;
78*e7be843bSPierre Pronchery
79*e7be843bSPierre Pronchery dest = kdf_pvk_new(src->provctx);
80*e7be843bSPierre Pronchery if (dest != NULL)
81*e7be843bSPierre Pronchery if (!ossl_prov_memdup(src->salt, src->salt_len,
82*e7be843bSPierre Pronchery &dest->salt, &dest->salt_len)
83*e7be843bSPierre Pronchery || !ossl_prov_memdup(src->pass, src->pass_len,
84*e7be843bSPierre Pronchery &dest->pass , &dest->pass_len)
85*e7be843bSPierre Pronchery || !ossl_prov_digest_copy(&dest->digest, &src->digest))
86*e7be843bSPierre Pronchery goto err;
87*e7be843bSPierre Pronchery return dest;
88*e7be843bSPierre Pronchery
89*e7be843bSPierre Pronchery err:
90*e7be843bSPierre Pronchery kdf_pvk_free(dest);
91*e7be843bSPierre Pronchery return NULL;
92*e7be843bSPierre Pronchery }
93*e7be843bSPierre Pronchery
kdf_pvk_reset(void * vctx)94*e7be843bSPierre Pronchery static void kdf_pvk_reset(void *vctx)
95*e7be843bSPierre Pronchery {
96*e7be843bSPierre Pronchery KDF_PVK *ctx = (KDF_PVK *)vctx;
97*e7be843bSPierre Pronchery void *provctx = ctx->provctx;
98*e7be843bSPierre Pronchery
99*e7be843bSPierre Pronchery kdf_pvk_cleanup(ctx);
100*e7be843bSPierre Pronchery ctx->provctx = provctx;
101*e7be843bSPierre Pronchery kdf_pvk_init(ctx);
102*e7be843bSPierre Pronchery }
103*e7be843bSPierre Pronchery
kdf_pvk_init(KDF_PVK * ctx)104*e7be843bSPierre Pronchery static void kdf_pvk_init(KDF_PVK *ctx)
105*e7be843bSPierre Pronchery {
106*e7be843bSPierre Pronchery OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
107*e7be843bSPierre Pronchery OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
108*e7be843bSPierre Pronchery
109*e7be843bSPierre Pronchery params[0] = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
110*e7be843bSPierre Pronchery SN_sha1, 0);
111*e7be843bSPierre Pronchery if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
112*e7be843bSPierre Pronchery /* This is an error, but there is no way to indicate such directly */
113*e7be843bSPierre Pronchery ossl_prov_digest_reset(&ctx->digest);
114*e7be843bSPierre Pronchery }
115*e7be843bSPierre Pronchery
pvk_set_membuf(unsigned char ** buffer,size_t * buflen,const OSSL_PARAM * p)116*e7be843bSPierre Pronchery static int pvk_set_membuf(unsigned char **buffer, size_t *buflen,
117*e7be843bSPierre Pronchery const OSSL_PARAM *p)
118*e7be843bSPierre Pronchery {
119*e7be843bSPierre Pronchery OPENSSL_clear_free(*buffer, *buflen);
120*e7be843bSPierre Pronchery *buffer = NULL;
121*e7be843bSPierre Pronchery *buflen = 0;
122*e7be843bSPierre Pronchery
123*e7be843bSPierre Pronchery if (p->data_size == 0) {
124*e7be843bSPierre Pronchery if ((*buffer = OPENSSL_malloc(1)) == NULL)
125*e7be843bSPierre Pronchery return 0;
126*e7be843bSPierre Pronchery } else if (p->data != NULL) {
127*e7be843bSPierre Pronchery if (!OSSL_PARAM_get_octet_string(p, (void **)buffer, 0, buflen))
128*e7be843bSPierre Pronchery return 0;
129*e7be843bSPierre Pronchery }
130*e7be843bSPierre Pronchery return 1;
131*e7be843bSPierre Pronchery }
132*e7be843bSPierre Pronchery
kdf_pvk_derive(void * vctx,unsigned char * key,size_t keylen,const OSSL_PARAM params[])133*e7be843bSPierre Pronchery static int kdf_pvk_derive(void *vctx, unsigned char *key, size_t keylen,
134*e7be843bSPierre Pronchery const OSSL_PARAM params[])
135*e7be843bSPierre Pronchery {
136*e7be843bSPierre Pronchery KDF_PVK *ctx = (KDF_PVK *)vctx;
137*e7be843bSPierre Pronchery const EVP_MD *md;
138*e7be843bSPierre Pronchery EVP_MD_CTX *mctx;
139*e7be843bSPierre Pronchery int res;
140*e7be843bSPierre Pronchery
141*e7be843bSPierre Pronchery if (!ossl_prov_is_running() || !kdf_pvk_set_ctx_params(ctx, params))
142*e7be843bSPierre Pronchery return 0;
143*e7be843bSPierre Pronchery
144*e7be843bSPierre Pronchery if (ctx->pass == NULL) {
145*e7be843bSPierre Pronchery ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_PASS);
146*e7be843bSPierre Pronchery return 0;
147*e7be843bSPierre Pronchery }
148*e7be843bSPierre Pronchery
149*e7be843bSPierre Pronchery if (ctx->salt == NULL) {
150*e7be843bSPierre Pronchery ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SALT);
151*e7be843bSPierre Pronchery return 0;
152*e7be843bSPierre Pronchery }
153*e7be843bSPierre Pronchery
154*e7be843bSPierre Pronchery md = ossl_prov_digest_md(&ctx->digest);
155*e7be843bSPierre Pronchery if (md == NULL) {
156*e7be843bSPierre Pronchery ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST);
157*e7be843bSPierre Pronchery return 0;
158*e7be843bSPierre Pronchery }
159*e7be843bSPierre Pronchery res = EVP_MD_get_size(md);
160*e7be843bSPierre Pronchery if (res <= 0) {
161*e7be843bSPierre Pronchery ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
162*e7be843bSPierre Pronchery return 0;
163*e7be843bSPierre Pronchery }
164*e7be843bSPierre Pronchery if ((size_t)res > keylen) {
165*e7be843bSPierre Pronchery ERR_raise(ERR_LIB_PROV, PROV_R_LENGTH_TOO_LARGE);
166*e7be843bSPierre Pronchery return 0;
167*e7be843bSPierre Pronchery }
168*e7be843bSPierre Pronchery
169*e7be843bSPierre Pronchery mctx = EVP_MD_CTX_new();
170*e7be843bSPierre Pronchery res = mctx != NULL
171*e7be843bSPierre Pronchery && EVP_DigestInit_ex(mctx, md, NULL)
172*e7be843bSPierre Pronchery && EVP_DigestUpdate(mctx, ctx->salt, ctx->salt_len)
173*e7be843bSPierre Pronchery && EVP_DigestUpdate(mctx, ctx->pass, ctx->pass_len)
174*e7be843bSPierre Pronchery && EVP_DigestFinal_ex(mctx, key, NULL);
175*e7be843bSPierre Pronchery EVP_MD_CTX_free(mctx);
176*e7be843bSPierre Pronchery return res;
177*e7be843bSPierre Pronchery }
178*e7be843bSPierre Pronchery
kdf_pvk_set_ctx_params(void * vctx,const OSSL_PARAM params[])179*e7be843bSPierre Pronchery static int kdf_pvk_set_ctx_params(void *vctx, const OSSL_PARAM params[])
180*e7be843bSPierre Pronchery {
181*e7be843bSPierre Pronchery const OSSL_PARAM *p;
182*e7be843bSPierre Pronchery KDF_PVK *ctx = vctx;
183*e7be843bSPierre Pronchery OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
184*e7be843bSPierre Pronchery
185*e7be843bSPierre Pronchery if (ossl_param_is_empty(params))
186*e7be843bSPierre Pronchery return 1;
187*e7be843bSPierre Pronchery
188*e7be843bSPierre Pronchery if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
189*e7be843bSPierre Pronchery return 0;
190*e7be843bSPierre Pronchery
191*e7be843bSPierre Pronchery if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PASSWORD)) != NULL)
192*e7be843bSPierre Pronchery if (!pvk_set_membuf(&ctx->pass, &ctx->pass_len, p))
193*e7be843bSPierre Pronchery return 0;
194*e7be843bSPierre Pronchery
195*e7be843bSPierre Pronchery if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
196*e7be843bSPierre Pronchery if (!pvk_set_membuf(&ctx->salt, &ctx->salt_len, p))
197*e7be843bSPierre Pronchery return 0;
198*e7be843bSPierre Pronchery }
199*e7be843bSPierre Pronchery
200*e7be843bSPierre Pronchery return 1;
201*e7be843bSPierre Pronchery }
202*e7be843bSPierre Pronchery
kdf_pvk_settable_ctx_params(ossl_unused void * ctx,ossl_unused void * p_ctx)203*e7be843bSPierre Pronchery static const OSSL_PARAM *kdf_pvk_settable_ctx_params(ossl_unused void *ctx,
204*e7be843bSPierre Pronchery ossl_unused void *p_ctx)
205*e7be843bSPierre Pronchery {
206*e7be843bSPierre Pronchery static const OSSL_PARAM known_settable_ctx_params[] = {
207*e7be843bSPierre Pronchery OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
208*e7be843bSPierre Pronchery OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
209*e7be843bSPierre Pronchery OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PASSWORD, NULL, 0),
210*e7be843bSPierre Pronchery OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
211*e7be843bSPierre Pronchery OSSL_PARAM_END
212*e7be843bSPierre Pronchery };
213*e7be843bSPierre Pronchery return known_settable_ctx_params;
214*e7be843bSPierre Pronchery }
215*e7be843bSPierre Pronchery
kdf_pvk_get_ctx_params(void * vctx,OSSL_PARAM params[])216*e7be843bSPierre Pronchery static int kdf_pvk_get_ctx_params(void *vctx, OSSL_PARAM params[])
217*e7be843bSPierre Pronchery {
218*e7be843bSPierre Pronchery OSSL_PARAM *p;
219*e7be843bSPierre Pronchery
220*e7be843bSPierre Pronchery if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
221*e7be843bSPierre Pronchery return OSSL_PARAM_set_size_t(p, SIZE_MAX);
222*e7be843bSPierre Pronchery return -2;
223*e7be843bSPierre Pronchery }
224*e7be843bSPierre Pronchery
kdf_pvk_gettable_ctx_params(ossl_unused void * ctx,ossl_unused void * p_ctx)225*e7be843bSPierre Pronchery static const OSSL_PARAM *kdf_pvk_gettable_ctx_params(ossl_unused void *ctx,
226*e7be843bSPierre Pronchery ossl_unused void *p_ctx)
227*e7be843bSPierre Pronchery {
228*e7be843bSPierre Pronchery static const OSSL_PARAM known_gettable_ctx_params[] = {
229*e7be843bSPierre Pronchery OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
230*e7be843bSPierre Pronchery OSSL_PARAM_END
231*e7be843bSPierre Pronchery };
232*e7be843bSPierre Pronchery return known_gettable_ctx_params;
233*e7be843bSPierre Pronchery }
234*e7be843bSPierre Pronchery
235*e7be843bSPierre Pronchery const OSSL_DISPATCH ossl_kdf_pvk_functions[] = {
236*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_pvk_new },
237*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_pvk_dup },
238*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_pvk_free },
239*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_pvk_reset },
240*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_pvk_derive },
241*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
242*e7be843bSPierre Pronchery (void(*)(void))kdf_pvk_settable_ctx_params },
243*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_pvk_set_ctx_params },
244*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
245*e7be843bSPierre Pronchery (void(*)(void))kdf_pvk_gettable_ctx_params },
246*e7be843bSPierre Pronchery { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_pvk_get_ctx_params },
247*e7be843bSPierre Pronchery OSSL_DISPATCH_END
248*e7be843bSPierre Pronchery };
249