openikev2::Payload_EAP

openikev2::Payload_EAP Class Reference

This class represents an EAP transport payload. More...

#include <payload_eap.h>

Inheritance diagram for openikev2::Payload_EAP:

Inheritance graph
[legend]
List of all members.

Public Types

enum  EAP_CODE {
  EAP_CODE_NONE = 0, EAP_CODE_REQUEST = 1, EAP_CODE_RESPONSE = 2, EAP_CODE_SUCCESS = 3,
  EAP_CODE_FAILURE = 4
}
 EAP codes. More...
enum  EAP_TYPE {
  EAP_TYPE_NONE = 0, EAP_TYPE_IDENTITY = 1, EAP_TYPE_NOTIFICATION = 2, EAP_TYPE_NAK = 3,
  EAP_TYPE_MD5_CHALLENGE = 4, EAP_TYPE_ONE_TIME_PASSWD = 5, EAP_TYPE_GENERIC_TOKEN_CARD = 6, EAP_TYPE_RSA_PK_AUTH = 9,
  EAP_TYPE_DSS_UNILATERAL = 10, EAP_TYPE_KEA = 11, EAP_TYPE_KEA_VALIDATE = 12, EAP_TYPE_EAP_TLS = 13,
  EAP_TYPE_DEFENDER_TOKEN = 14, EAP_TYPE_RSA_SECURID = 15, EAP_TYPE_ARCOT_SYSTEMS = 16, EAP_TYPE_CISCO_WIRELESS = 17,
  EAP_TYPE_EAP_SIM = 18, EAP_TYPE_SRP_SHA1 = 19, EAP_TYPE_EAP_TTLS = 21, EAP_TYPE_RAS = 22,
  EAP_TYPE_EAP_AKA = 23, EAP_TYPE_EAP_3COM_WIRELESS = 24, EAP_TYPE_PEAP = 25, EAP_TYPE_MS_EAP_AUTH = 26,
  EAP_TYPE_MAKE = 27, EAP_TYPE_CRYPTO_CARD = 28, EAP_TYPE_EAP_MSCHAP_V2 = 29, EAP_TYPE_DYNAM_ID = 30,
  EAP_TYPE_ROB_EAP = 31, EAP_TYPE_POTP = 32, EAP_TYPE_MS_AUTH_TLV = 33, EAP_TYPE_SENTRINET = 34,
  EAP_TYPE_EAP_ACTIONTEC_WIRELESS = 35, EAP_TYPE_COGENT_BIO_AUTH = 36, EAP_TYPE_AIRFORTRESS = 37, EAP_TYPE_HTTP_DIGEST = 38,
  EAP_TYPE_SECURE_SUITE = 39, EAP_TYPE_DEVICE_CONNECT = 40, EAP_TYPE_SPEKE = 41, EAP_TYPE_MOBAC = 42,
  EAP_TYPE_FAST = 43, EAP_TYPE_ZLXEAP = 44, EAP_TYPE_LINK = 45, EAP_TYPE_PAX = 46
}
 EAP types. More...

Public Member Functions

 Payload_EAP (EAP_CODE code, uint8_t identifier, EAP_TYPE eap_type, auto_ptr< ByteArray > eap_type_data)
 Creates a new Payload_EAP containing a REQUEST/RESPONSE.
 Payload_EAP (EAP_CODE code, uint8_t identifier)
 Creates a new Payload_EAP containing a SUCCESS/FAILURE.
 Payload_EAP (const Payload_EAP &other)
 Creates a new Payload_EAP cloning another one.
 Payload_EAP (ByteBuffer &byte_buffer)
 Creates a new Payload_EAP based on its binary representation.
virtual void getBinaryRepresentation (ByteBuffer &byte_buffer) const
 Appends the binary representation of the Payload at the end of the buffer, without the fixed header.
virtual string toStringTab (uint8_t tabs) const
 Construct a textual representation of the object, preceded of a num of tabs of size TAB_SIZE.
virtual auto_ptr< Payload > clone () const
 Cets a clone of this payload.

Static Public Member Functions

static string EAP_CODE_STR (uint16_t eap_code)
 Translate the enumeration values to String.
static string EAP_TYPE_STR (uint16_t eap_type)
 Translate the enumeration values to String.

Public Attributes

EAP_CODE code
 EAP message code.
uint8_t identifier
 EAP message identifier.
EAP_TYPE eap_type
 EAP message type.
auto_ptr< ByteArray > eap_type_data
 EAP message type data.

Detailed Description

This class represents an EAP transport payload.

Author:
Alejandro Perez Mendez, Pedro J. Fernandez Ruiz <alejandro_perez@dif.um.es, pedroj.fernandez@dif.um.es>

Member Enumeration Documentation

enum openikev2::Payload_EAP::EAP_CODE

EAP codes.

Enumerator:
EAP_CODE_NONE  EAP NONE.
EAP_CODE_REQUEST  EAP request.
EAP_CODE_RESPONSE  EAP response.
EAP_CODE_SUCCESS  EAP success.
EAP_CODE_FAILURE  EAP failure.

enum openikev2::Payload_EAP::EAP_TYPE

EAP types.

Enumerator:
EAP_TYPE_NONE  RESERVED.
EAP_TYPE_IDENTITY  Identity.
EAP_TYPE_NOTIFICATION  Notification.
EAP_TYPE_NAK  Legacy NAK.
EAP_TYPE_MD5_CHALLENGE  MD5-Challenge.
EAP_TYPE_ONE_TIME_PASSWD  One time password (OTP).
EAP_TYPE_GENERIC_TOKEN_CARD  Generic Token Card (GTC).
EAP_TYPE_RSA_PK_AUTH  RSA Public Key Authentication.
EAP_TYPE_DSS_UNILATERAL  DSS Unilateral.
EAP_TYPE_KEA  KEA.
EAP_TYPE_KEA_VALIDATE  KEA-VALIDATE.
EAP_TYPE_EAP_TLS  EAP-TLS.
EAP_TYPE_DEFENDER_TOKEN  Defender token (AXENT).
EAP_TYPE_RSA_SECURID  RSA Security SecurID EAP.
EAP_TYPE_ARCOT_SYSTEMS  Arcot Systems EAP.
EAP_TYPE_CISCO_WIRELESS  EAP-Cisco Wireless.
EAP_TYPE_EAP_SIM  GSM Subscriber Identity Modules (EAP-SIM).
EAP_TYPE_SRP_SHA1  SRP-SHA1.
EAP_TYPE_EAP_TTLS  EAP-TTLS.
EAP_TYPE_RAS  Remote Access Service.
EAP_TYPE_EAP_AKA  EAP-AKA Authentication.
EAP_TYPE_EAP_3COM_WIRELESS  EAP-3Com Wireless.
EAP_TYPE_PEAP  PEAP.
EAP_TYPE_MS_EAP_AUTH  MS-EAP-Authentication.
EAP_TYPE_MAKE  Mutual Authentication w/Key Exchange (MAKE).
EAP_TYPE_CRYPTO_CARD  CRYPTOCard.
EAP_TYPE_EAP_MSCHAP_V2  EAP-MSCHAP-V2.
EAP_TYPE_DYNAM_ID  DynamID.
EAP_TYPE_ROB_EAP  Rob EAP.
EAP_TYPE_POTP  Protected One-Time Password.
EAP_TYPE_MS_AUTH_TLV  MS-Authentication-TLV.
EAP_TYPE_SENTRINET  SentriNET.
EAP_TYPE_EAP_ACTIONTEC_WIRELESS  EAP-Actiontec Wireless.
EAP_TYPE_COGENT_BIO_AUTH  Cogent Systems Biometrics Authentication EAP.
EAP_TYPE_AIRFORTRESS  AirFortress EAP.
EAP_TYPE_HTTP_DIGEST  EAP-HTTP Digest.
EAP_TYPE_SECURE_SUITE  SecureSuite EAP.
EAP_TYPE_DEVICE_CONNECT  DeviceConnect EAP.
EAP_TYPE_SPEKE  EAP-SPEKE.
EAP_TYPE_MOBAC  EAP-MOBAC.
EAP_TYPE_FAST  EAP-FAST.
EAP_TYPE_ZLXEAP  ZoneLabs EAP (ZLXEAP).
EAP_TYPE_LINK  EAP-Link.
EAP_TYPE_PAX  EAP-PAX.

Constructor & Destructor Documentation

openikev2::Payload_EAP::Payload_EAP ( EAP_CODE  code,
uint8_t  identifier,
EAP_TYPE  eap_type,
auto_ptr< ByteArray >  eap_type_data 
)

Creates a new Payload_EAP containing a REQUEST/RESPONSE.

Parameters:
code EAP message code (only REQUEST or RESPONSE)
identifier EAP message identifier
eap_type EAP message type
eap_type_data EAP message data type

openikev2::Payload_EAP::Payload_EAP ( EAP_CODE  code,
uint8_t  identifier 
)

Creates a new Payload_EAP containing a SUCCESS/FAILURE.

Parameters:
code EAP message code (only SUCCESS or FAILURE)
identifier EAP message identifier

openikev2::Payload_EAP::Payload_EAP ( const Payload_EAP &  other  ) 

Creates a new Payload_EAP cloning another one.

Parameters:
other Other Payload_EAP to be cloned.

openikev2::Payload_EAP::Payload_EAP ( ByteBuffer &  byte_buffer  ) 

Creates a new Payload_EAP based on its binary representation.

Parameters:
byte_buffer Buffer with its read pointer at the "payload length" field

Member Function Documentation

string openikev2::Payload_EAP::EAP_CODE_STR ( uint16_t  eap_code  )  [static]

Translate the enumeration values to String.

Parameters:
eap_code Enumeration value
Returns:
String with the eap_code

string openikev2::Payload_EAP::EAP_TYPE_STR ( uint16_t  eap_type  )  [static]

Translate the enumeration values to String.

Parameters:
eap_type Enumeration value
Returns:
String with the eap_type

void openikev2::Payload_EAP::getBinaryRepresentation ( ByteBuffer &  byte_buffer  )  const [virtual]

Appends the binary representation of the Payload at the end of the buffer, without the fixed header.

Parameters:
byte_buffer Byte buffer where append the binary representation

Implements openikev2::Payload.

string openikev2::Payload_EAP::toStringTab ( uint8_t  tabs  )  const [virtual]

Construct a textual representation of the object, preceded of a num of tabs of size TAB_SIZE.

Parameters:
tabs Num of tabs preceding the textual representation.
Returns:
Textual tabulated represetation of the object.

Implements openikev2::Payload.

auto_ptr< Payload > openikev2::Payload_EAP::clone (  )  const [virtual]

Cets a clone of this payload.

Returns:
Clone of the payload.

Implements openikev2::Payload.

Generated on Fri Jul 27 11:04:54 2007 for libopenikev2 by  doxygen 1.5.1