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 #include <openssl/core_dispatch.h>
12 #include <openssl/core_names.h>
13 #include <openssl/params.h>
14 #include <openssl/evp.h>
15 #include <openssl/err.h>
16 #include <openssl/proverr.h>
18 #include "prov/implementations.h"
19 #include "prov/provider_ctx.h"
20 #include "prov/provider_util.h"
21 #include "prov/providercommon.h"
24 * Forward declaration of everything implemented here. This is not strictly
25 * necessary for the compiler, but provides an assurance that the signatures
26 * of the functions in the dispatch table are correct.
28 static OSSL_FUNC_mac_newctx_fn gmac_new
;
29 static OSSL_FUNC_mac_dupctx_fn gmac_dup
;
30 static OSSL_FUNC_mac_freectx_fn gmac_free
;
31 static OSSL_FUNC_mac_gettable_params_fn gmac_gettable_params
;
32 static OSSL_FUNC_mac_get_params_fn gmac_get_params
;
33 static OSSL_FUNC_mac_settable_ctx_params_fn gmac_settable_ctx_params
;
34 static OSSL_FUNC_mac_set_ctx_params_fn gmac_set_ctx_params
;
35 static OSSL_FUNC_mac_init_fn gmac_init
;
36 static OSSL_FUNC_mac_update_fn gmac_update
;
37 static OSSL_FUNC_mac_final_fn gmac_final
;
39 /* local GMAC pkey structure */
43 EVP_CIPHER_CTX
*ctx
; /* Cipher context */
47 static void gmac_free(void *vmacctx
)
49 struct gmac_data_st
*macctx
= vmacctx
;
52 EVP_CIPHER_CTX_free(macctx
->ctx
);
53 ossl_prov_cipher_reset(&macctx
->cipher
);
58 static void *gmac_new(void *provctx
)
60 struct gmac_data_st
*macctx
;
62 if (!ossl_prov_is_running())
65 if ((macctx
= OPENSSL_zalloc(sizeof(*macctx
))) == NULL
66 || (macctx
->ctx
= EVP_CIPHER_CTX_new()) == NULL
) {
70 macctx
->provctx
= provctx
;
75 static void *gmac_dup(void *vsrc
)
77 struct gmac_data_st
*src
= vsrc
;
78 struct gmac_data_st
*dst
;
80 if (!ossl_prov_is_running())
83 dst
= gmac_new(src
->provctx
);
87 if (!EVP_CIPHER_CTX_copy(dst
->ctx
, src
->ctx
)
88 || !ossl_prov_cipher_copy(&dst
->cipher
, &src
->cipher
)) {
95 static size_t gmac_size(void)
97 return EVP_GCM_TLS_TAG_LEN
;
100 static int gmac_setkey(struct gmac_data_st
*macctx
,
101 const unsigned char *key
, size_t keylen
)
103 EVP_CIPHER_CTX
*ctx
= macctx
->ctx
;
105 if (keylen
!= (size_t)EVP_CIPHER_CTX_get_key_length(ctx
)) {
106 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
109 if (!EVP_EncryptInit_ex(ctx
, NULL
, NULL
, key
, NULL
))
114 static int gmac_init(void *vmacctx
, const unsigned char *key
,
115 size_t keylen
, const OSSL_PARAM params
[])
117 struct gmac_data_st
*macctx
= vmacctx
;
119 if (!ossl_prov_is_running() || !gmac_set_ctx_params(macctx
, params
))
122 return gmac_setkey(macctx
, key
, keylen
);
123 return EVP_EncryptInit_ex(macctx
->ctx
, NULL
, NULL
, NULL
, NULL
);
126 static int gmac_update(void *vmacctx
, const unsigned char *data
,
129 struct gmac_data_st
*macctx
= vmacctx
;
130 EVP_CIPHER_CTX
*ctx
= macctx
->ctx
;
136 while (datalen
> INT_MAX
) {
137 if (!EVP_EncryptUpdate(ctx
, NULL
, &outlen
, data
, INT_MAX
))
142 return EVP_EncryptUpdate(ctx
, NULL
, &outlen
, data
, datalen
);
145 static int gmac_final(void *vmacctx
, unsigned char *out
, size_t *outl
,
148 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
149 struct gmac_data_st
*macctx
= vmacctx
;
152 if (!ossl_prov_is_running())
155 if (!EVP_EncryptFinal_ex(macctx
->ctx
, out
, &hlen
))
159 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
,
161 if (!EVP_CIPHER_CTX_get_params(macctx
->ctx
, params
))
168 static const OSSL_PARAM known_gettable_params
[] = {
169 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
172 static const OSSL_PARAM
*gmac_gettable_params(void *provctx
)
174 return known_gettable_params
;
177 static int gmac_get_params(OSSL_PARAM params
[])
181 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
)
182 return OSSL_PARAM_set_size_t(p
, gmac_size());
187 static const OSSL_PARAM known_settable_ctx_params
[] = {
188 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_CIPHER
, NULL
, 0),
189 OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES
, NULL
, 0),
190 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY
, NULL
, 0),
191 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_IV
, NULL
, 0),
194 static const OSSL_PARAM
*gmac_settable_ctx_params(ossl_unused
void *ctx
,
195 ossl_unused
void *provctx
)
197 return known_settable_ctx_params
;
201 * ALL parameters should be set before init().
203 static int gmac_set_ctx_params(void *vmacctx
, const OSSL_PARAM params
[])
205 struct gmac_data_st
*macctx
= vmacctx
;
206 EVP_CIPHER_CTX
*ctx
= macctx
->ctx
;
207 OSSL_LIB_CTX
*provctx
= PROV_LIBCTX_OF(macctx
->provctx
);
215 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_CIPHER
)) != NULL
) {
216 if (!ossl_prov_cipher_load_from_params(&macctx
->cipher
, params
, provctx
))
218 if (EVP_CIPHER_get_mode(ossl_prov_cipher_cipher(&macctx
->cipher
))
219 != EVP_CIPH_GCM_MODE
) {
220 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_MODE
);
223 if (!EVP_EncryptInit_ex(ctx
, ossl_prov_cipher_cipher(&macctx
->cipher
),
224 ossl_prov_cipher_engine(&macctx
->cipher
), NULL
,
229 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_KEY
)) != NULL
)
230 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
231 || !gmac_setkey(macctx
, p
->data
, p
->data_size
))
234 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_IV
)) != NULL
) {
235 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
)
238 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_AEAD_SET_IVLEN
,
240 || !EVP_EncryptInit_ex(ctx
, NULL
, NULL
, NULL
, p
->data
))
246 const OSSL_DISPATCH ossl_gmac_functions
[] = {
247 { OSSL_FUNC_MAC_NEWCTX
, (void (*)(void))gmac_new
},
248 { OSSL_FUNC_MAC_DUPCTX
, (void (*)(void))gmac_dup
},
249 { OSSL_FUNC_MAC_FREECTX
, (void (*)(void))gmac_free
},
250 { OSSL_FUNC_MAC_INIT
, (void (*)(void))gmac_init
},
251 { OSSL_FUNC_MAC_UPDATE
, (void (*)(void))gmac_update
},
252 { OSSL_FUNC_MAC_FINAL
, (void (*)(void))gmac_final
},
253 { OSSL_FUNC_MAC_GETTABLE_PARAMS
, (void (*)(void))gmac_gettable_params
},
254 { OSSL_FUNC_MAC_GET_PARAMS
, (void (*)(void))gmac_get_params
},
255 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS
,
256 (void (*)(void))gmac_settable_ctx_params
},
257 { OSSL_FUNC_MAC_SET_CTX_PARAMS
, (void (*)(void))gmac_set_ctx_params
},