Annotation of embedaddon/strongswan/src/libstrongswan/plugins/sha3/sha3_shake.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2016 Andreas Steffen
                      3:  * HSR Hochschule fuer Technik Rapperswil
                      4:  *
                      5:  * This program is free software; you can redistribute it and/or modify it
                      6:  * under the terms of the GNU General Public License as published by the
                      7:  * Free Software Foundation; either version 2 of the License, or (at your
                      8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
                      9:  *
                     10:  * This program is distributed in the hope that it will be useful, but
                     11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
                     12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
                     13:  * for more details.
                     14:  */
                     15: 
                     16: /**
                     17:  * @defgroup sha3_shake sha3_shake
                     18:  * @{ @ingroup sha3_p
                     19:  */
                     20: 
                     21: #ifndef SHA3_SHAKE_H_
                     22: #define SHA3_SHAKE_H_
                     23: 
                     24: typedef struct sha3_shake_t sha3_shake_t;
                     25: 
                     26: #include <crypto/xofs/xof.h>
                     27: 
                     28: /**
                     29:  * Implementation of xof_t interface using the SHA-3 XOF algorithm family
                     30:  * SHAKE128 and SHAKE256 as defined by FIPS-202.
                     31:  */
                     32: struct sha3_shake_t {
                     33: 
                     34:        /**
                     35:         * Generic xof_t interface for this Extended Output Function (XOF).
                     36:         */
                     37:        xof_t xof_interface;
                     38: };
                     39: 
                     40: /**
                     41:  * Creates a new sha3_shake_t.
                     42:  *
                     43:  * @param      algorithm       XOF_SHAKE_128 or XOF_SHAKE_256
                     44:  * @return                             sha3_shake_t object, NULL if not supported
                     45:  */
                     46: sha3_shake_t* sha3_shake_create(ext_out_function_t algorithm);
                     47: 
                     48: #endif /** SHA3_SHAKE_H_ @}*/

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>