2 * Copyright 2018-2022 The OpenSSL Project Authors. All Rights Reserved.
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
11 * CMAC low level APIs are deprecated for public use, but still ok for internal
14 #include "internal/deprecated.h"
16 #include <openssl/core_dispatch.h>
17 #include <openssl/core_names.h>
18 #include <openssl/params.h>
19 #include <openssl/evp.h>
20 #include <openssl/cmac.h>
22 #include "prov/implementations.h"
23 #include "prov/provider_ctx.h"
24 #include "prov/provider_util.h"
25 #include "prov/providercommon.h"
28 * Forward declaration of everything implemented here. This is not strictly
29 * necessary for the compiler, but provides an assurance that the signatures
30 * of the functions in the dispatch table are correct.
32 static OSSL_FUNC_mac_newctx_fn cmac_new;
33 static OSSL_FUNC_mac_dupctx_fn cmac_dup;
34 static OSSL_FUNC_mac_freectx_fn cmac_free;
35 static OSSL_FUNC_mac_gettable_ctx_params_fn cmac_gettable_ctx_params;
36 static OSSL_FUNC_mac_get_ctx_params_fn cmac_get_ctx_params;
37 static OSSL_FUNC_mac_settable_ctx_params_fn cmac_settable_ctx_params;
38 static OSSL_FUNC_mac_set_ctx_params_fn cmac_set_ctx_params;
39 static OSSL_FUNC_mac_init_fn cmac_init;
40 static OSSL_FUNC_mac_update_fn cmac_update;
41 static OSSL_FUNC_mac_final_fn cmac_final;
51 static void *cmac_new(void *provctx)
53 struct cmac_data_st *macctx;
55 if (!ossl_prov_is_running())
58 if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
59 || (macctx->ctx = CMAC_CTX_new()) == NULL) {
63 macctx->provctx = provctx;
69 static void cmac_free(void *vmacctx)
71 struct cmac_data_st *macctx = vmacctx;
74 CMAC_CTX_free(macctx->ctx);
75 ossl_prov_cipher_reset(&macctx->cipher);
80 static void *cmac_dup(void *vsrc)
82 struct cmac_data_st *src = vsrc;
83 struct cmac_data_st *dst;
85 if (!ossl_prov_is_running())
88 dst = cmac_new(src->provctx);
91 if (!CMAC_CTX_copy(dst->ctx, src->ctx)
92 || !ossl_prov_cipher_copy(&dst->cipher, &src->cipher)) {
99 static size_t cmac_size(void *vmacctx)
101 struct cmac_data_st *macctx = vmacctx;
103 return EVP_CIPHER_CTX_get_block_size(CMAC_CTX_get0_cipher_ctx(macctx->ctx));
106 static int cmac_setkey(struct cmac_data_st *macctx,
107 const unsigned char *key, size_t keylen)
109 int rv = CMAC_Init(macctx->ctx, key, keylen,
110 ossl_prov_cipher_cipher(&macctx->cipher),
111 ossl_prov_cipher_engine(&macctx->cipher));
112 ossl_prov_cipher_reset(&macctx->cipher);
116 static int cmac_init(void *vmacctx, const unsigned char *key,
117 size_t keylen, const OSSL_PARAM params[])
119 struct cmac_data_st *macctx = vmacctx;
121 if (!ossl_prov_is_running() || !cmac_set_ctx_params(macctx, params))
124 return cmac_setkey(macctx, key, keylen);
125 /* Reinitialize the CMAC context */
126 return CMAC_Init(macctx->ctx, NULL, 0, NULL, NULL);
129 static int cmac_update(void *vmacctx, const unsigned char *data,
132 struct cmac_data_st *macctx = vmacctx;
134 return CMAC_Update(macctx->ctx, data, datalen);
137 static int cmac_final(void *vmacctx, unsigned char *out, size_t *outl,
140 struct cmac_data_st *macctx = vmacctx;
142 if (!ossl_prov_is_running())
145 return CMAC_Final(macctx->ctx, out, outl);
148 static const OSSL_PARAM known_gettable_ctx_params[] = {
149 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
150 OSSL_PARAM_size_t(OSSL_MAC_PARAM_BLOCK_SIZE, NULL),
153 static const OSSL_PARAM *cmac_gettable_ctx_params(ossl_unused void *ctx,
154 ossl_unused void *provctx)
156 return known_gettable_ctx_params;
159 static int cmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
163 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
164 && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
167 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
168 && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
174 static const OSSL_PARAM known_settable_ctx_params[] = {
175 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER, NULL, 0),
176 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
177 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
180 static const OSSL_PARAM *cmac_settable_ctx_params(ossl_unused void *ctx,
181 ossl_unused void *provctx)
183 return known_settable_ctx_params;
187 * ALL parameters should be set before init().
189 static int cmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
191 struct cmac_data_st *macctx = vmacctx;
192 OSSL_LIB_CTX *ctx = PROV_LIBCTX_OF(macctx->provctx);
198 if (!ossl_prov_cipher_load_from_params(&macctx->cipher, params, ctx))
201 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
202 if (p->data_type != OSSL_PARAM_OCTET_STRING)
204 return cmac_setkey(macctx, p->data, p->data_size);
209 const OSSL_DISPATCH ossl_cmac_functions[] = {
210 { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))cmac_new },
211 { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))cmac_dup },
212 { OSSL_FUNC_MAC_FREECTX, (void (*)(void))cmac_free },
213 { OSSL_FUNC_MAC_INIT, (void (*)(void))cmac_init },
214 { OSSL_FUNC_MAC_UPDATE, (void (*)(void))cmac_update },
215 { OSSL_FUNC_MAC_FINAL, (void (*)(void))cmac_final },
216 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
217 (void (*)(void))cmac_gettable_ctx_params },
218 { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))cmac_get_ctx_params },
219 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
220 (void (*)(void))cmac_settable_ctx_params },
221 { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))cmac_set_ctx_params },