#include <bootp.h>

Inheritance diagram for Tins::BootP:

Classes
struct	bootp_header

Public Types
enum	OpCodes { BOOTREQUEST = 1 , BOOTREPLY = 2 }
	Enum which contains the different opcodes BootP messages.
typedef IPv4Address	ipaddress_type
typedef HWAddress< 16 >	chaddr_type
typedef std::vector< uint8_t >	vend_type
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

Public Member Functions
	BootP ()
	Creates an instance of BootP.
	BootP (const uint8_t *buffer, uint32_t total_sz, uint32_t vend_field_size=64)
	Constructs a BootP object from a buffer .
uint8_t	opcode () const
	Getter for the opcode field.
uint8_t	htype () const
	Getter for the htype field.
uint8_t	hlen () const
	Getter for the hlen field.
uint8_t	hops () const
	Getter for the hops field.
uint32_t	xid () const
	Getter for the xid field.
uint16_t	secs () const
	Getter for the secs field.
uint16_t	padding () const
	Getter for the padding field.
ipaddress_type	ciaddr () const
	Getter for the ciaddr field.
ipaddress_type	yiaddr () const
	Getter for the yiaddr field.
ipaddress_type	siaddr () const
	Getter for the siaddr field.
ipaddress_type	giaddr () const
	Getter for the giaddr field.
chaddr_type	chaddr () const
	Getter for the chaddr field.
const uint8_t *	sname () const
	Getter for the sname field.
const uint8_t *	file () const
	Getter for the file field.
const vend_type &	vend () const
	Getter for the vend field.
uint32_t	header_size () const
	Getter for the header size.
void	opcode (uint8_t code)
	Setter for the opcode field.
void	htype (uint8_t type)
	Setter for the hardware type field.
void	hlen (uint8_t length)
	Setter for the hlen field.
void	hops (uint8_t count)
	Setter for the hops field.
void	xid (uint32_t identifier)
	Setter for the xid field.
void	secs (uint16_t value)
	Setter for the secs field.
void	padding (uint16_t value)
	Setter for the padding field.
void	ciaddr (ipaddress_type address)
	Setter for the ciaddr field.
void	yiaddr (ipaddress_type address)
	Setter for the yiaddr field.
void	siaddr (ipaddress_type address)
	Setter for the siaddr field.
void	giaddr (ipaddress_type address)
	Setter for the giaddr field.
template<size_t n>
void	chaddr (const HWAddress< n > &new_chaddr)
	Setter for the chaddr field. The new_chaddr pointer must be at least BOOTP::hlen() bytes long.
void	sname (const uint8_t *new_sname)
	Setter for the sname field.
void	file (const uint8_t *new_file)
	Setter for the file field.
void	vend (const vend_type &newvend_)
	Setter for the vend field.
bool	matches_response (const uint8_t *ptr, uint32_t total_sz) const
	Check whether ptr points to a valid response for this PDU.
PDUType	pdu_type () const
	Getter for the PDU's type.
BootP *	clone () const
Public Member Functions inherited from Tins::PDU
	PDU ()
	Default constructor.
	PDU (PDU &&rhs) TINS_NOEXCEPT
	Move constructor.
PDU &	operator= (PDU &&rhs) TINS_NOEXCEPT
	Move assignment operator.
virtual	~PDU ()
	PDU destructor.
virtual uint32_t	trailer_size () const
	Trailer's size.
uint32_t	size () const
	The whole chain of PDU's size, including this one.
virtual uint32_t	advertised_size () const
	The whole chain of PDU's advertised size, including this one.
PDU *	inner_pdu () const
	Getter for the inner PDU.
PDU *	parent_pdu () const
PDU *	release_inner_pdu ()
	Releases the inner PDU.
void	inner_pdu (PDU *next_pdu)
	Sets the child PDU.
void	inner_pdu (const PDU &next_pdu)
	Sets the child PDU.
serialization_type	serialize ()
	Serializes the whole chain of PDU's, including this one.
template<typename T>
T *	find_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag.
template<typename T>
const T *	find_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag.
template<typename T>
T &	rfind_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag.
template<typename T>
const T &	rfind_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag.
virtual void	send (PacketSender &sender, const NetworkInterface &iface)
	Send the stack of PDUs through a PacketSender.
virtual PDU *	recv_response (PacketSender &sender, const NetworkInterface &iface)
	Receives a matching response for this packet.
virtual bool	matches_flag (PDUType flag) const
	Check whether this PDU matches the specified flag.

Static Public Attributes
static const PDU::PDUType	pdu_flag = PDU::BOOTP
	This PDU's flag.
Static Public Attributes inherited from Tins::PDU
static const endian_type	endianness = BE

Protected Member Functions
vend_type &	vend ()
	Getter for the vend field.
void	write_serialization (uint8_t *buffer, uint32_t total_sz)
	Serializes this TCP PDU.
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).
virtual void	prepare_for_serialize ()
	Prepares this PDU for serialization.
void	serialize (uint8_t *buffer, uint32_t total_sz)
	Serializes this PDU and propagates this action to child PDUs.

Protected Attributes
TINS_BEGIN_PACK struct Tins::BootP::bootp_header	TINS_END_PACK

Detailed Description

Represents a BootP PDU.

Member Typedef Documentation

◆ chaddr_type

typedef HWAddress<16> Tins::BootP::chaddr_type

The type of the chaddr field.

◆ ipaddress_type

typedef IPv4Address Tins::BootP::ipaddress_type

The type of the IP addresses.

◆ vend_type

typedef std::vector<uint8_t> Tins::BootP::vend_type

The type of the vend field.

Constructor & Destructor Documentation

◆ BootP() [1/2]

Tins::BootP::BootP ( )

Creates an instance of BootP.

This sets the size of the vend field to 64, as the BootP RFC states.

◆ BootP() [2/2]

Tins::BootP::BootP	(	const uint8_t *	buffer,
		uint32_t	total_sz,
		uint32_t	vend_field_size = 64 )

Constructs a BootP object from a buffer .

If there's not enough size for a BootP header, then 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.
vend_field_size	The vend field size to allocate. Subclasses might use 0 to provide their own interpretation of this field.

Member Function Documentation

◆ chaddr() [1/2]

chaddr_type Tins::BootP::chaddr ( ) const

inline

Getter for the chaddr field.

Returns: The chddr field for this BootP PDU.

◆ chaddr() [2/2]

template<size_t n>

void Tins::BootP::chaddr ( const HWAddress< n > & new_chaddr )

inline

Setter for the chaddr field. The new_chaddr pointer must be at least BOOTP::hlen() bytes long.

Parameters

new_chaddr The chaddr to be set.

◆ ciaddr() [1/2]

ipaddress_type Tins::BootP::ciaddr ( ) const

inline

Getter for the ciaddr field.

Returns: The ciaddr field for this BootP PDU.

◆ ciaddr() [2/2]

void Tins::BootP::ciaddr ( ipaddress_type address )

Setter for the ciaddr field.

Parameters

address The ciaddr to be set.

◆ clone()

BootP * Tins::BootP::clone ( ) const

inlinevirtual

See also: PDU::clone

Implements Tins::PDU.

Reimplemented in Tins::DHCP.

◆ file() [1/2]

const uint8_t * Tins::BootP::file ( ) const

inline

Getter for the file field.

Returns: The file field for this BootP PDU.

◆ file() [2/2]

void Tins::BootP::file ( const uint8_t * new_file )

Setter for the file field.

Parameters

new_file The file to be set.

◆ giaddr() [1/2]

ipaddress_type Tins::BootP::giaddr ( ) const

inline

Getter for the giaddr field.

Returns: The giaddr field for this BootP PDU.

◆ giaddr() [2/2]

void Tins::BootP::giaddr ( ipaddress_type address )

Setter for the giaddr field.

Parameters

address The giaddr to be set.

◆ header_size()

uint32_t Tins::BootP::header_size ( ) const

virtual

Getter for the header size.

Returns: Returns the BOOTP header size.

See also: PDU::header_size

Implements Tins::PDU.

Reimplemented in Tins::DHCP.

◆ hlen() [1/2]

uint8_t Tins::BootP::hlen ( ) const

inline

Getter for the hlen field.

Returns: The hlen field for this BootP PDU.

◆ hlen() [2/2]

void Tins::BootP::hlen ( uint8_t length )

Setter for the hlen field.

Parameters

length The hlen field value to be set.

◆ hops() [1/2]

uint8_t Tins::BootP::hops ( ) const

inline

Getter for the hops field.

Returns: The hops field for this BootP PDU.

◆ hops() [2/2]

void Tins::BootP::hops ( uint8_t count )

Setter for the hops field.

Parameters

count The hops field value to be set.

◆ htype() [1/2]

uint8_t Tins::BootP::htype ( ) const

inline

Getter for the htype field.

Returns: The htype field for this BootP PDU.

◆ htype() [2/2]

void Tins::BootP::htype ( uint8_t type )

Setter for the hardware type field.

Parameters

type	The hardware type field value to be set.

◆ matches_response()

bool Tins::BootP::matches_response	(	const uint8_t *	ptr,
		uint32_t	total_sz ) const

virtual

Check whether ptr points to a valid response for this PDU.

This returns true if the xid field is equal.

See also: PDU::matches_response

Parameters

ptr	The pointer to the buffer.
total_sz	The size of the buffer.

Reimplemented from Tins::PDU.

◆ opcode() [1/2]

uint8_t Tins::BootP::opcode ( ) const

inline

Getter for the opcode field.

Returns: The opcode field for this BootP PDU.

◆ opcode() [2/2]

void Tins::BootP::opcode ( uint8_t code )

Setter for the opcode field.

Parameters

code	The opcode to be set.

◆ padding() [1/2]

uint16_t Tins::BootP::padding ( ) const

inline

Getter for the padding field.

Returns: The padding field for this BootP PDU.

◆ padding() [2/2]

void Tins::BootP::padding ( uint16_t value )

Setter for the padding field.

Parameters

value The padding to be set.

◆ pdu_type()

PDUType Tins::BootP::pdu_type ( ) const

inlinevirtual

Getter for the PDU's type.

See also: PDU::pdu_type

Implements Tins::PDU.

Reimplemented in Tins::DHCP.

◆ secs() [1/2]

uint16_t Tins::BootP::secs ( ) const

inline

Getter for the secs field.

Returns: The secs field for this BootP PDU.

◆ secs() [2/2]

void Tins::BootP::secs ( uint16_t value )

Setter for the secs field.

Parameters

value The secs to be set.

◆ siaddr() [1/2]

ipaddress_type Tins::BootP::siaddr ( ) const

inline

Getter for the siaddr field.

Returns: The siaddr field for this BootP PDU.

◆ siaddr() [2/2]

void Tins::BootP::siaddr ( ipaddress_type address )

Setter for the siaddr field.

Parameters

address The siaddr to be set.

◆ sname() [1/2]

const uint8_t * Tins::BootP::sname ( ) const

inline

Getter for the sname field.

Returns: The sname field for this BootP PDU.

◆ sname() [2/2]

void Tins::BootP::sname ( const uint8_t * new_sname )

Setter for the sname field.

Parameters

new_sname The sname to be set.

◆ vend() [1/3]

vend_type & Tins::BootP::vend ( )

inlineprotected

Getter for the vend field.

This getter can be used by subclasses to avoid copying the vend field around.

Returns: The vend field for this BootP PDU.

◆ vend() [2/3]

const vend_type & Tins::BootP::vend ( ) const

inline

Getter for the vend field.

Returns: The vend field for this BootP PDU.

◆ vend() [3/3]

void Tins::BootP::vend ( const vend_type & newvend_ )

Setter for the vend field.

Parameters

newvend_ The vend to be set.

◆ write_serialization()

void Tins::BootP::write_serialization	(	uint8_t *	buffer,
		uint32_t	total_sz )

protectedvirtual

Serializes this TCP PDU.

Each PDU must override this method and implement it's own serialization.

Parameters

buffer	The buffer in which the PDU will be serialized.
total_sz	The size available in the buffer.

Implements Tins::PDU.

◆ xid() [1/2]

uint32_t Tins::BootP::xid ( ) const

inline

Getter for the xid field.

Returns: The xid field for this BootP PDU.

◆ xid() [2/2]

void Tins::BootP::xid ( uint32_t identifier )

Setter for the xid field.

Parameters

identifier The xid to be set.

◆ yiaddr() [1/2]

ipaddress_type Tins::BootP::yiaddr ( ) const

inline

Getter for the yiaddr field.

Returns: The yiaddr field for this BootP PDU.

◆ yiaddr() [2/2]

void Tins::BootP::yiaddr ( ipaddress_type address )

Setter for the yiaddr field.

Parameters

address The yiaddr to be set.

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

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ chaddr_type

◆ ipaddress_type

◆ vend_type

Constructor & Destructor Documentation

◆ BootP() [1/2]

◆ BootP() [2/2]

Member Function Documentation

◆ chaddr() [1/2]

◆ chaddr() [2/2]

◆ ciaddr() [1/2]

◆ ciaddr() [2/2]

◆ clone()

◆ file() [1/2]

◆ file() [2/2]

◆ giaddr() [1/2]

◆ giaddr() [2/2]

◆ header_size()

◆ hlen() [1/2]

◆ hlen() [2/2]

◆ hops() [1/2]

◆ hops() [2/2]

◆ htype() [1/2]

◆ htype() [2/2]

◆ matches_response()

◆ opcode() [1/2]

◆ opcode() [2/2]

◆ padding() [1/2]

◆ padding() [2/2]

◆ pdu_type()

◆ secs() [1/2]

◆ secs() [2/2]

◆ siaddr() [1/2]

◆ siaddr() [2/2]

◆ sname() [1/2]

◆ sname() [2/2]

◆ vend() [1/3]

◆ vend() [2/3]

◆ vend() [3/3]

◆ write_serialization()

◆ xid() [1/2]

◆ xid() [2/2]

◆ yiaddr() [1/2]

◆ yiaddr() [2/2]