/* $Id: sph_shabal.h 175 2010-05-07 16:03:20Z tp $ */ /** * Shabal interface. Shabal is a family of functions which differ by * their output size; this implementation defines Shabal for output * sizes 192, 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_shabal.h * @author Thomas Pornin <thomas.pornin@cryptolog.com> */ #ifndef SPH_SHABAL_H__ #define SPH_SHABAL_H__ #ifdef __cplusplus extern "C"{ #endif #include <stddef.h> #include "sph_types.h" /** * Output size (in bits) for Shabal-192. */ #define SPH_SIZE_shabal192 192 /** * Output size (in bits) for Shabal-224. */ #define SPH_SIZE_shabal224 224 /** * Output size (in bits) for Shabal-256. */ #define SPH_SIZE_shabal256 256 /** * Output size (in bits) for Shabal-384. */ #define SPH_SIZE_shabal384 384 /** * Output size (in bits) for Shabal-512. */ #define SPH_SIZE_shabal512 512 /** * This structure is a context for Shabal computations: it contains the * intermediate values and some data from the last entered block. Once * a Shabal computation has been performed, the context can be reused for * another computation. * * The contents of this structure are private. A running Shabal computation * can be cloned by copying the context (e.g. with a simple * <code>memcpy()</code>). */ typedef struct { #ifndef DOXYGEN_IGNORE unsigned char buf[64]; /* first field, for alignment */ size_t ptr; sph_u32 A[12], B[16], C[16]; sph_u32 Whigh, Wlow; #endif } sph_shabal_context; /** * Type for a Shabal-192 context (identical to the common context). */ typedef sph_shabal_context sph_shabal192_context; /** * Type for a Shabal-224 context (identical to the common context). */ typedef sph_shabal_context sph_shabal224_context; /** * Type for a Shabal-256 context (identical to the common context). */ typedef sph_shabal_context sph_shabal256_context; /** * Type for a Shabal-384 context (identical to the common context). */ typedef sph_shabal_context sph_shabal384_context; /** * Type for a Shabal-512 context (identical to the common context). */ typedef sph_shabal_context sph_shabal512_context; /** * Initialize a Shabal-192 context. This process performs no memory allocation. * * @param cc the Shabal-192 context (pointer to a * <code>sph_shabal192_context</code>) */ void sph_shabal192_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 Shabal-192 context * @param data the input data * @param len the input data length (in bytes) */ void sph_shabal192(void *cc, const void *data, size_t len); /** * Terminate the current Shabal-192 computation and output the result into * the provided buffer. The destination buffer must be wide enough to * accomodate the result (24 bytes). The context is automatically * reinitialized. * * @param cc the Shabal-192 context * @param dst the destination buffer */ void sph_shabal192_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 (24 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 Shabal-192 context * @param ub the extra bits * @param n the number of extra bits (0 to 7) * @param dst the destination buffer */ void sph_shabal192_addbits_and_close( void *cc, unsigned ub, unsigned n, void *dst); /** * Initialize a Shabal-224 context. This process performs no memory allocation. * * @param cc the Shabal-224 context (pointer to a * <code>sph_shabal224_context</code>) */ void sph_shabal224_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 Shabal-224 context * @param data the input data * @param len the input data length (in bytes) */ void sph_shabal224(void *cc, const void *data, size_t len); /** * Terminate the current Shabal-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 Shabal-224 context * @param dst the destination buffer */ void sph_shabal224_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 Shabal-224 context * @param ub the extra bits * @param n the number of extra bits (0 to 7) * @param dst the destination buffer */ void sph_shabal224_addbits_and_close( void *cc, unsigned ub, unsigned n, void *dst); /** * Initialize a Shabal-256 context. This process performs no memory allocation. * * @param cc the Shabal-256 context (pointer to a * <code>sph_shabal256_context</code>) */ void sph_shabal256_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 Shabal-256 context * @param data the input data * @param len the input data length (in bytes) */ void sph_shabal256(void *cc, const void *data, size_t len); /** * Terminate the current Shabal-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 Shabal-256 context * @param dst the destination buffer */ void sph_shabal256_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 Shabal-256 context * @param ub the extra bits * @param n the number of extra bits (0 to 7) * @param dst the destination buffer */ void sph_shabal256_addbits_and_close( void *cc, unsigned ub, unsigned n, void *dst); /** * Initialize a Shabal-384 context. This process performs no memory allocation. * * @param cc the Shabal-384 context (pointer to a * <code>sph_shabal384_context</code>) */ void sph_shabal384_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 Shabal-384 context * @param data the input data * @param len the input data length (in bytes) */ void sph_shabal384(void *cc, const void *data, size_t len); /** * Terminate the current Shabal-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 Shabal-384 context * @param dst the destination buffer */ void sph_shabal384_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 Shabal-384 context * @param ub the extra bits * @param n the number of extra bits (0 to 7) * @param dst the destination buffer */ void sph_shabal384_addbits_and_close( void *cc, unsigned ub, unsigned n, void *dst); /** * Initialize a Shabal-512 context. This process performs no memory allocation. * * @param cc the Shabal-512 context (pointer to a * <code>sph_shabal512_context</code>) */ void sph_shabal512_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 Shabal-512 context * @param data the input data * @param len the input data length (in bytes) */ void sph_shabal512(void *cc, const void *data, size_t len); /** * Terminate the current Shabal-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 Shabal-512 context * @param dst the destination buffer */ void sph_shabal512_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 Shabal-512 context * @param ub the extra bits * @param n the number of extra bits (0 to 7) * @param dst the destination buffer */ void sph_shabal512_addbits_and_close( void *cc, unsigned ub, unsigned n, void *dst); #ifdef __cplusplus } #endif #endif