Annotation of src/include/sha2.h, Revision 1.8
1.8 ! deraadt 1: /* $OpenBSD: sha2.h,v 1.7 2008/09/06 12:00:19 djm 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 ***********************/
42: #define SHA256_BLOCK_LENGTH 64
43: #define SHA256_DIGEST_LENGTH 32
44: #define SHA256_DIGEST_STRING_LENGTH (SHA256_DIGEST_LENGTH * 2 + 1)
45: #define SHA384_BLOCK_LENGTH 128
46: #define SHA384_DIGEST_LENGTH 48
47: #define SHA384_DIGEST_STRING_LENGTH (SHA384_DIGEST_LENGTH * 2 + 1)
48: #define SHA512_BLOCK_LENGTH 128
49: #define SHA512_DIGEST_LENGTH 64
50: #define SHA512_DIGEST_STRING_LENGTH (SHA512_DIGEST_LENGTH * 2 + 1)
51:
52:
1.7 djm 53: /*** SHA-256/384/512 Context Structure *******************************/
54: typedef struct _SHA2_CTX {
55: union {
56: u_int32_t st32[8];
57: u_int64_t st64[8];
58: } state;
1.1 millert 59: u_int64_t bitcount[2];
60: u_int8_t buffer[SHA512_BLOCK_LENGTH];
1.7 djm 61: } SHA2_CTX;
1.1 millert 62:
63: __BEGIN_DECLS
1.7 djm 64: void SHA256Init(SHA2_CTX *);
65: void SHA256Transform(u_int32_t state[8], const u_int8_t [SHA256_BLOCK_LENGTH]);
66: void SHA256Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 67: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 68: void SHA256Pad(SHA2_CTX *);
69: void SHA256Final(u_int8_t [SHA256_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 70: __attribute__((__bounded__(__minbytes__,1,SHA256_DIGEST_LENGTH)));
1.7 djm 71: char *SHA256End(SHA2_CTX *, char *)
1.2 millert 72: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 73: char *SHA256File(const char *, char *)
1.2 millert 74: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 75: char *SHA256FileChunk(const char *, char *, off_t, off_t)
1.4 millert 76: __attribute__((__bounded__(__minbytes__,2,SHA256_DIGEST_STRING_LENGTH)));
1.7 djm 77: char *SHA256Data(const u_int8_t *, size_t, char *)
1.2 millert 78: __attribute__((__bounded__(__string__,1,2)))
79: __attribute__((__bounded__(__minbytes__,3,SHA256_DIGEST_STRING_LENGTH)));
1.1 millert 80:
1.7 djm 81: void SHA384Init(SHA2_CTX *);
82: void SHA384Transform(u_int64_t state[8], const u_int8_t [SHA384_BLOCK_LENGTH]);
83: void SHA384Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 84: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 85: void SHA384Pad(SHA2_CTX *);
86: void SHA384Final(u_int8_t [SHA384_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 87: __attribute__((__bounded__(__minbytes__,1,SHA384_DIGEST_LENGTH)));
1.7 djm 88: char *SHA384End(SHA2_CTX *, char *)
1.2 millert 89: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 90: char *SHA384File(const char *, char *)
1.2 millert 91: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 92: char *SHA384FileChunk(const char *, char *, off_t, off_t)
1.4 millert 93: __attribute__((__bounded__(__minbytes__,2,SHA384_DIGEST_STRING_LENGTH)));
1.7 djm 94: char *SHA384Data(const u_int8_t *, size_t, char *)
1.2 millert 95: __attribute__((__bounded__(__string__,1,2)))
96: __attribute__((__bounded__(__minbytes__,3,SHA384_DIGEST_STRING_LENGTH)));
1.1 millert 97:
1.7 djm 98: void SHA512Init(SHA2_CTX *);
99: void SHA512Transform(u_int64_t state[8], const u_int8_t [SHA512_BLOCK_LENGTH]);
100: void SHA512Update(SHA2_CTX *, const u_int8_t *, size_t)
1.2 millert 101: __attribute__((__bounded__(__string__,2,3)));
1.7 djm 102: void SHA512Pad(SHA2_CTX *);
103: void SHA512Final(u_int8_t [SHA512_DIGEST_LENGTH], SHA2_CTX *)
1.2 millert 104: __attribute__((__bounded__(__minbytes__,1,SHA512_DIGEST_LENGTH)));
1.7 djm 105: char *SHA512End(SHA2_CTX *, char *)
1.2 millert 106: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 107: char *SHA512File(const char *, char *)
1.4 millert 108: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 109: char *SHA512FileChunk(const char *, char *, off_t, off_t)
1.2 millert 110: __attribute__((__bounded__(__minbytes__,2,SHA512_DIGEST_STRING_LENGTH)));
1.7 djm 111: char *SHA512Data(const u_int8_t *, size_t, char *)
1.2 millert 112: __attribute__((__bounded__(__string__,1,2)))
113: __attribute__((__bounded__(__minbytes__,3,SHA512_DIGEST_STRING_LENGTH)));
1.1 millert 114: __END_DECLS
115:
116: #endif /* _SHA2_H */