sph_groestl.h File Reference

Groestl interface. More...

#include <stddef.h>
#include <crypto/sph_types.h>

Include dependency graph for sph_groestl.h:

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

Go to the source code of this file.

Classes
struct	sph_groestl_small_context
	This structure is a context for Groestl-224 and Groestl-256 computations: it contains the intermediate values and some data from the last entered block. More...
struct	sph_groestl_big_context
	This structure is a context for Groestl-384 and Groestl-512 computations: it contains the intermediate values and some data from the last entered block. More...

Macros
#define	SPH_SIZE_groestl224   224
	Output size (in bits) for Groestl-224. More...
#define	SPH_SIZE_groestl256   256
	Output size (in bits) for Groestl-256. More...
#define	SPH_SIZE_groestl384   384
	Output size (in bits) for Groestl-384. More...
#define	SPH_SIZE_groestl512   512
	Output size (in bits) for Groestl-512. More...

Typedefs
typedef sph_groestl_small_context	sph_groestl224_context
	This structure is a context for Groestl-224 computations. More...
typedef sph_groestl_small_context	sph_groestl256_context
	This structure is a context for Groestl-256 computations. More...
typedef sph_groestl_big_context	sph_groestl384_context
	This structure is a context for Groestl-384 computations. More...
typedef sph_groestl_big_context	sph_groestl512_context
	This structure is a context for Groestl-512 computations. More...

Functions
void	sph_groestl224_init (void *cc)
	Initialize a Groestl-224 context. More...
void	sph_groestl224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_groestl224_close (void *cc, void *dst)
	Terminate the current Groestl-224 computation and output the result into the provided buffer. More...
void	sph_groestl224_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_groestl256_init (void *cc)
	Initialize a Groestl-256 context. More...
void	sph_groestl256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_groestl256_close (void *cc, void *dst)
	Terminate the current Groestl-256 computation and output the result into the provided buffer. More...
void	sph_groestl256_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...
void	sph_groestl384_init (void *cc)
	Initialize a Groestl-384 context. More...
void	sph_groestl384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_groestl384_close (void *cc, void *dst)
	Terminate the current Groestl-384 computation and output the result into the provided buffer. More...
void	sph_groestl384_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 (48 bytes). More...
void	sph_groestl512_init (void *cc)
	Initialize a Groestl-512 context. More...
void	sph_groestl512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_groestl512_close (void *cc, void *dst)
	Terminate the current Groestl-512 computation and output the result into the provided buffer. More...
void	sph_groestl512_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 (64 bytes). More...

Detailed Description

Groestl interface.

This code implements Groestl with the recommended parameters for SHA-3, with outputs of 224, 256, 384 and 512 bits.

==========================(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_groestl.h.

Macro Definition Documentation

SPH_SIZE_groestl224

#define SPH_SIZE_groestl224   224

Output size (in bits) for Groestl-224.

Definition at line 48 of file sph_groestl.h.

SPH_SIZE_groestl256

#define SPH_SIZE_groestl256   256

Output size (in bits) for Groestl-256.

Definition at line 53 of file sph_groestl.h.

SPH_SIZE_groestl384

#define SPH_SIZE_groestl384   384

Output size (in bits) for Groestl-384.

Definition at line 58 of file sph_groestl.h.

SPH_SIZE_groestl512

#define SPH_SIZE_groestl512   512

Output size (in bits) for Groestl-512.

Definition at line 63 of file sph_groestl.h.

Typedef Documentation

sph_groestl224_context

typedef sph_groestl_small_context sph_groestl224_context

This structure is a context for Groestl-224 computations.

It is identical to the common sph_groestl_small_context.

Definition at line 97 of file sph_groestl.h.

sph_groestl256_context

typedef sph_groestl_small_context sph_groestl256_context

This structure is a context for Groestl-256 computations.

It is identical to the common sph_groestl_small_context.

Definition at line 103 of file sph_groestl.h.

sph_groestl384_context

typedef sph_groestl_big_context sph_groestl384_context

This structure is a context for Groestl-384 computations.

It is identical to the common sph_groestl_small_context.

Definition at line 137 of file sph_groestl.h.

sph_groestl512_context

typedef sph_groestl_big_context sph_groestl512_context

This structure is a context for Groestl-512 computations.

It is identical to the common sph_groestl_small_context.

Definition at line 143 of file sph_groestl.h.

Function Documentation

sph_groestl224()

void sph_groestl224	(	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 Groestl-224 context
data	the input data
len	the input data length (in bytes)

Definition at line 3018 of file groestl.c.

References groestl_small_core().

sph_groestl224_addbits_and_close()

void sph_groestl224_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 Groestl-224 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 3032 of file groestl.c.

References groestl_small_close().

sph_groestl224_close()

void sph_groestl224_close	(	void *	cc,
		void *	dst
	)

Terminate the current Groestl-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 Groestl-224 context
dst	the destination buffer

Definition at line 3025 of file groestl.c.

References groestl_small_close().

sph_groestl224_init()

void sph_groestl224_init

(

void *

cc

)

Initialize a Groestl-224 context.

This process performs no memory allocation.

Parameters

cc	the Groestl-224 context (pointer to a sph_groestl224_context)

Definition at line 3011 of file groestl.c.

References groestl_small_init().

sph_groestl256()

void sph_groestl256	(	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 Groestl-256 context
data	the input data
len	the input data length (in bytes)

Definition at line 3046 of file groestl.c.

References groestl_small_core().

sph_groestl256_addbits_and_close()

void sph_groestl256_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 Groestl-256 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 3060 of file groestl.c.

References groestl_small_close().

sph_groestl256_close()

void sph_groestl256_close	(	void *	cc,
		void *	dst
	)

Terminate the current Groestl-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 Groestl-256 context
dst	the destination buffer

Definition at line 3053 of file groestl.c.

References groestl_small_close().

sph_groestl256_init()

void sph_groestl256_init

(

void *

cc

)

Initialize a Groestl-256 context.

This process performs no memory allocation.

Parameters

cc	the Groestl-256 context (pointer to a sph_groestl256_context)

Definition at line 3039 of file groestl.c.

References groestl_small_init().

sph_groestl384()

void sph_groestl384	(	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 Groestl-384 context
data	the input data
len	the input data length (in bytes)

Definition at line 3074 of file groestl.c.

References groestl_big_core().

sph_groestl384_addbits_and_close()

void sph_groestl384_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 (48 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 Groestl-384 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 3088 of file groestl.c.

References groestl_big_close().

sph_groestl384_close()

void sph_groestl384_close	(	void *	cc,
		void *	dst
	)

Terminate the current Groestl-384 computation and output the result into the provided buffer.

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

Parameters

cc	the Groestl-384 context
dst	the destination buffer

Definition at line 3081 of file groestl.c.

References groestl_big_close().

sph_groestl384_init()

void sph_groestl384_init

(

void *

cc

)

Initialize a Groestl-384 context.

This process performs no memory allocation.

Parameters

cc	the Groestl-384 context (pointer to a sph_groestl384_context)

Definition at line 3067 of file groestl.c.

References groestl_big_init().

sph_groestl512()

void sph_groestl512	(	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 Groestl-512 context
data	the input data
len	the input data length (in bytes)

Definition at line 3102 of file groestl.c.

References groestl_big_core().

Referenced by HashX11().

sph_groestl512_addbits_and_close()

void sph_groestl512_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 (64 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 Groestl-512 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

Definition at line 3116 of file groestl.c.

References groestl_big_close().

sph_groestl512_close()

void sph_groestl512_close	(	void *	cc,
		void *	dst
	)

Terminate the current Groestl-512 computation and output the result into the provided buffer.

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

Parameters

cc	the Groestl-512 context
dst	the destination buffer

Definition at line 3109 of file groestl.c.

References groestl_big_close().

Referenced by HashX11().

sph_groestl512_init()

void sph_groestl512_init

(

void *

cc

)

Initialize a Groestl-512 context.

This process performs no memory allocation.

Parameters

cc	the Groestl-512 context (pointer to a sph_groestl512_context)

Definition at line 3095 of file groestl.c.

References groestl_big_init().

Referenced by HashX11().