xref: /openbsd-src/lib/libcrypto/sha/sha.h (revision 515aa502ddfbfa9d16fb6d4368077c2ccf35cf3d)
1 /* $OpenBSD: sha.h,v 1.26 2025/01/25 17:59:44 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #include <stddef.h>
60 
61 #ifndef HEADER_SHA_H
62 #define HEADER_SHA_H
63 #if !defined(HAVE_ATTRIBUTE__BOUNDED__) && !defined(__OpenBSD__)
64 #define __bounded__(x, y, z)
65 #endif
66 
67 #include <openssl/opensslconf.h>
68 
69 #ifdef  __cplusplus
70 extern "C" {
71 #endif
72 
73 /*
74  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
75  * ! SHA_LONG has to be at least 32 bits wide.                    !
76  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
77  */
78 
79 #define SHA_LONG unsigned int
80 
81 #define SHA_LBLOCK	16
82 #define SHA_CBLOCK	(SHA_LBLOCK*4)	/* SHA treats input data as a
83 					 * contiguous array of 32 bit
84 					 * wide big-endian values. */
85 #define SHA_LAST_BLOCK  (SHA_CBLOCK-8)
86 #define SHA_DIGEST_LENGTH 20
87 
88 typedef struct SHAstate_st {
89 	SHA_LONG h0, h1, h2, h3, h4;
90 	SHA_LONG Nl, Nh;
91 	SHA_LONG data[SHA_LBLOCK];
92 	unsigned int num;
93 } SHA_CTX;
94 
95 #ifndef OPENSSL_NO_SHA1
96 int SHA1_Init(SHA_CTX *c);
97 int SHA1_Update(SHA_CTX *c, const void *data, size_t len)
98     __attribute__ ((__bounded__(__buffer__, 2, 3)));
99 int SHA1_Final(unsigned char *md, SHA_CTX *c);
100 unsigned char *SHA1(const unsigned char *d, size_t n, unsigned char *md)
101     __attribute__ ((__bounded__(__buffer__, 1, 2)))
102     __attribute__ ((__nonnull__(3)));
103 void SHA1_Transform(SHA_CTX *c, const unsigned char *data);
104 #endif
105 
106 #define SHA256_CBLOCK	(SHA_LBLOCK*4)	/* SHA-256 treats input data as a
107 					 * contiguous array of 32 bit
108 					 * wide big-endian values. */
109 #define SHA224_DIGEST_LENGTH	28
110 #define SHA256_DIGEST_LENGTH	32
111 
112 typedef struct SHA256state_st {
113 	SHA_LONG h[8];
114 	SHA_LONG Nl, Nh;
115 	SHA_LONG data[SHA_LBLOCK];
116 	unsigned int num, md_len;
117 } SHA256_CTX;
118 
119 #ifndef OPENSSL_NO_SHA256
120 int SHA224_Init(SHA256_CTX *c);
121 int SHA224_Update(SHA256_CTX *c, const void *data, size_t len)
122     __attribute__ ((__bounded__(__buffer__, 2, 3)));
123 int SHA224_Final(unsigned char *md, SHA256_CTX *c);
124 unsigned char *SHA224(const unsigned char *d, size_t n, unsigned char *md)
125     __attribute__ ((__bounded__(__buffer__, 1, 2)))
126     __attribute__ ((__nonnull__(3)));
127 int SHA256_Init(SHA256_CTX *c);
128 int SHA256_Update(SHA256_CTX *c, const void *data, size_t len)
129     __attribute__ ((__bounded__(__buffer__, 2, 3)));
130 int SHA256_Final(unsigned char *md, SHA256_CTX *c);
131 unsigned char *SHA256(const unsigned char *d, size_t n, unsigned char *md)
132     __attribute__ ((__bounded__(__buffer__, 1, 2)))
133     __attribute__ ((__nonnull__(3)));
134 void SHA256_Transform(SHA256_CTX *c, const unsigned char *data);
135 #endif
136 
137 #define SHA384_DIGEST_LENGTH	48
138 #define SHA512_DIGEST_LENGTH	64
139 
140 #ifndef OPENSSL_NO_SHA512
141 /*
142  * Unlike 32-bit digest algorithms, SHA-512 *relies* on SHA_LONG64
143  * being exactly 64-bit wide. See Implementation Notes in sha512.c
144  * for further details.
145  */
146 #define SHA512_CBLOCK	(SHA_LBLOCK*8)	/* SHA-512 treats input data as a
147 					 * contiguous array of 64 bit
148 					 * wide big-endian values. */
149 #if defined(_LP64)
150 #define SHA_LONG64 unsigned long
151 #define U64(C)     C##UL
152 #else
153 #define SHA_LONG64 unsigned long long
154 #define U64(C)     C##ULL
155 #endif
156 
157 typedef struct SHA512state_st {
158 	SHA_LONG64 h[8];
159 	SHA_LONG64 Nl, Nh;
160 	union {
161 		SHA_LONG64	d[SHA_LBLOCK];
162 		unsigned char	p[SHA512_CBLOCK];
163 	} u;
164 	unsigned int num, md_len;
165 } SHA512_CTX;
166 #endif
167 
168 #ifndef OPENSSL_NO_SHA512
169 int SHA384_Init(SHA512_CTX *c);
170 int SHA384_Update(SHA512_CTX *c, const void *data, size_t len)
171     __attribute__ ((__bounded__(__buffer__, 2, 3)));
172 int SHA384_Final(unsigned char *md, SHA512_CTX *c);
173 unsigned char *SHA384(const unsigned char *d, size_t n, unsigned char *md)
174     __attribute__ ((__bounded__(__buffer__, 1, 2)))
175     __attribute__ ((__nonnull__(3)));
176 int SHA512_Init(SHA512_CTX *c);
177 int SHA512_Update(SHA512_CTX *c, const void *data, size_t len)
178     __attribute__ ((__bounded__(__buffer__, 2, 3)));
179 int SHA512_Final(unsigned char *md, SHA512_CTX *c);
180 unsigned char *SHA512(const unsigned char *d, size_t n, unsigned char *md)
181     __attribute__ ((__bounded__(__buffer__, 1, 2)))
182     __attribute__ ((__nonnull__(3)));
183 void SHA512_Transform(SHA512_CTX *c, const unsigned char *data);
184 #endif
185 
186 #ifdef  __cplusplus
187 }
188 #endif
189 
190 #endif
191