sph_skein.h File Reference

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

Go to the source code of this file.

Data Structures

struct  sph_skein_small_context
struct  sph_skein_big_context

Defines

#define SPH_SIZE_skein224   224
#define SPH_SIZE_skein256   256
#define SPH_SIZE_skein384   384
#define SPH_SIZE_skein512   512

Typedefs

typedef sph_skein_small_context sph_skein224_context
typedef sph_skein_small_context sph_skein256_context
typedef sph_skein_big_context sph_skein384_context
typedef sph_skein_big_context sph_skein512_context

Functions

void sph_skein224_init (void *cc)
void sph_skein224 (void *cc, const void *data, size_t len)
void sph_skein224_close (void *cc, void *dst)
void sph_skein224_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_skein256_init (void *cc)
void sph_skein256 (void *cc, const void *data, size_t len)
void sph_skein256_close (void *cc, void *dst)
void sph_skein256_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_skein384_init (void *cc)
void sph_skein384 (void *cc, const void *data, size_t len)
void sph_skein384_close (void *cc, void *dst)
void sph_skein384_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_skein512_init (void *cc)
void sph_skein512 (void *cc, const void *data, size_t len)
void sph_skein512_close (void *cc, void *dst)
void sph_skein512_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)

Detailed Description

Skein interface. There are three main Skein functions, which the Skein specification calls, respectively, Skein-256, Skein-512 and Skein-1024. Each can be used to produce outputs of several lengths. This code implements Skein-256 with an output of length 224 or 256 bits, and Skein-512 with an output of length 384 or 512 bits. Thus, what we call hereafter Skein-224, Skein-256, Skein-384 and Skein-512 are what the Skein specification calls Skein-256-224, Skein-256-256, Skein-512-384 and Skein-512-512, respectively.

==========================(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 <thomas.pornin@cryptolog.com>

Define Documentation

#define SPH_SIZE_skein224   224

Output size (in bits) for Skein-224.

#define SPH_SIZE_skein256   256

Output size (in bits) for Skein-256.

#define SPH_SIZE_skein384   384

Output size (in bits) for Skein-384.

#define SPH_SIZE_skein512   512

Output size (in bits) for Skein-512.


Typedef Documentation

Type for a Skein-224 context (identical to the common "small" context).

Type for a Skein-256 context (identical to the common "small" context).

Type for a Skein-384 context (identical to the common "big" context).

Type for a Skein-512 context (identical to the common "big" context).


Function Documentation

void sph_skein224_init ( void *  cc  ) 

Initialize a Skein-224 context. This process performs no memory allocation.

Parameters:
cc the Skein-224 context (pointer to a sph_skein224_context)
void sph_skein224 ( 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 Skein-224 context
data the input data
len the input data length (in bytes)
void sph_skein224_close ( void *  cc,
void *  dst 
)

Terminate the current Skein-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 Skein-224 context
dst the destination buffer
void sph_skein224_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 Skein-224 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_skein256_init ( void *  cc  ) 

Initialize a Skein-256 context. This process performs no memory allocation.

Parameters:
cc the Skein-256 context (pointer to a sph_skein256_context)
void sph_skein256 ( 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 Skein-256 context
data the input data
len the input data length (in bytes)
void sph_skein256_close ( void *  cc,
void *  dst 
)

Terminate the current Skein-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 Skein-256 context
dst the destination buffer
void sph_skein256_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 Skein-256 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_skein384_init ( void *  cc  ) 

Initialize a Skein-384 context. This process performs no memory allocation.

Parameters:
cc the Skein-384 context (pointer to a sph_skein384_context)
void sph_skein384 ( 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 Skein-384 context
data the input data
len the input data length (in bytes)
void sph_skein384_close ( void *  cc,
void *  dst 
)

Terminate the current Skein-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 Skein-384 context
dst the destination buffer
void sph_skein384_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 Skein-384 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_skein512_init ( void *  cc  ) 

Initialize a Skein-512 context. This process performs no memory allocation.

Parameters:
cc the Skein-512 context (pointer to a sph_skein512_context)
void sph_skein512 ( 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 Skein-512 context
data the input data
len the input data length (in bytes)
void sph_skein512_close ( void *  cc,
void *  dst 
)

Terminate the current Skein-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 Skein-512 context
dst the destination buffer
void sph_skein512_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 Skein-512 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
Generated on Mon Jun 21 17:48:04 2010 for sphlib by  doxygen 1.6.3