sph_sha2.h File Reference

SHA-224, SHA-256, SHA-384 and SHA-512 interface. More...

#include <stddef.h>
#include "sph_types.h"

Include dependency graph for sph_sha2.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sph_sha224_context
	This structure is a context for SHA-224 computations: it contains the intermediate values and some data from the last entered block. More...

Macros
#define	SPH_SIZE_sha224   224
	Output size (in bits) for SHA-224. More...
#define	SPH_SIZE_sha256   256
	Output size (in bits) for SHA-256. More...
#define	sph_sha256   sph_sha224
#define	sph_sha256_comp   sph_sha224_comp

Typedefs
typedef sph_sha224_context	sph_sha256_context
	This structure is a context for SHA-256 computations. More...

Functions
void	sph_sha224_init (void *cc)
	Initialize a SHA-224 context. More...
void	sph_sha224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_sha224_close (void *cc, void *dst)
	Terminate the current SHA-224 computation and output the result into the provided buffer. More...
void	sph_sha224_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
	Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (28 bytes). More...
void	sph_sha224_comp (const sph_u32 msg[16], sph_u32 val[8])
	Apply the SHA-224 compression function on the provided data. More...
void	sph_sha256_init (void *cc)
	Initialize a SHA-256 context. More...
void	sph_sha256_close (void *cc, void *dst)
	Terminate the current SHA-256 computation and output the result into the provided buffer. More...
void	sph_sha256_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
	Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (32 bytes). More...

Detailed Description

SHA-224, SHA-256, SHA-384 and SHA-512 interface.

SHA-256 has been published in FIPS 180-2, now amended with a change notice to include SHA-224 as well (which is a simple variation on SHA-256). SHA-384 and SHA-512 are also defined in FIPS 180-2. FIPS standards can be found at: http://csrc.nist.gov/publications/fips/

==========================(LICENSE BEGIN)============================

Copyright (c) 2007-2010 Projet RNRT SAPHIR

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

===========================(LICENSE END)=============================

Author

Thomas Pornin thoma.nosp@m.s.po.nosp@m.rnin@.nosp@m.cryp.nosp@m.tolog.nosp@m..com

Definition in file sph_sha2.h.

Macro Definition Documentation

sph_sha256

#define sph_sha256   sph_sha224

Definition at line 168 of file sph_sha2.h.

sph_sha256_comp

#define sph_sha256_comp   sph_sha224_comp

Definition at line 209 of file sph_sha2.h.

SPH_SIZE_sha224

#define SPH_SIZE_sha224   224

Output size (in bits) for SHA-224.

Definition at line 53 of file sph_sha2.h.

SPH_SIZE_sha256

#define SPH_SIZE_sha256   256

Output size (in bits) for SHA-256.

Definition at line 58 of file sph_sha2.h.

Typedef Documentation

sph_sha256_context

typedef sph_sha224_context sph_sha256_context

This structure is a context for SHA-256 computations.

It is identical to the SHA-224 context. However, a context is initialized for SHA-224 or SHA-256, but not both (the internal IV is not the same).

Definition at line 88 of file sph_sha2.h.

Function Documentation

sph_sha224()

void sph_sha224	(	void *	cc,
		const void *	data,
		size_t	len
	)

Process some data bytes.

It is acceptable that len is zero (in which case this function does nothing).

Parameters

cc	the SHA-224 context
data	the input data
len	the input data length (in bytes)

sph_sha224_addbits_and_close()

void sph_sha224_addbits_and_close	(	void *	cc,
		unsigned	ub,
		unsigned	n,
		void *	dst
	)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (28 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters

cc	the SHA-224 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 668 of file sph_sha2.c.

sph_sha224_close()

void sph_sha224_close	(	void *	cc,
		void *	dst
	)

Terminate the current SHA-224 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (28 bytes). The context is automatically reinitialized.

Parameters

cc	the SHA-224 context
dst	the destination buffer

Definition at line 660 of file sph_sha2.c.

sph_sha224_comp()

void sph_sha224_comp	(	const sph_u32	msg[16],
		sph_u32	val[8]
	)

Apply the SHA-224 compression function on the provided data.

The msg parameter contains the 16 32-bit input blocks, as numerical values (hence after the big-endian decoding). The val parameter contains the 8 32-bit input blocks for the compression function; the output is written in place in this array.

Parameters

msg	the message block (16 values)
val	the function 256-bit input and output

Definition at line 692 of file sph_sha2.c.

sph_sha224_init()

void sph_sha224_init

(

void *

cc

)

Initialize a SHA-224 context.

This process performs no memory allocation.

Parameters

cc	the SHA-224 context (pointer to a sph_sha224_context)

Definition at line 625 of file sph_sha2.c.

Here is the call graph for this function:

sph_sha256_addbits_and_close()

void sph_sha256_addbits_and_close	(	void *	cc,
		unsigned	ub,
		unsigned	n,
		void *	dst
	)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (32 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters

cc	the SHA-256 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 684 of file sph_sha2.c.

sph_sha256_close()

void sph_sha256_close	(	void *	cc,
		void *	dst
	)

Terminate the current SHA-256 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (32 bytes). The context is automatically reinitialized.

Parameters

cc	the SHA-256 context
dst	the destination buffer

Definition at line 676 of file sph_sha2.c.

sph_sha256_init()

void sph_sha256_init

(

void *

cc

)

Initialize a SHA-256 context.

This process performs no memory allocation.

Parameters

cc	the SHA-256 context (pointer to a sph_sha256_context)

Definition at line 640 of file sph_sha2.c.

Here is the call graph for this function: