lib/libcrypto/sha/sha.h

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