1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay@cryptsoft.com). 6 * The implementation was written so as to conform with Netscapes SSL. 7 * 8 * This library is free for commercial and non-commercial use as long as 9 * the following conditions are aheared to. The following conditions 10 * apply to all code found in this distribution, be it the RC4, RSA, 11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12 * included with this distribution is covered by the same copyright terms 13 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 14 * 15 * Copyright remains Eric Young's, and as such any Copyright notices in 16 * the code are not to be removed. 17 * If this package is used in a product, Eric Young should be given attribution 18 * as the author of the parts of the library used. 19 * This can be in the form of a textual message at program startup or 20 * in documentation (online or textual) provided with the package. 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 1. Redistributions of source code must retain the copyright 26 * notice, this list of conditions and the following disclaimer. 27 * 2. Redistributions in binary form must reproduce the above copyright 28 * notice, this list of conditions and the following disclaimer in the 29 * documentation and/or other materials provided with the distribution. 30 * 3. All advertising materials mentioning features or use of this software 31 * must display the following acknowledgement: 32 * "This product includes cryptographic software written by 33 * Eric Young (eay@cryptsoft.com)" 34 * The word 'cryptographic' can be left out if the rouines from the library 35 * being used are not cryptographic related :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50 * SUCH DAMAGE. 51 * 52 * The licence and distribution terms for any publically available version or 53 * derivative of this code cannot be changed. i.e. this code cannot simply be 54 * copied and put under another distribution licence 55 * [including the GNU Public Licence.] */ 56 57 #ifndef OPENSSL_HEADER_SHA_H 58 #define OPENSSL_HEADER_SHA_H 59 60 #include <openssl/base.h> 61 62 #if defined(__cplusplus) 63 extern "C" { 64 #endif 65 66 67 // The SHA family of hash functions (SHA-1 and SHA-2). 68 69 70 // SHA_CBLOCK is the block size of SHA-1. 71 #define SHA_CBLOCK 64 72 73 // SHA_DIGEST_LENGTH is the length of a SHA-1 digest. 74 #define SHA_DIGEST_LENGTH 20 75 76 // SHA1_Init initialises |sha| and returns one. 77 OPENSSL_EXPORT int SHA1_Init(SHA_CTX *sha); 78 79 // SHA1_Update adds |len| bytes from |data| to |sha| and returns one. 80 OPENSSL_EXPORT int SHA1_Update(SHA_CTX *sha, const void *data, size_t len); 81 82 // SHA1_Final adds the final padding to |sha| and writes the resulting digest to 83 // |out|, which must have at least |SHA_DIGEST_LENGTH| bytes of space. It 84 // returns one. 85 OPENSSL_EXPORT int SHA1_Final(uint8_t out[SHA_DIGEST_LENGTH], SHA_CTX *sha); 86 87 // SHA1 writes the digest of |len| bytes from |data| to |out| and returns 88 // |out|. There must be at least |SHA_DIGEST_LENGTH| bytes of space in 89 // |out|. 90 OPENSSL_EXPORT uint8_t *SHA1(const uint8_t *data, size_t len, 91 uint8_t out[SHA_DIGEST_LENGTH]); 92 93 // SHA1_Transform is a low-level function that performs a single, SHA-1 block 94 // transformation using the state from |sha| and |SHA_CBLOCK| bytes from 95 // |block|. 96 OPENSSL_EXPORT void SHA1_Transform(SHA_CTX *sha, 97 const uint8_t block[SHA_CBLOCK]); 98 99 struct sha_state_st { 100 #if defined(__cplusplus) || defined(OPENSSL_WINDOWS) 101 uint32_t h[5]; 102 #else 103 // wpa_supplicant accesses |h0|..|h4| so we must support those names for 104 // compatibility with it until it can be updated. Anonymous unions are only 105 // standard in C11, so disable this workaround in C++. 106 union { 107 uint32_t h[5]; 108 struct { 109 uint32_t h0; 110 uint32_t h1; 111 uint32_t h2; 112 uint32_t h3; 113 uint32_t h4; 114 }; 115 }; 116 #endif 117 uint32_t Nl, Nh; 118 uint8_t data[SHA_CBLOCK]; 119 unsigned num; 120 }; 121 122 123 // SHA-224. 124 125 // SHA224_CBLOCK is the block size of SHA-224. 126 #define SHA224_CBLOCK 64 127 128 // SHA224_DIGEST_LENGTH is the length of a SHA-224 digest. 129 #define SHA224_DIGEST_LENGTH 28 130 131 // SHA224_Init initialises |sha| and returns 1. 132 OPENSSL_EXPORT int SHA224_Init(SHA256_CTX *sha); 133 134 // SHA224_Update adds |len| bytes from |data| to |sha| and returns 1. 135 OPENSSL_EXPORT int SHA224_Update(SHA256_CTX *sha, const void *data, size_t len); 136 137 // SHA224_Final adds the final padding to |sha| and writes the resulting digest 138 // to |out|, which must have at least |SHA224_DIGEST_LENGTH| bytes of space. It 139 // returns one on success and zero on programmer error. 140 OPENSSL_EXPORT int SHA224_Final(uint8_t out[SHA224_DIGEST_LENGTH], 141 SHA256_CTX *sha); 142 143 // SHA224 writes the digest of |len| bytes from |data| to |out| and returns 144 // |out|. There must be at least |SHA224_DIGEST_LENGTH| bytes of space in 145 // |out|. 146 OPENSSL_EXPORT uint8_t *SHA224(const uint8_t *data, size_t len, 147 uint8_t out[SHA224_DIGEST_LENGTH]); 148 149 150 // SHA-256. 151 152 // SHA256_CBLOCK is the block size of SHA-256. 153 #define SHA256_CBLOCK 64 154 155 // SHA256_DIGEST_LENGTH is the length of a SHA-256 digest. 156 #define SHA256_DIGEST_LENGTH 32 157 158 // SHA256_Init initialises |sha| and returns 1. 159 OPENSSL_EXPORT int SHA256_Init(SHA256_CTX *sha); 160 161 // SHA256_Update adds |len| bytes from |data| to |sha| and returns 1. 162 OPENSSL_EXPORT int SHA256_Update(SHA256_CTX *sha, const void *data, size_t len); 163 164 // SHA256_Final adds the final padding to |sha| and writes the resulting digest 165 // to |out|, which must have at least |SHA256_DIGEST_LENGTH| bytes of space. It 166 // returns one on success and zero on programmer error. 167 OPENSSL_EXPORT int SHA256_Final(uint8_t out[SHA256_DIGEST_LENGTH], 168 SHA256_CTX *sha); 169 170 // SHA256 writes the digest of |len| bytes from |data| to |out| and returns 171 // |out|. There must be at least |SHA256_DIGEST_LENGTH| bytes of space in 172 // |out|. 173 OPENSSL_EXPORT uint8_t *SHA256(const uint8_t *data, size_t len, 174 uint8_t out[SHA256_DIGEST_LENGTH]); 175 176 // SHA256_Transform is a low-level function that performs a single, SHA-256 177 // block transformation using the state from |sha| and |SHA256_CBLOCK| bytes 178 // from |block|. 179 OPENSSL_EXPORT void SHA256_Transform(SHA256_CTX *sha, 180 const uint8_t block[SHA256_CBLOCK]); 181 182 // SHA256_TransformBlocks is a low-level function that takes |num_blocks| * 183 // |SHA256_CBLOCK| bytes of data and performs SHA-256 transforms on it to update 184 // |state|. You should not use this function unless you are implementing a 185 // derivative of SHA-256. 186 OPENSSL_EXPORT void SHA256_TransformBlocks(uint32_t state[8], 187 const uint8_t *data, 188 size_t num_blocks); 189 190 struct sha256_state_st { 191 uint32_t h[8]; 192 uint32_t Nl, Nh; 193 uint8_t data[SHA256_CBLOCK]; 194 unsigned num, md_len; 195 }; 196 197 198 // SHA-384. 199 200 // SHA384_CBLOCK is the block size of SHA-384. 201 #define SHA384_CBLOCK 128 202 203 // SHA384_DIGEST_LENGTH is the length of a SHA-384 digest. 204 #define SHA384_DIGEST_LENGTH 48 205 206 // SHA384_Init initialises |sha| and returns 1. 207 OPENSSL_EXPORT int SHA384_Init(SHA512_CTX *sha); 208 209 // SHA384_Update adds |len| bytes from |data| to |sha| and returns 1. 210 OPENSSL_EXPORT int SHA384_Update(SHA512_CTX *sha, const void *data, size_t len); 211 212 // SHA384_Final adds the final padding to |sha| and writes the resulting digest 213 // to |out|, which must have at least |SHA384_DIGEST_LENGTH| bytes of space. It 214 // returns one on success and zero on programmer error. 215 OPENSSL_EXPORT int SHA384_Final(uint8_t out[SHA384_DIGEST_LENGTH], 216 SHA512_CTX *sha); 217 218 // SHA384 writes the digest of |len| bytes from |data| to |out| and returns 219 // |out|. There must be at least |SHA384_DIGEST_LENGTH| bytes of space in 220 // |out|. 221 OPENSSL_EXPORT uint8_t *SHA384(const uint8_t *data, size_t len, 222 uint8_t out[SHA384_DIGEST_LENGTH]); 223 224 225 // SHA-512. 226 227 // SHA512_CBLOCK is the block size of SHA-512. 228 #define SHA512_CBLOCK 128 229 230 // SHA512_DIGEST_LENGTH is the length of a SHA-512 digest. 231 #define SHA512_DIGEST_LENGTH 64 232 233 // SHA512_Init initialises |sha| and returns 1. 234 OPENSSL_EXPORT int SHA512_Init(SHA512_CTX *sha); 235 236 // SHA512_Update adds |len| bytes from |data| to |sha| and returns 1. 237 OPENSSL_EXPORT int SHA512_Update(SHA512_CTX *sha, const void *data, size_t len); 238 239 // SHA512_Final adds the final padding to |sha| and writes the resulting digest 240 // to |out|, which must have at least |SHA512_DIGEST_LENGTH| bytes of space. It 241 // returns one on success and zero on programmer error. 242 OPENSSL_EXPORT int SHA512_Final(uint8_t out[SHA512_DIGEST_LENGTH], 243 SHA512_CTX *sha); 244 245 // SHA512 writes the digest of |len| bytes from |data| to |out| and returns 246 // |out|. There must be at least |SHA512_DIGEST_LENGTH| bytes of space in 247 // |out|. 248 OPENSSL_EXPORT uint8_t *SHA512(const uint8_t *data, size_t len, 249 uint8_t out[SHA512_DIGEST_LENGTH]); 250 251 // SHA512_Transform is a low-level function that performs a single, SHA-512 252 // block transformation using the state from |sha| and |SHA512_CBLOCK| bytes 253 // from |block|. 254 OPENSSL_EXPORT void SHA512_Transform(SHA512_CTX *sha, 255 const uint8_t block[SHA512_CBLOCK]); 256 257 struct sha512_state_st { 258 uint64_t h[8]; 259 uint64_t Nl, Nh; 260 uint8_t p[128]; 261 unsigned num, md_len; 262 }; 263 264 265 // SHA-512-256 266 // 267 // See https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf section 5.3.6 268 269 #define SHA512_256_DIGEST_LENGTH 32 270 271 // SHA512_256_Init initialises |sha| and returns 1. 272 OPENSSL_EXPORT int SHA512_256_Init(SHA512_CTX *sha); 273 274 // SHA512_256_Update adds |len| bytes from |data| to |sha| and returns 1. 275 OPENSSL_EXPORT int SHA512_256_Update(SHA512_CTX *sha, const void *data, 276 size_t len); 277 278 // SHA512_256_Final adds the final padding to |sha| and writes the resulting 279 // digest to |out|, which must have at least |SHA512_256_DIGEST_LENGTH| bytes of 280 // space. It returns one on success and zero on programmer error. 281 OPENSSL_EXPORT int SHA512_256_Final(uint8_t out[SHA512_256_DIGEST_LENGTH], 282 SHA512_CTX *sha); 283 284 // SHA512_256 writes the digest of |len| bytes from |data| to |out| and returns 285 // |out|. There must be at least |SHA512_256_DIGEST_LENGTH| bytes of space in 286 // |out|. 287 OPENSSL_EXPORT uint8_t *SHA512_256(const uint8_t *data, size_t len, 288 uint8_t out[SHA512_256_DIGEST_LENGTH]); 289 290 291 #if defined(__cplusplus) 292 } // extern C 293 #endif 294 295 #endif // OPENSSL_HEADER_SHA_H 296