Class that represents the RC4 EAPOL PDU. More...

#include <eapol.h>

Inheritance diagram for Tins::RC4EAPOL:

Public Types
typedef std::vector< uint8_t >	key_type

Public Types inherited from Tins::EAPOL
enum	EAPOLTYPE { RC4 = 1, RSN, EAPOL_WPA = 254 }

Public Types inherited from Tins::PDU
enum	endian_type { BE, LE }

enum	PDUType { RAW, ETHERNET_II, IEEE802_3, DOT3 = IEEE802_3, RADIOTAP, DOT11, DOT11_ACK, DOT11_ASSOC_REQ, DOT11_ASSOC_RESP, DOT11_AUTH, DOT11_BEACON, DOT11_BLOCK_ACK, DOT11_BLOCK_ACK_REQ, DOT11_CF_END, DOT11_DATA, DOT11_CONTROL, DOT11_DEAUTH, DOT11_DIASSOC, DOT11_END_CF_ACK, DOT11_MANAGEMENT, DOT11_PROBE_REQ, DOT11_PROBE_RESP, DOT11_PS_POLL, DOT11_REASSOC_REQ, DOT11_REASSOC_RESP, DOT11_RTS, DOT11_QOS_DATA, LLC, SNAP, IP, ARP, TCP, UDP, ICMP, BOOTP, DHCP, EAPOL, RC4EAPOL, RSNEAPOL, DNS, LOOPBACK, IPv6, ICMPv6, SLL, DHCPv6, DOT1Q, PPPOE, STP, PPI, IPSEC_AH, IPSEC_ESP, PKTAP, MPLS, UNKNOWN = 999, USER_DEFINED_PDU = 1000 }
	Enum which identifies each type of PDU. More...

typedef byte_array	serialization_type

Public Member Functions
	RC4EAPOL ()
	Default constructor.

	RC4EAPOL (const uint8_t *buffer, uint32_t total_sz)
	Constructs a RC4EAPOL object from a buffer. More...

uint16_t	key_length () const
	Getter for the key length field. More...

uint64_t	replay_counter () const
	Getter for the replay counter field. More...

const uint8_t *	key_iv () const
	Getter for the key IV field. More...

small_uint< 1 >	key_flag () const
	Getter for the key flag field. More...

small_uint< 7 >	key_index () const
	Getter for the key index field. More...

const uint8_t *	key_sign () const
	Getter for the key signature field. More...

const key_type &	key () const
	Getter for the key field. More...

void	key_length (uint16_t value)
	Sets the key length field. More...

void	replay_counter (uint64_t value)
	Sets the replay counter field. More...

void	key_iv (const uint8_t *value)
	Sets the key IV field. More...

void	key_flag (small_uint< 1 > value)
	Sets the key flag field. More...

void	key_index (small_uint< 7 > value)
	Sets the key index field. More...

void	key_sign (const uint8_t *value)
	Sets the key signature field. More...

void	key (const key_type &value)
	Sets the key field. More...

uint32_t	header_size () const
	Returns the header size. More...

PDUType	pdu_type () const
	Getter for the PDU's type. More...

bool	matches_flag (PDUType flag) const
	Check whether this PDU matches the specified flag. More...

RC4EAPOL *	clone () const
	Clones this PDU. More...

Public Member Functions inherited from Tins::EAPOL
uint8_t	version () const
	Getter for the version field. More...

uint8_t	packet_type () const
	Getter for the packet type field. More...

uint16_t	length () const
	Getter for the length field. More...

uint8_t	type () const
	Getter for the type field. More...

void	version (uint8_t value)
	Sets the version field. More...

void	packet_type (uint8_t value)
	Sets the packet type field. More...

void	length (uint16_t value)
	Sets the length field. More...

void	type (uint8_t value)
	Sets the type field. More...

Public Member Functions inherited from Tins::PDU
	PDU ()
	Default constructor.

	PDU (PDU &&rhs) TINS_NOEXCEPT
	Move constructor. More...

PDU &	operator= (PDU &&rhs) TINS_NOEXCEPT
	Move assignment operator. More...

virtual	~PDU ()
	PDU destructor. More...

virtual uint32_t	trailer_size () const
	Trailer's size. More...

uint32_t	size () const
	The whole chain of PDU's size, including this one. More...

PDU *	inner_pdu () const
	Getter for the inner PDU. More...

PDU *	parent_pdu () const

PDU *	release_inner_pdu ()
	Releases the inner PDU. More...

void	inner_pdu (PDU *next_pdu)
	Sets the child PDU. More...

void	inner_pdu (const PDU &next_pdu)
	Sets the child PDU. More...

serialization_type	serialize ()
	Serializes the whole chain of PDU's, including this one. More...

template<typename T >
T *	find_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
const T *	find_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
T &	rfind_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
const T &	rfind_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag. More...

virtual void	send (PacketSender &sender, const NetworkInterface &iface)
	Send the stack of PDUs through a PacketSender. More...

virtual PDU *	recv_response (PacketSender &sender, const NetworkInterface &iface)
	Receives a matching response for this packet. More...

virtual bool	matches_response (const uint8_t *ptr, uint32_t total_sz) const
	Check whether ptr points to a valid response for this PDU. More...

Static Public Attributes
static const PDU::PDUType	pdu_flag = PDU::RC4EAPOL

static const size_t	key_iv_size = 16

static const size_t	key_sign_size = 16

Static Public Attributes inherited from Tins::EAPOL
static const PDU::PDUType	pdu_flag = PDU::EAPOL
	This PDU's flag.

Static Public Attributes inherited from Tins::PDU
static const endian_type	endianness = BE

Additional Inherited Members
Static Public Member Functions inherited from Tins::EAPOL
static metadata	extract_metadata (const uint8_t *buffer, uint32_t total_sz)
	Extracts metadata for this protocol based on the buffer provided. More...

static EAPOL *	from_bytes (const uint8_t *buffer, uint32_t total_sz)
	Static method to instantiate the correct EAPOL subclass based on a raw buffer. More...

Protected Member Functions inherited from Tins::EAPOL
	EAPOL (uint8_t packet_type, EAPOLTYPE type)
	Protected constructor that sets the packet_type and type fields.

	EAPOL (const uint8_t *buffer, uint32_t total_sz)
	Constructor which creates an EAPOL object from a buffer. More...

Protected Member Functions inherited from Tins::PDU
	PDU (const PDU &other)
	Copy constructor.

PDU &	operator= (const PDU &other)
	Copy assignment operator.

void	copy_inner_pdu (const PDU &pdu)
	Copy other PDU's inner PDU(if any). More...

virtual void	prepare_for_serialize ()
	Prepares this PDU for serialization. More...

void	serialize (uint8_t *buffer, uint32_t total_sz)
	Serializes this PDU and propagates this action to child PDUs. More...

Protected Attributes inherited from Tins::EAPOL
TINS_BEGIN_PACK struct Tins::EAPOL::eapol_header	TINS_END_PACK

Detailed Description

Class that represents the RC4 EAPOL PDU.

Member Typedef Documentation

typedef std::vector<uint8_t> Tins::RC4EAPOL::key_type

The type used to store the key.

Constructor & Destructor Documentation

Tins::RC4EAPOL::RC4EAPOL	(	const uint8_t *	buffer,
		uint32_t	total_sz
	)

Constructs a RC4EAPOL object from a buffer.

If there is not enough size for a RC4EAPOL header in the buffer, a malformed_packet exception is thrown.

Parameters

buffer	The buffer from which this PDU will be constructed.
total_sz	The total size of the buffer.

Member Function Documentation

RC4EAPOL* Tins::RC4EAPOL::clone ( ) const

inlinevirtual

Clones this PDU.

See also: PDU::clone

Implements Tins::PDU.

uint32_t Tins::RC4EAPOL::header_size ( ) const

virtual

Returns the header size.

This method overrides PDU::header_size. This size includes the payload and options size.

See also: PDU::header_size

Implements Tins::PDU.

const key_type& Tins::RC4EAPOL::key ( ) const

inline

Getter for the key field.

Returns: The key field.

void Tins::RC4EAPOL::key ( const key_type & value )

Sets the key field.

Parameters

value The new key to be set.

small_uint<1> Tins::RC4EAPOL::key_flag ( ) const

inline

Getter for the key flag field.

Returns: The key flag field.

void Tins::RC4EAPOL::key_flag ( small_uint< 1 > value )

Sets the key flag field.

Parameters

value The new key flag to be set.

small_uint<7> Tins::RC4EAPOL::key_index ( ) const

inline

Getter for the key index field.

Returns: The key index field.

void Tins::RC4EAPOL::key_index ( small_uint< 7 > value )

Sets the key index field.

Parameters

value The new key index to be set.

const uint8_t* Tins::RC4EAPOL::key_iv ( ) const

inline

Getter for the key IV field.

Returns: The key IV field.

void Tins::RC4EAPOL::key_iv ( const uint8_t * value )

Sets the key IV field.

Parameters

value The new key IV to be set.

uint16_t Tins::RC4EAPOL::key_length ( ) const

inline

Getter for the key length field.

Returns: The key length field.

void Tins::RC4EAPOL::key_length ( uint16_t value )

Sets the key length field.

Parameters

value The new key length to be set.

const uint8_t* Tins::RC4EAPOL::key_sign ( ) const

inline

Getter for the key signature field.

Returns: The key signature field.

void Tins::RC4EAPOL::key_sign ( const uint8_t * value )

Sets the key signature field.

Parameters

value The new key signature to be set.

bool Tins::RC4EAPOL::matches_flag ( PDUType flag ) const

inlinevirtual

Check whether this PDU matches the specified flag.

Parameters

flag	The flag to match

See also: PDU::matches_flag

Reimplemented from Tins::PDU.

PDUType Tins::RC4EAPOL::pdu_type ( ) const

inlinevirtual

Getter for the PDU's type.

Returns: Returns the PDUType corresponding to the PDU.

Reimplemented from Tins::EAPOL.

uint64_t Tins::RC4EAPOL::replay_counter ( ) const

inline

Getter for the replay counter field.

Returns: The replay counter field.

void Tins::RC4EAPOL::replay_counter ( uint64_t value )

Sets the replay counter field.

Parameters

value The new replay counter to be set.

Member Data Documentation

const size_t Tins::RC4EAPOL::key_iv_size = 16

static

The length of the key IV field

const size_t Tins::RC4EAPOL::key_sign_size = 16

static

The length of the key sign field

const PDU::PDUType Tins::RC4EAPOL::pdu_flag = PDU::RC4EAPOL

static

This PDU's flag.

The documentation for this class was generated from the following files:

/home/matias/Projects/libtins/code/include/tins/eapol.h
/home/matias/Projects/libtins/code/src/eapol.cpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation