Annotation of src/include/sha2.h, Revision 1.10
1.10 ! tedu 1: /* $OpenBSD: sha2.h,v 1.9 2013/04/15 15:54:17 millert Exp $ */
1.1 millert 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 ***********************/
1.9 millert 42: #define SHA224_BLOCK_LENGTH 64
43: #define SHA224_DIGEST_LENGTH 28
44: #define SHA224_DIGEST_STRING_LENGTH (SHA224_DIGEST_LENGTH * 2 + 1)
1.1 millert 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)
1.10 ! tedu 54: #define SHA512_256_BLOCK_LENGTH 128
! 55: #define SHA512_256_DIGEST_LENGTH 32
! 56: #define SHA512_256_DIGEST_STRING_LENGTH (SHA512_256_DIGEST_LENGTH * 2 + 1)
1.1 millert 57:
58:
1.9 millert 59: /*** SHA-224/256/384/512 Context Structure *******************************/
1.7 djm 60: typedef struct _SHA2_CTX {
61: union {
62: u_int32_t st32[8];
63: u_int64_t st64[8];
64: } state;
1.1 millert 65: u_int64_t bitcount[2];
66: u_int8_t buffer[SHA512_BLOCK_LENGTH];
1.7 djm 67: } SHA2_CTX;
1.1 millert 68:
69: __BEGIN_DECLS
1.9 millert 70: void SHA224Init(SHA2_CTX *);
71: void SHA224Transform(u_int32_t state[8], const u_int8_t [SHA224_BLOCK_LENGTH]);
72: void SHA224Update(SHA2_CTX *, const u_int8_t *, size_t)
73: __attribute__((__bounded__(__string__,2,3)));
74: void SHA224Pad(SHA2_CTX *);
75: void SHA224Final(u_int8_t [SHA224_DIGEST_LENGTH], SHA2_CTX *)
76: __attribute__((__bounded__(__minbytes__,1,SHA224_DIGEST_LENGTH)));
77: char *SHA224End(SHA2_CTX *, char *)
78: __attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
79: char *SHA224File(const char *, char *)
80: __attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
81: char *SHA224FileChunk(const char *, char *, off_t, off_t)
82: __attribute__((__bounded__(__minbytes__,2,SHA224_DIGEST_STRING_LENGTH)));
83: char *SHA224Data(const u_int8_t *, size_t, char *)
84: __attribute__((__bounded__(__string__,1,2)))
85: __attribute__((__bounded__(__minbytes__,3,SHA224_DIGEST_STRING_LENGTH)));
86:
1.7 djm 87: void SHA256Init(SHA2_CTX *);
88: void SHA256Transform(u_int32_t state[8], const u_int8_t [SHA256_BLOCK_LENGTH]);
89: void SHA256Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 90: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 91: void SHA256Pad(SHA2_CTX *);
92: void SHA256Final(u_int8_t [SHA256_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 93: __attribute__((__bounded__(__minbytes__,1,SHA256_DIGEST_LENGTH)));
1.7 djm 94: char *SHA256End(SHA2_CTX *, char *)
1.2 millert 95: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 96: char *SHA256File(const char *, char *)
1.2 millert 97: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 98: char *SHA256FileChunk(const char *, char *, off_t, off_t)
1.4 millert 99: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 100: char *SHA256Data(const u_int8_t *, size_t, char *)
1.2 millert 101: __attribute__((__bounded__(__string__,1,2)))
102: __attribute__((__bounded__(__minbytes__,3,SHA256_DIGEST_STRING_LENGTH)));
1.1 millert 103:
1.7 djm 104: void SHA384Init(SHA2_CTX *);
105: void SHA384Transform(u_int64_t state[8], const u_int8_t [SHA384_BLOCK_LENGTH]);
106: void SHA384Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 107: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 108: void SHA384Pad(SHA2_CTX *);
109: void SHA384Final(u_int8_t [SHA384_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 110: __attribute__((__bounded__(__minbytes__,1,SHA384_DIGEST_LENGTH)));
1.7 djm 111: char *SHA384End(SHA2_CTX *, char *)
1.2 millert 112: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 113: char *SHA384File(const char *, char *)
1.2 millert 114: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 115: char *SHA384FileChunk(const char *, char *, off_t, off_t)
1.4 millert 116: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 117: char *SHA384Data(const u_int8_t *, size_t, char *)
1.2 millert 118: __attribute__((__bounded__(__string__,1,2)))
119: __attribute__((__bounded__(__minbytes__,3,SHA384_DIGEST_STRING_LENGTH)));
1.1 millert 120:
1.7 djm 121: void SHA512Init(SHA2_CTX *);
122: void SHA512Transform(u_int64_t state[8], const u_int8_t [SHA512_BLOCK_LENGTH]);
123: void SHA512Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 124: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 125: void SHA512Pad(SHA2_CTX *);
126: void SHA512Final(u_int8_t [SHA512_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 127: __attribute__((__bounded__(__minbytes__,1,SHA512_DIGEST_LENGTH)));
1.7 djm 128: char *SHA512End(SHA2_CTX *, char *)
1.2 millert 129: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 130: char *SHA512File(const char *, char *)
1.4 millert 131: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 132: char *SHA512FileChunk(const char *, char *, off_t, off_t)
1.2 millert 133: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 134: char *SHA512Data(const u_int8_t *, size_t, char *)
1.2 millert 135: __attribute__((__bounded__(__string__,1,2)))
136: __attribute__((__bounded__(__minbytes__,3,SHA512_DIGEST_STRING_LENGTH)));
1.10 ! tedu 137:
! 138: void SHA512_256Init(SHA2_CTX *);
! 139: void SHA512_256Transform(u_int64_t state[8], const u_int8_t [SHA512_256_BLOCK_LENGTH]);
! 140: void SHA512_256Update(SHA2_CTX *, const u_int8_t *, size_t)
! 141: __attribute__((__bounded__(__string__,2,3)));
! 142: void SHA512_256Pad(SHA2_CTX *);
! 143: void SHA512_256Final(u_int8_t [SHA512_256_DIGEST_LENGTH], SHA2_CTX *)
! 144: __attribute__((__bounded__(__minbytes__,1,SHA512_256_DIGEST_LENGTH)));
! 145: char *SHA512_256End(SHA2_CTX *, char *)
! 146: __attribute__((__bounded__(__minbytes__,2,SHA512_256_DIGEST_STRING_LENGTH)));
! 147: char *SHA512_256File(const char *, char *)
! 148: __attribute__((__bounded__(__minbytes__,2,SHA512_256_DIGEST_STRING_LENGTH)));
! 149: char *SHA512_256FileChunk(const char *, char *, off_t, off_t)
! 150: __attribute__((__bounded__(__minbytes__,2,SHA512_256_DIGEST_STRING_LENGTH)));
! 151: char *SHA512_256Data(const u_int8_t *, size_t, char *)
! 152: __attribute__((__bounded__(__string__,1,2)))
! 153: __attribute__((__bounded__(__minbytes__,3,SHA512_256_DIGEST_STRING_LENGTH)));
1.1 millert 154: __END_DECLS
155:
156: #endif /* _SHA2_H */