sph_cubehash.h File Reference

CubeHash interface. More...

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

Include dependency graph for sph_cubehash.h:

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

Go to the source code of this file.

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

Macros
#define	SPH_SIZE_cubehash224   224
	Output size (in bits) for CubeHash-224. More...
#define	SPH_SIZE_cubehash256   256
	Output size (in bits) for CubeHash-256. More...
#define	SPH_SIZE_cubehash384   384
	Output size (in bits) for CubeHash-384. More...
#define	SPH_SIZE_cubehash512   512
	Output size (in bits) for CubeHash-512. More...

Typedefs
typedef sph_cubehash_context	sph_cubehash224_context
	Type for a CubeHash-224 context (identical to the common context). More...
typedef sph_cubehash_context	sph_cubehash256_context
	Type for a CubeHash-256 context (identical to the common context). More...
typedef sph_cubehash_context	sph_cubehash384_context
	Type for a CubeHash-384 context (identical to the common context). More...
typedef sph_cubehash_context	sph_cubehash512_context
	Type for a CubeHash-512 context (identical to the common context). More...

Functions
void	sph_cubehash224_init (void *cc)
	Initialize a CubeHash-224 context. More...
void	sph_cubehash224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_cubehash224_close (void *cc, void *dst)
	Terminate the current CubeHash-224 computation and output the result into the provided buffer. More...
void	sph_cubehash224_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_cubehash256_init (void *cc)
	Initialize a CubeHash-256 context. More...
void	sph_cubehash256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_cubehash256_close (void *cc, void *dst)
	Terminate the current CubeHash-256 computation and output the result into the provided buffer. More...
void	sph_cubehash256_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_cubehash384_init (void *cc)
	Initialize a CubeHash-384 context. More...
void	sph_cubehash384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_cubehash384_close (void *cc, void *dst)
	Terminate the current CubeHash-384 computation and output the result into the provided buffer. More...
void	sph_cubehash384_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_cubehash512_init (void *cc)
	Initialize a CubeHash-512 context. More...
void	sph_cubehash512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_cubehash512_close (void *cc, void *dst)
	Terminate the current CubeHash-512 computation and output the result into the provided buffer. More...
void	sph_cubehash512_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

CubeHash interface.

CubeHash is a family of functions which differ by their output size; this implementation defines CubeHash for output sizes 224, 256, 384 and 512 bits, with the "standard parameters" (CubeHash16/32 with the CubeHash specification notations).

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

Macro Definition Documentation

SPH_SIZE_cubehash224

#define SPH_SIZE_cubehash224   224

Output size (in bits) for CubeHash-224.

Definition at line 50 of file sph_cubehash.h.

SPH_SIZE_cubehash256

#define SPH_SIZE_cubehash256   256

Output size (in bits) for CubeHash-256.

Definition at line 55 of file sph_cubehash.h.

SPH_SIZE_cubehash384

#define SPH_SIZE_cubehash384   384

Output size (in bits) for CubeHash-384.

Definition at line 60 of file sph_cubehash.h.

SPH_SIZE_cubehash512

#define SPH_SIZE_cubehash512   512

Output size (in bits) for CubeHash-512.

Definition at line 65 of file sph_cubehash.h.

Typedef Documentation

sph_cubehash224_context

typedef sph_cubehash_context sph_cubehash224_context

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

Definition at line 88 of file sph_cubehash.h.

sph_cubehash256_context

typedef sph_cubehash_context sph_cubehash256_context

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

Definition at line 93 of file sph_cubehash.h.

sph_cubehash384_context

typedef sph_cubehash_context sph_cubehash384_context

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

Definition at line 98 of file sph_cubehash.h.

sph_cubehash512_context

typedef sph_cubehash_context sph_cubehash512_context

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

Definition at line 103 of file sph_cubehash.h.

Function Documentation

sph_cubehash224()

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

Definition at line 615 of file cubehash.c.

References cubehash_core().

sph_cubehash224_addbits_and_close()

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

Definition at line 629 of file cubehash.c.

References cubehash_close(), and sph_cubehash224_init().

Referenced by sph_cubehash224_close().

sph_cubehash224_close()

void sph_cubehash224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 622 of file cubehash.c.

References sph_cubehash224_addbits_and_close().

sph_cubehash224_init()

void sph_cubehash224_init

(

void *

cc

)

Initialize a CubeHash-224 context.

This process performs no memory allocation.

Parameters

cc	the CubeHash-224 context (pointer to a sph_cubehash224_context)

Definition at line 608 of file cubehash.c.

References cubehash_init(), and IV224.

Referenced by sph_cubehash224_addbits_and_close().

sph_cubehash256()

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

Definition at line 644 of file cubehash.c.

References cubehash_core().

sph_cubehash256_addbits_and_close()

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

Definition at line 658 of file cubehash.c.

References cubehash_close(), and sph_cubehash256_init().

Referenced by sph_cubehash256_close().

sph_cubehash256_close()

void sph_cubehash256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 651 of file cubehash.c.

References sph_cubehash256_addbits_and_close().

sph_cubehash256_init()

void sph_cubehash256_init

(

void *

cc

)

Initialize a CubeHash-256 context.

This process performs no memory allocation.

Parameters

cc	the CubeHash-256 context (pointer to a sph_cubehash256_context)

Definition at line 637 of file cubehash.c.

References cubehash_init(), and IV256.

Referenced by sph_cubehash256_addbits_and_close().

sph_cubehash384()

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

Definition at line 673 of file cubehash.c.

References cubehash_core().

sph_cubehash384_addbits_and_close()

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

Definition at line 687 of file cubehash.c.

References cubehash_close(), and sph_cubehash384_init().

Referenced by sph_cubehash384_close().

sph_cubehash384_close()

void sph_cubehash384_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 680 of file cubehash.c.

References sph_cubehash384_addbits_and_close().

sph_cubehash384_init()

void sph_cubehash384_init

(

void *

cc

)

Initialize a CubeHash-384 context.

This process performs no memory allocation.

Parameters

cc	the CubeHash-384 context (pointer to a sph_cubehash384_context)

Definition at line 666 of file cubehash.c.

References cubehash_init(), and IV384.

Referenced by sph_cubehash384_addbits_and_close().

sph_cubehash512()

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

Definition at line 702 of file cubehash.c.

References cubehash_core().

Referenced by HashX11().

sph_cubehash512_addbits_and_close()

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

Definition at line 716 of file cubehash.c.

References cubehash_close(), and sph_cubehash512_init().

Referenced by sph_cubehash512_close().

sph_cubehash512_close()

void sph_cubehash512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 709 of file cubehash.c.

References sph_cubehash512_addbits_and_close().

Referenced by HashX11().

sph_cubehash512_init()

void sph_cubehash512_init

(

void *

cc

)

Initialize a CubeHash-512 context.

This process performs no memory allocation.

Parameters

cc	the CubeHash-512 context (pointer to a sph_cubehash512_context)

Definition at line 695 of file cubehash.c.

References cubehash_init(), and IV512.

Referenced by HashX11(), and sph_cubehash512_addbits_and_close().