3d2d2fa136a7806a1c60722d010d720e7d226bfd
[openssl.git] / crypto / sha / sha.h
1 /* crypto/sha/sha.h */
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 #ifndef HEADER_SHA_H
60 # define HEADER_SHA_H
61
62 # include <openssl/e_os2.h>
63 # include <stddef.h>
64
65 #ifdef  __cplusplus
66 extern "C" {
67 #endif
68
69 # if defined(OPENSSL_NO_SHA) || (defined(OPENSSL_NO_SHA0) && defined(OPENSSL_NO_SHA1))
70 #  error SHA is disabled.
71 # endif
72
73 /*-
74  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
75  * ! SHA_LONG has to be at least 32 bits wide. If it's wider, then !
76  * ! SHA_LONG_LOG2 has to be defined along.                        !
77  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
78  */
79
80 # if defined(__LP32__)
81 #  define SHA_LONG unsigned long
82 # elif defined(__ILP64__)
83 #  define SHA_LONG unsigned long
84 #  define SHA_LONG_LOG2 3
85 # else
86 #  define SHA_LONG unsigned int
87 # endif
88
89 # define SHA_LBLOCK      16
90 # define SHA_CBLOCK      (SHA_LBLOCK*4)/* SHA treats input data as a
91                                         * contiguous array of 32 bit wide
92                                         * big-endian values. */
93 # define SHA_LAST_BLOCK  (SHA_CBLOCK-8)
94 # define SHA_DIGEST_LENGTH 20
95
96 typedef struct SHAstate_st {
97     SHA_LONG h0, h1, h2, h3, h4;
98     SHA_LONG Nl, Nh;
99     SHA_LONG data[SHA_LBLOCK];
100     unsigned int num;
101 } SHA_CTX;
102
103 # ifndef OPENSSL_NO_SHA0
104 int SHA_Init(SHA_CTX *c);
105 int SHA_Update(SHA_CTX *c, const void *data, size_t len);
106 int SHA_Final(unsigned char *md, SHA_CTX *c);
107 unsigned char *SHA(const unsigned char *d, size_t n, unsigned char *md);
108 void SHA_Transform(SHA_CTX *c, const unsigned char *data);
109 # endif
110 # ifndef OPENSSL_NO_SHA1
111 int SHA1_Init(SHA_CTX *c);
112 int SHA1_Update(SHA_CTX *c, const void *data, size_t len);
113 int SHA1_Final(unsigned char *md, SHA_CTX *c);
114 unsigned char *SHA1(const unsigned char *d, size_t n, unsigned char *md);
115 void SHA1_Transform(SHA_CTX *c, const unsigned char *data);
116 # endif
117
118 # define SHA256_CBLOCK   (SHA_LBLOCK*4)/* SHA-256 treats input data as a
119                                         * contiguous array of 32 bit wide
120                                         * big-endian values. */
121 # define SHA224_DIGEST_LENGTH    28
122 # define SHA256_DIGEST_LENGTH    32
123
124 typedef struct SHA256state_st {
125     SHA_LONG h[8];
126     SHA_LONG Nl, Nh;
127     SHA_LONG data[SHA_LBLOCK];
128     unsigned int num, md_len;
129 } SHA256_CTX;
130
131 # ifndef OPENSSL_NO_SHA256
132 int SHA224_Init(SHA256_CTX *c);
133 int SHA224_Update(SHA256_CTX *c, const void *data, size_t len);
134 int SHA224_Final(unsigned char *md, SHA256_CTX *c);
135 unsigned char *SHA224(const unsigned char *d, size_t n, unsigned char *md);
136 int SHA256_Init(SHA256_CTX *c);
137 int SHA256_Update(SHA256_CTX *c, const void *data, size_t len);
138 int SHA256_Final(unsigned char *md, SHA256_CTX *c);
139 unsigned char *SHA256(const unsigned char *d, size_t n, unsigned char *md);
140 void SHA256_Transform(SHA256_CTX *c, const unsigned char *data);
141 # endif
142
143 # define SHA384_DIGEST_LENGTH    48
144 # define SHA512_DIGEST_LENGTH    64
145
146 # ifndef OPENSSL_NO_SHA512
147 /*
148  * Unlike 32-bit digest algorithms, SHA-512 *relies* on SHA_LONG64
149  * being exactly 64-bit wide. See Implementation Notes in sha512.c
150  * for further details.
151  */
152 /*
153  * SHA-512 treats input data as a
154  * contiguous array of 64 bit
155  * wide big-endian values.
156  */
157 #  define SHA512_CBLOCK   (SHA_LBLOCK*8)
158 #  if (defined(_WIN32) || defined(_WIN64)) && !defined(__MINGW32__)
159 #   define SHA_LONG64 unsigned __int64
160 #   define U64(C)     C##UI64
161 #  elif defined(__arch64__)
162 #   define SHA_LONG64 unsigned long
163 #   define U64(C)     C##UL
164 #  else
165 #   define SHA_LONG64 unsigned long long
166 #   define U64(C)     C##ULL
167 #  endif
168
169 typedef struct SHA512state_st {
170     SHA_LONG64 h[8];
171     SHA_LONG64 Nl, Nh;
172     union {
173         SHA_LONG64 d[SHA_LBLOCK];
174         unsigned char p[SHA512_CBLOCK];
175     } u;
176     unsigned int num, md_len;
177 } SHA512_CTX;
178 # endif
179
180 # ifndef OPENSSL_NO_SHA512
181 int SHA384_Init(SHA512_CTX *c);
182 int SHA384_Update(SHA512_CTX *c, const void *data, size_t len);
183 int SHA384_Final(unsigned char *md, SHA512_CTX *c);
184 unsigned char *SHA384(const unsigned char *d, size_t n, unsigned char *md);
185 int SHA512_Init(SHA512_CTX *c);
186 int SHA512_Update(SHA512_CTX *c, const void *data, size_t len);
187 int SHA512_Final(unsigned char *md, SHA512_CTX *c);
188 unsigned char *SHA512(const unsigned char *d, size_t n, unsigned char *md);
189 void SHA512_Transform(SHA512_CTX *c, const unsigned char *data);
190 # endif
191
192 #ifdef  __cplusplus
193 }
194 #endif
195
196 #endif