Coverage Report

Created: 2025-06-13 06:56

/src/openssl/crypto/hmac/hmac.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1995-2024 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 <stdio.h>
17
#include <stdlib.h>
18
#include <string.h>
19
#include "internal/cryptlib.h"
20
#include <openssl/opensslconf.h>
21
#include <openssl/hmac.h>
22
#include <openssl/core_names.h>
23
#include "hmac_local.h"
24
25
int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
26
                 const EVP_MD *md, ENGINE *impl)
27
0
{
28
0
    int rv = 0, reset = 0;
29
0
    int i, j;
30
0
    unsigned char pad[HMAC_MAX_MD_CBLOCK_SIZE];
31
0
    unsigned int keytmp_length;
32
0
    unsigned char keytmp[HMAC_MAX_MD_CBLOCK_SIZE];
33
34
    /* If we are changing MD then we must have a key */
35
0
    if (md != NULL && md != ctx->md && (key == NULL || len < 0))
36
0
        return 0;
37
38
0
    if (md != NULL)
39
0
        ctx->md = md;
40
0
    else if (ctx->md != NULL)
41
0
        md = ctx->md;
42
0
    else
43
0
        return 0;
44
45
    /*
46
     * The HMAC construction is not allowed to be used with the
47
     * extendable-output functions (XOF) shake128 and shake256.
48
     */
49
0
    if (EVP_MD_xof(md))
50
0
        return 0;
51
52
#ifdef OPENSSL_HMAC_S390X
53
    rv = s390x_HMAC_init(ctx, key, len, impl);
54
    if (rv >= 1)
55
        return rv;
56
#endif
57
58
0
    if (key != NULL) {
59
0
        reset = 1;
60
61
0
        j = EVP_MD_get_block_size(md);
62
0
        if (!ossl_assert(j <= (int)sizeof(keytmp)))
63
0
            return 0;
64
0
        if (j < 0)
65
0
            return 0;
66
0
        if (j < len) {
67
0
            if (!EVP_DigestInit_ex(ctx->md_ctx, md, impl)
68
0
                    || !EVP_DigestUpdate(ctx->md_ctx, key, len)
69
0
                    || !EVP_DigestFinal_ex(ctx->md_ctx, keytmp,
70
0
                                           &keytmp_length))
71
0
                return 0;
72
0
        } else {
73
0
            if (len < 0 || len > (int)sizeof(keytmp))
74
0
                return 0;
75
0
            memcpy(keytmp, key, len);
76
0
            keytmp_length = len;
77
0
        }
78
0
        if (keytmp_length != HMAC_MAX_MD_CBLOCK_SIZE)
79
0
            memset(&keytmp[keytmp_length], 0,
80
0
                   HMAC_MAX_MD_CBLOCK_SIZE - keytmp_length);
81
82
0
        for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
83
0
            pad[i] = 0x36 ^ keytmp[i];
84
0
        if (!EVP_DigestInit_ex(ctx->i_ctx, md, impl)
85
0
                || !EVP_DigestUpdate(ctx->i_ctx, pad,
86
0
                                     EVP_MD_get_block_size(md)))
87
0
            goto err;
88
89
0
        for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
90
0
            pad[i] = 0x5c ^ keytmp[i];
91
0
        if (!EVP_DigestInit_ex(ctx->o_ctx, md, impl)
92
0
                || !EVP_DigestUpdate(ctx->o_ctx, pad,
93
0
                                     EVP_MD_get_block_size(md)))
94
0
            goto err;
95
0
    }
96
0
    if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->i_ctx))
97
0
        goto err;
98
0
    rv = 1;
99
0
 err:
100
0
    if (reset) {
101
0
        OPENSSL_cleanse(keytmp, sizeof(keytmp));
102
0
        OPENSSL_cleanse(pad, sizeof(pad));
103
0
    }
104
0
    return rv;
105
0
}
106
107
#ifndef OPENSSL_NO_DEPRECATED_1_1_0
108
int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
109
0
{
110
0
    if (key && md)
111
0
        HMAC_CTX_reset(ctx);
112
0
    return HMAC_Init_ex(ctx, key, len, md, NULL);
113
0
}
114
#endif
115
116
int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
117
0
{
118
0
    if (!ctx->md)
119
0
        return 0;
120
121
#ifdef OPENSSL_HMAC_S390X
122
    if (ctx->plat.s390x.fc)
123
        return s390x_HMAC_update(ctx, data, len);
124
#endif
125
126
0
    return EVP_DigestUpdate(ctx->md_ctx, data, len);
127
0
}
128
129
int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
130
0
{
131
0
    unsigned int i;
132
0
    unsigned char buf[EVP_MAX_MD_SIZE];
133
134
0
    if (!ctx->md)
135
0
        goto err;
136
137
#ifdef OPENSSL_HMAC_S390X
138
    if (ctx->plat.s390x.fc)
139
        return s390x_HMAC_final(ctx, md, len);
140
#endif
141
142
0
    if (!EVP_DigestFinal_ex(ctx->md_ctx, buf, &i))
143
0
        goto err;
144
0
    if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->o_ctx))
145
0
        goto err;
146
0
    if (!EVP_DigestUpdate(ctx->md_ctx, buf, i))
147
0
        goto err;
148
0
    if (!EVP_DigestFinal_ex(ctx->md_ctx, md, len))
149
0
        goto err;
150
0
    return 1;
151
0
 err:
152
0
    return 0;
153
0
}
154
155
size_t HMAC_size(const HMAC_CTX *ctx)
156
0
{
157
0
    int size = EVP_MD_get_size((ctx)->md);
158
159
0
    return (size < 0) ? 0 : size;
160
0
}
161
162
HMAC_CTX *HMAC_CTX_new(void)
163
0
{
164
0
    HMAC_CTX *ctx = OPENSSL_zalloc(sizeof(HMAC_CTX));
165
166
0
    if (ctx != NULL) {
167
0
        if (!HMAC_CTX_reset(ctx)) {
168
0
            HMAC_CTX_free(ctx);
169
0
            return NULL;
170
0
        }
171
0
    }
172
0
    return ctx;
173
0
}
174
175
static void hmac_ctx_cleanup(HMAC_CTX *ctx)
176
0
{
177
0
    EVP_MD_CTX_reset(ctx->i_ctx);
178
0
    EVP_MD_CTX_reset(ctx->o_ctx);
179
0
    EVP_MD_CTX_reset(ctx->md_ctx);
180
0
    ctx->md = NULL;
181
182
#ifdef OPENSSL_HMAC_S390X
183
    s390x_HMAC_CTX_cleanup(ctx);
184
#endif
185
0
}
186
187
void HMAC_CTX_free(HMAC_CTX *ctx)
188
0
{
189
0
    if (ctx != NULL) {
190
0
        hmac_ctx_cleanup(ctx);
191
0
        EVP_MD_CTX_free(ctx->i_ctx);
192
0
        EVP_MD_CTX_free(ctx->o_ctx);
193
0
        EVP_MD_CTX_free(ctx->md_ctx);
194
0
        OPENSSL_free(ctx);
195
0
    }
196
0
}
197
198
static int hmac_ctx_alloc_mds(HMAC_CTX *ctx)
199
0
{
200
0
    if (ctx->i_ctx == NULL)
201
0
        ctx->i_ctx = EVP_MD_CTX_new();
202
0
    if (ctx->i_ctx == NULL)
203
0
        return 0;
204
0
    if (ctx->o_ctx == NULL)
205
0
        ctx->o_ctx = EVP_MD_CTX_new();
206
0
    if (ctx->o_ctx == NULL)
207
0
        return 0;
208
0
    if (ctx->md_ctx == NULL)
209
0
        ctx->md_ctx = EVP_MD_CTX_new();
210
0
    if (ctx->md_ctx == NULL)
211
0
        return 0;
212
0
    return 1;
213
0
}
214
215
int HMAC_CTX_reset(HMAC_CTX *ctx)
216
0
{
217
0
    hmac_ctx_cleanup(ctx);
218
0
    if (!hmac_ctx_alloc_mds(ctx)) {
219
0
        hmac_ctx_cleanup(ctx);
220
0
        return 0;
221
0
    }
222
0
    return 1;
223
0
}
224
225
int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
226
0
{
227
0
    if (!hmac_ctx_alloc_mds(dctx))
228
0
        goto err;
229
0
    if (!EVP_MD_CTX_copy_ex(dctx->i_ctx, sctx->i_ctx))
230
0
        goto err;
231
0
    if (!EVP_MD_CTX_copy_ex(dctx->o_ctx, sctx->o_ctx))
232
0
        goto err;
233
0
    if (!EVP_MD_CTX_copy_ex(dctx->md_ctx, sctx->md_ctx))
234
0
        goto err;
235
0
    dctx->md = sctx->md;
236
237
#ifdef OPENSSL_HMAC_S390X
238
    if (s390x_HMAC_CTX_copy(dctx, sctx) == 0)
239
        goto err;
240
#endif
241
242
0
    return 1;
243
0
 err:
244
0
    hmac_ctx_cleanup(dctx);
245
0
    return 0;
246
0
}
247
248
unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
249
                    const unsigned char *data, size_t data_len,
250
                    unsigned char *md, unsigned int *md_len)
251
0
{
252
0
    static unsigned char static_md[EVP_MAX_MD_SIZE];
253
0
    int size = EVP_MD_get_size(evp_md);
254
0
    size_t temp_md_len = 0;
255
0
    unsigned char *ret = NULL;
256
257
0
    if (size > 0) {
258
0
        ret = EVP_Q_mac(NULL, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL,
259
0
                        key, key_len, data, data_len,
260
0
                        md == NULL ? static_md : md, size, &temp_md_len);
261
0
        if (md_len != NULL)
262
0
            *md_len = (unsigned int)temp_md_len;
263
0
    }
264
0
    return ret;
265
0
}
266
267
void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
268
0
{
269
0
    EVP_MD_CTX_set_flags(ctx->i_ctx, flags);
270
0
    EVP_MD_CTX_set_flags(ctx->o_ctx, flags);
271
0
    EVP_MD_CTX_set_flags(ctx->md_ctx, flags);
272
0
}
273
274
const EVP_MD *HMAC_CTX_get_md(const HMAC_CTX *ctx)
275
0
{
276
0
    return ctx->md;
277
0
}