Return to nonce_gen.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libstrongswan / crypto

Annotation of embedaddon/strongswan/src/libstrongswan/crypto/nonce_gen.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2012 Adrian-Ken Rueegsegger
                      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 nonce_gen nonce_gen
                     18:  * @{ @ingroup crypto
                     19:  */
                     20: 
                     21: #ifndef NONCE_GEN_H_
                     22: #define NONCE_GEN_H_
                     23: 
                     24: typedef struct nonce_gen_t nonce_gen_t;
                     25: 
                     26: #include <library.h>
                     27: 
                     28: /**
                     29:  * Generic interface for nonce generators.
                     30:  */
                     31: struct nonce_gen_t {
                     32: 
                     33:        /**
                     34:         * Generates a nonce and writes it into the buffer.
                     35:         *
                     36:         * @param size          size of nonce in bytes
                     37:         * @param buffer        pointer where the generated nonce will be written
                     38:         * @return                      TRUE if nonce allocation was successful, FALSE otherwise
                     39:         */
                     40:        bool (*get_nonce)(nonce_gen_t *this, size_t size,
                     41:                                          uint8_t *buffer) __attribute__((warn_unused_result));
                     42: 
                     43:        /**
                     44:         * Generates a nonce and allocates space for it.
                     45:         *
                     46:         * @param size          size of nonce in bytes
                     47:         * @param chunk         chunk which will hold the generated nonce
                     48:         * @return                      TRUE if nonce allocation was successful, FALSE otherwise
                     49:         */
                     50:        bool (*allocate_nonce)(nonce_gen_t *this, size_t size,
                     51:                                                   chunk_t *chunk) __attribute__((warn_unused_result));
                     52: 
                     53:        /**
                     54:         * Destroys a nonce generator object.
                     55:         */
                     56:        void (*destroy)(nonce_gen_t *this);
                     57: };
                     58: 
                     59: #endif /** NONCE_GEN_H_ @}*/