asn1: fix indentation
[openssl.git] / providers / implementations / macs / gmac_prov.c
1 /*
2  * Copyright 2018-2021 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 #include <stdlib.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/core_names.h>
13 #include <openssl/params.h>
14 #include <openssl/engine.h>
15 #include <openssl/evp.h>
16 #include <openssl/err.h>
17 #include <openssl/proverr.h>
18
19 #include "prov/implementations.h"
20 #include "prov/provider_ctx.h"
21 #include "prov/provider_util.h"
22 #include "prov/providercommon.h"
23
24 /*
25  * Forward declaration of everything implemented here.  This is not strictly
26  * necessary for the compiler, but provides an assurance that the signatures
27  * of the functions in the dispatch table are correct.
28  */
29 static OSSL_FUNC_mac_newctx_fn gmac_new;
30 static OSSL_FUNC_mac_dupctx_fn gmac_dup;
31 static OSSL_FUNC_mac_freectx_fn gmac_free;
32 static OSSL_FUNC_mac_gettable_params_fn gmac_gettable_params;
33 static OSSL_FUNC_mac_get_params_fn gmac_get_params;
34 static OSSL_FUNC_mac_settable_ctx_params_fn gmac_settable_ctx_params;
35 static OSSL_FUNC_mac_set_ctx_params_fn gmac_set_ctx_params;
36 static OSSL_FUNC_mac_init_fn gmac_init;
37 static OSSL_FUNC_mac_update_fn gmac_update;
38 static OSSL_FUNC_mac_final_fn gmac_final;
39
40 /* local GMAC pkey structure */
41
42 struct gmac_data_st {
43     void *provctx;
44     EVP_CIPHER_CTX *ctx;         /* Cipher context */
45     PROV_CIPHER cipher;
46 };
47
48 static void gmac_free(void *vmacctx)
49 {
50     struct gmac_data_st *macctx = vmacctx;
51
52     if (macctx != NULL) {
53         EVP_CIPHER_CTX_free(macctx->ctx);
54         ossl_prov_cipher_reset(&macctx->cipher);
55         OPENSSL_free(macctx);
56     }
57 }
58
59 static void *gmac_new(void *provctx)
60 {
61     struct gmac_data_st *macctx;
62
63     if (!ossl_prov_is_running())
64         return NULL;
65
66     if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
67         || (macctx->ctx = EVP_CIPHER_CTX_new()) == NULL) {
68         gmac_free(macctx);
69         return NULL;
70     }
71     macctx->provctx = provctx;
72
73     return macctx;
74 }
75
76 static void *gmac_dup(void *vsrc)
77 {
78     struct gmac_data_st *src = vsrc;
79     struct gmac_data_st *dst;
80
81     if (!ossl_prov_is_running())
82         return NULL;
83
84     dst = gmac_new(src->provctx);
85     if (dst == NULL)
86         return NULL;
87
88     if (!EVP_CIPHER_CTX_copy(dst->ctx, src->ctx)
89         || !ossl_prov_cipher_copy(&dst->cipher, &src->cipher)) {
90         gmac_free(dst);
91         return NULL;
92     }
93     return dst;
94 }
95
96 static size_t gmac_size(void)
97 {
98     return EVP_GCM_TLS_TAG_LEN;
99 }
100
101 static int gmac_setkey(struct gmac_data_st *macctx,
102                        const unsigned char *key, size_t keylen)
103 {
104     EVP_CIPHER_CTX *ctx = macctx->ctx;
105
106     if (keylen != (size_t)EVP_CIPHER_CTX_key_length(ctx)) {
107         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
108         return 0;
109     }
110     if (!EVP_EncryptInit_ex(ctx, NULL, NULL, key, NULL))
111         return 0;
112     return 1;
113 }
114
115 static int gmac_init(void *vmacctx, const unsigned char *key,
116                      size_t keylen, const OSSL_PARAM params[])
117 {
118     struct gmac_data_st *macctx = vmacctx;
119
120     if (!ossl_prov_is_running() || !gmac_set_ctx_params(macctx, params))
121         return 0;
122     if (key != NULL)
123         return gmac_setkey(macctx, key, keylen);
124     return 1;
125 }
126
127 static int gmac_update(void *vmacctx, const unsigned char *data,
128                        size_t datalen)
129 {
130     struct gmac_data_st *macctx = vmacctx;
131     EVP_CIPHER_CTX *ctx = macctx->ctx;
132     int outlen;
133
134     if (datalen == 0)
135         return 1;
136
137     while (datalen > INT_MAX) {
138         if (!EVP_EncryptUpdate(ctx, NULL, &outlen, data, INT_MAX))
139             return 0;
140         data += INT_MAX;
141         datalen -= INT_MAX;
142     }
143     return EVP_EncryptUpdate(ctx, NULL, &outlen, data, datalen);
144 }
145
146 static int gmac_final(void *vmacctx, unsigned char *out, size_t *outl,
147                       size_t outsize)
148 {
149     struct gmac_data_st *macctx = vmacctx;
150     int hlen = 0;
151
152     if (!ossl_prov_is_running())
153         return 0;
154
155     if (!EVP_EncryptFinal_ex(macctx->ctx, out, &hlen))
156         return 0;
157
158     /* TODO(3.0) Use params */
159     hlen = gmac_size();
160     if (!EVP_CIPHER_CTX_ctrl(macctx->ctx, EVP_CTRL_AEAD_GET_TAG,
161                              hlen, out))
162         return 0;
163
164     *outl = hlen;
165     return 1;
166 }
167
168 static const OSSL_PARAM known_gettable_params[] = {
169     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
170     OSSL_PARAM_END
171 };
172 static const OSSL_PARAM *gmac_gettable_params(void *provctx)
173 {
174     return known_gettable_params;
175 }
176
177 static int gmac_get_params(OSSL_PARAM params[])
178 {
179     OSSL_PARAM *p;
180
181     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
182         return OSSL_PARAM_set_size_t(p, gmac_size());
183
184     return 1;
185 }
186
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),
192     OSSL_PARAM_END
193 };
194 static const OSSL_PARAM *gmac_settable_ctx_params(ossl_unused void *ctx,
195                                                   ossl_unused void *provctx)
196 {
197     return known_settable_ctx_params;
198 }
199
200 /*
201  * ALL parameters should be set before init().
202  */
203 static int gmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
204 {
205     struct gmac_data_st *macctx = vmacctx;
206     EVP_CIPHER_CTX *ctx = macctx->ctx;
207     OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(macctx->provctx);
208     const OSSL_PARAM *p;
209
210     if (params == NULL)
211         return 1;
212     if (ctx == NULL
213         || !ossl_prov_cipher_load_from_params(&macctx->cipher, params, provctx))
214         return 0;
215
216     if (EVP_CIPHER_mode(ossl_prov_cipher_cipher(&macctx->cipher))
217         != EVP_CIPH_GCM_MODE) {
218         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
219         return 0;
220     }
221     if (!EVP_EncryptInit_ex(ctx, ossl_prov_cipher_cipher(&macctx->cipher),
222                             ossl_prov_cipher_engine(&macctx->cipher), NULL,
223                             NULL))
224         return 0;
225
226     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL)
227         if (p->data_type != OSSL_PARAM_OCTET_STRING
228                 || !gmac_setkey(macctx, p->data, p->data_size))
229             return 0;
230
231     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_IV)) != NULL) {
232         if (p->data_type != OSSL_PARAM_OCTET_STRING)
233             return 0;
234
235         if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN,
236                                  p->data_size, NULL)
237             || !EVP_EncryptInit_ex(ctx, NULL, NULL, NULL, p->data))
238             return 0;
239     }
240     return 1;
241 }
242
243 const OSSL_DISPATCH ossl_gmac_functions[] = {
244     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))gmac_new },
245     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))gmac_dup },
246     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))gmac_free },
247     { OSSL_FUNC_MAC_INIT, (void (*)(void))gmac_init },
248     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))gmac_update },
249     { OSSL_FUNC_MAC_FINAL, (void (*)(void))gmac_final },
250     { OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))gmac_gettable_params },
251     { OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))gmac_get_params },
252     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
253       (void (*)(void))gmac_settable_ctx_params },
254     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))gmac_set_ctx_params },
255     { 0, NULL }
256 };