1 /*
2 * Copyright 2018-2023 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 /*
11 * CMAC low level APIs are deprecated for public use, but still ok for internal
12 * use.
13 */
14 #include "internal/deprecated.h"
15
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>
21 #include <openssl/err.h>
22 #include <openssl/proverr.h>
23
24 #include "prov/implementations.h"
25 #include "prov/provider_ctx.h"
26 #include "prov/provider_util.h"
27 #include "prov/providercommon.h"
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 */
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;
44
45 /* local CMAC data */
46
47 struct cmac_data_st {
48 void *provctx;
49 CMAC_CTX *ctx;
50 PROV_CIPHER cipher;
51 };
52
cmac_new(void * provctx)53 static void *cmac_new(void *provctx)
54 {
55 struct cmac_data_st *macctx;
56
57 if (!ossl_prov_is_running())
58 return NULL;
59
60 if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
61 || (macctx->ctx = CMAC_CTX_new()) == NULL) {
62 OPENSSL_free(macctx);
63 macctx = NULL;
64 } else {
65 macctx->provctx = provctx;
66 }
67
68 return macctx;
69 }
70
cmac_free(void * vmacctx)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);
77 ossl_prov_cipher_reset(&macctx->cipher);
78 OPENSSL_free(macctx);
79 }
80 }
81
cmac_dup(void * vsrc)82 static void *cmac_dup(void *vsrc)
83 {
84 struct cmac_data_st *src = vsrc;
85 struct cmac_data_st *dst;
86
87 if (!ossl_prov_is_running())
88 return NULL;
89
90 dst = cmac_new(src->provctx);
91 if (dst == NULL)
92 return NULL;
93 if (!CMAC_CTX_copy(dst->ctx, src->ctx)
94 || !ossl_prov_cipher_copy(&dst->cipher, &src->cipher)) {
95 cmac_free(dst);
96 return NULL;
97 }
98 return dst;
99 }
100
cmac_size(void * vmacctx)101 static size_t cmac_size(void *vmacctx)
102 {
103 struct cmac_data_st *macctx = vmacctx;
104 const EVP_CIPHER_CTX *cipherctx = CMAC_CTX_get0_cipher_ctx(macctx->ctx);
105
106 if (EVP_CIPHER_CTX_get0_cipher(cipherctx) == NULL)
107 return 0;
108
109 return EVP_CIPHER_CTX_get_block_size(cipherctx);
110 }
111
cmac_setkey(struct cmac_data_st * macctx,const unsigned char * key,size_t keylen)112 static int cmac_setkey(struct cmac_data_st *macctx,
113 const unsigned char *key, size_t keylen)
114 {
115 int rv = CMAC_Init(macctx->ctx, key, keylen,
116 ossl_prov_cipher_cipher(&macctx->cipher),
117 ossl_prov_cipher_engine(&macctx->cipher));
118 ossl_prov_cipher_reset(&macctx->cipher);
119 return rv;
120 }
121
cmac_init(void * vmacctx,const unsigned char * key,size_t keylen,const OSSL_PARAM params[])122 static int cmac_init(void *vmacctx, const unsigned char *key,
123 size_t keylen, const OSSL_PARAM params[])
124 {
125 struct cmac_data_st *macctx = vmacctx;
126
127 if (!ossl_prov_is_running() || !cmac_set_ctx_params(macctx, params))
128 return 0;
129 if (key != NULL)
130 return cmac_setkey(macctx, key, keylen);
131 /* Reinitialize the CMAC context */
132 return CMAC_Init(macctx->ctx, NULL, 0, NULL, NULL);
133 }
134
cmac_update(void * vmacctx,const unsigned char * data,size_t datalen)135 static int cmac_update(void *vmacctx, const unsigned char *data,
136 size_t datalen)
137 {
138 struct cmac_data_st *macctx = vmacctx;
139
140 return CMAC_Update(macctx->ctx, data, datalen);
141 }
142
cmac_final(void * vmacctx,unsigned char * out,size_t * outl,size_t outsize)143 static int cmac_final(void *vmacctx, unsigned char *out, size_t *outl,
144 size_t outsize)
145 {
146 struct cmac_data_st *macctx = vmacctx;
147
148 if (!ossl_prov_is_running())
149 return 0;
150
151 return CMAC_Final(macctx->ctx, out, outl);
152 }
153
154 static const OSSL_PARAM known_gettable_ctx_params[] = {
155 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
156 OSSL_PARAM_size_t(OSSL_MAC_PARAM_BLOCK_SIZE, NULL),
157 OSSL_PARAM_END
158 };
cmac_gettable_ctx_params(ossl_unused void * ctx,ossl_unused void * provctx)159 static const OSSL_PARAM *cmac_gettable_ctx_params(ossl_unused void *ctx,
160 ossl_unused void *provctx)
161 {
162 return known_gettable_ctx_params;
163 }
164
cmac_get_ctx_params(void * vmacctx,OSSL_PARAM params[])165 static int cmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
166 {
167 OSSL_PARAM *p;
168
169 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
170 && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
171 return 0;
172
173 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
174 && !OSSL_PARAM_set_size_t(p, cmac_size(vmacctx)))
175 return 0;
176
177 return 1;
178 }
179
180 static const OSSL_PARAM known_settable_ctx_params[] = {
181 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER, NULL, 0),
182 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
183 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
184 OSSL_PARAM_END
185 };
cmac_settable_ctx_params(ossl_unused void * ctx,ossl_unused void * provctx)186 static const OSSL_PARAM *cmac_settable_ctx_params(ossl_unused void *ctx,
187 ossl_unused void *provctx)
188 {
189 return known_settable_ctx_params;
190 }
191
192 /*
193 * ALL parameters should be set before init().
194 */
cmac_set_ctx_params(void * vmacctx,const OSSL_PARAM params[])195 static int cmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
196 {
197 struct cmac_data_st *macctx = vmacctx;
198 OSSL_LIB_CTX *ctx = PROV_LIBCTX_OF(macctx->provctx);
199 const OSSL_PARAM *p;
200
201 if (params == NULL)
202 return 1;
203
204 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CIPHER)) != NULL) {
205 if (!ossl_prov_cipher_load_from_params(&macctx->cipher, params, ctx))
206 return 0;
207
208 if (EVP_CIPHER_get_mode(ossl_prov_cipher_cipher(&macctx->cipher))
209 != EVP_CIPH_CBC_MODE) {
210 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
211 return 0;
212 }
213 }
214
215 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
216 if (p->data_type != OSSL_PARAM_OCTET_STRING)
217 return 0;
218 return cmac_setkey(macctx, p->data, p->data_size);
219 }
220 return 1;
221 }
222
223 const OSSL_DISPATCH ossl_cmac_functions[] = {
224 { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))cmac_new },
225 { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))cmac_dup },
226 { OSSL_FUNC_MAC_FREECTX, (void (*)(void))cmac_free },
227 { OSSL_FUNC_MAC_INIT, (void (*)(void))cmac_init },
228 { OSSL_FUNC_MAC_UPDATE, (void (*)(void))cmac_update },
229 { OSSL_FUNC_MAC_FINAL, (void (*)(void))cmac_final },
230 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
231 (void (*)(void))cmac_gettable_ctx_params },
232 { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))cmac_get_ctx_params },
233 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
234 (void (*)(void))cmac_settable_ctx_params },
235 { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))cmac_set_ctx_params },
236 OSSL_DISPATCH_END
237 };
238
