/src/openssl30/crypto/hmac/hmac.c

Source (jump to first uncovered line)
/*
 * Copyright 1995-2021 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
 */

/*
 * HMAC low level APIs are deprecated for public use, but still ok for internal
 * use.
 */
#include "internal/deprecated.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "internal/cryptlib.h"
#include <openssl/opensslconf.h>
#include <openssl/hmac.h>
#include <openssl/core_names.h>
#include "hmac_local.h"

int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
                 const EVP_MD *md, ENGINE *impl)
{
    int rv = 0, reset = 0;
    int i, j;
    unsigned char pad[HMAC_MAX_MD_CBLOCK_SIZE];
    unsigned int keytmp_length;
    unsigned char keytmp[HMAC_MAX_MD_CBLOCK_SIZE];

    /* If we are changing MD then we must have a key */
    if (md != NULL && md != ctx->md && (key == NULL || len < 0))
        return 0;

    if (md != NULL)
        ctx->md = md;
    else if (ctx->md != NULL)
        md = ctx->md;
    else
        return 0;

    /*
     * The HMAC construction is not allowed to be used with the
     * extendable-output functions (XOF) shake128 and shake256.
     */
    if ((EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF) != 0)
        return 0;

    if (key != NULL) {
        reset = 1;

        j = EVP_MD_get_block_size(md);
        if (!ossl_assert(j <= (int)sizeof(keytmp)))
            return 0;
        if (j < 0)
            return 0;
        if (j < len) {
            if (!EVP_DigestInit_ex(ctx->md_ctx, md, impl)
                    || !EVP_DigestUpdate(ctx->md_ctx, key, len)
                    || !EVP_DigestFinal_ex(ctx->md_ctx, keytmp,
                                           &keytmp_length))
                return 0;
        } else {
            if (len < 0 || len > (int)sizeof(keytmp))
                return 0;
            memcpy(keytmp, key, len);
            keytmp_length = len;
        }
        if (keytmp_length != HMAC_MAX_MD_CBLOCK_SIZE)
            memset(&keytmp[keytmp_length], 0,
                   HMAC_MAX_MD_CBLOCK_SIZE - keytmp_length);

        for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
            pad[i] = 0x36 ^ keytmp[i];
        if (!EVP_DigestInit_ex(ctx->i_ctx, md, impl)
                || !EVP_DigestUpdate(ctx->i_ctx, pad,
                                     EVP_MD_get_block_size(md)))
            goto err;

        for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
            pad[i] = 0x5c ^ keytmp[i];
        if (!EVP_DigestInit_ex(ctx->o_ctx, md, impl)
                || !EVP_DigestUpdate(ctx->o_ctx, pad,
                                     EVP_MD_get_block_size(md)))
            goto err;
    }
    if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->i_ctx))
        goto err;
    rv = 1;
 err:
    if (reset) {
        OPENSSL_cleanse(keytmp, sizeof(keytmp));
        OPENSSL_cleanse(pad, sizeof(pad));
    }
    return rv;
}

#ifndef OPENSSL_NO_DEPRECATED_1_1_0
int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
{
    if (key && md)
        HMAC_CTX_reset(ctx);
    return HMAC_Init_ex(ctx, key, len, md, NULL);
}
#endif

int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
{
    if (!ctx->md)
        return 0;
    return EVP_DigestUpdate(ctx->md_ctx, data, len);
}

int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
{
    unsigned int i;
    unsigned char buf[EVP_MAX_MD_SIZE];

    if (!ctx->md)
        goto err;

    if (!EVP_DigestFinal_ex(ctx->md_ctx, buf, &i))
        goto err;
    if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->o_ctx))
        goto err;
    if (!EVP_DigestUpdate(ctx->md_ctx, buf, i))
        goto err;
    if (!EVP_DigestFinal_ex(ctx->md_ctx, md, len))
        goto err;
    return 1;
 err:
    return 0;
}

size_t HMAC_size(const HMAC_CTX *ctx)
{
    int size = EVP_MD_get_size((ctx)->md);

    return (size < 0) ? 0 : size;
}

HMAC_CTX *HMAC_CTX_new(void)
{
    HMAC_CTX *ctx = OPENSSL_zalloc(sizeof(HMAC_CTX));

    if (ctx != NULL) {
        if (!HMAC_CTX_reset(ctx)) {
            HMAC_CTX_free(ctx);
            return NULL;
        }
    }
    return ctx;
}

static void hmac_ctx_cleanup(HMAC_CTX *ctx)
{
    EVP_MD_CTX_reset(ctx->i_ctx);
    EVP_MD_CTX_reset(ctx->o_ctx);
    EVP_MD_CTX_reset(ctx->md_ctx);
    ctx->md = NULL;
}

void HMAC_CTX_free(HMAC_CTX *ctx)
{
    if (ctx != NULL) {
        hmac_ctx_cleanup(ctx);
        EVP_MD_CTX_free(ctx->i_ctx);
        EVP_MD_CTX_free(ctx->o_ctx);
        EVP_MD_CTX_free(ctx->md_ctx);
        OPENSSL_free(ctx);
    }
}

static int hmac_ctx_alloc_mds(HMAC_CTX *ctx)
{
    if (ctx->i_ctx == NULL)
        ctx->i_ctx = EVP_MD_CTX_new();
    if (ctx->i_ctx == NULL)
        return 0;
    if (ctx->o_ctx == NULL)
        ctx->o_ctx = EVP_MD_CTX_new();
    if (ctx->o_ctx == NULL)
        return 0;
    if (ctx->md_ctx == NULL)
        ctx->md_ctx = EVP_MD_CTX_new();
    if (ctx->md_ctx == NULL)
        return 0;
    return 1;
}

int HMAC_CTX_reset(HMAC_CTX *ctx)
{
    hmac_ctx_cleanup(ctx);
    if (!hmac_ctx_alloc_mds(ctx)) {
        hmac_ctx_cleanup(ctx);
        return 0;
    }
    return 1;
}

int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
{
    if (!hmac_ctx_alloc_mds(dctx))
        goto err;
    if (!EVP_MD_CTX_copy_ex(dctx->i_ctx, sctx->i_ctx))
        goto err;
    if (!EVP_MD_CTX_copy_ex(dctx->o_ctx, sctx->o_ctx))
        goto err;
    if (!EVP_MD_CTX_copy_ex(dctx->md_ctx, sctx->md_ctx))
        goto err;
    dctx->md = sctx->md;
    return 1;
 err:
    hmac_ctx_cleanup(dctx);
    return 0;
}

unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
                    const unsigned char *data, size_t data_len,
                    unsigned char *md, unsigned int *md_len)
{
    static unsigned char static_md[EVP_MAX_MD_SIZE];
    int size = EVP_MD_get_size(evp_md);
    size_t temp_md_len = 0;
    unsigned char *ret = NULL;

    if (size >= 0) {
        ret = EVP_Q_mac(NULL, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL,
                        key, key_len, data, data_len,
                        md == NULL ? static_md : md, size, &temp_md_len);
        if (md_len != NULL)
            *md_len = (unsigned int)temp_md_len;
    }
    return ret;
}

void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
{
    EVP_MD_CTX_set_flags(ctx->i_ctx, flags);
    EVP_MD_CTX_set_flags(ctx->o_ctx, flags);
    EVP_MD_CTX_set_flags(ctx->md_ctx, flags);
}

const EVP_MD *HMAC_CTX_get_md(const HMAC_CTX *ctx)
{
    return ctx->md;
}

Coverage Report

Created: 2025-06-13 06:58

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 1995-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 <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	348k	{
28	348k	int rv = 0, reset = 0;
29	348k	int i, j;
30	348k	unsigned char pad[HMAC_MAX_MD_CBLOCK_SIZE];
31	348k	unsigned int keytmp_length;
32	348k	unsigned char keytmp[HMAC_MAX_MD_CBLOCK_SIZE];
33
34		/* If we are changing MD then we must have a key */
35	348k	if (md != NULL && md != ctx->md && (key == NULL \|\| len < 0))
36	0	return 0;
37
38	348k	if (md != NULL)
39	348k	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	348k	if ((EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF) != 0)
50	0	return 0;
51
52	348k	if (key != NULL) {
53	348k	reset = 1;
54
55	348k	j = EVP_MD_get_block_size(md);
56	348k	if (!ossl_assert(j <= (int)sizeof(keytmp)))
57	0	return 0;
58	348k	if (j < 0)
59	0	return 0;
60	348k	if (j < len) {
61	2.45k	if (!EVP_DigestInit_ex(ctx->md_ctx, md, impl)
62	2.45k	\|\| !EVP_DigestUpdate(ctx->md_ctx, key, len)
63	2.45k	\|\| !EVP_DigestFinal_ex(ctx->md_ctx, keytmp,
64	2.45k	&keytmp_length))
65	0	return 0;
66	345k	} else {
67	345k	if (len < 0 \|\| len > (int)sizeof(keytmp))
68	0	return 0;
69	345k	memcpy(keytmp, key, len);
70	345k	keytmp_length = len;
71	345k	}
72	348k	if (keytmp_length != HMAC_MAX_MD_CBLOCK_SIZE)
73	348k	memset(&keytmp[keytmp_length], 0,
74	348k	HMAC_MAX_MD_CBLOCK_SIZE - keytmp_length);
75
76	50.4M	for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
77	50.1M	pad[i] = 0x36 ^ keytmp[i];
78	348k	if (!EVP_DigestInit_ex(ctx->i_ctx, md, impl)
79	348k	\|\| !EVP_DigestUpdate(ctx->i_ctx, pad,
80	348k	EVP_MD_get_block_size(md)))
81	0	goto err;
82
83	50.4M	for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
84	50.1M	pad[i] = 0x5c ^ keytmp[i];
85	348k	if (!EVP_DigestInit_ex(ctx->o_ctx, md, impl)
86	348k	\|\| !EVP_DigestUpdate(ctx->o_ctx, pad,
87	348k	EVP_MD_get_block_size(md)))
88	0	goto err;
89	348k	}
90	348k	if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->i_ctx))
91	0	goto err;
92	348k	rv = 1;
93	348k	err:
94	348k	if (reset) {
95	348k	OPENSSL_cleanse(keytmp, sizeof(keytmp));
96	348k	OPENSSL_cleanse(pad, sizeof(pad));
97	348k	}
98	348k	return rv;
99	348k	}
100
101		#ifndef OPENSSL_NO_DEPRECATED_1_1_0
102		int HMAC_Init(HMAC_CTX ctx, const void key, int len, const EVP_MD *md)
103	0	{
104	0	if (key && md)
105	0	HMAC_CTX_reset(ctx);
106	0	return HMAC_Init_ex(ctx, key, len, md, NULL);
107	0	}
108		#endif
109
110		int HMAC_Update(HMAC_CTX ctx, const unsigned char data, size_t len)
111	1.68M	{
112	1.68M	if (!ctx->md)
113	0	return 0;
114	1.68M	return EVP_DigestUpdate(ctx->md_ctx, data, len);
115	1.68M	}
116
117		int HMAC_Final(HMAC_CTX ctx, unsigned char md, unsigned int *len)
118	949k	{
119	949k	unsigned int i;
120	949k	unsigned char buf[EVP_MAX_MD_SIZE];
121
122	949k	if (!ctx->md)
123	0	goto err;
124
125	949k	if (!EVP_DigestFinal_ex(ctx->md_ctx, buf, &i))
126	0	goto err;
127	949k	if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->o_ctx))
128	0	goto err;
129	949k	if (!EVP_DigestUpdate(ctx->md_ctx, buf, i))
130	0	goto err;
131	949k	if (!EVP_DigestFinal_ex(ctx->md_ctx, md, len))
132	0	goto err;
133	949k	return 1;
134	0	err:
135	0	return 0;
136	949k	}
137
138		size_t HMAC_size(const HMAC_CTX *ctx)
139	460k	{
140	460k	int size = EVP_MD_get_size((ctx)->md);
141
142	460k	return (size < 0) ? 0 : size;
143	460k	}
144
145		HMAC_CTX *HMAC_CTX_new(void)
146	1.20M	{
147	1.20M	HMAC_CTX *ctx = OPENSSL_zalloc(sizeof(HMAC_CTX));
148
149	1.20M	if (ctx != NULL) {
150	1.20M	if (!HMAC_CTX_reset(ctx)) {
151	0	HMAC_CTX_free(ctx);
152	0	return NULL;
153	0	}
154	1.20M	}
155	1.20M	return ctx;
156	1.20M	}
157
158		static void hmac_ctx_cleanup(HMAC_CTX *ctx)
159	2.40M	{
160	2.40M	EVP_MD_CTX_reset(ctx->i_ctx);
161	2.40M	EVP_MD_CTX_reset(ctx->o_ctx);
162	2.40M	EVP_MD_CTX_reset(ctx->md_ctx);
163	2.40M	ctx->md = NULL;
164	2.40M	}
165
166		void HMAC_CTX_free(HMAC_CTX *ctx)
167	1.20M	{
168	1.20M	if (ctx != NULL) {
169	1.20M	hmac_ctx_cleanup(ctx);
170	1.20M	EVP_MD_CTX_free(ctx->i_ctx);
171	1.20M	EVP_MD_CTX_free(ctx->o_ctx);
172	1.20M	EVP_MD_CTX_free(ctx->md_ctx);
173	1.20M	OPENSSL_free(ctx);
174	1.20M	}
175	1.20M	}
176
177		static int hmac_ctx_alloc_mds(HMAC_CTX *ctx)
178	1.72M	{
179	1.72M	if (ctx->i_ctx == NULL)
180	1.20M	ctx->i_ctx = EVP_MD_CTX_new();
181	1.72M	if (ctx->i_ctx == NULL)
182	0	return 0;
183	1.72M	if (ctx->o_ctx == NULL)
184	1.20M	ctx->o_ctx = EVP_MD_CTX_new();
185	1.72M	if (ctx->o_ctx == NULL)
186	0	return 0;
187	1.72M	if (ctx->md_ctx == NULL)
188	1.20M	ctx->md_ctx = EVP_MD_CTX_new();
189	1.72M	if (ctx->md_ctx == NULL)
190	0	return 0;
191	1.72M	return 1;
192	1.72M	}
193
194		int HMAC_CTX_reset(HMAC_CTX *ctx)
195	1.20M	{
196	1.20M	hmac_ctx_cleanup(ctx);
197	1.20M	if (!hmac_ctx_alloc_mds(ctx)) {
198	0	hmac_ctx_cleanup(ctx);
199	0	return 0;
200	0	}
201	1.20M	return 1;
202	1.20M	}
203
204		int HMAC_CTX_copy(HMAC_CTX dctx, HMAC_CTX sctx)
205	524k	{
206	524k	if (!hmac_ctx_alloc_mds(dctx))
207	0	goto err;
208	524k	if (!EVP_MD_CTX_copy_ex(dctx->i_ctx, sctx->i_ctx))
209	0	goto err;
210	524k	if (!EVP_MD_CTX_copy_ex(dctx->o_ctx, sctx->o_ctx))
211	0	goto err;
212	524k	if (!EVP_MD_CTX_copy_ex(dctx->md_ctx, sctx->md_ctx))
213	0	goto err;
214	524k	dctx->md = sctx->md;
215	524k	return 1;
216	0	err:
217	0	hmac_ctx_cleanup(dctx);
218	0	return 0;
219	524k	}
220
221		unsigned char HMAC(const EVP_MD evp_md, const void *key, int key_len,
222		const unsigned char *data, size_t data_len,
223		unsigned char md, unsigned int md_len)
224	0	{
225	0	static unsigned char static_md[EVP_MAX_MD_SIZE];
226	0	int size = EVP_MD_get_size(evp_md);
227	0	size_t temp_md_len = 0;
228	0	unsigned char *ret = NULL;
229
230	0	if (size >= 0) {
231	0	ret = EVP_Q_mac(NULL, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL,
232	0	key, key_len, data, data_len,
233	0	md == NULL ? static_md : md, size, &temp_md_len);
234	0	if (md_len != NULL)
235	0	*md_len = (unsigned int)temp_md_len;
236	0	}
237	0	return ret;
238	0	}
239
240		void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
241	0	{
242	0	EVP_MD_CTX_set_flags(ctx->i_ctx, flags);
243	0	EVP_MD_CTX_set_flags(ctx->o_ctx, flags);
244	0	EVP_MD_CTX_set_flags(ctx->md_ctx, flags);
245	0	}
246
247		const EVP_MD HMAC_CTX_get_md(const HMAC_CTX ctx)
248	0	{
249	0	return ctx->md;
250	0	}