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

1.1       misho       1: /*
                      2:  * Copyright (C) 2015 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_hasher sha3_hasher
                     18:  * @{ @ingroup sha3_p
                     19:  */
                     20: 
                     21: #ifndef SHA3_HASHER_H_
                     22: #define SHA3_HASHER_H_
                     23: 
                     24: typedef struct sha3_hasher_t sha3_hasher_t;
                     25: 
                     26: #include <crypto/hashers/hasher.h>
                     27: 
                     28: /**
                     29:  * Implementation of hasher_t interface using the SHA-3 algorithm family
                     30:  * SHA3_224, SHA3_256, SHA3_384 and SHA3_512 as defined by FIPS-202.
                     31:  */
                     32: struct sha3_hasher_t {
                     33: 
                     34:        /**
                     35:         * Generic hasher_t interface for this hasher.
                     36:         */
                     37:        hasher_t hasher_interface;
                     38: };
                     39: 
                     40: /**
                     41:  * Creates a new sha3_hasher_t.
                     42:  *
                     43:  * @param      algorithm       HASH3_224, HASH_SHA3_256, HASH_SHA3_384 or HASH_SHA3_512
                     44:  * @return                             sha3_hasher_t object, NULL if not supported
                     45:  */
                     46: sha3_hasher_t *sha3_hasher_create(hash_algorithm_t algorithm);
                     47: 
                     48: #endif /** SHA3_HASHER_H_ @}*/

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