[thirdparty/openssl.git] / crypto / evp / mac_lib.c

/*
 * Copyright 2018-2021 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 <string.h>
#include <stdarg.h>
#include <openssl/evp.h>
#include <openssl/err.h>
#include <openssl/core.h>
#include <openssl/core_names.h>
#include <openssl/types.h>
#include "internal/nelem.h"
#include "crypto/evp.h"
#include "internal/provider.h"
#include "evp_local.h"

EVP_MAC_CTX *EVP_MAC_CTX_new(EVP_MAC *mac)
{
    EVP_MAC_CTX *ctx = OPENSSL_zalloc(sizeof(EVP_MAC_CTX));

    if (ctx == NULL
        || (ctx->algctx = mac->newctx(ossl_provider_ctx(mac->prov))) == NULL
        || !EVP_MAC_up_ref(mac)) {
        ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
        if (ctx != NULL)
            mac->freectx(ctx->algctx);
        OPENSSL_free(ctx);
        ctx = NULL;
    } else {
        ctx->meth = mac;
    }
    return ctx;
}

void EVP_MAC_CTX_free(EVP_MAC_CTX *ctx)
{
    if (ctx == NULL)
        return;
    ctx->meth->freectx(ctx->algctx);
    ctx->algctx = NULL;
    /* refcnt-- */
    EVP_MAC_free(ctx->meth);
    OPENSSL_free(ctx);
}

EVP_MAC_CTX *EVP_MAC_CTX_dup(const EVP_MAC_CTX *src)
{
    EVP_MAC_CTX *dst;

    if (src->algctx == NULL)
        return NULL;

    dst = OPENSSL_malloc(sizeof(*dst));
    if (dst == NULL) {
        ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
        return NULL;
    }

    *dst = *src;
    if (!EVP_MAC_up_ref(dst->meth)) {
        ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
        OPENSSL_free(dst);
        return NULL;
    }

    dst->algctx = src->meth->dupctx(src->algctx);
    if (dst->algctx == NULL) {
        EVP_MAC_CTX_free(dst);
        return NULL;
    }

    return dst;
}

EVP_MAC *EVP_MAC_CTX_get0_mac(EVP_MAC_CTX *ctx)
{
    return ctx->meth;
}

static size_t get_size_t_ctx_param(EVP_MAC_CTX *ctx, const char *name)
{
    size_t sz = 0;

    if (ctx->algctx != NULL) {
        OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };

        params[0] = OSSL_PARAM_construct_size_t(name, &sz);
        if (ctx->meth->get_ctx_params != NULL) {
            if (ctx->meth->get_ctx_params(ctx->algctx, params))
                return sz;
        } else if (ctx->meth->get_params != NULL) {
            if (ctx->meth->get_params(params))
                return sz;
        }
    }
    /*
     * If the MAC hasn't been initialized yet, or there is no size to get,
     * we return zero
     */
    return 0;
}

size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx)
{
    return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_SIZE);
}

size_t EVP_MAC_CTX_get_block_size(EVP_MAC_CTX *ctx)
{
    return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_BLOCK_SIZE);
}

int EVP_MAC_init(EVP_MAC_CTX *ctx, const unsigned char *key, size_t keylen,
                 const OSSL_PARAM params[])
{
    return ctx->meth->init(ctx->algctx, key, keylen, params);
}

int EVP_MAC_update(EVP_MAC_CTX *ctx, const unsigned char *data, size_t datalen)
{
    return ctx->meth->update(ctx->algctx, data, datalen);
}

static int evp_mac_final(EVP_MAC_CTX *ctx, int xof,
                         unsigned char *out, size_t *outl, size_t outsize)
{
    size_t l;
    int res;
    OSSL_PARAM params[2];

    if (ctx == NULL || ctx->meth == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_NULL_ALGORITHM);
        return 0;
    }
    if (ctx->meth->final == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
        return 0;
    }

    if (out == NULL) {
        if (outl == NULL) {
            ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
            return 0;
        }
        *outl = EVP_MAC_CTX_get_mac_size(ctx);
        return 1;
    }
    if (xof) {
        params[0] = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof);
        params[1] = OSSL_PARAM_construct_end();

        if (EVP_MAC_CTX_set_params(ctx, params) <= 0) {
            ERR_raise(ERR_LIB_EVP, EVP_R_SETTING_XOF_FAILED);
            return 0;
        }
    }
    res = ctx->meth->final(ctx->algctx, out, &l, outsize);
    if (outl != NULL)
        *outl = l;
    return res;
}

int EVP_MAC_final(EVP_MAC_CTX *ctx,
                  unsigned char *out, size_t *outl, size_t outsize)
{
    return evp_mac_final(ctx, 0, out, outl, outsize);
}

int EVP_MAC_finalXOF(EVP_MAC_CTX *ctx, unsigned char *out, size_t outsize)
{
    return evp_mac_final(ctx, 1, out, NULL, outsize);
}

/*
 * The {get,set}_params functions return 1 if there is no corresponding
 * function in the implementation.  This is the same as if there was one,
 * but it didn't recognise any of the given params, i.e. nothing in the
 * bag of parameters was useful.
 */
int EVP_MAC_get_params(EVP_MAC *mac, OSSL_PARAM params[])
{
    if (mac->get_params != NULL)
        return mac->get_params(params);
    return 1;
}

int EVP_MAC_CTX_get_params(EVP_MAC_CTX *ctx, OSSL_PARAM params[])
{
    if (ctx->meth->get_ctx_params != NULL)
        return ctx->meth->get_ctx_params(ctx->algctx, params);
    return 1;
}

int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[])
{
    if (ctx->meth->set_ctx_params != NULL)
        return ctx->meth->set_ctx_params(ctx->algctx, params);
    return 1;
}

int EVP_MAC_get_number(const EVP_MAC *mac)
{
    return mac->name_id;
}

const char *EVP_MAC_get0_name(const EVP_MAC *mac)
{
    return mac->type_name;
}

const char *EVP_MAC_get0_description(const EVP_MAC *mac)
{
    return mac->description;
}

int EVP_MAC_is_a(const EVP_MAC *mac, const char *name)
{
    return evp_is_a(mac->prov, mac->name_id, NULL, name);
}

int EVP_MAC_names_do_all(const EVP_MAC *mac,
                         void (*fn)(const char *name, void *data),
                         void *data)
{
    if (mac->prov != NULL)
        return evp_names_do_all(mac->prov, mac->name_id, fn, data);

    return 1;
}

unsigned char *EVP_Q_mac(OSSL_LIB_CTX *libctx, const char *name, const char *propq,
                         const char *subalg, const OSSL_PARAM *params,
                         const void *key, size_t keylen,
                         const unsigned char *data, size_t datalen,
                         unsigned char *out, size_t outsize, unsigned int *outlen)
{
    EVP_MAC *mac = EVP_MAC_fetch(libctx, name, propq);
    OSSL_PARAM subalg_param[] = { OSSL_PARAM_END, OSSL_PARAM_END };
    EVP_MAC_CTX *ctx  = NULL;
    size_t len;
    unsigned char *res = NULL;

    if (outlen != NULL)
        *outlen = 0;
    if (mac == NULL)
        return NULL;
    if (subalg != NULL) {
        const OSSL_PARAM *defined_params = EVP_MAC_settable_ctx_params(mac);
        const char *param_name = OSSL_MAC_PARAM_DIGEST;

        /*
         * The underlying algorithm may be a cipher or a digest.
         * We don't know which it is, but we can ask the MAC what it
         * should be and bet on that.
         */
        if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
            param_name = OSSL_MAC_PARAM_CIPHER;
            if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
                ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
                goto err;
            }
        }
        subalg_param[0] =
            OSSL_PARAM_construct_utf8_string(param_name, (char *)subalg, 0);
    }
    /* Single-shot - on NULL key input, set dummy key value for EVP_MAC_Init. */
    if (key == NULL && keylen == 0)
        key = data;
    if ((ctx = EVP_MAC_CTX_new(mac)) != NULL
            && EVP_MAC_CTX_set_params(ctx, subalg_param)
            && EVP_MAC_CTX_set_params(ctx, params)
            && EVP_MAC_init(ctx, key, keylen, params)
            && EVP_MAC_update(ctx, data, datalen)
            && EVP_MAC_final(ctx, out, &len, outsize)) {
        if (out == NULL) {
            out = OPENSSL_malloc(len);
            if (out != NULL && !EVP_MAC_final(ctx, out, NULL, len)) {
                OPENSSL_free(out);
                out = NULL;
            }
        }
        res = out;
        if (res != NULL && outlen != NULL)
            *outlen = (unsigned int)len;
    }

 err:
    EVP_MAC_CTX_free(ctx);
    EVP_MAC_free(mac);
    return res;
}
Commit	Line	Data
567db2c1	1	/*
8020d79b	2	* Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
567db2c1	3	*
4a8b0c55	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
567db2c1 RL	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 <string.h>
	11	#include <stdarg.h>
	12	#include <openssl/evp.h>
	13	#include <openssl/err.h>
e74bd290 RL	14	#include <openssl/core.h>
e74bd290 RL	15	#include <openssl/core_names.h>
50cd4768	16	#include <openssl/types.h>
567db2c1	17	#include "internal/nelem.h"
25f2138b	18	#include "crypto/evp.h"
e74bd290	19	#include "internal/provider.h"
706457b7	20	#include "evp_local.h"
567db2c1	21
865adf97	22	EVP_MAC_CTX EVP_MAC_CTX_new(EVP_MAC mac)
567db2c1 RL	23	{
	24	EVP_MAC_CTX *ctx = OPENSSL_zalloc(sizeof(EVP_MAC_CTX));
	25
e74bd290	26	if (ctx == NULL
7c14d0c1	27	\|\| (ctx->algctx = mac->newctx(ossl_provider_ctx(mac->prov))) == NULL
e74bd290	28	\|\| !EVP_MAC_up_ref(mac)) {
9311d0c4	29	ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
e74bd290	30	if (ctx != NULL)
7c14d0c1	31	mac->freectx(ctx->algctx);
567db2c1 RL	32	OPENSSL_free(ctx);
	33	ctx = NULL;
	34	} else {
	35	ctx->meth = mac;
	36	}
	37	return ctx;
	38	}
	39
865adf97	40	void EVP_MAC_CTX_free(EVP_MAC_CTX *ctx)
567db2c1	41	{
543e740b RS	42	if (ctx == NULL)
543e740b RS	43	return;
7c14d0c1 SL	44	ctx->meth->freectx(ctx->algctx);
7c14d0c1 SL	45	ctx->algctx = NULL;
543e740b RS	46	/* refcnt-- */
543e740b RS	47	EVP_MAC_free(ctx->meth);
567db2c1 RL	48	OPENSSL_free(ctx);
	49	}
	50
865adf97	51	EVP_MAC_CTX EVP_MAC_CTX_dup(const EVP_MAC_CTX src)
567db2c1	52	{
7ed66e26	53	EVP_MAC_CTX *dst;
567db2c1	54
7c14d0c1	55	if (src->algctx == NULL)
be5fc053 KR	56	return NULL;
	57
	58	dst = OPENSSL_malloc(sizeof(*dst));
	59	if (dst == NULL) {
9311d0c4	60	ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
be5fc053 KR	61	return NULL;
be5fc053 KR	62	}
567db2c1	63
567db2c1	64	dst = src;
e74bd290	65	if (!EVP_MAC_up_ref(dst->meth)) {
9311d0c4	66	ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
e74bd290 RL	67	OPENSSL_free(dst);
	68	return NULL;
	69	}
567db2c1	70
7c14d0c1 SL	71	dst->algctx = src->meth->dupctx(src->algctx);
7c14d0c1 SL	72	if (dst->algctx == NULL) {
865adf97	73	EVP_MAC_CTX_free(dst);
be5fc053 KR	74	return NULL;
	75	}
	76
	77	return dst;
567db2c1 RL	78	}
567db2c1 RL	79
ed576acd	80	EVP_MAC EVP_MAC_CTX_get0_mac(EVP_MAC_CTX ctx)
567db2c1 RL	81	{
	82	return ctx->meth;
	83	}
	84
eb1b66f0	85	static size_t get_size_t_ctx_param(EVP_MAC_CTX ctx, const char name)
567db2c1	86	{
e74bd290 RL	87	size_t sz = 0;
e74bd290 RL	88
7c14d0c1	89	if (ctx->algctx != NULL) {
e74bd290 RL	90	OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
e74bd290 RL	91
eb1b66f0	92	params[0] = OSSL_PARAM_construct_size_t(name, &sz);
92d9d0ae	93	if (ctx->meth->get_ctx_params != NULL) {
7c14d0c1	94	if (ctx->meth->get_ctx_params(ctx->algctx, params))
e74bd290 RL	95	return sz;
	96	} else if (ctx->meth->get_params != NULL) {
	97	if (ctx->meth->get_params(params))
	98	return sz;
	99	}
	100	}
	101	/*
	102	* If the MAC hasn't been initialized yet, or there is no size to get,
	103	* we return zero
	104	*/
567db2c1 RL	105	return 0;
	106	}
	107
eb1b66f0 P	108	size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx)
	109	{
	110	return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_SIZE);
	111	}
	112
	113	size_t EVP_MAC_CTX_get_block_size(EVP_MAC_CTX *ctx)
	114	{
	115	return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_BLOCK_SIZE);
	116	}
	117
cc2314a9 P	118	int EVP_MAC_init(EVP_MAC_CTX ctx, const unsigned char key, size_t keylen,
cc2314a9 P	119	const OSSL_PARAM params[])
567db2c1	120	{
7c14d0c1	121	return ctx->meth->init(ctx->algctx, key, keylen, params);
567db2c1 RL	122	}
	123
	124	int EVP_MAC_update(EVP_MAC_CTX ctx, const unsigned char data, size_t datalen)
	125	{
7c14d0c1	126	return ctx->meth->update(ctx->algctx, data, datalen);
567db2c1 RL	127	}
567db2c1 RL	128
b039c87a P	129	static int evp_mac_final(EVP_MAC_CTX *ctx, int xof,
b039c87a P	130	unsigned char out, size_t outl, size_t outsize)
567db2c1	131	{
5f6a0b2f	132	size_t l;
b039c87a P	133	int res;
	134	OSSL_PARAM params[2];
	135
	136	if (ctx == NULL \|\| ctx->meth == NULL) {
	137	ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_NULL_ALGORITHM);
	138	return 0;
	139	}
	140	if (ctx->meth->final == NULL) {
	141	ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
	142	return 0;
	143	}
567db2c1	144
b039c87a P	145	if (out == NULL) {
	146	if (outl == NULL) {
	147	ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
	148	return 0;
	149	}
	150	*outl = EVP_MAC_CTX_get_mac_size(ctx);
	151	return 1;
	152	}
	153	if (xof) {
	154	params[0] = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof);
	155	params[1] = OSSL_PARAM_construct_end();
	156
	157	if (EVP_MAC_CTX_set_params(ctx, params) <= 0) {
	158	ERR_raise(ERR_LIB_EVP, EVP_R_SETTING_XOF_FAILED);
	159	return 0;
	160	}
	161	}
7c14d0c1	162	res = ctx->meth->final(ctx->algctx, out, &l, outsize);
e74bd290 RL	163	if (outl != NULL)
e74bd290 RL	164	*outl = l;
a85c9021	165	return res;
567db2c1 RL	166	}
567db2c1 RL	167
b039c87a P	168	int EVP_MAC_final(EVP_MAC_CTX *ctx,
	169	unsigned char out, size_t outl, size_t outsize)
	170	{
	171	return evp_mac_final(ctx, 0, out, outl, outsize);
	172	}
	173
	174	int EVP_MAC_finalXOF(EVP_MAC_CTX ctx, unsigned char out, size_t outsize)
	175	{
	176	return evp_mac_final(ctx, 1, out, NULL, outsize);
	177	}
	178
e74bd290 RL	179	/*
	180	* The {get,set}_params functions return 1 if there is no corresponding
	181	* function in the implementation. This is the same as if there was one,
	182	* but it didn't recognise any of the given params, i.e. nothing in the
	183	* bag of parameters was useful.
	184	*/
	185	int EVP_MAC_get_params(EVP_MAC *mac, OSSL_PARAM params[])
567db2c1	186	{
e74bd290 RL	187	if (mac->get_params != NULL)
	188	return mac->get_params(params);
	189	return 1;
567db2c1 RL	190	}
567db2c1 RL	191
865adf97	192	int EVP_MAC_CTX_get_params(EVP_MAC_CTX *ctx, OSSL_PARAM params[])
567db2c1	193	{
92d9d0ae	194	if (ctx->meth->get_ctx_params != NULL)
7c14d0c1	195	return ctx->meth->get_ctx_params(ctx->algctx, params);
e74bd290	196	return 1;
567db2c1 RL	197	}
567db2c1 RL	198
865adf97	199	int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[])
567db2c1	200	{
92d9d0ae	201	if (ctx->meth->set_ctx_params != NULL)
7c14d0c1	202	return ctx->meth->set_ctx_params(ctx->algctx, params);
e74bd290	203	return 1;
567db2c1	204	}
251e610c	205
ed576acd	206	int EVP_MAC_get_number(const EVP_MAC *mac)
506cb0f6 RL	207	{
	208	return mac->name_id;
	209	}
	210
ed576acd	211	const char EVP_MAC_get0_name(const EVP_MAC mac)
c9452d74	212	{
6c9bc258	213	return mac->type_name;
c9452d74 P	214	}
c9452d74 P	215
ed576acd	216	const char EVP_MAC_get0_description(const EVP_MAC mac)
03888233 RL	217	{
	218	return mac->description;
	219	}
	220
251e610c RL	221	int EVP_MAC_is_a(const EVP_MAC mac, const char name)
251e610c RL	222	{
e4a1d023	223	return evp_is_a(mac->prov, mac->name_id, NULL, name);
251e610c	224	}
f651c727	225
d84f5515 MC	226	int EVP_MAC_names_do_all(const EVP_MAC *mac,
	227	void (fn)(const char name, void *data),
	228	void *data)
f651c727 RL	229	{
f651c727 RL	230	if (mac->prov != NULL)
d84f5515 MC	231	return evp_names_do_all(mac->prov, mac->name_id, fn, data);
	232
	233	return 1;
f651c727	234	}
0a8a6afd DDO	235
	236	unsigned char EVP_Q_mac(OSSL_LIB_CTX libctx, const char name, const char propq,
	237	const char subalg, const OSSL_PARAM params,
	238	const void *key, size_t keylen,
	239	const unsigned char *data, size_t datalen,
	240	unsigned char out, size_t outsize, unsigned int outlen)
	241	{
	242	EVP_MAC *mac = EVP_MAC_fetch(libctx, name, propq);
	243	OSSL_PARAM subalg_param[] = { OSSL_PARAM_END, OSSL_PARAM_END };
	244	EVP_MAC_CTX *ctx = NULL;
	245	size_t len;
	246	unsigned char *res = NULL;
	247
	248	if (outlen != NULL)
	249	*outlen = 0;
	250	if (mac == NULL)
	251	return NULL;
	252	if (subalg != NULL) {
	253	const OSSL_PARAM *defined_params = EVP_MAC_settable_ctx_params(mac);
	254	const char *param_name = OSSL_MAC_PARAM_DIGEST;
	255
	256	/*
	257	* The underlying algorithm may be a cipher or a digest.
	258	* We don't know which it is, but we can ask the MAC what it
	259	* should be and bet on that.
	260	*/
	261	if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
	262	param_name = OSSL_MAC_PARAM_CIPHER;
	263	if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
	264	ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
	265	goto err;
	266	}
	267	}
	268	subalg_param[0] =
	269	OSSL_PARAM_construct_utf8_string(param_name, (char *)subalg, 0);
	270	}
	271	/* Single-shot - on NULL key input, set dummy key value for EVP_MAC_Init. */
	272	if (key == NULL && keylen == 0)
	273	key = data;
	274	if ((ctx = EVP_MAC_CTX_new(mac)) != NULL
	275	&& EVP_MAC_CTX_set_params(ctx, subalg_param)
	276	&& EVP_MAC_CTX_set_params(ctx, params)
	277	&& EVP_MAC_init(ctx, key, keylen, params)
	278	&& EVP_MAC_update(ctx, data, datalen)
	279	&& EVP_MAC_final(ctx, out, &len, outsize)) {
	280	if (out == NULL) {
	281	out = OPENSSL_malloc(len);
	282	if (out != NULL && !EVP_MAC_final(ctx, out, NULL, len)) {
	283	OPENSSL_free(out);
	284	out = NULL;
	285	}
	286	}
	287	res = out;
	288	if (res != NULL && outlen != NULL)
	289	*outlen = (unsigned int)len;
	290	}
	291
	292	err:
	293	EVP_MAC_CTX_free(ctx);
	294	EVP_MAC_free(mac);
	295	return res;
	296	}