diff options
author | Jan Hutter <jhutter@hsr.ch> | 2005-12-05 18:56:22 +0000 |
---|---|---|
committer | Jan Hutter <jhutter@hsr.ch> | 2005-12-05 18:56:22 +0000 |
commit | c81eb6e77ca17136ddff82fe93433007f9b93681 (patch) | |
tree | d299af38a1439fe661c43ef4bce5a1dd2cced262 /Source/charon/encoding/payloads/eap_payload.h | |
parent | 7ba3f707df54449e3119fb50e684862898aa998c (diff) | |
download | strongswan-c81eb6e77ca17136ddff82fe93433007f9b93681.tar.bz2 strongswan-c81eb6e77ca17136ddff82fe93433007f9b93681.tar.xz |
- Implemented and tested eap_payload_t
Diffstat (limited to 'Source/charon/encoding/payloads/eap_payload.h')
-rw-r--r-- | Source/charon/encoding/payloads/eap_payload.h | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/Source/charon/encoding/payloads/eap_payload.h b/Source/charon/encoding/payloads/eap_payload.h new file mode 100644 index 000000000..b7b466769 --- /dev/null +++ b/Source/charon/encoding/payloads/eap_payload.h @@ -0,0 +1,101 @@ +/** + * @file eap_payload.h + * + * @brief Interface of eap_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 _EAP_PAYLOAD_H_ +#define _EAP_PAYLOAD_H_ + +#include <types.h> +#include <encoding/payloads/payload.h> + +/** + * Length of a EAP payload without the EAP Message in bytes. + * + * @ingroup payloads + */ +#define EAP_PAYLOAD_HEADER_LENGTH 4 + + +typedef struct eap_payload_t eap_payload_t; + +/** + * Object representing an IKEv2 EAP payload. + * + * The EAP payload format is described in draft section 3.16. + * + * @ingroup payloads + * + */ +struct eap_payload_t { + /** + * The payload_t interface. + */ + payload_t payload_interface; + + /** + * @brief Set the EAP Message. + * + * Data are getting cloned. + * + * @param this calling eap_payload_t object + * @param message EAP message as chunk_t + */ + void (*set_message) (eap_payload_t *this, chunk_t message); + + /** + * @brief Get the EAP message. + * + * Returned data are a copy of the internal one. + * + * @param this calling eap_payload_t object + * @return EAP message as chunk_t + */ + chunk_t (*get_message_clone) (eap_payload_t *this); + + /** + * @brief Get the EAP message. + * + * Returned data are NOT copied. + * + * @param this calling eap_payload_t object + * @return EAP message as chunk_t + */ + chunk_t (*get_message) (eap_payload_t *this); + + /** + * @brief Destroys an eap_payload_t object. + * + * @param this eap_payload_t object to destroy + */ + void (*destroy) (eap_payload_t *this); +}; + +/** + * @brief Creates an empty eap_payload_t object. + * + * @return created eap_payload_t object + * + * @ingroup payloads + */ +eap_payload_t *eap_payload_create(); + + +#endif //_EAP_PAYLOAD_H_ |