xref: /dragonfly/sys/crypto/sha2/sha2.h (revision 86d7f5d3)
1 /*	$FreeBSD: src/sys/crypto/sha2/sha2.h,v 1.2 2002/03/20 05:13:51 alfred Exp $	*/
2 /*	$KAME: sha2.h,v 1.3 2001/03/12 08:27:48 itojun Exp $	*/
3 
4 /*
5  * sha2.h
6  *
7  * Version 1.0.0beta1
8  *
9  * Written by Aaron D. Gifford <me@aarongifford.com>
10  *
11  * Copyright 2000 Aaron D. Gifford.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the copyright holder nor the names of contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTOR(S) ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTOR(S) BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  */
38 
39 #ifndef __SHA2_H__
40 #define __SHA2_H__
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 /*** SHA-256/384/512 Various Length Definitions ***********************/
48 #define SHA256_BLOCK_LENGTH		64
49 #define SHA256_DIGEST_LENGTH		32
50 #define SHA256_DIGEST_STRING_LENGTH	(SHA256_DIGEST_LENGTH * 2 + 1)
51 #define SHA384_BLOCK_LENGTH		128
52 #define SHA384_DIGEST_LENGTH		48
53 #define SHA384_DIGEST_STRING_LENGTH	(SHA384_DIGEST_LENGTH * 2 + 1)
54 #define SHA512_BLOCK_LENGTH		128
55 #define SHA512_DIGEST_LENGTH		64
56 #define SHA512_DIGEST_STRING_LENGTH	(SHA512_DIGEST_LENGTH * 2 + 1)
57 
58 
59 /*** SHA-256/384/512 Context Structures *******************************/
60 /* NOTE: If your architecture does not define either u_intXX_t types or
61  * uintXX_t (from inttypes.h), you may need to define things by hand
62  * for your system:
63  */
64 #if 0
65 typedef unsigned char u_int8_t;		/* 1-byte  (8-bits)  */
66 typedef unsigned int u_int32_t;		/* 4-bytes (32-bits) */
67 typedef unsigned long long u_int64_t;	/* 8-bytes (64-bits) */
68 #endif
69 /*
70  * Most BSD systems already define u_intXX_t types, as does Linux.
71  * Some systems, however, like Compaq's Tru64 Unix instead can use
72  * uintXX_t types defined by very recent ANSI C standards and included
73  * in the file:
74  *
75  *   #include <inttypes.h>
76  *
77  * If you choose to use <inttypes.h> then please define:
78  *
79  *   #define SHA2_USE_INTTYPES_H
80  *
81  * Or on the command line during compile:
82  *
83  *   cc -DSHA2_USE_INTTYPES_H ...
84  */
85 #if 0 /*def SHA2_USE_INTTYPES_H*/
86 
87 typedef struct _SHA256_CTX {
88 	uint32_t	state[8];
89 	uint64_t	bitcount;
90 	uint8_t	buffer[SHA256_BLOCK_LENGTH];
91 } SHA256_CTX;
92 typedef struct _SHA512_CTX {
93 	uint64_t	state[8];
94 	uint64_t	bitcount[2];
95 	uint8_t	buffer[SHA512_BLOCK_LENGTH];
96 } SHA512_CTX;
97 
98 #else /* SHA2_USE_INTTYPES_H */
99 
100 typedef struct _SHA256_CTX {
101 	u_int32_t	state[8];
102 	u_int64_t	bitcount;
103 	u_int8_t	buffer[SHA256_BLOCK_LENGTH];
104 } SHA256_CTX;
105 typedef struct _SHA512_CTX {
106 	u_int64_t	state[8];
107 	u_int64_t	bitcount[2];
108 	u_int8_t	buffer[SHA512_BLOCK_LENGTH];
109 } SHA512_CTX;
110 
111 #endif /* SHA2_USE_INTTYPES_H */
112 
113 typedef SHA512_CTX SHA384_CTX;
114 
115 
116 /*** SHA-256/384/512 Function Prototypes ******************************/
117 
118 void SHA256_Init(SHA256_CTX *);
119 void SHA256_Update(SHA256_CTX*, const u_int8_t*, size_t);
120 void SHA256_Final(u_int8_t[SHA256_DIGEST_LENGTH], SHA256_CTX*);
121 char* SHA256_End(SHA256_CTX*, char[SHA256_DIGEST_STRING_LENGTH]);
122 char* SHA256_Data(const u_int8_t*, size_t, char[SHA256_DIGEST_STRING_LENGTH]);
123 
124 void SHA384_Init(SHA384_CTX*);
125 void SHA384_Update(SHA384_CTX*, const u_int8_t*, size_t);
126 void SHA384_Final(u_int8_t[SHA384_DIGEST_LENGTH], SHA384_CTX*);
127 char* SHA384_End(SHA384_CTX*, char[SHA384_DIGEST_STRING_LENGTH]);
128 char* SHA384_Data(const u_int8_t*, size_t, char[SHA384_DIGEST_STRING_LENGTH]);
129 
130 void SHA512_Init(SHA512_CTX*);
131 void SHA512_Update(SHA512_CTX*, const u_int8_t*, size_t);
132 void SHA512_Final(u_int8_t[SHA512_DIGEST_LENGTH], SHA512_CTX*);
133 char* SHA512_End(SHA512_CTX*, char[SHA512_DIGEST_STRING_LENGTH]);
134 char* SHA512_Data(const u_int8_t*, size_t, char[SHA512_DIGEST_STRING_LENGTH]);
135 
136 #ifdef	__cplusplus
137 }
138 #endif /* __cplusplus */
139 
140 #endif /* __SHA2_H__ */
141 
142