sph_keccak.h File Reference

Keccak interface. More...

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

Include dependency graph for sph_keccak.h:

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

Go to the source code of this file.

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

Macros
#define	SPH_SIZE_keccak224   224
	Output size (in bits) for Keccak-224. More...
#define	SPH_SIZE_keccak256   256
	Output size (in bits) for Keccak-256. More...
#define	SPH_SIZE_keccak384   384
	Output size (in bits) for Keccak-384. More...
#define	SPH_SIZE_keccak512   512
	Output size (in bits) for Keccak-512. More...

Typedefs
typedef sph_keccak_context	sph_keccak224_context
	Type for a Keccak-224 context (identical to the common context). More...
typedef sph_keccak_context	sph_keccak256_context
	Type for a Keccak-256 context (identical to the common context). More...
typedef sph_keccak_context	sph_keccak384_context
	Type for a Keccak-384 context (identical to the common context). More...
typedef sph_keccak_context	sph_keccak512_context
	Type for a Keccak-512 context (identical to the common context). More...

Functions
void	sph_keccak224_init (void *cc)
	Initialize a Keccak-224 context. More...
void	sph_keccak224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_keccak224_close (void *cc, void *dst)
	Terminate the current Keccak-224 computation and output the result into the provided buffer. More...
void	sph_keccak224_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_keccak256_init (void *cc)
	Initialize a Keccak-256 context. More...
void	sph_keccak256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_keccak256_close (void *cc, void *dst)
	Terminate the current Keccak-256 computation and output the result into the provided buffer. More...
void	sph_keccak256_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_keccak384_init (void *cc)
	Initialize a Keccak-384 context. More...
void	sph_keccak384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_keccak384_close (void *cc, void *dst)
	Terminate the current Keccak-384 computation and output the result into the provided buffer. More...
void	sph_keccak384_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_keccak512_init (void *cc)
	Initialize a Keccak-512 context. More...
void	sph_keccak512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_keccak512_close (void *cc, void *dst)
	Terminate the current Keccak-512 computation and output the result into the provided buffer. More...
void	sph_keccak512_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

Keccak interface.

This is the interface for Keccak with the recommended parameters for SHA-3, with output lengths 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_keccak.h.

Macro Definition Documentation

SPH_SIZE_keccak224

#define SPH_SIZE_keccak224   224

Output size (in bits) for Keccak-224.

Definition at line 49 of file sph_keccak.h.

SPH_SIZE_keccak256

#define SPH_SIZE_keccak256   256

Output size (in bits) for Keccak-256.

Definition at line 54 of file sph_keccak.h.

SPH_SIZE_keccak384

#define SPH_SIZE_keccak384   384

Output size (in bits) for Keccak-384.

Definition at line 59 of file sph_keccak.h.

SPH_SIZE_keccak512

#define SPH_SIZE_keccak512   512

Output size (in bits) for Keccak-512.

Definition at line 64 of file sph_keccak.h.

Typedef Documentation

sph_keccak224_context

typedef sph_keccak_context sph_keccak224_context

Type for a Keccak-224 context (identical to the common context).

Definition at line 92 of file sph_keccak.h.

sph_keccak256_context

typedef sph_keccak_context sph_keccak256_context

Type for a Keccak-256 context (identical to the common context).

Definition at line 97 of file sph_keccak.h.

sph_keccak384_context

typedef sph_keccak_context sph_keccak384_context

Type for a Keccak-384 context (identical to the common context).

Definition at line 102 of file sph_keccak.h.

sph_keccak512_context

typedef sph_keccak_context sph_keccak512_context

Type for a Keccak-512 context (identical to the common context).

Definition at line 107 of file sph_keccak.h.

Function Documentation

sph_keccak224()

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

Definition at line 1718 of file keccak.c.

References keccak_core().

sph_keccak224_addbits_and_close()

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

Definition at line 1732 of file keccak.c.

Referenced by sph_keccak224_close().

sph_keccak224_close()

void sph_keccak224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1725 of file keccak.c.

References sph_keccak224_addbits_and_close().

sph_keccak224_init()

void sph_keccak224_init

(

void *

cc

)

Initialize a Keccak-224 context.

This process performs no memory allocation.

Parameters

cc	the Keccak-224 context (pointer to a sph_keccak224_context)

Definition at line 1711 of file keccak.c.

References keccak_init().

sph_keccak256()

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

Definition at line 1746 of file keccak.c.

References keccak_core().

sph_keccak256_addbits_and_close()

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

Definition at line 1760 of file keccak.c.

Referenced by sph_keccak256_close().

sph_keccak256_close()

void sph_keccak256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1753 of file keccak.c.

References sph_keccak256_addbits_and_close().

sph_keccak256_init()

void sph_keccak256_init

(

void *

cc

)

Initialize a Keccak-256 context.

This process performs no memory allocation.

Parameters

cc	the Keccak-256 context (pointer to a sph_keccak256_context)

Definition at line 1739 of file keccak.c.

References keccak_init().

sph_keccak384()

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

Definition at line 1774 of file keccak.c.

References keccak_core().

sph_keccak384_addbits_and_close()

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

Definition at line 1788 of file keccak.c.

Referenced by sph_keccak384_close().

sph_keccak384_close()

void sph_keccak384_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1781 of file keccak.c.

References sph_keccak384_addbits_and_close().

sph_keccak384_init()

void sph_keccak384_init

(

void *

cc

)

Initialize a Keccak-384 context.

This process performs no memory allocation.

Parameters

cc	the Keccak-384 context (pointer to a sph_keccak384_context)

Definition at line 1767 of file keccak.c.

References keccak_init().

sph_keccak512()

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

Definition at line 1802 of file keccak.c.

References keccak_core().

Referenced by HashX11().

sph_keccak512_addbits_and_close()

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

Definition at line 1816 of file keccak.c.

Referenced by sph_keccak512_close().

sph_keccak512_close()

void sph_keccak512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1809 of file keccak.c.

References sph_keccak512_addbits_and_close().

Referenced by HashX11().

sph_keccak512_init()

void sph_keccak512_init

(

void *

cc

)

Initialize a Keccak-512 context.

This process performs no memory allocation.

Parameters

cc	the Keccak-512 context (pointer to a sph_keccak512_context)

Definition at line 1795 of file keccak.c.

References keccak_init().

Referenced by HashX11().