summaryrefslogtreecommitdiff
path: root/beecrypt/sha256.h
blob: 65a1b08c15225b72bdcd51b0ba3f4b21b2262784 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 * Copyright (c) 2000, 2001, 2002 Virtual Unlimited B.V.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

/*!\file sha256.h
 * \brief SHA-256 hash function, headers.
 * \author Bob Deblier <bob.deblier@pandora.be>
 * \ingroup HASH_m HASH_sha256_m
 */

#ifndef _SHA256_H
#define _SHA256_H

#include "beecrypt.h"

/** \ingroup HASH_sha256_m
 */
typedef struct
{
	uint32_t h[8];
	uint32_t data[64];
	#if (MP_WBITS == 64)
	mpw length[1];
	#elif (MP_WBITS == 32)
	mpw length[2];
	#else
	# error
	#endif
	uint32_t offset;
} sha256Param;

#ifdef __cplusplus
extern "C" {
#endif

/** \ingroup HASH_sha256_m
 * Holds the full API description of the SHA-256 algorithm.
 */
/*@observer@*/ /*@checked@*/
extern BEECRYPTAPI const hashFunction sha256;

/*@-exportlocal@*/
/** \ingroup HASH_sha256_m
 * This function performs the SHA-256 hash algorithm on 64 byte blocks of data.
 * @param sp		hash parameter block
 */
BEECRYPTAPI
void sha256Process(sha256Param* sp)
	/*@globals internalState @*/
	/*@modifies sp, internalState @*/;

/** \ingroup HASH_sha256_m
 * This function resets the parameter block so that it's ready for a new hash.
 * @param sp		hash parameter block
 * @return		0 on success
 */
BEECRYPTAPI
int  sha256Reset  (sha256Param* sp)
	/*@modifies sp @*/;

/** \ingroup HASH_sha256_m
 * This function should be used to pass successive blocks of data to be hashed.
 * @param sp		hash parameter block
 * @param *data		bytes to hash
 * @param size		no. of bytes to hash
 * @return		0 on success
 */
BEECRYPTAPI
int  sha256Update (sha256Param* sp, const byte* data, size_t size)
	/*@globals internalState @*/
	/*@modifies sp, internalState @*/;

/** \ingroup HASH_sha256_m
 * This function finishes the current hash computation, returning the digest
 * value in \a digest.
 * @param sp		hash parameter block
 * @retval *digest	32 byte SHA-256 digest
 * @return		0 on success
 */
BEECRYPTAPI
int  sha256Digest (sha256Param* sp, /*@out@*/ byte* digest)
	/*@globals internalState @*/
	/*@modifies sp, digest, internalState @*/;
/*@=exportlocal@*/

#ifdef __cplusplus
}
#endif

#endif