Header for SHA-256 implementation.
[kopensolaris-gnu/glibc.git] / crypt / sha256.h
1 /* Declaration of functions and data types used for SHA256 sum computing
2    library functions.
3    Copyright (C) 2007 Free Software Foundation, Inc.
4    This file is part of the GNU C Library.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 #ifndef _SHA256_H
22 #define _SHA256_H 1
23
24 #include <limits.h>
25 #include <stdint.h>
26 #include <stdio.h>
27
28
29 /* Structure to save state of computation between the single steps.  */
30 struct sha256_ctx
31 {
32   uint32_t H[8];
33
34   uint32_t total[2];
35   uint32_t buflen;
36   char buffer[128] __attribute__ ((__aligned__ (__alignof__ (uint32_t))));
37 };
38
39 /* Initialize structure containing state of computation.
40    (FIPS 180-2: 5.3.2)  */
41 extern void __sha256_init_ctx (struct sha256_ctx *ctx) __THROW;
42
43 /* Starting with the result of former calls of this function (or the
44    initialization function update the context for the next LEN bytes
45    starting at BUFFER.
46    It is NOT required that LEN is a multiple of 64.  */
47 extern void __sha256_process_bytes (const void *buffer, size_t len,
48                                     struct sha256_ctx *ctx) __THROW;
49
50 /* Process the remaining bytes in the buffer and put result from CTX
51    in first 32 bytes following RESBUF.
52
53    IMPORTANT: On some systems it is required that RESBUF is correctly
54    aligned for a 32 bits value.  */
55 extern void *__sha256_finish_ctx (struct sha256_ctx *ctx, void *resbuf)
56   __THROW;
57
58 #endif /* sha256.h */