sph_echo.h File Reference

ECHO interface. More...

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

Include dependency graph for sph_echo.h:

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

Go to the source code of this file.

Classes
struct	sph_echo_small_context
	This structure is a context for ECHO computations: it contains the intermediate values and some data from the last entered block. More...
struct	sph_echo_big_context
	This structure is a context for ECHO computations: it contains the intermediate values and some data from the last entered block. More...

Macros
#define	SPH_SIZE_echo224   224
	Output size (in bits) for ECHO-224. More...
#define	SPH_SIZE_echo256   256
	Output size (in bits) for ECHO-256. More...
#define	SPH_SIZE_echo384   384
	Output size (in bits) for ECHO-384. More...
#define	SPH_SIZE_echo512   512
	Output size (in bits) for ECHO-512. More...

Typedefs
typedef sph_echo_small_context	sph_echo224_context
	Type for a ECHO-224 context (identical to the common "small" context). More...
typedef sph_echo_small_context	sph_echo256_context
	Type for a ECHO-256 context (identical to the common "small" context). More...
typedef sph_echo_big_context	sph_echo384_context
	Type for a ECHO-384 context (identical to the common "big" context). More...
typedef sph_echo_big_context	sph_echo512_context
	Type for a ECHO-512 context (identical to the common "big" context). More...

Functions
void	sph_echo224_init (void *cc)
	Initialize an ECHO-224 context. More...
void	sph_echo224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_echo224_close (void *cc, void *dst)
	Terminate the current ECHO-224 computation and output the result into the provided buffer. More...
void	sph_echo224_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_echo256_init (void *cc)
	Initialize an ECHO-256 context. More...
void	sph_echo256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_echo256_close (void *cc, void *dst)
	Terminate the current ECHO-256 computation and output the result into the provided buffer. More...
void	sph_echo256_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_echo384_init (void *cc)
	Initialize an ECHO-384 context. More...
void	sph_echo384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_echo384_close (void *cc, void *dst)
	Terminate the current ECHO-384 computation and output the result into the provided buffer. More...
void	sph_echo384_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_echo512_init (void *cc)
	Initialize an ECHO-512 context. More...
void	sph_echo512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_echo512_close (void *cc, void *dst)
	Terminate the current ECHO-512 computation and output the result into the provided buffer. More...
void	sph_echo512_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

ECHO interface.

ECHO is a family of functions which differ by their output size; this implementation defines ECHO for output sizes 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_echo.h.

Macro Definition Documentation

SPH_SIZE_echo224

#define SPH_SIZE_echo224   224

Output size (in bits) for ECHO-224.

Definition at line 49 of file sph_echo.h.

SPH_SIZE_echo256

#define SPH_SIZE_echo256   256

Output size (in bits) for ECHO-256.

Definition at line 54 of file sph_echo.h.

SPH_SIZE_echo384

#define SPH_SIZE_echo384   384

Output size (in bits) for ECHO-384.

Definition at line 59 of file sph_echo.h.

SPH_SIZE_echo512

#define SPH_SIZE_echo512   512

Output size (in bits) for ECHO-512.

Definition at line 64 of file sph_echo.h.

Typedef Documentation

sph_echo224_context

typedef sph_echo_small_context sph_echo224_context

Type for a ECHO-224 context (identical to the common "small" context).

Definition at line 119 of file sph_echo.h.

sph_echo256_context

typedef sph_echo_small_context sph_echo256_context

Type for a ECHO-256 context (identical to the common "small" context).

Definition at line 124 of file sph_echo.h.

sph_echo384_context

typedef sph_echo_big_context sph_echo384_context

Type for a ECHO-384 context (identical to the common "big" context).

Definition at line 129 of file sph_echo.h.

sph_echo512_context

typedef sph_echo_big_context sph_echo512_context

Type for a ECHO-512 context (identical to the common "big" context).

Definition at line 134 of file sph_echo.h.

Function Documentation

sph_echo224()

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

Definition at line 927 of file echo.c.

References echo_small_core().

sph_echo224_addbits_and_close()

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

Definition at line 941 of file echo.c.

References echo_small_close().

sph_echo224_close()

void sph_echo224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 934 of file echo.c.

References echo_small_close().

sph_echo224_init()

void sph_echo224_init

(

void *

cc

)

Initialize an ECHO-224 context.

This process performs no memory allocation.

Parameters

cc	the ECHO-224 context (pointer to a sph_echo224_context)

Definition at line 920 of file echo.c.

References echo_small_init().

sph_echo256()

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

Definition at line 955 of file echo.c.

References echo_small_core().

sph_echo256_addbits_and_close()

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

Definition at line 969 of file echo.c.

References echo_small_close().

sph_echo256_close()

void sph_echo256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 962 of file echo.c.

References echo_small_close().

sph_echo256_init()

void sph_echo256_init

(

void *

cc

)

Initialize an ECHO-256 context.

This process performs no memory allocation.

Parameters

cc	the ECHO-256 context (pointer to a sph_echo256_context)

Definition at line 948 of file echo.c.

References echo_small_init().

sph_echo384()

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

Definition at line 983 of file echo.c.

References echo_big_core().

sph_echo384_addbits_and_close()

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

Definition at line 997 of file echo.c.

References echo_big_close().

sph_echo384_close()

void sph_echo384_close	(	void *	cc,
		void *	dst
	)

Terminate the current ECHO-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 ECHO-384 context
dst	the destination buffer

Definition at line 990 of file echo.c.

References echo_big_close().

sph_echo384_init()

void sph_echo384_init

(

void *

cc

)

Initialize an ECHO-384 context.

This process performs no memory allocation.

Parameters

cc	the ECHO-384 context (pointer to a sph_echo384_context)

Definition at line 976 of file echo.c.

References echo_big_init().

sph_echo512()

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

Definition at line 1011 of file echo.c.

References echo_big_core().

Referenced by HashX11().

sph_echo512_addbits_and_close()

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

Definition at line 1025 of file echo.c.

References echo_big_close().

sph_echo512_close()

void sph_echo512_close	(	void *	cc,
		void *	dst
	)

Terminate the current ECHO-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 ECHO-512 context
dst	the destination buffer

Definition at line 1018 of file echo.c.

References echo_big_close().

Referenced by HashX11().

sph_echo512_init()

void sph_echo512_init

(

void *

cc

)

Initialize an ECHO-512 context.

This process performs no memory allocation.

Parameters

cc	the ECHO-512 context (pointer to a sph_echo512_context)

Definition at line 1004 of file echo.c.

References echo_big_init().

Referenced by HashX11().