/src/openssl30/crypto/evp/legacy_sha.c

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

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

#include <openssl/sha.h>         /* diverse SHA macros */
#include "internal/sha3.h"       /* KECCAK1600_WIDTH */
#include "crypto/evp.h"
/* Used by legacy methods */
#include "crypto/sha.h"
#include "legacy_meth.h"
#include "evp_local.h"

/*-
 * LEGACY methods for SHA.
 * These only remain to support engines that can get these methods.
 * Hardware support for SHA3 has been removed from these legacy cases.
 */
#define IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(nm, fn, tag)                         \
static int nm##_init(EVP_MD_CTX *ctx)                                          \
{                                                                              \
    return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
}                                                                              \
static int nm##_update(EVP_MD_CTX *ctx, const void *data, size_t count)        \
{                                                                              \
    return fn##_update(EVP_MD_CTX_get0_md_data(ctx), data, count);             \
}                                                                              \
static int nm##_final(EVP_MD_CTX *ctx, unsigned char *md)                      \
{                                                                              \
    return fn##_final(md, EVP_MD_CTX_get0_md_data(ctx));                       \
}
#define IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(nm, fn, tag)                        \
static int nm##_init(EVP_MD_CTX *ctx)                                          \
{                                                                              \
    return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
}                                                                              \

#define sha512_224_Init    sha512_224_init
#define sha512_256_Init    sha512_256_init

#define sha512_224_Update  SHA512_Update
#define sha512_224_Final   SHA512_Final
#define sha512_256_Update  SHA512_Update
#define sha512_256_Final   SHA512_Final

IMPLEMENT_LEGACY_EVP_MD_METH(sha1, SHA1)
IMPLEMENT_LEGACY_EVP_MD_METH(sha224, SHA224)
IMPLEMENT_LEGACY_EVP_MD_METH(sha256, SHA256)
IMPLEMENT_LEGACY_EVP_MD_METH(sha384, SHA384)
IMPLEMENT_LEGACY_EVP_MD_METH(sha512, SHA512)
IMPLEMENT_LEGACY_EVP_MD_METH(sha512_224_int, sha512_224)
IMPLEMENT_LEGACY_EVP_MD_METH(sha512_256_int, sha512_256)
IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(sha3_int, ossl_sha3, '\x06')
IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(shake, ossl_sha3, '\x1f')

static int sha1_int_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void *p2)
{
    return ossl_sha1_ctrl(ctx != NULL ? EVP_MD_CTX_get0_md_data(ctx) : NULL,
                          cmd, p1, p2);
}

static int shake_ctrl(EVP_MD_CTX *evp_ctx, int cmd, int p1, void *p2)
{
    KECCAK1600_CTX *ctx = evp_ctx->md_data;

    switch (cmd) {
    case EVP_MD_CTRL_XOF_LEN:
        ctx->md_size = p1;
        return 1;
    default:
        return 0;
    }
}



static const EVP_MD sha1_md = {
    NID_sha1,
    NID_sha1WithRSAEncryption,
    SHA_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha1_init, sha1_update, sha1_final, sha1_int_ctrl,
                             SHA_CBLOCK),
};

const EVP_MD *EVP_sha1(void)
{
    return &sha1_md;
}

static const EVP_MD sha224_md = {
    NID_sha224,
    NID_sha224WithRSAEncryption,
    SHA224_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha224_init, sha224_update, sha224_final, NULL,
                             SHA256_CBLOCK),
};

const EVP_MD *EVP_sha224(void)
{
    return &sha224_md;
}

static const EVP_MD sha256_md = {
    NID_sha256,
    NID_sha256WithRSAEncryption,
    SHA256_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha256_init, sha256_update, sha256_final, NULL,
                             SHA256_CBLOCK),
};

const EVP_MD *EVP_sha256(void)
{
    return &sha256_md;
}

static const EVP_MD sha512_224_md = {
    NID_sha512_224,
    NID_sha512_224WithRSAEncryption,
    SHA224_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha512_224_int_init, sha512_224_int_update,
                             sha512_224_int_final, NULL, SHA512_CBLOCK),
};

const EVP_MD *EVP_sha512_224(void)
{
    return &sha512_224_md;
}

static const EVP_MD sha512_256_md = {
    NID_sha512_256,
    NID_sha512_256WithRSAEncryption,
    SHA256_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha512_256_int_init, sha512_256_int_update,
                             sha512_256_int_final, NULL, SHA512_CBLOCK),
};

const EVP_MD *EVP_sha512_256(void)
{
    return &sha512_256_md;
}

static const EVP_MD sha384_md = {
    NID_sha384,
    NID_sha384WithRSAEncryption,
    SHA384_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha384_init, sha384_update, sha384_final, NULL,
                             SHA512_CBLOCK),
};

const EVP_MD *EVP_sha384(void)
{
    return &sha384_md;
}

static const EVP_MD sha512_md = {
    NID_sha512,
    NID_sha512WithRSAEncryption,
    SHA512_DIGEST_LENGTH,
    EVP_MD_FLAG_DIGALGID_ABSENT,
    EVP_ORIG_GLOBAL,
    LEGACY_EVP_MD_METH_TABLE(sha512_init, sha512_update, sha512_final, NULL,
                             SHA512_CBLOCK),
};

const EVP_MD *EVP_sha512(void)
{
    return &sha512_md;
}

#define EVP_MD_SHA3(bitlen)                                                    \
const EVP_MD *EVP_sha3_##bitlen(void)                                          \
{                                                                              \
    static const EVP_MD sha3_##bitlen##_md = {                                 \
        NID_sha3_##bitlen,                                                     \
        NID_RSA_SHA3_##bitlen,                                                 \
        bitlen / 8,                                                            \
        EVP_MD_FLAG_DIGALGID_ABSENT,                                           \
        EVP_ORIG_GLOBAL,                                                       \
        LEGACY_EVP_MD_METH_TABLE(sha3_int_init, sha3_int_update,               \
                                 sha3_int_final, NULL,                         \
                                 (KECCAK1600_WIDTH - bitlen * 2) / 8),         \
    };                                                                         \
    return &sha3_##bitlen##_md;                                                \
}
#define EVP_MD_SHAKE(bitlen)                                                   \
const EVP_MD *EVP_shake##bitlen(void)                                          \
{                                                                              \
    static const EVP_MD shake##bitlen##_md = {                                 \
        NID_shake##bitlen,                                                     \
        0,                                                                     \
        bitlen / 8,                                                            \
        EVP_MD_FLAG_XOF,                                                       \
        EVP_ORIG_GLOBAL,                                                       \
        LEGACY_EVP_MD_METH_TABLE(shake_init, sha3_int_update, sha3_int_final,  \
                        shake_ctrl, (KECCAK1600_WIDTH - bitlen * 2) / 8),      \
    };                                                                         \
    return &shake##bitlen##_md;                                                \
}

EVP_MD_SHA3(224)
EVP_MD_SHA3(256)
EVP_MD_SHA3(384)
EVP_MD_SHA3(512)

EVP_MD_SHAKE(128)
EVP_MD_SHAKE(256)

Coverage Report

Created: 2023-06-08 06:41

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2019-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		* All SHA low level APIs are deprecated for public use, but still ok for
12		* internal use.
13		*/
14		#include "internal/deprecated.h"
15
16		#include <openssl/sha.h> /* diverse SHA macros */
17		#include "internal/sha3.h" /* KECCAK1600_WIDTH */
18		#include "crypto/evp.h"
19		/* Used by legacy methods */
20		#include "crypto/sha.h"
21		#include "legacy_meth.h"
22		#include "evp_local.h"
23
24		/*-
25		* LEGACY methods for SHA.
26		* These only remain to support engines that can get these methods.
27		* Hardware support for SHA3 has been removed from these legacy cases.
28		*/
29		#define IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(nm, fn, tag) \
30	0	static int nm##_init(EVP_MD_CTX *ctx) \
31	0	{ \
32	0	return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
33	0	} \
34	0	static int nm##_update(EVP_MD_CTX ctx, const void data, size_t count) \
35	0	{ \
36	0	return fn##_update(EVP_MD_CTX_get0_md_data(ctx), data, count); \
37	0	} \
38	0	static int nm##_final(EVP_MD_CTX ctx, unsigned char md) \
39	0	{ \
40	0	return fn##_final(md, EVP_MD_CTX_get0_md_data(ctx)); \
41	0	}
42		#define IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(nm, fn, tag) \
43	0	static int nm##_init(EVP_MD_CTX *ctx) \
44	0	{ \
45	0	return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
46	0	} \
47
48	0	#define sha512_224_Init sha512_224_init
49	0	#define sha512_256_Init sha512_256_init
50
51	0	#define sha512_224_Update SHA512_Update
52	0	#define sha512_224_Final SHA512_Final
53	0	#define sha512_256_Update SHA512_Update
54	0	#define sha512_256_Final SHA512_Final
55
56		IMPLEMENT_LEGACY_EVP_MD_METH(sha1, SHA1)
57		IMPLEMENT_LEGACY_EVP_MD_METH(sha224, SHA224)
58		IMPLEMENT_LEGACY_EVP_MD_METH(sha256, SHA256)
59		IMPLEMENT_LEGACY_EVP_MD_METH(sha384, SHA384)
60		IMPLEMENT_LEGACY_EVP_MD_METH(sha512, SHA512)
61		IMPLEMENT_LEGACY_EVP_MD_METH(sha512_224_int, sha512_224)
62		IMPLEMENT_LEGACY_EVP_MD_METH(sha512_256_int, sha512_256)
63		IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(sha3_int, ossl_sha3, '\x06')
64		IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(shake, ossl_sha3, '\x1f')
65
66		static int sha1_int_ctrl(EVP_MD_CTX ctx, int cmd, int p1, void p2)
67	0	{
68	0	return ossl_sha1_ctrl(ctx != NULL ? EVP_MD_CTX_get0_md_data(ctx) : NULL,
69	0	cmd, p1, p2);
70	0	}
71
72		static int shake_ctrl(EVP_MD_CTX evp_ctx, int cmd, int p1, void p2)
73	0	{
74	0	KECCAK1600_CTX *ctx = evp_ctx->md_data;
75
76	0	switch (cmd) {
77	0	case EVP_MD_CTRL_XOF_LEN:
78	0	ctx->md_size = p1;
79	0	return 1;
80	0	default:
81	0	return 0;
82	0	}
83	0	}
84
85
86
87		static const EVP_MD sha1_md = {
88		NID_sha1,
89		NID_sha1WithRSAEncryption,
90		SHA_DIGEST_LENGTH,
91		EVP_MD_FLAG_DIGALGID_ABSENT,
92		EVP_ORIG_GLOBAL,
93		LEGACY_EVP_MD_METH_TABLE(sha1_init, sha1_update, sha1_final, sha1_int_ctrl,
94		SHA_CBLOCK),
95		};
96
97		const EVP_MD *EVP_sha1(void)
98	0	{
99	0	return &sha1_md;
100	0	}
101
102		static const EVP_MD sha224_md = {
103		NID_sha224,
104		NID_sha224WithRSAEncryption,
105		SHA224_DIGEST_LENGTH,
106		EVP_MD_FLAG_DIGALGID_ABSENT,
107		EVP_ORIG_GLOBAL,
108		LEGACY_EVP_MD_METH_TABLE(sha224_init, sha224_update, sha224_final, NULL,
109		SHA256_CBLOCK),
110		};
111
112		const EVP_MD *EVP_sha224(void)
113	0	{
114	0	return &sha224_md;
115	0	}
116
117		static const EVP_MD sha256_md = {
118		NID_sha256,
119		NID_sha256WithRSAEncryption,
120		SHA256_DIGEST_LENGTH,
121		EVP_MD_FLAG_DIGALGID_ABSENT,
122		EVP_ORIG_GLOBAL,
123		LEGACY_EVP_MD_METH_TABLE(sha256_init, sha256_update, sha256_final, NULL,
124		SHA256_CBLOCK),
125		};
126
127		const EVP_MD *EVP_sha256(void)
128	0	{
129	0	return &sha256_md;
130	0	}
131
132		static const EVP_MD sha512_224_md = {
133		NID_sha512_224,
134		NID_sha512_224WithRSAEncryption,
135		SHA224_DIGEST_LENGTH,
136		EVP_MD_FLAG_DIGALGID_ABSENT,
137		EVP_ORIG_GLOBAL,
138		LEGACY_EVP_MD_METH_TABLE(sha512_224_int_init, sha512_224_int_update,
139		sha512_224_int_final, NULL, SHA512_CBLOCK),
140		};
141
142		const EVP_MD *EVP_sha512_224(void)
143	0	{
144	0	return &sha512_224_md;
145	0	}
146
147		static const EVP_MD sha512_256_md = {
148		NID_sha512_256,
149		NID_sha512_256WithRSAEncryption,
150		SHA256_DIGEST_LENGTH,
151		EVP_MD_FLAG_DIGALGID_ABSENT,
152		EVP_ORIG_GLOBAL,
153		LEGACY_EVP_MD_METH_TABLE(sha512_256_int_init, sha512_256_int_update,
154		sha512_256_int_final, NULL, SHA512_CBLOCK),
155		};
156
157		const EVP_MD *EVP_sha512_256(void)
158	0	{
159	0	return &sha512_256_md;
160	0	}
161
162		static const EVP_MD sha384_md = {
163		NID_sha384,
164		NID_sha384WithRSAEncryption,
165		SHA384_DIGEST_LENGTH,
166		EVP_MD_FLAG_DIGALGID_ABSENT,
167		EVP_ORIG_GLOBAL,
168		LEGACY_EVP_MD_METH_TABLE(sha384_init, sha384_update, sha384_final, NULL,
169		SHA512_CBLOCK),
170		};
171
172		const EVP_MD *EVP_sha384(void)
173	0	{
174	0	return &sha384_md;
175	0	}
176
177		static const EVP_MD sha512_md = {
178		NID_sha512,
179		NID_sha512WithRSAEncryption,
180		SHA512_DIGEST_LENGTH,
181		EVP_MD_FLAG_DIGALGID_ABSENT,
182		EVP_ORIG_GLOBAL,
183		LEGACY_EVP_MD_METH_TABLE(sha512_init, sha512_update, sha512_final, NULL,
184		SHA512_CBLOCK),
185		};
186
187		const EVP_MD *EVP_sha512(void)
188	0	{
189	0	return &sha512_md;
190	0	}
191
192		#define EVP_MD_SHA3(bitlen) \
193	0	const EVP_MD *EVP_sha3_##bitlen(void) \
194	0	{ \
195	0	static const EVP_MD sha3_##bitlen##_md = { \
196	0	NID_sha3_##bitlen, \
197	0	NID_RSA_SHA3_##bitlen, \
198	0	bitlen / 8, \
199	0	EVP_MD_FLAG_DIGALGID_ABSENT, \
200	0	EVP_ORIG_GLOBAL, \
201	0	LEGACY_EVP_MD_METH_TABLE(sha3_int_init, sha3_int_update, \
202	0	sha3_int_final, NULL, \
203	0	(KECCAK1600_WIDTH - bitlen * 2) / 8), \
204	0	}; \
205	0	return &sha3_##bitlen##_md; \
206	0	} Unexecuted instantiation: EVP_sha3_224 Unexecuted instantiation: EVP_sha3_256 Unexecuted instantiation: EVP_sha3_384 Unexecuted instantiation: EVP_sha3_512
207		#define EVP_MD_SHAKE(bitlen) \
208	0	const EVP_MD *EVP_shake##bitlen(void) \
209	0	{ \
210	0	static const EVP_MD shake##bitlen##_md = { \
211	0	NID_shake##bitlen, \
212	0	0, \
213	0	bitlen / 8, \
214	0	EVP_MD_FLAG_XOF, \
215	0	EVP_ORIG_GLOBAL, \
216	0	LEGACY_EVP_MD_METH_TABLE(shake_init, sha3_int_update, sha3_int_final, \
217	0	shake_ctrl, (KECCAK1600_WIDTH - bitlen * 2) / 8), \
218	0	}; \
219	0	return &shake##bitlen##_md; \
220	0	} Unexecuted instantiation: EVP_shake128 Unexecuted instantiation: EVP_shake256
221
222		EVP_MD_SHA3(224)
223		EVP_MD_SHA3(256)
224		EVP_MD_SHA3(384)
225		EVP_MD_SHA3(512)
226
227		EVP_MD_SHAKE(128)
228		EVP_MD_SHAKE(256)