sph_sha2.h File Reference

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

Go to the source code of this file.

Data Structures

struct  sph_sha224_context
struct  sph_sha384_context

Defines

#define SPH_SIZE_sha224   224
#define SPH_SIZE_sha256   256
#define SPH_SIZE_sha384   384
#define SPH_SIZE_sha512   512

Typedefs

typedef sph_sha224_context sph_sha256_context
typedef sph_sha384_context sph_sha512_context

Functions

void sph_sha224_init (void *cc)
void sph_sha224 (void *cc, const void *data, size_t len)
void sph_sha224_close (void *cc, void *dst)
void sph_sha224_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_sha224_comp (const sph_u32 msg[16], sph_u32 val[8])
void sph_sha256_init (void *cc)
void sph_sha256 (void *cc, const void *data, size_t len)
void sph_sha256_close (void *cc, void *dst)
void sph_sha256_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_sha256_comp (const sph_u32 msg[16], sph_u32 val[8])
void sph_sha384_init (void *cc)
void sph_sha384 (void *cc, const void *data, size_t len)
void sph_sha384_close (void *cc, void *dst)
void sph_sha384_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_sha384_comp (const sph_u64 msg[16], sph_u64 val[8])
void sph_sha512_init (void *cc)
void sph_sha512 (void *cc, const void *data, size_t len)
void sph_sha512_close (void *cc, void *dst)
void sph_sha512_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
void sph_sha512_comp (const sph_u64 msg[16], sph_u64 val[8])

Detailed Description

SHA-224, SHA-256, SHA-384 and SHA-512 interface.

SHA-256 has been published in FIPS 180-2, now amended with a change notice to include SHA-224 as well (which is a simple variation on SHA-256). SHA-384 and SHA-512 are also defined in FIPS 180-2. FIPS standards can be found at: http://csrc.nist.gov/publications/fips/

==========================(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_sha224   224

Output size (in bits) for SHA-224.

#define SPH_SIZE_sha256   256

Output size (in bits) for SHA-256.

#define SPH_SIZE_sha384   384

Output size (in bits) for SHA-384.

#define SPH_SIZE_sha512   512

Output size (in bits) for SHA-512.


Typedef Documentation

This structure is a context for SHA-256 computations. It is identical to the SHA-224 context. However, a context is initialized for SHA-224 or SHA-256, but not both (the internal IV is not the same).

This structure is a context for SHA-512 computations. It is identical to the SHA-384 context. However, a context is initialized for SHA-384 or SHA-512, but not both (the internal IV is not the same).


Function Documentation

void sph_sha224_init ( void *  cc  ) 

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

Parameters:
cc the SHA-224 context (pointer to a sph_sha224_context)
void sph_sha224 ( 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 SHA-224 context
data the input data
len the input data length (in bytes)
void sph_sha224_close ( void *  cc,
void *  dst 
)

Terminate the current SHA-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 SHA-224 context
dst the destination buffer
void sph_sha224_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 SHA-224 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_sha224_comp ( const sph_u32  msg[16],
sph_u32  val[8] 
)

Apply the SHA-224 compression function on the provided data. The msg parameter contains the 16 32-bit input blocks, as numerical values (hence after the big-endian decoding). The val parameter contains the 8 32-bit input blocks for the compression function; the output is written in place in this array.

Parameters:
msg the message block (16 values)
val the function 256-bit input and output
void sph_sha256_init ( void *  cc  ) 

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

Parameters:
cc the SHA-256 context (pointer to a sph_sha256_context)
void sph_sha256 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes, for SHA-256. This function is identical to sha_224()

Parameters:
cc the SHA-224 context
data the input data
len the input data length (in bytes)
void sph_sha256_close ( void *  cc,
void *  dst 
)

Terminate the current SHA-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 SHA-256 context
dst the destination buffer
void sph_sha256_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 SHA-256 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_sha256_comp ( const sph_u32  msg[16],
sph_u32  val[8] 
)

Apply the SHA-256 compression function on the provided data. This function is identical to sha224_comp().

Parameters:
msg the message block (16 values)
val the function 256-bit input and output
void sph_sha384_init ( void *  cc  ) 

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

Parameters:
cc the SHA-384 context (pointer to a sph_sha384_context)
void sph_sha384 ( 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 SHA-384 context
data the input data
len the input data length (in bytes)
void sph_sha384_close ( void *  cc,
void *  dst 
)

Terminate the current SHA-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 SHA-384 context
dst the destination buffer
void sph_sha384_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 SHA-384 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_sha384_comp ( const sph_u64  msg[16],
sph_u64  val[8] 
)

Apply the SHA-384 compression function on the provided data. The msg parameter contains the 16 64-bit input blocks, as numerical values (hence after the big-endian decoding). The val parameter contains the 8 64-bit input blocks for the compression function; the output is written in place in this array.

Parameters:
msg the message block (16 values)
val the function 512-bit input and output
void sph_sha512_init ( void *  cc  ) 

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

Parameters:
cc the SHA-512 context (pointer to a sph_sha512_context)
void sph_sha512 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes, for SHA-512. This function is identical to sph_sha384().

Parameters:
cc the SHA-384 context
data the input data
len the input data length (in bytes)
void sph_sha512_close ( void *  cc,
void *  dst 
)

Terminate the current SHA-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 SHA-512 context
dst the destination buffer
void sph_sha512_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 SHA-512 context
ub the extra bits
n the number of extra bits (0 to 7)
dst the destination buffer
void sph_sha512_comp ( const sph_u64  msg[16],
sph_u64  val[8] 
)

Apply the SHA-512 compression function. This function is identical to sph_sha384_comp().

Parameters:
msg the message block (16 values)
val the function 512-bit input and output
Generated on Mon Jun 21 17:48:04 2010 for sphlib by  doxygen 1.6.3