Remove no-longer-relevant comment.
[platform/upstream/coreutils.git] / lib / sha512.h
1 /* Declarations of functions and data types used for SHA512 and SHA384 sum
2    library functions.
3    Copyright (C) 2005 Free Software Foundation, Inc.
4
5    This program is free software; you can redistribute it and/or modify it
6    under the terms of the GNU General Public License as published by the
7    Free Software Foundation; either version 2, or (at your option) any
8    later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software Foundation,
17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
18
19 #ifndef SHA512_H
20 # define SHA512_H 1
21
22 # include <stdio.h>
23
24 # if HAVE_INTTYPES_H
25 #  include <inttypes.h>
26 # endif
27 # if HAVE_STDINT_H || _LIBC
28 #  include <stdint.h>
29 # endif
30
31 typedef uint64_t sha512_uint64;
32
33
34 /* Structure to save state of computation between the single steps.  */
35 struct sha512_ctx
36 {
37   sha512_uint64 state[8];
38
39   sha512_uint64 total[2];
40   sha512_uint64 buflen;
41   char buffer[256];
42 };
43
44
45 /* Initialize structure containing state of computation. */
46 extern void sha512_init_ctx (struct sha512_ctx *ctx);
47 extern void sha384_init_ctx (struct sha512_ctx *ctx);
48
49 /* Starting with the result of former calls of this function (or the
50    initialization function update the context for the next LEN bytes
51    starting at BUFFER.
52    It is necessary that LEN is a multiple of 128!!! */
53 extern void sha512_process_block (const void *buffer, size_t len,
54                                   struct sha512_ctx *ctx);
55
56 /* Starting with the result of former calls of this function (or the
57    initialization function update the context for the next LEN bytes
58    starting at BUFFER.
59    It is NOT required that LEN is a multiple of 128.  */
60 extern void sha512_process_bytes (const void *buffer, size_t len,
61                                   struct sha512_ctx *ctx);
62
63 /* Process the remaining bytes in the buffer and put result from CTX
64    in first 64 (48) bytes following RESBUF.  The result is always in little
65    endian byte order, so that a byte-wise output yields to the wanted
66    ASCII representation of the message digest.
67
68    IMPORTANT: On some systems it is required that RESBUF be correctly
69    aligned for a 64 bits value.  */
70 extern void *sha512_finish_ctx (struct sha512_ctx *ctx, void *resbuf);
71 extern void *sha384_finish_ctx (struct sha512_ctx *ctx, void *resbuf);
72
73
74 /* Put result from CTX in first 64 (48) bytes following RESBUF.  The result is
75    always in little endian byte order, so that a byte-wise output yields
76    to the wanted ASCII representation of the message digest.
77
78    IMPORTANT: On some systems it is required that RESBUF is correctly
79    aligned for a 32 bits value.  */
80 extern void *sha512_read_ctx (const struct sha512_ctx *ctx, void *resbuf);
81 extern void *sha384_read_ctx (const struct sha512_ctx *ctx, void *resbuf);
82
83
84 /* Compute SHA512 (SHA384) message digest for bytes read from STREAM.  The
85    resulting message digest number will be written into the 64 (48) bytes
86    beginning at RESBLOCK.  */
87 extern int sha512_stream (FILE *stream, void *resblock);
88 extern int sha384_stream (FILE *stream, void *resblock);
89
90 /* Compute SHA512 (SHA384) message digest for LEN bytes beginning at BUFFER.  The
91    result is always in little endian byte order, so that a byte-wise
92    output yields to the wanted ASCII representation of the message
93    digest.  */
94 extern void *sha512_buffer (const char *buffer, size_t len, void *resblock);
95 extern void *sha384_buffer (const char *buffer, size_t len, void *resblock);
96
97 # define rol64(x,n) ( ((x) << (n)) | ((x) >> (64-(n))) )
98
99 #endif