SHAvite-3 interface. More...

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

Include dependency graph for sph_shavite.h:

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

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

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

Macros
#define	SPH_SIZE_shavite224 224
	Output size (in bits) for SHAvite-224. More...

#define	SPH_SIZE_shavite256 256
	Output size (in bits) for SHAvite-256. More...

#define	SPH_SIZE_shavite384 384
	Output size (in bits) for SHAvite-384. More...

#define	SPH_SIZE_shavite512 512
	Output size (in bits) for SHAvite-512. More...

Typedefs
typedef sph_shavite_small_context	sph_shavite224_context
	This structure is a context for SHAvite-224 computations. More...

typedef sph_shavite_small_context	sph_shavite256_context
	This structure is a context for SHAvite-256 computations. More...

typedef sph_shavite_big_context	sph_shavite384_context
	This structure is a context for SHAvite-384 computations. More...

typedef sph_shavite_big_context	sph_shavite512_context
	This structure is a context for SHAvite-512 computations. More...

Functions
void	sph_shavite224_init (void *cc)
	Initialize a SHAvite-224 context. More...

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

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

void	sph_shavite224_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_shavite256_init (void *cc)
	Initialize a SHAvite-256 context. More...

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

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

void	sph_shavite256_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_shavite384_init (void *cc)
	Initialize a SHAvite-384 context. More...

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

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

void	sph_shavite384_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_shavite512_init (void *cc)
	Initialize a SHAvite-512 context. More...

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

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

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

SHAvite-3 interface.

This code implements SHAvite-3 with the recommended parameters for SHA-3, with outputs of 224, 256, 384 and 512 bits. In the following, we call the function "SHAvite" (without the "-3" suffix), thus "SHAvite-224" is "SHAvite-3 with a 224-bit output".

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

Macro Definition Documentation

◆ SPH_SIZE_shavite224

#define SPH_SIZE_shavite224 224

Output size (in bits) for SHAvite-224.

Definition at line 51 of file sph_shavite.h.

◆ SPH_SIZE_shavite256

#define SPH_SIZE_shavite256 256

Output size (in bits) for SHAvite-256.

Definition at line 56 of file sph_shavite.h.

◆ SPH_SIZE_shavite384

#define SPH_SIZE_shavite384 384

Output size (in bits) for SHAvite-384.

Definition at line 61 of file sph_shavite.h.

◆ SPH_SIZE_shavite512

#define SPH_SIZE_shavite512 512

Output size (in bits) for SHAvite-512.

Definition at line 66 of file sph_shavite.h.

Typedef Documentation

◆ sph_shavite224_context

typedef sph_shavite_small_context sph_shavite224_context

This structure is a context for SHAvite-224 computations.

It is identical to the common sph_shavite_small_context.

Definition at line 91 of file sph_shavite.h.

◆ sph_shavite256_context

typedef sph_shavite_small_context sph_shavite256_context

This structure is a context for SHAvite-256 computations.

It is identical to the common sph_shavite_small_context.

Definition at line 97 of file sph_shavite.h.

◆ sph_shavite384_context

typedef sph_shavite_big_context sph_shavite384_context

This structure is a context for SHAvite-384 computations.

It is identical to the common sph_shavite_small_context.

Definition at line 122 of file sph_shavite.h.

◆ sph_shavite512_context

typedef sph_shavite_big_context sph_shavite512_context

This structure is a context for SHAvite-512 computations.

It is identical to the common sph_shavite_small_context.

Definition at line 128 of file sph_shavite.h.

Function Documentation

◆ sph_shavite224()

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

Definition at line 1651 of file shavite.c.

◆ sph_shavite224_addbits_and_close()

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

Definition at line 1666 of file shavite.c.

◆ sph_shavite224_close()

void sph_shavite224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1658 of file shavite.c.

◆ sph_shavite224_init()

void sph_shavite224_init ( void * cc )

Initialize a SHAvite-224 context.

This process performs no memory allocation.

Parameters

cc	the SHAvite-224 context (pointer to a `sph_shavite224_context`)

Definition at line 1644 of file shavite.c.

◆ sph_shavite256()

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

Definition at line 1681 of file shavite.c.

◆ sph_shavite256_addbits_and_close()

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

Definition at line 1696 of file shavite.c.

◆ sph_shavite256_close()

void sph_shavite256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1688 of file shavite.c.

◆ sph_shavite256_init()

void sph_shavite256_init ( void * cc )

Initialize a SHAvite-256 context.

This process performs no memory allocation.

Parameters

cc	the SHAvite-256 context (pointer to a `sph_shavite256_context`)

Definition at line 1674 of file shavite.c.

◆ sph_shavite384()

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

Definition at line 1711 of file shavite.c.

◆ sph_shavite384_addbits_and_close()

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

Definition at line 1726 of file shavite.c.

◆ sph_shavite384_close()

void sph_shavite384_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1718 of file shavite.c.

◆ sph_shavite384_init()

void sph_shavite384_init ( void * cc )

Initialize a SHAvite-384 context.

This process performs no memory allocation.

Parameters

cc	the SHAvite-384 context (pointer to a `sph_shavite384_context`)

Definition at line 1704 of file shavite.c.

◆ sph_shavite512()

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

Definition at line 1741 of file shavite.c.

Here is the caller graph for this function:

◆ sph_shavite512_addbits_and_close()

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

Definition at line 1756 of file shavite.c.

◆ sph_shavite512_close()

void sph_shavite512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1748 of file shavite.c.

Here is the caller graph for this function:

◆ sph_shavite512_init()

void sph_shavite512_init ( void * cc )

Initialize a SHAvite-512 context.

This process performs no memory allocation.

Parameters

cc	the SHAvite-512 context (pointer to a `sph_shavite512_context`)

Definition at line 1734 of file shavite.c.

Here is the caller graph for this function:

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ SPH_SIZE_shavite224

◆ SPH_SIZE_shavite256

◆ SPH_SIZE_shavite384

◆ SPH_SIZE_shavite512

Typedef Documentation

◆ sph_shavite224_context

◆ sph_shavite256_context

◆ sph_shavite384_context

◆ sph_shavite512_context

Function Documentation

◆ sph_shavite224()

◆ sph_shavite224_addbits_and_close()

◆ sph_shavite224_close()

◆ sph_shavite224_init()

◆ sph_shavite256()

◆ sph_shavite256_addbits_and_close()

◆ sph_shavite256_close()

◆ sph_shavite256_init()

◆ sph_shavite384()

◆ sph_shavite384_addbits_and_close()

◆ sph_shavite384_close()

◆ sph_shavite384_init()

◆ sph_shavite512()

◆ sph_shavite512_addbits_and_close()

◆ sph_shavite512_close()

◆ sph_shavite512_init()