Represents an IPSec Authentication Header. More...

#include <ipsec.h>

Inheritance diagram for Tins::IPSecESP:

Public Member Functions
	IPSecESP ()
	Default constructor.

	IPSecESP (const uint8_t *buffer, uint32_t total_sz)
	Constructs an IPSecESP object from a buffer and adds all identifiable PDUs found in the buffer as children of this one. More...

uint32_t	spi () const
	Getter for the Security Parameters Index field. More...

uint32_t	seq_number () const
	Getter for the Sequence number field. More...

void	spi (uint32_t new_spi)
	Setter for the Security Parameters Index field. More...

void	seq_number (uint32_t new_seq_number)
	Setter for the Sequence number field. More...

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

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

IPSecESP *	clone () const

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...

virtual uint32_t	advertised_size () const
	The whole chain of PDU's advertised 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...

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

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

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

Additional Inherited Members
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 , DOT1AD , DOT1Q , PPPOE , STP , PPI , IPSEC_AH , IPSEC_ESP , PKTAP , MPLS , DOT11_CONTROL_TA , VXLAN , UNKNOWN = 999 , USER_DEFINED_PDU = 1000 }
	Enum which identifies each type of PDU. More...

typedef byte_array	serialization_type

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...

Detailed Description

Represents an IPSec Authentication Header.

Constructor & Destructor Documentation

◆ IPSecESP()

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

Constructs an IPSecESP object from a buffer and adds all identifiable PDUs found in the buffer as children of this one.

If there is not enough size for an IPSecESP header, 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

◆ clone()

IPSecESP* Tins::IPSecESP::clone ( ) const

inlinevirtual

See also: PDU::clone

Implements Tins::PDU.

◆ header_size()

uint32_t Tins::IPSecESP::header_size ( ) const

virtual

Returns the header size.

This method overrides PDU::header_size.

See also: PDU::header_size

Implements Tins::PDU.

◆ pdu_type()

PDUType Tins::IPSecESP::pdu_type ( ) const

inlinevirtual

Getter for the PDU's type.

See also: PDU::pdu_type

Implements Tins::PDU.

◆ seq_number() [1/2]

uint32_t Tins::IPSecESP::seq_number ( ) const

inline

Getter for the Sequence number field.

Returns: The stored Sequence number field value.

◆ seq_number() [2/2]

void Tins::IPSecESP::seq_number ( uint32_t new_seq_number )

Setter for the Sequence number field.

Parameters

new_seq_number The new Sequence number field value.

◆ spi() [1/2]

uint32_t Tins::IPSecESP::spi ( ) const

inline

Getter for the Security Parameters Index field.

Returns: The stored Security Parameters Index field value.

◆ spi() [2/2]

void Tins::IPSecESP::spi ( uint32_t new_spi )

Setter for the Security Parameters Index field.

Parameters

new_spi The new Security Parameters Index field value.

Member Data Documentation

◆ pdu_flag

const PDU::PDUType Tins::IPSecESP::pdu_flag = PDU::IPSEC_ESP

static

This PDU's flag.

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

/builddir/build/BUILD/libtins-4.5/include/tins/ipsec.h
/builddir/build/BUILD/libtins-4.5/src/ipsec.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IPSecESP()

Member Function Documentation

◆ clone()

◆ header_size()

◆ pdu_type()

◆ seq_number() [1/2]

◆ seq_number() [2/2]

◆ spi() [1/2]

◆ spi() [2/2]

Member Data Documentation

◆ pdu_flag