diff options
Diffstat (limited to 'src/charon/encoding/payloads/eap_payload.h')
-rw-r--r-- | src/charon/encoding/payloads/eap_payload.h | 90 |
1 files changed, 67 insertions, 23 deletions
diff --git a/src/charon/encoding/payloads/eap_payload.h b/src/charon/encoding/payloads/eap_payload.h index bf493eb7f..13c0ade80 100644 --- a/src/charon/encoding/payloads/eap_payload.h +++ b/src/charon/encoding/payloads/eap_payload.h @@ -28,6 +28,7 @@ typedef struct eap_payload_t eap_payload_t; #include <library.h> #include <encoding/payloads/payload.h> +#include <sa/authenticators/eap/eap_method.h> /** * Length of a EAP payload without the EAP Message in bytes. @@ -44,62 +45,105 @@ typedef struct eap_payload_t eap_payload_t; * @b Constructors: * - eap_payload_create() * - * @todo Implement functionality for this payload - * * @ingroup payloads */ struct eap_payload_t { + /** * The payload_t interface. */ payload_t payload_interface; /** - * @brief Set the EAP Message. - * - * Data are getting cloned. + * @brief Set the contained EAP data. + * + * This contains the FULL EAP message starting with "code". + * Chunk gets cloned. + * + * @param this calling eap_payload_t object + * @param message EAP data + */ + void (*set_data) (eap_payload_t *this, chunk_t data); + + /** + * @brief Get the contained EAP data. + * + * This contains the FULL EAP message starting with "code". * - * @param this calling eap_payload_t object - * @param message EAP message as chunk_t + * @param this calling eap_payload_t object + * @return EAP data (pointer to internal data) */ - void (*set_message) (eap_payload_t *this, chunk_t message); + chunk_t (*get_data) (eap_payload_t *this); /** - * @brief Get the EAP message. - * - * Returned data are a copy of the internal one. + * @brief Get the EAP code. * - * @param this calling eap_payload_t object - * @return EAP message as chunk_t + * @param this calling eap_payload_t object + * @return EAP message as chunk_t */ - chunk_t (*get_message_clone) (eap_payload_t *this); + eap_code_t (*get_code) (eap_payload_t *this); /** - * @brief Get the EAP message. - * - * Returned data are NOT copied. + * @brief Get the EAP identifier. * - * @param this calling eap_payload_t object - * @return EAP message as chunk_t + * @param this calling eap_payload_t object + * @return unique identifier */ - chunk_t (*get_message) (eap_payload_t *this); + u_int8_t (*get_identifier) (eap_payload_t *this); + + /** + * @brief Get the EAP method type. + * + * @param this calling eap_payload_t object + * @return EAP method type + */ + eap_type_t (*get_type) (eap_payload_t *this); /** * @brief Destroys an eap_payload_t object. * - * @param this eap_payload_t object to destroy + * @param this eap_payload_t object to destroy */ void (*destroy) (eap_payload_t *this); }; /** * @brief Creates an empty eap_payload_t object. - * + * * @return eap_payload_t object - * + * * @ingroup payloads */ eap_payload_t *eap_payload_create(void); +/** + * @brief Creates an eap_payload_t object with data. + * + * @return eap_payload_t object + * + * @ingroup payloads + */ +eap_payload_t *eap_payload_create_data(chunk_t data); + +/** + * @brief Creates an eap_payload_t object with a code. + * + * Could should be either EAP_SUCCESS/EAP_FAILURE, use + * constructor above otherwise. + * + * @return eap_payload_t object + * + * @ingroup payloads + */ +eap_payload_t *eap_payload_create_code(eap_code_t code); + +/** + * @brief Creates an eap_payload_t EAP_RESPONSE containing an EAP_NAK. + * + * @return eap_payload_t object + * + * @ingroup payloads + */ +eap_payload_t *eap_payload_create_nak(); #endif /* EAP_PAYLOAD_H_ */ |