xref: /openbsd-src/include/sha2.h (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1 /*	$OpenBSD: sha2.h,v 1.9 2013/04/15 15:54:17 millert Exp $	*/
2 
3 /*
4  * FILE:	sha2.h
5  * AUTHOR:	Aaron D. Gifford <me@aarongifford.com>
6  *
7  * Copyright (c) 2000-2001, Aaron D. Gifford
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the copyright holder nor the names of contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTOR(S) ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTOR(S) BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $From: sha2.h,v 1.1 2001/11/08 00:02:01 adg Exp adg $
35  */
36 
37 #ifndef _SHA2_H
38 #define _SHA2_H
39 
40 
41 /*** SHA-256/384/512 Various Length Definitions ***********************/
42 #define SHA224_BLOCK_LENGTH		64
43 #define SHA224_DIGEST_LENGTH		28
44 #define SHA224_DIGEST_STRING_LENGTH	(SHA224_DIGEST_LENGTH * 2 + 1)
45 #define SHA256_BLOCK_LENGTH		64
46 #define SHA256_DIGEST_LENGTH		32
47 #define SHA256_DIGEST_STRING_LENGTH	(SHA256_DIGEST_LENGTH * 2 + 1)
48 #define SHA384_BLOCK_LENGTH		128
49 #define SHA384_DIGEST_LENGTH		48
50 #define SHA384_DIGEST_STRING_LENGTH	(SHA384_DIGEST_LENGTH * 2 + 1)
51 #define SHA512_BLOCK_LENGTH		128
52 #define SHA512_DIGEST_LENGTH		64
53 #define SHA512_DIGEST_STRING_LENGTH	(SHA512_DIGEST_LENGTH * 2 + 1)
54 
55 
56 /*** SHA-224/256/384/512 Context Structure *******************************/
57 typedef struct _SHA2_CTX {
58 	union {
59 		u_int32_t	st32[8];
60 		u_int64_t	st64[8];
61 	} state;
62 	u_int64_t	bitcount[2];
63 	u_int8_t	buffer[SHA512_BLOCK_LENGTH];
64 } SHA2_CTX;
65 
66 __BEGIN_DECLS
67 void SHA224Init(SHA2_CTX *);
68 void SHA224Transform(u_int32_t state[8], const u_int8_t [SHA224_BLOCK_LENGTH]);
69 void SHA224Update(SHA2_CTX *, const u_int8_t *, size_t)
70 	__attribute__((__bounded__(__string__,2,3)));
71 void SHA224Pad(SHA2_CTX *);
72 void SHA224Final(u_int8_t [SHA224_DIGEST_LENGTH], SHA2_CTX *)
73 	__attribute__((__bounded__(__minbytes__,1,SHA224_DIGEST_LENGTH)));
74 char *SHA224End(SHA2_CTX *, char *)
75 	__attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
76 char *SHA224File(const char *, char *)
77 	__attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
78 char *SHA224FileChunk(const char *, char *, off_t, off_t)
79 	__attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
80 char *SHA224Data(const u_int8_t *, size_t, char *)
81 	__attribute__((__bounded__(__string__,1,2)))
82 	__attribute__((__bounded__(__minbytes__,3,SHA224_DIGEST_STRING_LENGTH)));
83 
84 void SHA256Init(SHA2_CTX *);
85 void SHA256Transform(u_int32_t state[8], const u_int8_t [SHA256_BLOCK_LENGTH]);
86 void SHA256Update(SHA2_CTX *, const u_int8_t *, size_t)
87 	__attribute__((__bounded__(__string__,2,3)));
88 void SHA256Pad(SHA2_CTX *);
89 void SHA256Final(u_int8_t [SHA256_DIGEST_LENGTH], SHA2_CTX *)
90 	__attribute__((__bounded__(__minbytes__,1,SHA256_DIGEST_LENGTH)));
91 char *SHA256End(SHA2_CTX *, char *)
92 	__attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
93 char *SHA256File(const char *, char *)
94 	__attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
95 char *SHA256FileChunk(const char *, char *, off_t, off_t)
96 	__attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
97 char *SHA256Data(const u_int8_t *, size_t, char *)
98 	__attribute__((__bounded__(__string__,1,2)))
99 	__attribute__((__bounded__(__minbytes__,3,SHA256_DIGEST_STRING_LENGTH)));
100 
101 void SHA384Init(SHA2_CTX *);
102 void SHA384Transform(u_int64_t state[8], const u_int8_t [SHA384_BLOCK_LENGTH]);
103 void SHA384Update(SHA2_CTX *, const u_int8_t *, size_t)
104 	__attribute__((__bounded__(__string__,2,3)));
105 void SHA384Pad(SHA2_CTX *);
106 void SHA384Final(u_int8_t [SHA384_DIGEST_LENGTH], SHA2_CTX *)
107 	__attribute__((__bounded__(__minbytes__,1,SHA384_DIGEST_LENGTH)));
108 char *SHA384End(SHA2_CTX *, char *)
109 	__attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
110 char *SHA384File(const char *, char *)
111 	__attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
112 char *SHA384FileChunk(const char *, char *, off_t, off_t)
113 	__attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
114 char *SHA384Data(const u_int8_t *, size_t, char *)
115 	__attribute__((__bounded__(__string__,1,2)))
116 	__attribute__((__bounded__(__minbytes__,3,SHA384_DIGEST_STRING_LENGTH)));
117 
118 void SHA512Init(SHA2_CTX *);
119 void SHA512Transform(u_int64_t state[8], const u_int8_t [SHA512_BLOCK_LENGTH]);
120 void SHA512Update(SHA2_CTX *, const u_int8_t *, size_t)
121 	__attribute__((__bounded__(__string__,2,3)));
122 void SHA512Pad(SHA2_CTX *);
123 void SHA512Final(u_int8_t [SHA512_DIGEST_LENGTH], SHA2_CTX *)
124 	__attribute__((__bounded__(__minbytes__,1,SHA512_DIGEST_LENGTH)));
125 char *SHA512End(SHA2_CTX *, char *)
126 	__attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
127 char *SHA512File(const char *, char *)
128 	__attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
129 char *SHA512FileChunk(const char *, char *, off_t, off_t)
130 	__attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
131 char *SHA512Data(const u_int8_t *, size_t, char *)
132 	__attribute__((__bounded__(__string__,1,2)))
133 	__attribute__((__bounded__(__minbytes__,3,SHA512_DIGEST_STRING_LENGTH)));
134 __END_DECLS
135 
136 #endif /* _SHA2_H */
137