/*******************************************************************************************/
/* Shabal hash function                                                                    */
/*                                                                                         */
/* Shabal submitters:                                                                      */
/* Cryptolog International, DCSSI, EADS SN, France Telecom, Gemalto, INRIA, Sagem Sécurité */ /*******************************************************************************************/

\README
This file list all files that are included on this disc with a brief description of each

\Reference_ Implementation
    \shabal.c
    Reference Implementation of the Shabal hash function (reference code).
    This code is meant for illustration of the function internals rather than optimization for speed.

    \shabal.h
    Reference Implementation of the Shabal hash function (header file).
    Note that this header is the same for the "reference" and the "optimized" implementations.

\Optimized_32 bit
    \shabal_opt.c
    32-bit optimized implementation of the Shabal hash function (reference code).
    Note that this code should run efficiently on all supported platforms. In particular, it is optimized for both 32-bit and 64-bit platforms.

    \shabal_opt.h
    32-bit optimized implementation of the Shabal hash function (header file).
    Note that this header is the same for the "reference" and the "optimized" implementations.

\Optimized_64 bit
    \shabal_opt.c
    64-bit optimized implementation of the Shabal hash function (reference code).
    Note that this code should run efficiently on all supported platforms. In particular, it is optimized for both 32-bit and 64-bit platforms.

    \shabal_opt.h
    64-bit optimized implementation of the Shabal hash function (header file).
    Note that this header is the same for the "reference" and the "optimized" implementations.

\KAT_MCT
    \ExtremelyLongMsgKAT_224.txt
    \ExtremelyLongMsgKAT_256.txt
    \ExtremelyLongMsgKAT_384.txt
    \ExtremelyLongMsgKAT_512.txt
    \LongMsgKAT_224.txt
    \LongMsgKAT_256.txt
    \LongMsgKAT_384.txt
    \LongMsgKAT_512.txt
    \MonteCarlo_224.txt
    \MonteCarlo_256.txt
    \MonteCarlo_384.txt
    \MonteCarlo_512.txt
    \ShortMsgKAT_224.txt
    \ShortMsgKAT_256.txt
    \ShortMsgKAT_384.txt
    \ShortMsgKAT_512.txt

\Supporting_Documentation
    \description.pdf
    This file contains the algorithm specification and supporting documention for Shabal. More precisely, a complete specification of Shabal, its computational efficiency and memory requirements, a statement of its expected strength, an analysis of Shabal with respect to known attacks and a statement that lists and describes the advantages and limitations of Shabal.

    \Cover_Sheet_SHABAL.pdf
    The Cover Sheet of the submission.

    \Statement by the Submitter_SHABAL.pdf
    The PDF version of the Intellectual Property Statement by the submitter of Shabal.

    \Statement_ref_impl_SHABAL.pdf
    The PDF version of the Intellectual Property Statement by the Reference/Optimized Implementations' Owner.

\Additional_Implementations
    \optgen.c
    This program generates part of the code in shabal_opt.c. It is configured at compilation time by setting the SHABAL_PARAM_P and SHABAL_PARAM_R. If non-default values are set for those macros, then the same values MUST be used when compiling the resulting shabal_opt.c file. The generated code includes a failsafe detection system which checks exactly for that property.