[thirdparty/openssl.git] / providers / implementations / kdfs / hmacdrbg_kdf.c

/*
 * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdlib.h>
#include <string.h>
#include <openssl/crypto.h>
#include <openssl/err.h>
#include <openssl/kdf.h>
#include <openssl/proverr.h>
#include <openssl/core_names.h>
#include "prov/providercommon.h"
#include "prov/implementations.h"
#include "prov/hmac_drbg.h"
#include "prov/provider_ctx.h"

static OSSL_FUNC_kdf_newctx_fn hmac_drbg_kdf_new;
static OSSL_FUNC_kdf_dupctx_fn hmac_drbg_kdf_dup;
static OSSL_FUNC_kdf_freectx_fn hmac_drbg_kdf_free;
static OSSL_FUNC_kdf_reset_fn hmac_drbg_kdf_reset;
static OSSL_FUNC_kdf_derive_fn hmac_drbg_kdf_derive;
static OSSL_FUNC_kdf_settable_ctx_params_fn hmac_drbg_kdf_settable_ctx_params;
static OSSL_FUNC_kdf_set_ctx_params_fn hmac_drbg_kdf_set_ctx_params;
static OSSL_FUNC_kdf_gettable_ctx_params_fn hmac_drbg_kdf_gettable_ctx_params;
static OSSL_FUNC_kdf_get_ctx_params_fn hmac_drbg_kdf_get_ctx_params;

typedef struct {
    PROV_DRBG_HMAC base;
    void *provctx;
    unsigned char *entropy, *nonce;
    size_t entropylen, noncelen;
    int init;
} KDF_HMAC_DRBG;

static void *hmac_drbg_kdf_new(void *provctx)
{
    KDF_HMAC_DRBG *ctx;

    if (!ossl_prov_is_running())
        return NULL;

    ctx = OPENSSL_zalloc(sizeof(*ctx));
    if (ctx == NULL) {
        ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
        return NULL;
    }
    ctx->provctx = provctx;
    return ctx;
}

static void hmac_drbg_kdf_reset(void *vctx)
{
    KDF_HMAC_DRBG *ctx = (KDF_HMAC_DRBG *)vctx;
    PROV_DRBG_HMAC *drbg = &ctx->base;
    void *provctx = ctx->provctx;

    EVP_MAC_CTX_free(drbg->ctx);
    ossl_prov_digest_reset(&drbg->digest);
    OPENSSL_clear_free(ctx->entropy, ctx->entropylen);
    OPENSSL_clear_free(ctx->nonce, ctx->noncelen);
    OPENSSL_cleanse(ctx, sizeof(*ctx));
    ctx->provctx = provctx;
}

static void hmac_drbg_kdf_free(void *vctx)
{
    KDF_HMAC_DRBG *ctx = (KDF_HMAC_DRBG *)vctx;

    if (ctx != NULL) {
        hmac_drbg_kdf_reset(ctx);
        OPENSSL_free(ctx);
    }
}

static int ossl_drbg_hmac_dup(PROV_DRBG_HMAC *dst, const PROV_DRBG_HMAC *src) {
    if (src->ctx != NULL) {
        dst->ctx = EVP_MAC_CTX_dup(src->ctx);
        if (dst->ctx == NULL)
            return 0;
    }
    if (!ossl_prov_digest_copy(&dst->digest, &src->digest))
        return 0;
    memcpy(dst->K, src->K, sizeof(dst->K));
    memcpy(dst->V, src->V, sizeof(dst->V));
    dst->blocklen = src->blocklen;
    return 1;
}

static void *hmac_drbg_kdf_dup(void *vctx)
{
    const KDF_HMAC_DRBG *src = (const KDF_HMAC_DRBG *)vctx;
    KDF_HMAC_DRBG *dst;

    dst = hmac_drbg_kdf_new(src->provctx);
    if (dst != NULL) {
        if (!ossl_drbg_hmac_dup(&dst->base, &src->base)
                || !ossl_prov_memdup(src->entropy, src->entropylen,
                                     &dst->entropy , &dst->entropylen)
                || !ossl_prov_memdup(src->nonce, src->noncelen,
                                     &dst->nonce, &dst->noncelen))
            goto err;
        dst->init = src->init;
    }
    return dst;

 err:
    hmac_drbg_kdf_free(dst);
    return NULL;
}

static int hmac_drbg_kdf_derive(void *vctx, unsigned char *out, size_t outlen,
                                const OSSL_PARAM params[])
{
    KDF_HMAC_DRBG *ctx = (KDF_HMAC_DRBG *)vctx;
    PROV_DRBG_HMAC *drbg = &ctx->base;

    if (!ossl_prov_is_running()
            || !hmac_drbg_kdf_set_ctx_params(vctx, params))
        return 0;
    if (!ctx->init) {
        if (ctx->entropy == NULL
                || ctx->entropylen == 0
                || ctx->nonce == NULL
                || ctx->noncelen == 0
                || !ossl_drbg_hmac_init(drbg, ctx->entropy, ctx->entropylen,
                                        ctx->nonce, ctx->noncelen, NULL, 0))
            return 0;
        ctx->init = 1;
    }

    return ossl_drbg_hmac_generate(drbg, out, outlen, NULL, 0);
}

static int hmac_drbg_kdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
{
    KDF_HMAC_DRBG *hmac = (KDF_HMAC_DRBG *)vctx;
    PROV_DRBG_HMAC *drbg = &hmac->base;
    const char *name;
    const EVP_MD *md;
    OSSL_PARAM *p;

    p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_MAC);
    if (p != NULL) {
        if (drbg->ctx == NULL)
            return 0;
        name = EVP_MAC_get0_name(EVP_MAC_CTX_get0_mac(drbg->ctx));
        if (!OSSL_PARAM_set_utf8_string(p, name))
            return 0;
    }

    p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_DIGEST);
    if (p != NULL) {
        md = ossl_prov_digest_md(&drbg->digest);
        if (md == NULL || !OSSL_PARAM_set_utf8_string(p, EVP_MD_get0_name(md)))
            return 0;
    }
    return 1;
}

static const OSSL_PARAM *hmac_drbg_kdf_gettable_ctx_params(
    ossl_unused void *vctx, ossl_unused void *p_ctx)
{
    static const OSSL_PARAM known_gettable_ctx_params[] = {
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
        OSSL_PARAM_END
    };
    return known_gettable_ctx_params;
}

static int hmac_drbg_kdf_set_ctx_params(void *vctx,
                                        const OSSL_PARAM params[])
{
    KDF_HMAC_DRBG *hmac = (KDF_HMAC_DRBG *)vctx;
    PROV_DRBG_HMAC *drbg = &hmac->base;
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(hmac->provctx);
    const EVP_MD *md;
    const OSSL_PARAM *p;
    void *ptr = NULL;
    size_t size = 0;

    if (params == NULL)
        return 1;

    p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_HMACDRBG_ENTROPY);
    if (p != NULL) {
        if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
            return 0;
        OPENSSL_free(hmac->entropy);
        hmac->entropy = ptr;
        hmac->entropylen = size;
        hmac->init = 0;
        ptr = NULL;
    }

    p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_HMACDRBG_NONCE);
    if (p != NULL) {
        if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
            return 0;
        OPENSSL_free(hmac->nonce);
        hmac->nonce = ptr;
        hmac->noncelen = size;
        hmac->init = 0;
    }

    p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_DIGEST);
    if (p != NULL) {
        if (!ossl_prov_digest_load_from_params(&drbg->digest, params, libctx))
            return 0;

        /* Confirm digest is allowed. Allow all digests that are not XOF */
        md = ossl_prov_digest_md(&drbg->digest);
        if (md != NULL) {
            if ((EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF) != 0) {
                ERR_raise(ERR_LIB_PROV, PROV_R_XOF_DIGESTS_NOT_ALLOWED);
                return 0;
            }
            drbg->blocklen = EVP_MD_get_size(md);
        }
        return ossl_prov_macctx_load_from_params(&drbg->ctx, params,
                                                 "HMAC", NULL, NULL, libctx);
    }
    return 1;
}

static const OSSL_PARAM *hmac_drbg_kdf_settable_ctx_params(
    ossl_unused void *vctx, ossl_unused void *p_ctx)
{
    static const OSSL_PARAM known_settable_ctx_params[] = {
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_HMACDRBG_ENTROPY, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_HMACDRBG_NONCE, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
        OSSL_PARAM_END
    };
    return known_settable_ctx_params;
}

const OSSL_DISPATCH ossl_kdf_hmac_drbg_functions[] = {
    { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))hmac_drbg_kdf_new },
    { OSSL_FUNC_KDF_FREECTX, (void(*)(void))hmac_drbg_kdf_free },
    { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))hmac_drbg_kdf_dup },
    { OSSL_FUNC_KDF_RESET, (void(*)(void))hmac_drbg_kdf_reset },
    { OSSL_FUNC_KDF_DERIVE, (void(*)(void))hmac_drbg_kdf_derive },
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
      (void(*)(void))hmac_drbg_kdf_settable_ctx_params },
    { OSSL_FUNC_KDF_SET_CTX_PARAMS,
      (void(*)(void))hmac_drbg_kdf_set_ctx_params },
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
      (void(*)(void))hmac_drbg_kdf_gettable_ctx_params },
    { OSSL_FUNC_KDF_GET_CTX_PARAMS,
      (void(*)(void))hmac_drbg_kdf_get_ctx_params },
    OSSL_DISPATCH_END
};
Commit	Line	Data
f3090fc7	1	/*
	2	* Copyright 2022 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 <stdlib.h>
	11	#include <string.h>
	12	#include <openssl/crypto.h>
	13	#include <openssl/err.h>
	14	#include <openssl/kdf.h>
	15	#include <openssl/proverr.h>
	16	#include <openssl/core_names.h>
	17	#include "prov/providercommon.h"
	18	#include "prov/implementations.h"
	19	#include "prov/hmac_drbg.h"
	20	#include "prov/provider_ctx.h"
	21
	22	static OSSL_FUNC_kdf_newctx_fn hmac_drbg_kdf_new;
	23	static OSSL_FUNC_kdf_dupctx_fn hmac_drbg_kdf_dup;
	24	static OSSL_FUNC_kdf_freectx_fn hmac_drbg_kdf_free;
	25	static OSSL_FUNC_kdf_reset_fn hmac_drbg_kdf_reset;
	26	static OSSL_FUNC_kdf_derive_fn hmac_drbg_kdf_derive;
	27	static OSSL_FUNC_kdf_settable_ctx_params_fn hmac_drbg_kdf_settable_ctx_params;
	28	static OSSL_FUNC_kdf_set_ctx_params_fn hmac_drbg_kdf_set_ctx_params;
	29	static OSSL_FUNC_kdf_gettable_ctx_params_fn hmac_drbg_kdf_gettable_ctx_params;
	30	static OSSL_FUNC_kdf_get_ctx_params_fn hmac_drbg_kdf_get_ctx_params;
	31
	32	typedef struct {
	33	PROV_DRBG_HMAC base;
	34	void *provctx;
	35	unsigned char entropy, nonce;
	36	size_t entropylen, noncelen;
	37	int init;
	38	} KDF_HMAC_DRBG;
	39
	40	static void hmac_drbg_kdf_new(void provctx)
	41	{
	42	KDF_HMAC_DRBG *ctx;
	43
	44	if (!ossl_prov_is_running())
	45	return NULL;
	46
	47	ctx = OPENSSL_zalloc(sizeof(*ctx));
	48	if (ctx == NULL) {
	49	ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
	50	return NULL;
	51	}
	52	ctx->provctx = provctx;
	53	return ctx;
	54	}
	55
	56	static void hmac_drbg_kdf_reset(void *vctx)
	57	{
	58	KDF_HMAC_DRBG ctx = (KDF_HMAC_DRBG )vctx;
	59	PROV_DRBG_HMAC *drbg = &ctx->base;
	60	void *provctx = ctx->provctx;
	61
	62	EVP_MAC_CTX_free(drbg->ctx);
	63	ossl_prov_digest_reset(&drbg->digest);
	64	OPENSSL_clear_free(ctx->entropy, ctx->entropylen);
65	OPENSSL_clear_free(ctx->nonce, ctx->noncelen);
66	OPENSSL_cleanse(ctx, sizeof(*ctx));
67	ctx->provctx = provctx;
68	}
69
70	static void hmac_drbg_kdf_free(void *vctx)
71	{
72	KDF_HMAC_DRBG ctx = (KDF_HMAC_DRBG )vctx;
73
74	if (ctx != NULL) {
75	hmac_drbg_kdf_reset(ctx);
76	OPENSSL_free(ctx);
77	}
78	}
79
80	static int ossl_drbg_hmac_dup(PROV_DRBG_HMAC dst, const PROV_DRBG_HMAC src) {
81	if (src->ctx != NULL) {
82	dst->ctx = EVP_MAC_CTX_dup(src->ctx);
83	if (dst->ctx == NULL)
84	return 0;
85	}
86	if (!ossl_prov_digest_copy(&dst->digest, &src->digest))
87	return 0;
88	memcpy(dst->K, src->K, sizeof(dst->K));
89	memcpy(dst->V, src->V, sizeof(dst->V));
90	dst->blocklen = src->blocklen;
91	return 1;
92	}
93
94	static void hmac_drbg_kdf_dup(void vctx)
95	{
96	const KDF_HMAC_DRBG src = (const KDF_HMAC_DRBG )vctx;
97	KDF_HMAC_DRBG *dst;
98
99	dst = hmac_drbg_kdf_new(src->provctx);
100	if (dst != NULL) {
101	if (!ossl_drbg_hmac_dup(&dst->base, &src->base)
102	\|\| !ossl_prov_memdup(src->entropy, src->entropylen,
103	&dst->entropy , &dst->entropylen)
104	\|\| !ossl_prov_memdup(src->nonce, src->noncelen,
105	&dst->nonce, &dst->noncelen))
106	goto err;
107	dst->init = src->init;
108	}
109	return dst;
110
111	err:
112	hmac_drbg_kdf_free(dst);
113	return NULL;
114	}
115
116	static int hmac_drbg_kdf_derive(void vctx, unsigned char out, size_t outlen,
117	const OSSL_PARAM params[])
118	{
119	KDF_HMAC_DRBG ctx = (KDF_HMAC_DRBG )vctx;
120	PROV_DRBG_HMAC *drbg = &ctx->base;
121
122	if (!ossl_prov_is_running()
123	\|\| !hmac_drbg_kdf_set_ctx_params(vctx, params))
124	return 0;
125	if (!ctx->init) {
126	if (ctx->entropy == NULL
127	\|\| ctx->entropylen == 0
128	\|\| ctx->nonce == NULL
129	\|\| ctx->noncelen == 0
130	\|\| !ossl_drbg_hmac_init(drbg, ctx->entropy, ctx->entropylen,
131	ctx->nonce, ctx->noncelen, NULL, 0))
132	return 0;
133	ctx->init = 1;
134	}
135
136	return ossl_drbg_hmac_generate(drbg, out, outlen, NULL, 0);
137	}
138
139	static int hmac_drbg_kdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
140	{
141	KDF_HMAC_DRBG hmac = (KDF_HMAC_DRBG )vctx;
142	PROV_DRBG_HMAC *drbg = &hmac->base;
143	const char *name;
144	const EVP_MD *md;
145	OSSL_PARAM *p;
146
147	p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_MAC);
148	if (p != NULL) {
149	if (drbg->ctx == NULL)
150	return 0;
151	name = EVP_MAC_get0_name(EVP_MAC_CTX_get0_mac(drbg->ctx));
152	if (!OSSL_PARAM_set_utf8_string(p, name))
153	return 0;
154	}
155
156	p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_DIGEST);
157	if (p != NULL) {
158	md = ossl_prov_digest_md(&drbg->digest);
159	if (md == NULL \|\| !OSSL_PARAM_set_utf8_string(p, EVP_MD_get0_name(md)))
160	return 0;
161	}
162	return 1;
163	}
164
165	static const OSSL_PARAM *hmac_drbg_kdf_gettable_ctx_params(
166	ossl_unused void vctx, ossl_unused void p_ctx)
167	{
168	static const OSSL_PARAM known_gettable_ctx_params[] = {
169	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC, NULL, 0),
170	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
171	OSSL_PARAM_END
172	};
173	return known_gettable_ctx_params;
174	}
175
176	static int hmac_drbg_kdf_set_ctx_params(void *vctx,
177	const OSSL_PARAM params[])
178	{
179	KDF_HMAC_DRBG hmac = (KDF_HMAC_DRBG )vctx;
180	PROV_DRBG_HMAC *drbg = &hmac->base;
181	OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(hmac->provctx);
182	const EVP_MD *md;
183	const OSSL_PARAM *p;
184	void *ptr = NULL;
185	size_t size = 0;
186
187	if (params == NULL)
188	return 1;
189
190	p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_HMACDRBG_ENTROPY);
191	if (p != NULL) {
192	if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
193	return 0;
194	OPENSSL_free(hmac->entropy);
195	hmac->entropy = ptr;
196	hmac->entropylen = size;
197	hmac->init = 0;
198	ptr = NULL;
199	}
200
201	p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_HMACDRBG_NONCE);
202	if (p != NULL) {
203	if (!OSSL_PARAM_get_octet_string(p, &ptr, 0, &size))
204	return 0;
205	OPENSSL_free(hmac->nonce);
206	hmac->nonce = ptr;
207	hmac->noncelen = size;
208	hmac->init = 0;
209	}
210
211	p = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_DIGEST);
212	if (p != NULL) {
213	if (!ossl_prov_digest_load_from_params(&drbg->digest, params, libctx))
214	return 0;
215
216	/* Confirm digest is allowed. Allow all digests that are not XOF */
217	md = ossl_prov_digest_md(&drbg->digest);
218	if (md != NULL) {
219	if ((EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF) != 0) {
220	ERR_raise(ERR_LIB_PROV, PROV_R_XOF_DIGESTS_NOT_ALLOWED);
221	return 0;
222	}
223	drbg->blocklen = EVP_MD_get_size(md);
224	}
225	return ossl_prov_macctx_load_from_params(&drbg->ctx, params,
226	"HMAC", NULL, NULL, libctx);
227	}
228	return 1;
229	}
230
231	static const OSSL_PARAM *hmac_drbg_kdf_settable_ctx_params(
232	ossl_unused void vctx, ossl_unused void p_ctx)
233	{
234	static const OSSL_PARAM known_settable_ctx_params[] = {
235	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_HMACDRBG_ENTROPY, NULL, 0),
236	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_HMACDRBG_NONCE, NULL, 0),
237	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
238	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
239	OSSL_PARAM_END
240	};
241	return known_settable_ctx_params;
242	}
243
244	const OSSL_DISPATCH ossl_kdf_hmac_drbg_functions[] = {
245	{ OSSL_FUNC_KDF_NEWCTX, (void(*)(void))hmac_drbg_kdf_new },
246	{ OSSL_FUNC_KDF_FREECTX, (void(*)(void))hmac_drbg_kdf_free },
247	{ OSSL_FUNC_KDF_DUPCTX, (void(*)(void))hmac_drbg_kdf_dup },
248	{ OSSL_FUNC_KDF_RESET, (void(*)(void))hmac_drbg_kdf_reset },
249	{ OSSL_FUNC_KDF_DERIVE, (void(*)(void))hmac_drbg_kdf_derive },
250	{ OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
251	(void(*)(void))hmac_drbg_kdf_settable_ctx_params },
252	{ OSSL_FUNC_KDF_SET_CTX_PARAMS,
253	(void(*)(void))hmac_drbg_kdf_set_ctx_params },
254	{ OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
255	(void(*)(void))hmac_drbg_kdf_gettable_ctx_params },
256	{ OSSL_FUNC_KDF_GET_CTX_PARAMS,
257	(void(*)(void))hmac_drbg_kdf_get_ctx_params },
1e6bd31e	258	OSSL_DISPATCH_END
f3090fc7	259	};