increase nonce size to 32 bytes, required when using SHA384/512 PRFs
[strongswan.git] / src / charon / encoding / payloads / nonce_payload.h
index 9365bb5..9cb7583 100644 (file)
@@ -1,12 +1,6 @@
-/**
- * @file nonce_payload.h
- * 
- * @brief Interface of nonce_payload_t.
- * 
- */
-
 /*
- * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Copyright (C) 2005-2006 Martin Willi
+ * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
  *
  * This program is free software; you can redistribute it and/or modify it
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup nonce_payload nonce_payload
+ * @{ @ingroup payloads
  */
 
 #ifndef NONCE_PAYLOAD_H_
 #define NONCE_PAYLOAD_H_
 
-#include <types.h>
+typedef struct nonce_payload_t nonce_payload_t;
+
+#include <library.h>
 #include <encoding/payloads/payload.h>
 
 /**
  * Nonce size in bytes for nonces sending to other peer.
- * 
- * @warning Nonce size MUST be between 16 and 256 bytes.
- * 
- * @ingroup payloads
  */
-#define NONCE_SIZE 16
+#define NONCE_SIZE 32
 
 /**
  * Length of a nonce payload without a nonce in bytes.
- * 
- * @ingroup payloads
  */
 #define NONCE_PAYLOAD_HEADER_LENGTH 4
 
-typedef struct nonce_payload_t nonce_payload_t;
-
 /**
  * Object representing an IKEv2 Nonce payload.
  * 
  * The Nonce payload format is described in RFC section 3.3.
- * 
- * @b Constructors:
- * - nonce_payload_create()
- * 
- * @ingroup payloads
  */
 struct nonce_payload_t {
        /**
@@ -61,38 +51,30 @@ struct nonce_payload_t {
        payload_t payload_interface;
 
        /**
-        * @brief Set the nonce value.
+        * Set the nonce value.
         *
-        * @param this                  calling nonce_payload_t object
         * @param nonce                 chunk containing the nonce, will be cloned
         */
        void (*set_nonce) (nonce_payload_t *this, chunk_t nonce);
        
        /**
-        * @brief Get the nonce value.
+        * Get the nonce value.
         *
-        * @param this                  calling nonce_payload_t object
         * @return                              a chunk containing the cloned nonce
         */
        chunk_t (*get_nonce) (nonce_payload_t *this);
        
        /**
-        * @brief Destroys an nonce_payload_t object.
-        *
-        * @param this  nonce_payload_t object to destroy
+        * Destroys an nonce_payload_t object.
         */
        void (*destroy) (nonce_payload_t *this);
 };
 
 /**
- * @brief Creates an empty nonce_payload_t object
+ * Creates an empty nonce_payload_t object
  * 
  * @return nonce_payload_t object
- * 
- * @ingroup payloads
  */
 nonce_payload_t *nonce_payload_create(void);
 
-
-#endif /*NONCE_PAYLOAD_H_*/
+#endif /*NONCE_PAYLOAD_H_ @} */