2 * Copyright 2018-2020 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/engine.h>
20 #include <openssl/evp.h>
21 #include <openssl/cmac.h>
23 #include "prov/implementations.h"
24 #include "prov/provider_ctx.h"
25 #include "prov/provider_util.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 ((macctx
= OPENSSL_zalloc(sizeof(*macctx
))) == NULL
56 || (macctx
->ctx
= CMAC_CTX_new()) == NULL
) {
60 macctx
->provctx
= provctx
;
66 static void cmac_free(void *vmacctx
)
68 struct cmac_data_st
*macctx
= vmacctx
;
71 CMAC_CTX_free(macctx
->ctx
);
72 ossl_prov_cipher_reset(&macctx
->cipher
);
77 static void *cmac_dup(void *vsrc
)
79 struct cmac_data_st
*src
= vsrc
;
80 struct cmac_data_st
*dst
= cmac_new(src
->provctx
);
82 if (!CMAC_CTX_copy(dst
->ctx
, src
->ctx
)
83 || !ossl_prov_cipher_copy(&dst
->cipher
, &src
->cipher
)) {
90 static size_t cmac_size(void *vmacctx
)
92 struct cmac_data_st
*macctx
= vmacctx
;
94 return EVP_CIPHER_CTX_block_size(CMAC_CTX_get0_cipher_ctx(macctx
->ctx
));
97 static int cmac_init(void *vmacctx
)
99 struct cmac_data_st
*macctx
= vmacctx
;
100 int rv
= CMAC_Init(macctx
->ctx
, NULL
, 0,
101 ossl_prov_cipher_cipher(&macctx
->cipher
),
102 ossl_prov_cipher_engine(&macctx
->cipher
));
104 ossl_prov_cipher_reset(&macctx
->cipher
);
108 static int cmac_update(void *vmacctx
, const unsigned char *data
,
111 struct cmac_data_st
*macctx
= vmacctx
;
113 return CMAC_Update(macctx
->ctx
, data
, datalen
);
116 static int cmac_final(void *vmacctx
, unsigned char *out
, size_t *outl
,
119 struct cmac_data_st
*macctx
= vmacctx
;
121 return CMAC_Final(macctx
->ctx
, out
, outl
);
124 static const OSSL_PARAM known_gettable_ctx_params
[] = {
125 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
128 static const OSSL_PARAM
*cmac_gettable_ctx_params(void)
130 return known_gettable_ctx_params
;
133 static int cmac_get_ctx_params(void *vmacctx
, OSSL_PARAM params
[])
137 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
)
138 return OSSL_PARAM_set_size_t(p
, cmac_size(vmacctx
));
143 static const OSSL_PARAM known_settable_ctx_params
[] = {
144 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER
, NULL
, 0),
145 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES
, NULL
, 0),
146 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY
, NULL
, 0),
149 static const OSSL_PARAM
*cmac_settable_ctx_params(void)
151 return known_settable_ctx_params
;
155 * ALL parameters should be set before init().
157 static int cmac_set_ctx_params(void *vmacctx
, const OSSL_PARAM params
[])
159 struct cmac_data_st
*macctx
= vmacctx
;
160 OPENSSL_CTX
*ctx
= PROV_LIBRARY_CONTEXT_OF(macctx
->provctx
);
163 if (!ossl_prov_cipher_load_from_params(&macctx
->cipher
, params
, ctx
))
166 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_KEY
)) != NULL
) {
167 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
)
170 if (!CMAC_Init(macctx
->ctx
, p
->data
, p
->data_size
,
171 ossl_prov_cipher_cipher(&macctx
->cipher
),
172 ossl_prov_cipher_engine(&macctx
->cipher
)))
175 ossl_prov_cipher_reset(&macctx
->cipher
);
180 const OSSL_DISPATCH cmac_functions
[] = {
181 { OSSL_FUNC_MAC_NEWCTX
, (void (*)(void))cmac_new
},
182 { OSSL_FUNC_MAC_DUPCTX
, (void (*)(void))cmac_dup
},
183 { OSSL_FUNC_MAC_FREECTX
, (void (*)(void))cmac_free
},
184 { OSSL_FUNC_MAC_INIT
, (void (*)(void))cmac_init
},
185 { OSSL_FUNC_MAC_UPDATE
, (void (*)(void))cmac_update
},
186 { OSSL_FUNC_MAC_FINAL
, (void (*)(void))cmac_final
},
187 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS
,
188 (void (*)(void))cmac_gettable_ctx_params
},
189 { OSSL_FUNC_MAC_GET_CTX_PARAMS
, (void (*)(void))cmac_get_ctx_params
},
190 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS
,
191 (void (*)(void))cmac_settable_ctx_params
},
192 { OSSL_FUNC_MAC_SET_CTX_PARAMS
, (void (*)(void))cmac_set_ctx_params
},