sph_bmw.h File Reference

BMW interface. More...

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

Include dependency graph for sph_bmw.h:

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

Go to the source code of this file.

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

Macros
#define	SPH_SIZE_bmw224   224
	Output size (in bits) for BMW-224. More...
#define	SPH_SIZE_bmw256   256
	Output size (in bits) for BMW-256. More...

Typedefs
typedef sph_bmw_small_context	sph_bmw224_context
	This structure is a context for BMW-224 computations. More...
typedef sph_bmw_small_context	sph_bmw256_context
	This structure is a context for BMW-256 computations. More...

Functions
void	sph_bmw224_init (void *cc)
	Initialize a BMW-224 context. More...
void	sph_bmw224 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_bmw224_close (void *cc, void *dst)
	Terminate the current BMW-224 computation and output the result into the provided buffer. More...
void	sph_bmw224_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_bmw256_init (void *cc)
	Initialize a BMW-256 context. More...
void	sph_bmw256 (void *cc, const void *data, size_t len)
	Process some data bytes. More...
void	sph_bmw256_close (void *cc, void *dst)
	Terminate the current BMW-256 computation and output the result into the provided buffer. More...
void	sph_bmw256_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...

Detailed Description

BMW interface.

BMW (aka "Blue Midnight Wish") is a family of functions which differ by their output size; this implementation defines BMW 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_bmw.h.

Macro Definition Documentation

SPH_SIZE_bmw224

#define SPH_SIZE_bmw224   224

Output size (in bits) for BMW-224.

Definition at line 49 of file sph_bmw.h.

SPH_SIZE_bmw256

#define SPH_SIZE_bmw256   256

Output size (in bits) for BMW-256.

Definition at line 54 of file sph_bmw.h.

Typedef Documentation

sph_bmw224_context

typedef sph_bmw_small_context sph_bmw224_context

This structure is a context for BMW-224 computations.

It is identical to the common sph_bmw_small_context.

Definition at line 97 of file sph_bmw.h.

sph_bmw256_context

typedef sph_bmw_small_context sph_bmw256_context

This structure is a context for BMW-256 computations.

It is identical to the common sph_bmw_small_context.

Definition at line 103 of file sph_bmw.h.

Function Documentation

sph_bmw224()

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

Definition at line 852 of file bmw.c.

References bmw32().

sph_bmw224_addbits_and_close()

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

Definition at line 866 of file bmw.c.

References bmw32_close(), and sph_bmw224_init().

Referenced by sph_bmw224_close().

sph_bmw224_close()

void sph_bmw224_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 859 of file bmw.c.

References sph_bmw224_addbits_and_close().

sph_bmw224_init()

void sph_bmw224_init

(

void *

cc

)

Initialize a BMW-224 context.

This process performs no memory allocation.

Parameters

cc	the BMW-224 context (pointer to a sph_bmw224_context)

Definition at line 845 of file bmw.c.

References bmw32_init(), and IV224.

Referenced by sph_bmw224_addbits_and_close().

sph_bmw256()

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

Definition at line 881 of file bmw.c.

References bmw32().

sph_bmw256_addbits_and_close()

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

Definition at line 895 of file bmw.c.

References bmw32_close(), and sph_bmw256_init().

Referenced by sph_bmw256_close().

sph_bmw256_close()

void sph_bmw256_close	(	void *	cc,
		void *	dst
	)

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

Definition at line 888 of file bmw.c.

References sph_bmw256_addbits_and_close().

sph_bmw256_init()

void sph_bmw256_init

(

void *

cc

)

Initialize a BMW-256 context.

This process performs no memory allocation.

Parameters

cc	the BMW-256 context (pointer to a sph_bmw256_context)

Definition at line 874 of file bmw.c.

References bmw32_init(), and IV256.

Referenced by sph_bmw256_addbits_and_close().