1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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 /* TODO(fork): remove */ 77 #define SHA_LBLOCK 16 78 #define SHA_LONG uint32_t 79 80 /* SHA1_Init initialises |sha| and returns one. */ 81 OPENSSL_EXPORT int SHA1_Init(SHA_CTX *sha); 82 83 /* SHA1_Update adds |len| bytes from |data| to |sha| and returns one. */ 84 OPENSSL_EXPORT int SHA1_Update(SHA_CTX *sha, const void *data, size_t len); 85 86 /* SHA1_Final adds the final padding to |sha| and writes the resulting digest 87 * to |md|, which must have at least |SHA_DIGEST_LENGTH| bytes of space. It 88 * returns one. */ 89 OPENSSL_EXPORT int SHA1_Final(uint8_t *md, SHA_CTX *sha); 90 91 /* SHA1 writes the digest of |len| bytes from |data| to |out| and returns 92 * |out|. There must be at least |SHA_DIGEST_LENGTH| bytes of space in 93 * |out|. */ 94 OPENSSL_EXPORT uint8_t *SHA1(const uint8_t *data, size_t len, uint8_t *out); 95 96 /* SHA1_Transform is a low-level function that performs a single, SHA-1 block 97 * transformation using the state from |sha| and 64 bytes from |block|. */ 98 OPENSSL_EXPORT void SHA1_Transform(SHA_CTX *sha, const uint8_t *block); 99 100 struct sha_state_st { 101 uint32_t h0, h1, h2, h3, h4; 102 uint32_t Nl, Nh; 103 uint32_t data[16]; 104 unsigned int num; 105 }; 106 107 108 /* SHA-224. */ 109 110 /* SHA224_CBLOCK is the block size of SHA-224. */ 111 #define SHA224_CBLOCK 64 112 113 /* SHA224_DIGEST_LENGTH is the length of a SHA-224 digest. */ 114 #define SHA224_DIGEST_LENGTH 28 115 116 /* SHA224_Init initialises |sha| and returns 1. */ 117 OPENSSL_EXPORT int SHA224_Init(SHA256_CTX *sha); 118 119 /* SHA224_Update adds |len| bytes from |data| to |sha| and returns 1. */ 120 OPENSSL_EXPORT int SHA224_Update(SHA256_CTX *sha, const void *data, size_t len); 121 122 /* SHA224_Final adds the final padding to |sha| and writes the resulting digest 123 * to |md|, which must have at least |SHA224_DIGEST_LENGTH| bytes of space. It 124 * returns one on success and zero on programmer error. */ 125 OPENSSL_EXPORT int SHA224_Final(uint8_t *md, SHA256_CTX *sha); 126 127 /* SHA224 writes the digest of |len| bytes from |data| to |out| and returns 128 * |out|. There must be at least |SHA224_DIGEST_LENGTH| bytes of space in 129 * |out|. */ 130 OPENSSL_EXPORT uint8_t *SHA224(const uint8_t *data, size_t len, uint8_t *out); 131 132 133 /* SHA-256. */ 134 135 /* SHA256_CBLOCK is the block size of SHA-256. */ 136 #define SHA256_CBLOCK 64 137 138 /* SHA256_DIGEST_LENGTH is the length of a SHA-256 digest. */ 139 #define SHA256_DIGEST_LENGTH 32 140 141 /* SHA256_Init initialises |sha| and returns 1. */ 142 OPENSSL_EXPORT int SHA256_Init(SHA256_CTX *sha); 143 144 /* SHA256_Update adds |len| bytes from |data| to |sha| and returns 1. */ 145 OPENSSL_EXPORT int SHA256_Update(SHA256_CTX *sha, const void *data, size_t len); 146 147 /* SHA256_Final adds the final padding to |sha| and writes the resulting digest 148 * to |md|, which must have at least |SHA256_DIGEST_LENGTH| bytes of space. It 149 * returns one on success and zero on programmer error. */ 150 OPENSSL_EXPORT int SHA256_Final(uint8_t *md, SHA256_CTX *sha); 151 152 /* SHA256 writes the digest of |len| bytes from |data| to |out| and returns 153 * |out|. There must be at least |SHA256_DIGEST_LENGTH| bytes of space in 154 * |out|. */ 155 OPENSSL_EXPORT uint8_t *SHA256(const uint8_t *data, size_t len, uint8_t *out); 156 157 /* SHA256_Transform is a low-level function that performs a single, SHA-1 block 158 * transformation using the state from |sha| and 64 bytes from |block|. */ 159 OPENSSL_EXPORT void SHA256_Transform(SHA256_CTX *sha, const uint8_t *data); 160 161 struct sha256_state_st { 162 uint32_t h[8]; 163 uint32_t Nl, Nh; 164 uint32_t data[16]; 165 unsigned int num, md_len; 166 }; 167 168 169 /* SHA-384. */ 170 171 /* SHA384_CBLOCK is the block size of SHA-384. */ 172 #define SHA384_CBLOCK 128 173 174 /* SHA384_DIGEST_LENGTH is the length of a SHA-384 digest. */ 175 #define SHA384_DIGEST_LENGTH 48 176 177 /* SHA384_Init initialises |sha| and returns 1. */ 178 OPENSSL_EXPORT int SHA384_Init(SHA512_CTX *sha); 179 180 /* SHA384_Update adds |len| bytes from |data| to |sha| and returns 1. */ 181 OPENSSL_EXPORT int SHA384_Update(SHA512_CTX *sha, const void *data, size_t len); 182 183 /* SHA384_Final adds the final padding to |sha| and writes the resulting digest 184 * to |md|, which must have at least |SHA384_DIGEST_LENGTH| bytes of space. It 185 * returns one on success and zero on programmer error. */ 186 OPENSSL_EXPORT int SHA384_Final(uint8_t *md, SHA512_CTX *sha); 187 188 /* SHA384 writes the digest of |len| bytes from |data| to |out| and returns 189 * |out|. There must be at least |SHA384_DIGEST_LENGTH| bytes of space in 190 * |out|. */ 191 OPENSSL_EXPORT uint8_t *SHA384(const uint8_t *data, size_t len, uint8_t *out); 192 193 /* SHA384_Transform is a low-level function that performs a single, SHA-1 block 194 * transformation using the state from |sha| and 64 bytes from |block|. */ 195 OPENSSL_EXPORT void SHA384_Transform(SHA512_CTX *sha, const uint8_t *data); 196 197 198 /* SHA-512. */ 199 200 /* SHA512_CBLOCK is the block size of SHA-512. */ 201 #define SHA512_CBLOCK 128 202 203 /* SHA512_DIGEST_LENGTH is the length of a SHA-512 digest. */ 204 #define SHA512_DIGEST_LENGTH 64 205 206 /* SHA512_Init initialises |sha| and returns 1. */ 207 OPENSSL_EXPORT int SHA512_Init(SHA512_CTX *sha); 208 209 /* SHA512_Update adds |len| bytes from |data| to |sha| and returns 1. */ 210 OPENSSL_EXPORT int SHA512_Update(SHA512_CTX *sha, const void *data, size_t len); 211 212 /* SHA512_Final adds the final padding to |sha| and writes the resulting digest 213 * to |md|, which must have at least |SHA512_DIGEST_LENGTH| bytes of space. It 214 * returns one on success and zero on programmer error. */ 215 OPENSSL_EXPORT int SHA512_Final(uint8_t *md, SHA512_CTX *sha); 216 217 /* SHA512 writes the digest of |len| bytes from |data| to |out| and returns 218 * |out|. There must be at least |SHA512_DIGEST_LENGTH| bytes of space in 219 * |out|. */ 220 OPENSSL_EXPORT uint8_t *SHA512(const uint8_t *data, size_t len, uint8_t *out); 221 222 /* SHA512_Transform is a low-level function that performs a single, SHA-1 block 223 * transformation using the state from |sha| and 64 bytes from |block|. */ 224 OPENSSL_EXPORT void SHA512_Transform(SHA512_CTX *sha, const uint8_t *data); 225 226 struct sha512_state_st { 227 uint64_t h[8]; 228 uint64_t Nl, Nh; 229 union { 230 uint64_t d[16]; 231 uint8_t p[128]; 232 } u; 233 unsigned int num, md_len; 234 }; 235 236 237 #if defined(__cplusplus) 238 } /* extern C */ 239 #endif 240 241 #endif /* OPENSSL_HEADER_SHA_H */ 242
