You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
293 lines
9.3 KiB
293 lines
9.3 KiB
/* $Id: sph_keccak.h 216 2010-06-08 09:46:57Z tp $ */
|
|
/**
|
|
* Keccak interface. This is the interface for Keccak with the
|
|
* recommended parameters for SHA-3, with output lengths 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)=============================
|
|
*
|
|
* @file sph_keccak.h
|
|
* @author Thomas Pornin <thomas.pornin@cryptolog.com>
|
|
*/
|
|
|
|
#ifndef SPH_KECCAK_H__
|
|
#define SPH_KECCAK_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"{
|
|
#endif
|
|
|
|
#include <stddef.h>
|
|
#include "sph_types.h"
|
|
|
|
/**
|
|
* Output size (in bits) for Keccak-224.
|
|
*/
|
|
#define SPH_SIZE_keccak224 224
|
|
|
|
/**
|
|
* Output size (in bits) for Keccak-256.
|
|
*/
|
|
#define SPH_SIZE_keccak256 256
|
|
|
|
/**
|
|
* Output size (in bits) for Keccak-384.
|
|
*/
|
|
#define SPH_SIZE_keccak384 384
|
|
|
|
/**
|
|
* Output size (in bits) for Keccak-512.
|
|
*/
|
|
#define SPH_SIZE_keccak512 512
|
|
|
|
/**
|
|
* This structure is a context for Keccak computations: it contains the
|
|
* intermediate values and some data from the last entered block. Once a
|
|
* Keccak computation has been performed, the context can be reused for
|
|
* another computation.
|
|
*
|
|
* The contents of this structure are private. A running Keccak computation
|
|
* can be cloned by copying the context (e.g. with a simple
|
|
* <code>memcpy()</code>).
|
|
*/
|
|
typedef struct {
|
|
#ifndef DOXYGEN_IGNORE
|
|
unsigned char buf[144]; /* first field, for alignment */
|
|
size_t ptr, lim;
|
|
union {
|
|
#if SPH_64
|
|
sph_u64 wide[25];
|
|
#endif
|
|
sph_u32 narrow[50];
|
|
} u;
|
|
#endif
|
|
} sph_keccak_context;
|
|
|
|
/**
|
|
* Type for a Keccak-224 context (identical to the common context).
|
|
*/
|
|
typedef sph_keccak_context sph_keccak224_context;
|
|
|
|
/**
|
|
* Type for a Keccak-256 context (identical to the common context).
|
|
*/
|
|
typedef sph_keccak_context sph_keccak256_context;
|
|
|
|
/**
|
|
* Type for a Keccak-384 context (identical to the common context).
|
|
*/
|
|
typedef sph_keccak_context sph_keccak384_context;
|
|
|
|
/**
|
|
* Type for a Keccak-512 context (identical to the common context).
|
|
*/
|
|
typedef sph_keccak_context sph_keccak512_context;
|
|
|
|
/**
|
|
* Initialize a Keccak-224 context. This process performs no memory allocation.
|
|
*
|
|
* @param cc the Keccak-224 context (pointer to a
|
|
* <code>sph_keccak224_context</code>)
|
|
*/
|
|
void sph_keccak224_init(void *cc);
|
|
|
|
/**
|
|
* Process some data bytes. It is acceptable that <code>len</code> is zero
|
|
* (in which case this function does nothing).
|
|
*
|
|
* @param cc the Keccak-224 context
|
|
* @param data the input data
|
|
* @param len the input data length (in bytes)
|
|
*/
|
|
void sph_keccak224(void *cc, const void *data, size_t len);
|
|
|
|
/**
|
|
* Terminate the current Keccak-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.
|
|
*
|
|
* @param cc the Keccak-224 context
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak224_close(void *cc, 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 <code>ub</code> 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.
|
|
*
|
|
* @param cc the Keccak-224 context
|
|
* @param ub the extra bits
|
|
* @param n the number of extra bits (0 to 7)
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak224_addbits_and_close(
|
|
void *cc, unsigned ub, unsigned n, void *dst);
|
|
|
|
/**
|
|
* Initialize a Keccak-256 context. This process performs no memory allocation.
|
|
*
|
|
* @param cc the Keccak-256 context (pointer to a
|
|
* <code>sph_keccak256_context</code>)
|
|
*/
|
|
void sph_keccak256_init(void *cc);
|
|
|
|
/**
|
|
* Process some data bytes. It is acceptable that <code>len</code> is zero
|
|
* (in which case this function does nothing).
|
|
*
|
|
* @param cc the Keccak-256 context
|
|
* @param data the input data
|
|
* @param len the input data length (in bytes)
|
|
*/
|
|
void sph_keccak256(void *cc, const void *data, size_t len);
|
|
|
|
/**
|
|
* Terminate the current Keccak-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.
|
|
*
|
|
* @param cc the Keccak-256 context
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak256_close(void *cc, 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 <code>ub</code> 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.
|
|
*
|
|
* @param cc the Keccak-256 context
|
|
* @param ub the extra bits
|
|
* @param n the number of extra bits (0 to 7)
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak256_addbits_and_close(
|
|
void *cc, unsigned ub, unsigned n, void *dst);
|
|
|
|
/**
|
|
* Initialize a Keccak-384 context. This process performs no memory allocation.
|
|
*
|
|
* @param cc the Keccak-384 context (pointer to a
|
|
* <code>sph_keccak384_context</code>)
|
|
*/
|
|
void sph_keccak384_init(void *cc);
|
|
|
|
/**
|
|
* Process some data bytes. It is acceptable that <code>len</code> is zero
|
|
* (in which case this function does nothing).
|
|
*
|
|
* @param cc the Keccak-384 context
|
|
* @param data the input data
|
|
* @param len the input data length (in bytes)
|
|
*/
|
|
void sph_keccak384(void *cc, const void *data, size_t len);
|
|
|
|
/**
|
|
* Terminate the current Keccak-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.
|
|
*
|
|
* @param cc the Keccak-384 context
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak384_close(void *cc, 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 <code>ub</code> 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.
|
|
*
|
|
* @param cc the Keccak-384 context
|
|
* @param ub the extra bits
|
|
* @param n the number of extra bits (0 to 7)
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak384_addbits_and_close(
|
|
void *cc, unsigned ub, unsigned n, void *dst);
|
|
|
|
/**
|
|
* Initialize a Keccak-512 context. This process performs no memory allocation.
|
|
*
|
|
* @param cc the Keccak-512 context (pointer to a
|
|
* <code>sph_keccak512_context</code>)
|
|
*/
|
|
void sph_keccak512_init(void *cc);
|
|
|
|
/**
|
|
* Process some data bytes. It is acceptable that <code>len</code> is zero
|
|
* (in which case this function does nothing).
|
|
*
|
|
* @param cc the Keccak-512 context
|
|
* @param data the input data
|
|
* @param len the input data length (in bytes)
|
|
*/
|
|
void sph_keccak512(void *cc, const void *data, size_t len);
|
|
|
|
/**
|
|
* Terminate the current Keccak-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.
|
|
*
|
|
* @param cc the Keccak-512 context
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak512_close(void *cc, 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 <code>ub</code> 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.
|
|
*
|
|
* @param cc the Keccak-512 context
|
|
* @param ub the extra bits
|
|
* @param n the number of extra bits (0 to 7)
|
|
* @param dst the destination buffer
|
|
*/
|
|
void sph_keccak512_addbits_and_close(
|
|
void *cc, unsigned ub, unsigned n, void *dst);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|