[thirdparty/openssl.git] / providers / implementations / macs / cmac_prov.c

/*
 * Copyright 2018-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
 */

/*
 * CMAC low level APIs are deprecated for public use, but still ok for internal
 * use.
 */
#include "internal/deprecated.h"

#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/evp.h>
#include <openssl/cmac.h>
#include <openssl/err.h>
#include <openssl/proverr.h>

#include "prov/implementations.h"
#include "prov/provider_ctx.h"
#include "prov/provider_util.h"
#include "prov/providercommon.h"

/*
 * Forward declaration of everything implemented here.  This is not strictly
 * necessary for the compiler, but provides an assurance that the signatures
 * of the functions in the dispatch table are correct.
 */
static OSSL_FUNC_mac_newctx_fn cmac_new;
static OSSL_FUNC_mac_dupctx_fn cmac_dup;
static OSSL_FUNC_mac_freectx_fn cmac_free;
static OSSL_FUNC_mac_gettable_ctx_params_fn cmac_gettable_ctx_params;
static OSSL_FUNC_mac_get_ctx_params_fn cmac_get_ctx_params;
static OSSL_FUNC_mac_settable_ctx_params_fn cmac_settable_ctx_params;
static OSSL_FUNC_mac_set_ctx_params_fn cmac_set_ctx_params;
static OSSL_FUNC_mac_init_fn cmac_init;
static OSSL_FUNC_mac_update_fn cmac_update;
static OSSL_FUNC_mac_final_fn cmac_final;

/* local CMAC data */

struct cmac_data_st {
    void *provctx;
    CMAC_CTX *ctx;
    PROV_CIPHER cipher;
};

static void *cmac_new(void *provctx)
{
    struct cmac_data_st *macctx;

    if (!ossl_prov_is_running())
        return NULL;

    if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
        || (macctx->ctx = CMAC_CTX_new()) == NULL) {
        OPENSSL_free(macctx);
        macctx = NULL;
    } else {
        macctx->provctx = provctx;
    }

    return macctx;
}

static void cmac_free(void *vmacctx)
{
    struct cmac_data_st *macctx = vmacctx;

    if (macctx != NULL) {
        CMAC_CTX_free(macctx->ctx);
        ossl_prov_cipher_reset(&macctx->cipher);
        OPENSSL_free(macctx);
    }
}

static void *cmac_dup(void *vsrc)
{
    struct cmac_data_st *src = vsrc;
    struct cmac_data_st *dst;

    if (!ossl_prov_is_running())
        return NULL;

    dst = cmac_new(src->provctx);
    if (dst == NULL)
        return NULL;
    if (!CMAC_CTX_copy(dst->ctx, src->ctx)
        || !ossl_prov_cipher_copy(&dst->cipher, &src->cipher)) {
        cmac_free(dst);
        return NULL;
    }
    return dst;
}

static size_t cmac_size(void *vmacctx)
{
    struct cmac_data_st *macctx = vmacctx;

    return EVP_CIPHER_CTX_get_block_size(CMAC_CTX_get0_cipher_ctx(macctx->ctx));
}

static int cmac_setkey(struct cmac_data_st *macctx,
                       const unsigned char *key, size_t keylen)
{
    int rv = CMAC_Init(macctx->ctx, key, keylen,
                       ossl_prov_cipher_cipher(&macctx->cipher),
                       ossl_prov_cipher_engine(&macctx->cipher));
    ossl_prov_cipher_reset(&macctx->cipher);
    return rv;
}

static int cmac_init(void *vmacctx, const unsigned char *key,
                     size_t keylen, const OSSL_PARAM params[])
{
    struct cmac_data_st *macctx = vmacctx;

    if (!ossl_prov_is_running() || !cmac_set_ctx_params(macctx, params))
        return 0;
    if (key != NULL)
        return cmac_setkey(macctx, key, keylen);
    /* Reinitialize the CMAC context */
    return CMAC_Init(macctx->ctx, NULL, 0, NULL, NULL);
}

static int cmac_update(void *vmacctx, const unsigned char *data,
                       size_t datalen)
{
    struct cmac_data_st *macctx = vmacctx;

    return CMAC_Update(macctx->ctx, data, datalen);
}

static int cmac_final(void *vmacctx, unsigned char *out, size_t *outl,
                      size_t outsize)
{
    struct cmac_data_st *macctx = vmacctx;

    if (!ossl_prov_is_running())
        return 0;

    return CMAC_Final(macctx->ctx, out, outl);
}

static const OSSL_PARAM known_gettable_ctx_params[] = {
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_BLOCK_SIZE, NULL),
    OSSL_PARAM_END
};
static const OSSL_PARAM *cmac_gettable_ctx_params(ossl_unused void *ctx,
                                                  ossl_unused void *provctx)
{
    return known_gettable_ctx_params;
}

static int cmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
{
    OSSL_PARAM *p;

    if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
            && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
        return 0;

    if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
            && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
        return 0;

    return 1;
}

static const OSSL_PARAM known_settable_ctx_params[] = {
    OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER, NULL, 0),
    OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
    OSSL_PARAM_END
};
static const OSSL_PARAM *cmac_settable_ctx_params(ossl_unused void *ctx,
                                                  ossl_unused void *provctx)
{
    return known_settable_ctx_params;
}

/*
 * ALL parameters should be set before init().
 */
static int cmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
{
    struct cmac_data_st *macctx = vmacctx;
    OSSL_LIB_CTX *ctx = PROV_LIBCTX_OF(macctx->provctx);
    const OSSL_PARAM *p;

    if (params == NULL)
        return 1;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CIPHER)) != NULL) {
        if (!ossl_prov_cipher_load_from_params(&macctx->cipher, params, ctx))
            return 0;

        if (EVP_CIPHER_get_mode(ossl_prov_cipher_cipher(&macctx->cipher))
            != EVP_CIPH_CBC_MODE) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
            return 0;
        }
    }

    if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
        if (p->data_type != OSSL_PARAM_OCTET_STRING)
            return 0;
        return cmac_setkey(macctx, p->data, p->data_size);
    }
    return 1;
}

const OSSL_DISPATCH ossl_cmac_functions[] = {
    { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))cmac_new },
    { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))cmac_dup },
    { OSSL_FUNC_MAC_FREECTX, (void (*)(void))cmac_free },
    { OSSL_FUNC_MAC_INIT, (void (*)(void))cmac_init },
    { OSSL_FUNC_MAC_UPDATE, (void (*)(void))cmac_update },
    { OSSL_FUNC_MAC_FINAL, (void (*)(void))cmac_final },
    { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
      (void (*)(void))cmac_gettable_ctx_params },
    { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))cmac_get_ctx_params },
    { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
      (void (*)(void))cmac_settable_ctx_params },
    { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))cmac_set_ctx_params },
    OSSL_DISPATCH_END
};
Commit	Line	Data
2e5db6ad	1	/*
fecb3aae	2	* Copyright 2018-2022 The OpenSSL Project Authors. All Rights Reserved.
2e5db6ad RL	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
a6d572e6 P	10	/*
	11	* CMAC low level APIs are deprecated for public use, but still ok for internal
	12	* use.
	13	*/
	14	#include "internal/deprecated.h"
	15
23c48d94	16	#include <openssl/core_dispatch.h>
bad41b68 MC	17	#include <openssl/core_names.h>
bad41b68 MC	18	#include <openssl/params.h>
bad41b68 MC	19	#include <openssl/evp.h>
bad41b68 MC	20	#include <openssl/cmac.h>
94976a1e TM	21	#include <openssl/err.h>
94976a1e TM	22	#include <openssl/proverr.h>
2e5db6ad	23
af3e7e1b	24	#include "prov/implementations.h"
ddd21319 RL	25	#include "prov/provider_ctx.h"
ddd21319 RL	26	#include "prov/provider_util.h"
5b104a81	27	#include "prov/providercommon.h"
2e5db6ad RL	28
	29	/*
	30	* Forward declaration of everything implemented here. This is not strictly
	31	* necessary for the compiler, but provides an assurance that the signatures
	32	* of the functions in the dispatch table are correct.
	33	*/
363b1e5d DMSP	34	static OSSL_FUNC_mac_newctx_fn cmac_new;
	35	static OSSL_FUNC_mac_dupctx_fn cmac_dup;
	36	static OSSL_FUNC_mac_freectx_fn cmac_free;
	37	static OSSL_FUNC_mac_gettable_ctx_params_fn cmac_gettable_ctx_params;
	38	static OSSL_FUNC_mac_get_ctx_params_fn cmac_get_ctx_params;
	39	static OSSL_FUNC_mac_settable_ctx_params_fn cmac_settable_ctx_params;
	40	static OSSL_FUNC_mac_set_ctx_params_fn cmac_set_ctx_params;
	41	static OSSL_FUNC_mac_init_fn cmac_init;
	42	static OSSL_FUNC_mac_update_fn cmac_update;
	43	static OSSL_FUNC_mac_final_fn cmac_final;
2e5db6ad RL	44
	45	/* local CMAC data */
	46
	47	struct cmac_data_st {
	48	void *provctx;
	49	CMAC_CTX *ctx;
1dcc7ee6	50	PROV_CIPHER cipher;
2e5db6ad RL	51	};
	52
	53	static void cmac_new(void provctx)
	54	{
	55	struct cmac_data_st *macctx;
	56
5b104a81 P	57	if (!ossl_prov_is_running())
	58	return NULL;
	59
2e5db6ad RL	60	if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
	61	\|\| (macctx->ctx = CMAC_CTX_new()) == NULL) {
	62	OPENSSL_free(macctx);
	63	macctx = NULL;
d5f85429 RL	64	} else {
d5f85429 RL	65	macctx->provctx = provctx;
2e5db6ad	66	}
2e5db6ad RL	67
	68	return macctx;
	69	}
	70
	71	static void cmac_free(void *vmacctx)
	72	{
	73	struct cmac_data_st *macctx = vmacctx;
	74
	75	if (macctx != NULL) {
	76	CMAC_CTX_free(macctx->ctx);
1dcc7ee6	77	ossl_prov_cipher_reset(&macctx->cipher);
2e5db6ad RL	78	OPENSSL_free(macctx);
	79	}
	80	}
	81
	82	static void cmac_dup(void vsrc)
	83	{
	84	struct cmac_data_st *src = vsrc;
5b104a81 P	85	struct cmac_data_st *dst;
	86
	87	if (!ossl_prov_is_running())
	88	return NULL;
2e5db6ad	89
5b104a81	90	dst = cmac_new(src->provctx);
ba3ea453 SL	91	if (dst == NULL)
ba3ea453 SL	92	return NULL;
1dcc7ee6 P	93	if (!CMAC_CTX_copy(dst->ctx, src->ctx)
1dcc7ee6 P	94	\|\| !ossl_prov_cipher_copy(&dst->cipher, &src->cipher)) {
2e5db6ad RL	95	cmac_free(dst);
	96	return NULL;
	97	}
2e5db6ad RL	98	return dst;
	99	}
	100
	101	static size_t cmac_size(void *vmacctx)
	102	{
	103	struct cmac_data_st *macctx = vmacctx;
	104
ed576acd	105	return EVP_CIPHER_CTX_get_block_size(CMAC_CTX_get0_cipher_ctx(macctx->ctx));
2e5db6ad RL	106	}
2e5db6ad RL	107
005b1902 P	108	static int cmac_setkey(struct cmac_data_st *macctx,
	109	const unsigned char *key, size_t keylen)
	110	{
	111	int rv = CMAC_Init(macctx->ctx, key, keylen,
	112	ossl_prov_cipher_cipher(&macctx->cipher),
	113	ossl_prov_cipher_engine(&macctx->cipher));
	114	ossl_prov_cipher_reset(&macctx->cipher);
3f773c91	115	return rv;
005b1902 P	116	}
	117
	118	static int cmac_init(void vmacctx, const unsigned char key,
	119	size_t keylen, const OSSL_PARAM params[])
2e5db6ad RL	120	{
2e5db6ad RL	121	struct cmac_data_st *macctx = vmacctx;
5b104a81	122
005b1902	123	if (!ossl_prov_is_running() \|\| !cmac_set_ctx_params(macctx, params))
5b104a81	124	return 0;
005b1902 P	125	if (key != NULL)
005b1902 P	126	return cmac_setkey(macctx, key, keylen);
c9ddc5af TM	127	/* Reinitialize the CMAC context */
c9ddc5af TM	128	return CMAC_Init(macctx->ctx, NULL, 0, NULL, NULL);
2e5db6ad RL	129	}
	130
	131	static int cmac_update(void vmacctx, const unsigned char data,
	132	size_t datalen)
	133	{
	134	struct cmac_data_st *macctx = vmacctx;
	135
	136	return CMAC_Update(macctx->ctx, data, datalen);
	137	}
	138
	139	static int cmac_final(void vmacctx, unsigned char out, size_t *outl,
	140	size_t outsize)
	141	{
	142	struct cmac_data_st *macctx = vmacctx;
	143
5b104a81 P	144	if (!ossl_prov_is_running())
	145	return 0;
	146
2e5db6ad RL	147	return CMAC_Final(macctx->ctx, out, outl);
	148	}
	149
	150	static const OSSL_PARAM known_gettable_ctx_params[] = {
703170d4	151	OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
eb1b66f0	152	OSSL_PARAM_size_t(OSSL_MAC_PARAM_BLOCK_SIZE, NULL),
2e5db6ad RL	153	OSSL_PARAM_END
2e5db6ad RL	154	};
eee323c3 P	155	static const OSSL_PARAM cmac_gettable_ctx_params(ossl_unused void ctx,
eee323c3 P	156	ossl_unused void *provctx)
2e5db6ad RL	157	{
	158	return known_gettable_ctx_params;
	159	}
	160
92d9d0ae	161	static int cmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
2e5db6ad RL	162	{
	163	OSSL_PARAM *p;
	164
eb1b66f0 P	165	if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
	166	&& !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
	167	return 0;
	168
	169	if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
	170	&& !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
	171	return 0;
2e5db6ad RL	172
	173	return 1;
	174	}
	175
	176	static const OSSL_PARAM known_settable_ctx_params[] = {
2e5db6ad	177	OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER, NULL, 0),
2e5db6ad RL	178	OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
	179	OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
	180	OSSL_PARAM_END
	181	};
eee323c3 P	182	static const OSSL_PARAM cmac_settable_ctx_params(ossl_unused void ctx,
eee323c3 P	183	ossl_unused void *provctx)
2e5db6ad RL	184	{
	185	return known_settable_ctx_params;
	186	}
	187
	188	/*
	189	* ALL parameters should be set before init().
	190	*/
92d9d0ae	191	static int cmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
2e5db6ad RL	192	{
2e5db6ad RL	193	struct cmac_data_st *macctx = vmacctx;
a829b735	194	OSSL_LIB_CTX *ctx = PROV_LIBCTX_OF(macctx->provctx);
2e5db6ad RL	195	const OSSL_PARAM *p;
2e5db6ad RL	196
5a6b62bb P	197	if (params == NULL)
	198	return 1;
	199
94976a1e TM	200	if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CIPHER)) != NULL) {
	201	if (!ossl_prov_cipher_load_from_params(&macctx->cipher, params, ctx))
	202	return 0;
	203
	204	if (EVP_CIPHER_get_mode(ossl_prov_cipher_cipher(&macctx->cipher))
	205	!= EVP_CIPH_CBC_MODE) {
	206	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
	207	return 0;
	208	}
	209	}
2e5db6ad	210
2e5db6ad RL	211	if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
	212	if (p->data_type != OSSL_PARAM_OCTET_STRING)
	213	return 0;
005b1902	214	return cmac_setkey(macctx, p->data, p->data_size);
2e5db6ad RL	215	}
	216	return 1;
	217	}
	218
1be63951	219	const OSSL_DISPATCH ossl_cmac_functions[] = {
2e5db6ad RL	220	{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))cmac_new },
	221	{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))cmac_dup },
	222	{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))cmac_free },
	223	{ OSSL_FUNC_MAC_INIT, (void (*)(void))cmac_init },
	224	{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))cmac_update },
	225	{ OSSL_FUNC_MAC_FINAL, (void (*)(void))cmac_final },
	226	{ OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
	227	(void (*)(void))cmac_gettable_ctx_params },
92d9d0ae	228	{ OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))cmac_get_ctx_params },
2e5db6ad RL	229	{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
2e5db6ad RL	230	(void (*)(void))cmac_settable_ctx_params },
92d9d0ae	231	{ OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))cmac_set_ctx_params },
1e6bd31e	232	OSSL_DISPATCH_END
2e5db6ad	233	};