sph_shabal.h File Reference

Shabal interface. More...

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

Include dependency graph for sph_shabal.h:

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

Go to the source code of this file.

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

Macros
#define	SPH_SIZE_shabal192   192
	Output size (in bits) for Shabal-192. More...
#define	SPH_SIZE_shabal224   224
	Output size (in bits) for Shabal-224. More...
#define	SPH_SIZE_shabal256   256
	Output size (in bits) for Shabal-256. More...
#define	SPH_SIZE_shabal384   384
	Output size (in bits) for Shabal-384. More...
#define	SPH_SIZE_shabal512   512
	Output size (in bits) for Shabal-512. More...

Typedefs
typedef sph_shabal_context	sph_shabal192_context
	Type for a Shabal-192 context (identical to the common context). More...
typedef sph_shabal_context	sph_shabal224_context
	Type for a Shabal-224 context (identical to the common context). More...
typedef sph_shabal_context	sph_shabal256_context
	Type for a Shabal-256 context (identical to the common context). More...
typedef sph_shabal_context	sph_shabal384_context
	Type for a Shabal-384 context (identical to the common context). More...
typedef sph_shabal_context	sph_shabal512_context
	Type for a Shabal-512 context (identical to the common context). More...

Functions
void	sph_shabal192_init (void *cc)
	Initialize a Shabal-192 context. More...
void	sph_shabal192 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_shabal192_close (void *cc, void *dst)
	Terminate the current Shabal-192 computation and output the result into the provided buffer. More...
void	sph_shabal192_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 (24 bytes). More...
void	sph_shabal224_init (void *cc)
	Initialize a Shabal-224 context. More...
void	sph_shabal224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_shabal224_close (void *cc, void *dst)
	Terminate the current Shabal-224 computation and output the result into the provided buffer. More...
void	sph_shabal224_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_shabal256_init (void *cc)
	Initialize a Shabal-256 context. More...
void	sph_shabal256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_shabal256_close (void *cc, void *dst)
	Terminate the current Shabal-256 computation and output the result into the provided buffer. More...
void	sph_shabal256_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_shabal384_init (void *cc)
	Initialize a Shabal-384 context. More...
void	sph_shabal384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_shabal384_close (void *cc, void *dst)
	Terminate the current Shabal-384 computation and output the result into the provided buffer. More...
void	sph_shabal384_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_shabal512_init (void *cc)
	Initialize a Shabal-512 context. More...
void	sph_shabal512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_shabal512_close (void *cc, void *dst)
	Terminate the current Shabal-512 computation and output the result into the provided buffer. More...
void	sph_shabal512_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

Shabal interface.

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

Macro Definition Documentation

SPH_SIZE_shabal192

#define SPH_SIZE_shabal192   192

Output size (in bits) for Shabal-192.

Definition at line 48 of file sph_shabal.h.

SPH_SIZE_shabal224

#define SPH_SIZE_shabal224   224

Output size (in bits) for Shabal-224.

Definition at line 53 of file sph_shabal.h.

SPH_SIZE_shabal256

#define SPH_SIZE_shabal256   256

Output size (in bits) for Shabal-256.

Definition at line 58 of file sph_shabal.h.

SPH_SIZE_shabal384

#define SPH_SIZE_shabal384   384

Output size (in bits) for Shabal-384.

Definition at line 63 of file sph_shabal.h.

SPH_SIZE_shabal512

#define SPH_SIZE_shabal512   512

Output size (in bits) for Shabal-512.

Definition at line 68 of file sph_shabal.h.

Typedef Documentation

sph_shabal192_context

typedef sph_shabal_context sph_shabal192_context

Type for a Shabal-192 context (identical to the common context).

Definition at line 92 of file sph_shabal.h.

sph_shabal224_context

typedef sph_shabal_context sph_shabal224_context

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

Definition at line 97 of file sph_shabal.h.

sph_shabal256_context

typedef sph_shabal_context sph_shabal256_context

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

Definition at line 102 of file sph_shabal.h.

sph_shabal384_context

typedef sph_shabal_context sph_shabal384_context

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

Definition at line 107 of file sph_shabal.h.

sph_shabal512_context

typedef sph_shabal_context sph_shabal512_context

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

Definition at line 112 of file sph_shabal.h.

Function Documentation

sph_shabal192()

void sph_shabal192	(	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 Shabal-192 context
data	the input data
len	the input data length (in bytes)

sph_shabal192_addbits_and_close()

void sph_shabal192_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 (24 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 Shabal-192 context
ub	the extra bits
n	the number of extra bits (0 to 7)
dst	the destination buffer

sph_shabal192_close()

void sph_shabal192_close	(	void *	cc,
		void *	dst
	)

Terminate the current Shabal-192 computation and output the result into the provided buffer.

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

Parameters

cc	the Shabal-192 context
dst	the destination buffer

sph_shabal192_init()

void sph_shabal192_init

(

void *

cc

)

Initialize a Shabal-192 context.

This process performs no memory allocation.

Parameters

cc	the Shabal-192 context (pointer to a sph_shabal192_context)

sph_shabal224()

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

sph_shabal224_addbits_and_close()

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

sph_shabal224_close()

void sph_shabal224_close	(	void *	cc,
		void *	dst
	)

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

sph_shabal224_init()

void sph_shabal224_init

(

void *

cc

)

Initialize a Shabal-224 context.

This process performs no memory allocation.

Parameters

cc	the Shabal-224 context (pointer to a sph_shabal224_context)

sph_shabal256()

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

Definition at line 730 of file sph_shabal.c.

sph_shabal256_addbits_and_close()

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

Definition at line 744 of file sph_shabal.c.

sph_shabal256_close()

void sph_shabal256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 737 of file sph_shabal.c.

sph_shabal256_init()

void sph_shabal256_init

(

void *

cc

)

Initialize a Shabal-256 context.

This process performs no memory allocation.

Parameters

cc	the Shabal-256 context (pointer to a sph_shabal256_context)

Definition at line 723 of file sph_shabal.c.

sph_shabal384()

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

sph_shabal384_addbits_and_close()

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

sph_shabal384_close()

void sph_shabal384_close	(	void *	cc,
		void *	dst
	)

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

sph_shabal384_init()

void sph_shabal384_init

(

void *

cc

)

Initialize a Shabal-384 context.

This process performs no memory allocation.

Parameters

cc	the Shabal-384 context (pointer to a sph_shabal384_context)

sph_shabal512()

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

Definition at line 788 of file sph_shabal.c.

Here is the caller graph for this function:

sph_shabal512_addbits_and_close()

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

Definition at line 802 of file sph_shabal.c.

sph_shabal512_close()

void sph_shabal512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 795 of file sph_shabal.c.

Here is the caller graph for this function:

sph_shabal512_init()

void sph_shabal512_init

(

void *

cc

)

Initialize a Shabal-512 context.

This process performs no memory allocation.

Parameters

cc	the Shabal-512 context (pointer to a sph_shabal512_context)

Definition at line 781 of file sph_shabal.c.

Here is the caller graph for this function: