Hamsi interface. More...

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

Include dependency graph for sph_hamsi.h:

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

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

struct	sph_hamsi_big_context
	This structure is a context for Hamsi-384 and Hamsi-512 computations: it contains the intermediate values and some data from the last entered block. More...

Macros
#define	SPH_SIZE_hamsi224 224
	Output size (in bits) for Hamsi-224. More...

#define	SPH_SIZE_hamsi256 256
	Output size (in bits) for Hamsi-256. More...

#define	SPH_SIZE_hamsi384 384
	Output size (in bits) for Hamsi-384. More...

#define	SPH_SIZE_hamsi512 512
	Output size (in bits) for Hamsi-512. More...

Typedefs
typedef sph_hamsi_small_context	sph_hamsi224_context
	This structure is a context for Hamsi-224 computations. More...

typedef sph_hamsi_small_context	sph_hamsi256_context
	This structure is a context for Hamsi-256 computations. More...

typedef sph_hamsi_big_context	sph_hamsi384_context
	This structure is a context for Hamsi-384 computations. More...

typedef sph_hamsi_big_context	sph_hamsi512_context
	This structure is a context for Hamsi-512 computations. More...

Functions
void	sph_hamsi224_init (void *cc)
	Initialize a Hamsi-224 context. More...

void	sph_hamsi224 (void cc, const void data, size_t len)
	Process some data bytes. More...

void	sph_hamsi224_close (void cc, void dst)
	Terminate the current Hamsi-224 computation and output the result into the provided buffer. More...

void	sph_hamsi224_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_hamsi256_init (void *cc)
	Initialize a Hamsi-256 context. More...

void	sph_hamsi256 (void cc, const void data, size_t len)
	Process some data bytes. More...

void	sph_hamsi256_close (void cc, void dst)
	Terminate the current Hamsi-256 computation and output the result into the provided buffer. More...

void	sph_hamsi256_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_hamsi384_init (void *cc)
	Initialize a Hamsi-384 context. More...

void	sph_hamsi384 (void cc, const void data, size_t len)
	Process some data bytes. More...

void	sph_hamsi384_close (void cc, void dst)
	Terminate the current Hamsi-384 computation and output the result into the provided buffer. More...

void	sph_hamsi384_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_hamsi512_init (void *cc)
	Initialize a Hamsi-512 context. More...

void	sph_hamsi512 (void cc, const void data, size_t len)
	Process some data bytes. More...

void	sph_hamsi512_close (void cc, void dst)
	Terminate the current Hamsi-512 computation and output the result into the provided buffer. More...

void	sph_hamsi512_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

Hamsi interface.

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

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

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_hamsi.h.

Macro Definition Documentation

◆ SPH_SIZE_hamsi224

#define SPH_SIZE_hamsi224 224

Output size (in bits) for Hamsi-224.

Definition at line 48 of file sph_hamsi.h.

◆ SPH_SIZE_hamsi256

#define SPH_SIZE_hamsi256 256

Output size (in bits) for Hamsi-256.

Definition at line 53 of file sph_hamsi.h.

◆ SPH_SIZE_hamsi384

#define SPH_SIZE_hamsi384 384

Output size (in bits) for Hamsi-384.

Definition at line 58 of file sph_hamsi.h.

◆ SPH_SIZE_hamsi512

#define SPH_SIZE_hamsi512 512

Output size (in bits) for Hamsi-512.

Definition at line 63 of file sph_hamsi.h.

Typedef Documentation

◆ sph_hamsi224_context

typedef sph_hamsi_small_context sph_hamsi224_context

This structure is a context for Hamsi-224 computations.

It is identical to the common sph_hamsi_small_context.

Definition at line 92 of file sph_hamsi.h.

◆ sph_hamsi256_context

typedef sph_hamsi_small_context sph_hamsi256_context

This structure is a context for Hamsi-256 computations.

It is identical to the common sph_hamsi_small_context.

Definition at line 98 of file sph_hamsi.h.

◆ sph_hamsi384_context

typedef sph_hamsi_big_context sph_hamsi384_context

This structure is a context for Hamsi-384 computations.

It is identical to the common sph_hamsi_small_context.

Definition at line 127 of file sph_hamsi.h.

◆ sph_hamsi512_context

typedef sph_hamsi_big_context sph_hamsi512_context

This structure is a context for Hamsi-512 computations.

It is identical to the common sph_hamsi_small_context.

Definition at line 133 of file sph_hamsi.h.

Function Documentation

◆ sph_hamsi224()

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

Definition at line 754 of file sph_hamsi.c.

◆ sph_hamsi224_addbits_and_close()

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

Definition at line 769 of file sph_hamsi.c.

◆ sph_hamsi224_close()

void sph_hamsi224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 761 of file sph_hamsi.c.

◆ sph_hamsi224_init()

void sph_hamsi224_init ( void * cc )

Initialize a Hamsi-224 context.

This process performs no memory allocation.

Parameters

cc	the Hamsi-224 context (pointer to a `sph_hamsi224_context`)

Definition at line 747 of file sph_hamsi.c.

◆ sph_hamsi256()

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

Definition at line 784 of file sph_hamsi.c.

◆ sph_hamsi256_addbits_and_close()

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

Definition at line 799 of file sph_hamsi.c.

◆ sph_hamsi256_close()

void sph_hamsi256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 791 of file sph_hamsi.c.

◆ sph_hamsi256_init()

void sph_hamsi256_init ( void * cc )

Initialize a Hamsi-256 context.

This process performs no memory allocation.

Parameters

cc	the Hamsi-256 context (pointer to a `sph_hamsi256_context`)

Definition at line 777 of file sph_hamsi.c.

◆ sph_hamsi384()

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

Definition at line 814 of file sph_hamsi.c.

◆ sph_hamsi384_addbits_and_close()

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

Definition at line 829 of file sph_hamsi.c.

◆ sph_hamsi384_close()

void sph_hamsi384_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 821 of file sph_hamsi.c.

◆ sph_hamsi384_init()

void sph_hamsi384_init ( void * cc )

Initialize a Hamsi-384 context.

This process performs no memory allocation.

Parameters

cc	the Hamsi-384 context (pointer to a `sph_hamsi384_context`)

Definition at line 807 of file sph_hamsi.c.

◆ sph_hamsi512()

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

Definition at line 844 of file sph_hamsi.c.

Here is the caller graph for this function:

◆ sph_hamsi512_addbits_and_close()

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

Definition at line 859 of file sph_hamsi.c.

◆ sph_hamsi512_close()

void sph_hamsi512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 851 of file sph_hamsi.c.

Here is the caller graph for this function:

◆ sph_hamsi512_init()

void sph_hamsi512_init ( void * cc )

Initialize a Hamsi-512 context.

This process performs no memory allocation.

Parameters

cc	the Hamsi-512 context (pointer to a `sph_hamsi512_context`)

Definition at line 837 of file sph_hamsi.c.

Here is the caller graph for this function:

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ SPH_SIZE_hamsi224

◆ SPH_SIZE_hamsi256

◆ SPH_SIZE_hamsi384

◆ SPH_SIZE_hamsi512

Typedef Documentation

◆ sph_hamsi224_context

◆ sph_hamsi256_context

◆ sph_hamsi384_context

◆ sph_hamsi512_context

Function Documentation

◆ sph_hamsi224()

◆ sph_hamsi224_addbits_and_close()

◆ sph_hamsi224_close()

◆ sph_hamsi224_init()

◆ sph_hamsi256()

◆ sph_hamsi256_addbits_and_close()

◆ sph_hamsi256_close()

◆ sph_hamsi256_init()

◆ sph_hamsi384()

◆ sph_hamsi384_addbits_and_close()

◆ sph_hamsi384_close()

◆ sph_hamsi384_init()

◆ sph_hamsi512()

◆ sph_hamsi512_addbits_and_close()

◆ sph_hamsi512_close()

◆ sph_hamsi512_init()