Don't remove $(TARFILE) when cleaning
[openssl.git] / providers / implementations / macs / hmac_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 /*
11  * HMAC low level APIs are deprecated for public use, but still ok for internal
12  * use.
13  */
14 #include "internal/deprecated.h"
15
16 #include <string.h>
17
18 #include <openssl/core_dispatch.h>
19 #include <openssl/core_names.h>
20 #include <openssl/params.h>
21 #include <openssl/engine.h>
22 #include <openssl/evp.h>
23 #include <openssl/hmac.h>
24
25 #include "prov/implementations.h"
26 #include "prov/provider_ctx.h"
27 #include "prov/provider_util.h"
28 #include "prov/providercommon.h"
29
30 /*
31  * Forward declaration of everything implemented here.  This is not strictly
32  * necessary for the compiler, but provides an assurance that the signatures
33  * of the functions in the dispatch table are correct.
34  */
35 static OSSL_FUNC_mac_newctx_fn hmac_new;
36 static OSSL_FUNC_mac_dupctx_fn hmac_dup;
37 static OSSL_FUNC_mac_freectx_fn hmac_free;
38 static OSSL_FUNC_mac_gettable_ctx_params_fn hmac_gettable_ctx_params;
39 static OSSL_FUNC_mac_get_ctx_params_fn hmac_get_ctx_params;
40 static OSSL_FUNC_mac_settable_ctx_params_fn hmac_settable_ctx_params;
41 static OSSL_FUNC_mac_set_ctx_params_fn hmac_set_ctx_params;
42 static OSSL_FUNC_mac_init_fn hmac_init;
43 static OSSL_FUNC_mac_update_fn hmac_update;
44 static OSSL_FUNC_mac_final_fn hmac_final;
45
46 /* local HMAC context structure */
47
48 /* typedef EVP_MAC_IMPL */
49 struct hmac_data_st {
50     void *provctx;
51     HMAC_CTX *ctx;               /* HMAC context */
52     PROV_DIGEST digest;
53     unsigned char *key;
54     size_t keylen;
55     /* Length of full TLS record including the MAC and any padding */
56     size_t tls_data_size;
57     unsigned char tls_header[13];
58     int tls_header_set;
59     unsigned char tls_mac_out[EVP_MAX_MD_SIZE];
60     size_t tls_mac_out_size;
61 };
62
63 /* Defined in ssl/s3_cbc.c */
64 int ssl3_cbc_digest_record(const EVP_MD *md,
65                            unsigned char *md_out,
66                            size_t *md_out_size,
67                            const unsigned char header[13],
68                            const unsigned char *data,
69                            size_t data_size,
70                            size_t data_plus_mac_plus_padding_size,
71                            const unsigned char *mac_secret,
72                            size_t mac_secret_length, char is_sslv3);
73
74 static void *hmac_new(void *provctx)
75 {
76     struct hmac_data_st *macctx;
77
78     if (!ossl_prov_is_running())
79         return NULL;
80
81     if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
82         || (macctx->ctx = HMAC_CTX_new()) == NULL) {
83         OPENSSL_free(macctx);
84         return NULL;
85     }
86     macctx->provctx = provctx;
87
88     return macctx;
89 }
90
91 static void hmac_free(void *vmacctx)
92 {
93     struct hmac_data_st *macctx = vmacctx;
94
95     if (macctx != NULL) {
96         HMAC_CTX_free(macctx->ctx);
97         ossl_prov_digest_reset(&macctx->digest);
98         OPENSSL_secure_clear_free(macctx->key, macctx->keylen);
99         OPENSSL_free(macctx);
100     }
101 }
102
103 static void *hmac_dup(void *vsrc)
104 {
105     struct hmac_data_st *src = vsrc;
106     struct hmac_data_st *dst;
107     HMAC_CTX *ctx;
108
109     if (!ossl_prov_is_running())
110         return NULL;
111     dst = hmac_new(src->provctx);
112     if (dst == NULL)
113         return NULL;
114
115     ctx = dst->ctx;
116     *dst = *src;
117     dst->ctx = ctx;
118     dst->key = NULL;
119
120     if (!HMAC_CTX_copy(dst->ctx, src->ctx)
121         || !ossl_prov_digest_copy(&dst->digest, &src->digest)) {
122         hmac_free(dst);
123         return NULL;
124     }
125     if (src->key != NULL) {
126         /* There is no "secure" OPENSSL_memdup */
127         dst->key = OPENSSL_secure_malloc(src->keylen > 0 ? src->keylen : 1);
128         if (dst->key == NULL) {
129             hmac_free(dst);
130             return 0;
131         }
132         memcpy(dst->key, src->key, src->keylen);
133     }
134     return dst;
135 }
136
137 static size_t hmac_size(void *vmacctx)
138 {
139     struct hmac_data_st *macctx = vmacctx;
140
141     return HMAC_size(macctx->ctx);
142 }
143
144 static int hmac_setkey(struct hmac_data_st *macctx,
145                        const unsigned char *key, size_t keylen)
146 {
147     const EVP_MD *digest;
148
149     if (macctx->keylen > 0)
150         OPENSSL_secure_clear_free(macctx->key, macctx->keylen);
151     /* Keep a copy of the key in case we need it for TLS HMAC */
152     macctx->key = OPENSSL_secure_malloc(keylen > 0 ? keylen : 1);
153     if (macctx->key == NULL)
154         return 0;
155     memcpy(macctx->key, key, keylen);
156     macctx->keylen = keylen;
157
158     digest = ossl_prov_digest_md(&macctx->digest);
159     /* HMAC_Init_ex doesn't tolerate all zero params, so we must be careful */
160     if (key != NULL || (macctx->tls_data_size == 0 && digest != NULL))
161         return HMAC_Init_ex(macctx->ctx, key, keylen, digest,
162                             ossl_prov_digest_engine(&macctx->digest));
163     return 1;
164 }
165
166 static int hmac_init(void *vmacctx, const unsigned char *key,
167                      size_t keylen, const OSSL_PARAM params[])
168 {
169     struct hmac_data_st *macctx = vmacctx;
170
171     if (!ossl_prov_is_running() || !hmac_set_ctx_params(macctx, params))
172         return 0;
173
174     if (key != NULL && !hmac_setkey(macctx, key, keylen))
175         return 0;
176     return 1;
177 }
178
179 static int hmac_update(void *vmacctx, const unsigned char *data,
180                        size_t datalen)
181 {
182     struct hmac_data_st *macctx = vmacctx;
183
184     if (macctx->tls_data_size > 0) {
185         /* We're doing a TLS HMAC */
186         if (!macctx->tls_header_set) {
187             /* We expect the first update call to contain the TLS header */
188             if (datalen != sizeof(macctx->tls_header))
189                 return 0;
190             memcpy(macctx->tls_header, data, datalen);
191             macctx->tls_header_set = 1;
192             return 1;
193         }
194         /* macctx->tls_data_size is datalen plus the padding length */
195         if (macctx->tls_data_size < datalen)
196             return 0;
197
198         return ssl3_cbc_digest_record(ossl_prov_digest_md(&macctx->digest),
199                                       macctx->tls_mac_out,
200                                       &macctx->tls_mac_out_size,
201                                       macctx->tls_header,
202                                       data,
203                                       datalen,
204                                       macctx->tls_data_size,
205                                       macctx->key,
206                                       macctx->keylen,
207                                       0);
208     }
209
210     return HMAC_Update(macctx->ctx, data, datalen);
211 }
212
213 static int hmac_final(void *vmacctx, unsigned char *out, size_t *outl,
214                       size_t outsize)
215 {
216     unsigned int hlen;
217     struct hmac_data_st *macctx = vmacctx;
218
219     if (!ossl_prov_is_running())
220         return 0;
221     if (macctx->tls_data_size > 0) {
222         if (macctx->tls_mac_out_size == 0)
223             return 0;
224         if (outl != NULL)
225             *outl = macctx->tls_mac_out_size;
226         memcpy(out, macctx->tls_mac_out, macctx->tls_mac_out_size);
227         return 1;
228     }
229     if (!HMAC_Final(macctx->ctx, out, &hlen))
230         return 0;
231     *outl = hlen;
232     return 1;
233 }
234
235 static const OSSL_PARAM known_gettable_ctx_params[] = {
236     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
237     OSSL_PARAM_END
238 };
239 static const OSSL_PARAM *hmac_gettable_ctx_params(ossl_unused void *ctx,
240                                                   ossl_unused void *provctx)
241 {
242     return known_gettable_ctx_params;
243 }
244
245 static int hmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
246 {
247     OSSL_PARAM *p;
248
249     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
250         return OSSL_PARAM_set_size_t(p, hmac_size(vmacctx));
251
252     return 1;
253 }
254
255 static const OSSL_PARAM known_settable_ctx_params[] = {
256     OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_DIGEST, NULL, 0),
257     OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
258     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
259     OSSL_PARAM_int(OSSL_MAC_PARAM_DIGEST_NOINIT, NULL),
260     OSSL_PARAM_int(OSSL_MAC_PARAM_DIGEST_ONESHOT, NULL),
261     OSSL_PARAM_size_t(OSSL_MAC_PARAM_TLS_DATA_SIZE, NULL),
262     OSSL_PARAM_END
263 };
264 static const OSSL_PARAM *hmac_settable_ctx_params(ossl_unused void *ctx,
265                                                   ossl_unused void *provctx)
266 {
267     return known_settable_ctx_params;
268 }
269
270 static int set_flag(const OSSL_PARAM params[], const char *key, int mask,
271                     int *flags)
272 {
273     const OSSL_PARAM *p = OSSL_PARAM_locate_const(params, key);
274     int flag = 0;
275
276     if (p != NULL) {
277         if (!OSSL_PARAM_get_int(p, &flag))
278             return 0;
279         if (flag == 0)
280             *flags &= ~mask;
281         else
282             *flags |= mask;
283     }
284     return 1;
285 }
286
287 /*
288  * ALL parameters should be set before init().
289  */
290 static int hmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
291 {
292     struct hmac_data_st *macctx = vmacctx;
293     OSSL_LIB_CTX *ctx = PROV_LIBCTX_OF(macctx->provctx);
294     const OSSL_PARAM *p;
295     int flags = 0;
296
297     if (!ossl_prov_digest_load_from_params(&macctx->digest, params, ctx))
298         return 0;
299
300     if (!set_flag(params, OSSL_MAC_PARAM_DIGEST_NOINIT, EVP_MD_CTX_FLAG_NO_INIT,
301                   &flags))
302         return 0;
303     if (!set_flag(params, OSSL_MAC_PARAM_DIGEST_ONESHOT, EVP_MD_CTX_FLAG_ONESHOT,
304                   &flags))
305         return 0;
306     if (flags)
307         HMAC_CTX_set_flags(macctx->ctx, flags);
308
309     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
310         if (p->data_type != OSSL_PARAM_OCTET_STRING)
311             return 0;
312
313         if (macctx->keylen > 0)
314             OPENSSL_secure_clear_free(macctx->key, macctx->keylen);
315         /* Keep a copy of the key if we need it for TLS HMAC */
316         macctx->key = OPENSSL_secure_malloc(p->data_size > 0 ? p->data_size : 1);
317         if (macctx->key == NULL)
318             return 0;
319         memcpy(macctx->key, p->data, p->data_size);
320         macctx->keylen = p->data_size;
321
322         if (!HMAC_Init_ex(macctx->ctx, p->data, p->data_size,
323                           ossl_prov_digest_md(&macctx->digest),
324                           NULL /* ENGINE */))
325             return 0;
326
327     }
328     if ((p = OSSL_PARAM_locate_const(params,
329                                      OSSL_MAC_PARAM_TLS_DATA_SIZE)) != NULL) {
330         if (!OSSL_PARAM_get_size_t(p, &macctx->tls_data_size))
331             return 0;
332     }
333     return 1;
334 }
335
336 const OSSL_DISPATCH ossl_hmac_functions[] = {
337     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))hmac_new },
338     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))hmac_dup },
339     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))hmac_free },
340     { OSSL_FUNC_MAC_INIT, (void (*)(void))hmac_init },
341     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))hmac_update },
342     { OSSL_FUNC_MAC_FINAL, (void (*)(void))hmac_final },
343     { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
344       (void (*)(void))hmac_gettable_ctx_params },
345     { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))hmac_get_ctx_params },
346     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
347       (void (*)(void))hmac_settable_ctx_params },
348     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))hmac_set_ctx_params },
349     { 0, NULL }
350 };