1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/*
* Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* in the file LICENSE in the source distribution or at
* https://www.openssl.org/source/license.html
*/
#include <openssl/core_numbers.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/engine.h>
#include <openssl/evp.h>
#include <openssl/hmac.h>
#include "internal/provider_algs.h"
#include "internal/provider_ctx.h"
/*
* Forward declaration of everything implemented here. This is not strictly
* necessary for the compiler, but provides an assurance that the signatures
* of the functions in the dispatch table are correct.
*/
static OSSL_OP_mac_newctx_fn hmac_new;
static OSSL_OP_mac_dupctx_fn hmac_dup;
static OSSL_OP_mac_freectx_fn hmac_free;
static OSSL_OP_mac_gettable_ctx_params_fn hmac_gettable_ctx_params;
static OSSL_OP_mac_get_ctx_params_fn hmac_get_ctx_params;
static OSSL_OP_mac_settable_ctx_params_fn hmac_settable_ctx_params;
static OSSL_OP_mac_set_ctx_params_fn hmac_set_ctx_params;
static OSSL_OP_mac_init_fn hmac_init;
static OSSL_OP_mac_update_fn hmac_update;
static OSSL_OP_mac_final_fn hmac_final;
/* local HMAC context structure */
/* typedef EVP_MAC_IMPL */
struct hmac_data_st {
void *provctx;
HMAC_CTX *ctx; /* HMAC context */
/*
* References to the underlying digest implementation. tmpmd caches
* the md, always. alloc_md only holds a reference to an explicitly
* fetched digest.
* tmpmd is cleared after a CMAC_Init call.
*/
const EVP_MD *tmpmd; /* HMAC digest */
EVP_MD *alloc_md; /* fetched digest */
/*
* Conditions for legacy EVP_MD uses.
* tmpengine is cleared after a CMAC_Init call.
*/
ENGINE *tmpengine; /* HMAC digest engine */
};
static size_t hmac_size(void *vmacctx);
static void *hmac_new(void *provctx)
{
struct hmac_data_st *macctx;
if ((macctx = OPENSSL_zalloc(sizeof(*macctx))) == NULL
|| (macctx->ctx = HMAC_CTX_new()) == NULL) {
OPENSSL_free(macctx);
return NULL;
}
/* TODO(3.0) Should we do something more with that context? */
macctx->provctx = provctx;
return macctx;
}
static void hmac_free(void *vmacctx)
{
struct hmac_data_st *macctx = vmacctx;
if (macctx != NULL) {
HMAC_CTX_free(macctx->ctx);
EVP_MD_free(macctx->alloc_md);
OPENSSL_free(macctx);
}
}
static void *hmac_dup(void *vsrc)
{
struct hmac_data_st *src = vsrc;
struct hmac_data_st *dst = hmac_new(src->provctx);
if (dst == NULL)
return NULL;
if (!HMAC_CTX_copy(dst->ctx, src->ctx)) {
hmac_free(dst);
return NULL;
}
if (src->alloc_md != NULL && !EVP_MD_up_ref(src->alloc_md)) {
hmac_free(dst);
return NULL;
}
dst->tmpengine = src->tmpengine;
dst->tmpmd = src->tmpmd;
dst->alloc_md = src->alloc_md;
return dst;
}
static size_t hmac_size(void *vmacctx)
{
struct hmac_data_st *macctx = vmacctx;
return HMAC_size(macctx->ctx);
}
static int hmac_init(void *vmacctx)
{
struct hmac_data_st *macctx = vmacctx;
int rv = 1;
/* HMAC_Init_ex doesn't tolerate all zero params, so we must be careful */
if (macctx->tmpmd != NULL)
rv = HMAC_Init_ex(macctx->ctx, NULL, 0, macctx->tmpmd,
(ENGINE * )macctx->tmpengine);
macctx->tmpengine = NULL;
macctx->tmpmd = NULL;
return rv;
}
static int hmac_update(void *vmacctx, const unsigned char *data,
size_t datalen)
{
struct hmac_data_st *macctx = vmacctx;
return HMAC_Update(macctx->ctx, data, datalen);
}
static int hmac_final(void *vmacctx, unsigned char *out, size_t *outl,
size_t outsize)
{
unsigned int hlen;
struct hmac_data_st *macctx = vmacctx;
if (!HMAC_Final(macctx->ctx, out, &hlen))
return 0;
if (outl != NULL)
*outl = hlen;
return 1;
}
static const OSSL_PARAM known_gettable_ctx_params[] = {
OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
OSSL_PARAM_END
};
static const OSSL_PARAM *hmac_gettable_ctx_params(void)
{
return known_gettable_ctx_params;
}
static int hmac_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
{
OSSL_PARAM *p;
if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
return OSSL_PARAM_set_size_t(p, hmac_size(vmacctx));
return 1;
}
static const OSSL_PARAM known_settable_ctx_params[] = {
OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_DIGEST, NULL, 0),
OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_ENGINE, NULL, 0),
OSSL_PARAM_utf8_string(OSSL_MAC_PARAM_PROPERTIES, NULL, 0),
OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
OSSL_PARAM_int(OSSL_MAC_PARAM_FLAGS, NULL),
OSSL_PARAM_END
};
static const OSSL_PARAM *hmac_settable_ctx_params(void)
{
return known_settable_ctx_params;
}
/*
* ALL parameters should be set before init().
*/
static int hmac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
{
struct hmac_data_st *macctx = vmacctx;
const OSSL_PARAM *p;
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_DIGEST)) != NULL) {
if (p->data_type != OSSL_PARAM_UTF8_STRING)
return 0;
{
const char *algoname = p->data;
const char *propquery = NULL;
/* Inside the FIPS module, we don't support engines */
#if !defined(FIPS_MODE) && !defined(OPENSSL_NO_ENGINE)
ENGINE_finish(macctx->tmpengine);
macctx->tmpengine = NULL;
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_ENGINE))
!= NULL) {
if (p->data_type != OSSL_PARAM_UTF8_STRING)
return 0;
macctx->tmpengine = ENGINE_by_id(p->data);
if (macctx->tmpengine == NULL)
return 0;
}
#endif
if ((p = OSSL_PARAM_locate_const(params,
OSSL_MAC_PARAM_PROPERTIES))
!= NULL) {
if (p->data_type != OSSL_PARAM_UTF8_STRING)
return 0;
propquery = p->data;
}
EVP_MD_free(macctx->alloc_md);
macctx->tmpmd = macctx->alloc_md =
EVP_MD_fetch(PROV_LIBRARY_CONTEXT_OF(macctx->provctx),
algoname, propquery);
#ifndef FIPS_MODE /* Inside the FIPS module, we don't support legacy digests */
/* TODO(3.0) BEGIN legacy stuff, to be removed */
if (macctx->tmpmd == NULL)
macctx->tmpmd = EVP_get_digestbyname(algoname);
/* TODO(3.0) END of legacy stuff */
#endif
if (macctx->tmpmd == NULL)
return 0;
}
}
/* TODO(3.0) formalize the meaning of "flags", perhaps as other params */
if ((p = OSSL_PARAM_locate_const(params,
OSSL_MAC_PARAM_FLAGS)) != NULL) {
int flags = 0;
if (!OSSL_PARAM_get_int(p, &flags))
return 0;
HMAC_CTX_set_flags(macctx->ctx, flags);
}
if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
if (p->data_type != OSSL_PARAM_OCTET_STRING)
return 0;
if (!HMAC_Init_ex(macctx->ctx, p->data, p->data_size,
macctx->tmpmd, NULL /* ENGINE */))
return 0;
macctx->tmpmd = NULL;
macctx->tmpengine = NULL;
}
return 1;
}
const OSSL_DISPATCH hmac_functions[] = {
{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))hmac_new },
{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))hmac_dup },
{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))hmac_free },
{ OSSL_FUNC_MAC_INIT, (void (*)(void))hmac_init },
{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))hmac_update },
{ OSSL_FUNC_MAC_FINAL, (void (*)(void))hmac_final },
{ OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
(void (*)(void))hmac_gettable_ctx_params },
{ OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))hmac_get_ctx_params },
{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
(void (*)(void))hmac_settable_ctx_params },
{ OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))hmac_set_ctx_params },
{ 0, NULL }
};
|
