Coverage Report

Created: 2025-12-31 06:58

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