Switch deprecation method for SHA
[openssl.git] / include / openssl / sha.h
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OPENSSL_SHA_H
11 # define OPENSSL_SHA_H
12 # pragma once
13
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 #  define HEADER_SHA_H
17 # endif
18
19 # include <openssl/e_os2.h>
20 # include <stddef.h>
21
22 # ifdef  __cplusplus
23 extern "C" {
24 # endif
25
26 # define SHA_DIGEST_LENGTH 20
27
28 # ifndef OPENSSL_NO_DEPRECATED_3_0
29 /*-
30  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31  * ! SHA_LONG has to be at least 32 bits wide.                    !
32  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33  */
34 #  define SHA_LONG unsigned int
35
36 #  define SHA_LBLOCK      16
37 #  define SHA_CBLOCK      (SHA_LBLOCK*4)/* SHA treats input data as a
38                                          * contiguous array of 32 bit wide
39                                          * big-endian values. */
40 #  define SHA_LAST_BLOCK  (SHA_CBLOCK-8)
41
42 typedef struct SHAstate_st {
43     SHA_LONG h0, h1, h2, h3, h4;
44     SHA_LONG Nl, Nh;
45     SHA_LONG data[SHA_LBLOCK];
46     unsigned int num;
47 } SHA_CTX;
48 # endif /* !defined(OPENSSL_NO_DEPRECATED_3_0) */
49 # ifndef OPENSSL_NO_DEPRECATED_3_0
50 OSSL_DEPRECATEDIN_3_0 int SHA1_Init(SHA_CTX *c);
51 OSSL_DEPRECATEDIN_3_0 int SHA1_Update(SHA_CTX *c, const void *data, size_t len);
52 OSSL_DEPRECATEDIN_3_0 int SHA1_Final(unsigned char *md, SHA_CTX *c);
53 OSSL_DEPRECATEDIN_3_0 unsigned char *SHA1(const unsigned char *d, size_t n,
54                                           unsigned char *md);
55 OSSL_DEPRECATEDIN_3_0 void SHA1_Transform(SHA_CTX *c, const unsigned char *data);
56 # endif
57
58 # ifndef OPENSSL_NO_DEPRECATED_3_0
59 #  define SHA256_CBLOCK   (SHA_LBLOCK*4)/* SHA-256 treats input data as a
60                                         * contiguous array of 32 bit wide
61                                         * big-endian values. */
62
63 typedef struct SHA256state_st {
64     SHA_LONG h[8];
65     SHA_LONG Nl, Nh;
66     SHA_LONG data[SHA_LBLOCK];
67     unsigned int num, md_len;
68 } SHA256_CTX;
69 # endif /* !defined(OPENSSL_NO_DEPRECATED_3_0) */
70 # ifndef OPENSSL_NO_DEPRECATED_3_0
71 OSSL_DEPRECATEDIN_3_0 int SHA224_Init(SHA256_CTX *c);
72 OSSL_DEPRECATEDIN_3_0 int SHA224_Update(SHA256_CTX *c,
73                                         const void *data, size_t len);
74 OSSL_DEPRECATEDIN_3_0 int SHA224_Final(unsigned char *md, SHA256_CTX *c);
75 OSSL_DEPRECATEDIN_3_0 unsigned char *SHA224(const unsigned char *d, size_t n,
76                                             unsigned char *md);
77 OSSL_DEPRECATEDIN_3_0 int SHA256_Init(SHA256_CTX *c);
78 OSSL_DEPRECATEDIN_3_0 int SHA256_Update(SHA256_CTX *c,
79                                         const void *data, size_t len);
80 OSSL_DEPRECATEDIN_3_0 int SHA256_Final(unsigned char *md, SHA256_CTX *c);
81 OSSL_DEPRECATEDIN_3_0 unsigned char *SHA256(const unsigned char *d, size_t n,
82                                             unsigned char *md);
83 OSSL_DEPRECATEDIN_3_0 void SHA256_Transform(SHA256_CTX *c,
84                                             const unsigned char *data);
85 # endif
86
87 # define SHA224_DIGEST_LENGTH    28
88 # define SHA256_DIGEST_LENGTH    32
89 # define SHA384_DIGEST_LENGTH    48
90 # define SHA512_DIGEST_LENGTH    64
91
92 # ifndef OPENSSL_NO_DEPRECATED_3_0
93 /*
94  * Unlike 32-bit digest algorithms, SHA-512 *relies* on SHA_LONG64
95  * being exactly 64-bit wide. See Implementation Notes in sha512.c
96  * for further details.
97  */
98 /*
99  * SHA-512 treats input data as a
100  * contiguous array of 64 bit
101  * wide big-endian values.
102  */
103 #  define SHA512_CBLOCK   (SHA_LBLOCK*8)
104 #  if (defined(_WIN32) || defined(_WIN64)) && !defined(__MINGW32__)
105 #   define SHA_LONG64 unsigned __int64
106 #  elif defined(__arch64__)
107 #   define SHA_LONG64 unsigned long
108 #  else
109 #   define SHA_LONG64 unsigned long long
110 #  endif
111
112 typedef struct SHA512state_st {
113     SHA_LONG64 h[8];
114     SHA_LONG64 Nl, Nh;
115     union {
116         SHA_LONG64 d[SHA_LBLOCK];
117         unsigned char p[SHA512_CBLOCK];
118     } u;
119     unsigned int num, md_len;
120 } SHA512_CTX;
121 # endif /* !defined(OPENSSL_NO_DEPRECATED_3_0) */
122 # ifndef OPENSSL_NO_DEPRECATED_3_0
123 OSSL_DEPRECATEDIN_3_0 int SHA384_Init(SHA512_CTX *c);
124 OSSL_DEPRECATEDIN_3_0 int SHA384_Update(SHA512_CTX *c,
125                                         const void *data, size_t len);
126 OSSL_DEPRECATEDIN_3_0 int SHA384_Final(unsigned char *md, SHA512_CTX *c);
127 OSSL_DEPRECATEDIN_3_0 unsigned char *SHA384(const unsigned char *d, size_t n,
128                                             unsigned char *md);
129 OSSL_DEPRECATEDIN_3_0 int SHA512_Init(SHA512_CTX *c);
130 OSSL_DEPRECATEDIN_3_0 int SHA512_Update(SHA512_CTX *c,
131                                         const void *data, size_t len);
132 OSSL_DEPRECATEDIN_3_0 int SHA512_Final(unsigned char *md, SHA512_CTX *c);
133 OSSL_DEPRECATEDIN_3_0 unsigned char *SHA512(const unsigned char *d, size_t n,
134                                             unsigned char *md);
135 OSSL_DEPRECATEDIN_3_0 void SHA512_Transform(SHA512_CTX *c,
136                                             const unsigned char *data);
137 # endif
138
139 # ifdef  __cplusplus
140 }
141 # endif
142
143 #endif