- code cleaned up

[thirdparty/strongswan.git] / Source / charon / encoding / payloads / nonce_payload.h

/**
 * @file nonce_payload.h
 * 
 * @brief Interface of nonce_payload_t.
 * 
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * 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.
 */

#ifndef NONCE_PAYLOAD_H_
#define NONCE_PAYLOAD_H_

#include <types.h>
#include <encoding/payloads/payload.h>

/**
 * 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 draft section 3.3.
 * 
 * @ingroup payloads
 * 
 */
struct nonce_payload_t {
	/**
	 * The payload_t interface.
	 */
	payload_t payload_interface;

	/**
	 * @brief Set the nonce value.
	 * 
	 * The nonce must have length between 16 and 256 bytes.
	 *
	 * @param this 			calling nonce_payload_t object
	 * @param nonce	  		chunk containing the nonce, will be cloned
	 * @return 				
	 * 						- SUCCESS or
	 * 						- INVALID_ARG, if nonce has an invalid size
	 */
	status_t (*set_nonce) (nonce_payload_t *this, chunk_t nonce);
	
	/**
	 * @brief Get the nonce value.
	 *
	 * @param this 			calling nonce_payload_t object
	 * @param[out] nonce	chunk where nonce data is located (cloned)
	 */
	void (*get_nonce) (nonce_payload_t *this, chunk_t *nonce);
	
	/**
	 * @brief Destroys an nonce_payload_t object.
	 *
	 * @param this 	nonce_payload_t object to destroy
	 */
	void (*destroy) (nonce_payload_t *this);
};

/**
 * @brief Creates an empty nonce_payload_t object
 * 
 * @return			created nonce_payload_t object
 * 
 * @ingroup payloads
 */
 
nonce_payload_t *nonce_payload_create();


#endif /*NONCE_PAYLOAD_H_*/