sph_jh.h File Reference

JH interface. More...

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

Include dependency graph for sph_jh.h:

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

Go to the source code of this file.

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

Macros
#define	SPH_SIZE_jh224   224
	Output size (in bits) for JH-224. More...
#define	SPH_SIZE_jh256   256
	Output size (in bits) for JH-256. More...
#define	SPH_SIZE_jh384   384
	Output size (in bits) for JH-384. More...
#define	SPH_SIZE_jh512   512
	Output size (in bits) for JH-512. More...

Typedefs
typedef sph_jh_context	sph_jh224_context
	Type for a JH-224 context (identical to the common context). More...
typedef sph_jh_context	sph_jh256_context
	Type for a JH-256 context (identical to the common context). More...
typedef sph_jh_context	sph_jh384_context
	Type for a JH-384 context (identical to the common context). More...
typedef sph_jh_context	sph_jh512_context
	Type for a JH-512 context (identical to the common context). More...

Functions
void	sph_jh224_init (void *cc)
	Initialize a JH-224 context. More...
void	sph_jh224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_jh224_close (void *cc, void *dst)
	Terminate the current JH-224 computation and output the result into the provided buffer. More...
void	sph_jh224_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_jh256_init (void *cc)
	Initialize a JH-256 context. More...
void	sph_jh256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_jh256_close (void *cc, void *dst)
	Terminate the current JH-256 computation and output the result into the provided buffer. More...
void	sph_jh256_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_jh384_init (void *cc)
	Initialize a JH-384 context. More...
void	sph_jh384 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_jh384_close (void *cc, void *dst)
	Terminate the current JH-384 computation and output the result into the provided buffer. More...
void	sph_jh384_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_jh512_init (void *cc)
	Initialize a JH-512 context. More...
void	sph_jh512 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_jh512_close (void *cc, void *dst)
	Terminate the current JH-512 computation and output the result into the provided buffer. More...
void	sph_jh512_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

JH interface.

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

Macro Definition Documentation

SPH_SIZE_jh224

#define SPH_SIZE_jh224   224

Output size (in bits) for JH-224.

Definition at line 49 of file sph_jh.h.

SPH_SIZE_jh256

#define SPH_SIZE_jh256   256

Output size (in bits) for JH-256.

Definition at line 54 of file sph_jh.h.

SPH_SIZE_jh384

#define SPH_SIZE_jh384   384

Output size (in bits) for JH-384.

Definition at line 59 of file sph_jh.h.

SPH_SIZE_jh512

#define SPH_SIZE_jh512   512

Output size (in bits) for JH-512.

Definition at line 64 of file sph_jh.h.

Typedef Documentation

sph_jh224_context

typedef sph_jh_context sph_jh224_context

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

Definition at line 97 of file sph_jh.h.

sph_jh256_context

typedef sph_jh_context sph_jh256_context

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

Definition at line 102 of file sph_jh.h.

sph_jh384_context

typedef sph_jh_context sph_jh384_context

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

Definition at line 107 of file sph_jh.h.

sph_jh512_context

typedef sph_jh_context sph_jh512_context

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

Definition at line 112 of file sph_jh.h.

Function Documentation

sph_jh224()

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

Definition at line 1011 of file jh.c.

sph_jh224_addbits_and_close()

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

Definition at line 1025 of file jh.c.

sph_jh224_close()

void sph_jh224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1018 of file jh.c.

sph_jh224_init()

void sph_jh224_init

(

void *

cc

)

Initialize a JH-224 context.

This process performs no memory allocation.

Parameters

cc	the JH-224 context (pointer to a sph_jh224_context)

Definition at line 1004 of file jh.c.

sph_jh256()

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

Definition at line 1039 of file jh.c.

sph_jh256_addbits_and_close()

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

Definition at line 1053 of file jh.c.

sph_jh256_close()

void sph_jh256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1046 of file jh.c.

sph_jh256_init()

void sph_jh256_init

(

void *

cc

)

Initialize a JH-256 context.

This process performs no memory allocation.

Parameters

cc	the JH-256 context (pointer to a sph_jh256_context)

Definition at line 1032 of file jh.c.

sph_jh384()

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

Definition at line 1067 of file jh.c.

sph_jh384_addbits_and_close()

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

Definition at line 1081 of file jh.c.

sph_jh384_close()

void sph_jh384_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1074 of file jh.c.

sph_jh384_init()

void sph_jh384_init

(

void *

cc

)

Initialize a JH-384 context.

This process performs no memory allocation.

Parameters

cc	the JH-384 context (pointer to a sph_jh384_context)

Definition at line 1060 of file jh.c.

sph_jh512()

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

Definition at line 1095 of file jh.c.

Here is the caller graph for this function:

sph_jh512_addbits_and_close()

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

Definition at line 1109 of file jh.c.

sph_jh512_close()

void sph_jh512_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 1102 of file jh.c.

Here is the caller graph for this function:

sph_jh512_init()

void sph_jh512_init

(

void *

cc

)

Initialize a JH-512 context.

This process performs no memory allocation.

Parameters

cc	the JH-512 context (pointer to a sph_jh512_context)

Definition at line 1088 of file jh.c.

Here is the caller graph for this function: