Kea  2.1.6-git
isc::perfdhcp::PerfPkt6 Class Reference

PerfPkt6 (DHCPv6 packet) More...

#include <perf_pkt6.h>

+ Inheritance diagram for isc::perfdhcp::PerfPkt6:

Public Types

typedef boost::shared_ptr< LocalizedOptionLocalizedOptionPtr
 Localized option pointer type. More...
 
- Public Types inherited from isc::dhcp::Pkt6
enum  DHCPv6Proto { UDP = 0, TCP = 1 }
 DHCPv6 transport protocol. More...
 
enum  RelaySearchOrder { RELAY_SEARCH_FROM_CLIENT = 1, RELAY_SEARCH_FROM_SERVER = 2, RELAY_GET_FIRST = 3, RELAY_GET_LAST = 4 }
 defines relay search pattern More...
 

Public Member Functions

 PerfPkt6 (const uint8_t *buf, size_t len, size_t transid_offset=1, uint32_t transid=0)
 Constructor, used to create messages from packet template files. More...
 
size_t getTransidOffset () const
 Returns transaction id offset in packet buffer. More...
 
bool rawPack ()
 Prepares on-wire format from raw buffer. More...
 
bool rawUnpack ()
 Handles limited binary packet parsing for packets with custom offsets of options and transaction id. More...
 
void writeAt (size_t dest_pos, std::vector< uint8_t >::iterator first, std::vector< uint8_t >::iterator last)
 Replace contents of buffer with data. More...
 
template<typename T >
void writeValueAt (size_t dest_pos, T val)
 Replace contents of buffer with value. More...
 
- Public Member Functions inherited from isc::dhcp::Pkt6
 Pkt6 (uint8_t msg_type, uint32_t transid, DHCPv6Proto proto=UDP)
 Constructor, used in replying to a message. More...
 
 Pkt6 (const uint8_t *buf, uint32_t len, DHCPv6Proto proto=UDP)
 Constructor, used in message transmission. More...
 
void addRelayInfo (const RelayInfo &relay)
 add information about one traversed relay More...
 
void copyRelayInfo (const Pkt6Ptr &question)
 copies relay information from client's packet to server's response More...
 
OptionPtr getAnyRelayOption (const uint16_t option_code, const RelaySearchOrder &order)
 Return first instance of a specified option. More...
 
DuidPtr getClientId () const
 Retrieves the DUID from the Client Identifier option. More...
 
virtual std::string getLabel () const
 Returns text representation of the primary packet identifiers. More...
 
const char * getName () const
 Returns name of the DHCPv6 message. More...
 
isc::dhcp::OptionCollection getOptions (const uint16_t type)
 Returns all instances of specified type. More...
 
DHCPv6Proto getProto ()
 Returns protocol of this packet (UDP or TCP). More...
 
const isc::asiolink::IOAddressgetRelay6LinkAddress (uint8_t relay_level) const
 return the link address field from a relay option More...
 
const isc::asiolink::IOAddressgetRelay6PeerAddress (uint8_t relay_level) const
 return the peer address field from a relay option More...
 
OptionPtr getRelayOption (uint16_t option_code, uint8_t nesting_level)
 Returns option inserted by relay. More...
 
virtual uint8_t getType () const
 Returns message type (e.g. More...
 
virtual size_t len ()
 Returns length of the packet. More...
 
virtual void pack ()
 Prepares on-wire format. More...
 
void setProto (DHCPv6Proto proto=UDP)
 Sets protocol of this packet. More...
 
virtual void setType (uint8_t type)
 Sets message type (e.g. More...
 
virtual std::string toText () const
 Returns text representation of the packet. More...
 
virtual void unpack ()
 Dispatch method that handles binary packet parsing. More...
 
- Public Member Functions inherited from isc::dhcp::Pkt
virtual ~Pkt ()
 Virtual destructor. More...
 
void addClass (const isc::dhcp::ClientClass &client_class, bool required=false)
 Adds packet to a specified class. More...
 
virtual void addOption (const OptionPtr &opt)
 Adds an option to this packet. More...
 
bool delOption (uint16_t type)
 Attempts to delete first suboption of requested type. More...
 
isc::util::OutputBuffergetBuffer ()
 Returns reference to output buffer. More...
 
const ClientClassesgetClasses (bool required=false) const
 Returns the class set. More...
 
std::string getIface () const
 Returns interface name. More...
 
int getIndex () const
 Returns interface index. More...
 
const isc::asiolink::IOAddressgetLocalAddr () const
 Returns local IP address. More...
 
uint16_t getLocalPort () const
 Returns local UDP (and soon TCP) port. More...
 
HWAddrPtr getMAC (uint32_t hw_addr_src)
 Returns MAC address. More...
 
OptionPtr getOption (const uint16_t type)
 Returns the first option of specified type. More...
 
const isc::asiolink::IOAddressgetRemoteAddr () const
 Returns remote IP address. More...
 
HWAddrPtr getRemoteHWAddr () const
 Returns the remote HW address obtained from raw sockets. More...
 
uint16_t getRemotePort () const
 Returns remote port. More...
 
const boost::posix_time::ptime & getTimestamp () const
 Returns packet timestamp. More...
 
uint32_t getTransid () const
 Returns value of transaction-id field. More...
 
bool inClass (const isc::dhcp::ClientClass &client_class)
 Checks whether a client belongs to a given class. More...
 
bool indexSet () const
 Checks if interface index has been set. More...
 
bool isCopyRetrievedOptions () const
 Returns whether the copying of retrieved options is enabled. More...
 
void repack ()
 Copies content of input buffer to output buffer. More...
 
void resetIndex ()
 Resets interface index to negative value. More...
 
virtual void setCopyRetrievedOptions (const bool copy)
 Controls whether the option retrieved by the Pkt::getOption should be copied before being returned. More...
 
void setIface (const std::string &iface)
 Sets interface name. More...
 
void setIndex (int ifindex)
 Sets interface index. More...
 
void setLocalAddr (const isc::asiolink::IOAddress &local)
 Sets local IP address. More...
 
void setLocalPort (uint16_t local)
 Sets local UDP (and soon TCP) port. More...
 
void setRemoteAddr (const isc::asiolink::IOAddress &remote)
 Sets remote IP address. More...
 
void setRemoteHWAddr (const HWAddrPtr &hw_addr)
 Sets remote hardware address. More...
 
void setRemoteHWAddr (const uint8_t htype, const uint8_t hlen, const std::vector< uint8_t > &hw_addr)
 Sets remote hardware address. More...
 
void setRemotePort (uint16_t remote)
 Sets remote UDP (and soon TCP) port. More...
 
void setTimestamp (boost::posix_time::ptime &timestamp)
 Set packet timestamp. More...
 
void setTransid (uint32_t transid)
 Sets transaction-id value. More...
 
void updateTimestamp ()
 Update packet timestamp. More...
 
- Public Member Functions inherited from isc::hooks::CalloutHandleAssociate
 CalloutHandleAssociate ()
 Constructor. More...
 
CalloutHandlePtr getCalloutHandle ()
 Returns callout handle. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::dhcp::Pkt6
static const char * getName (const uint8_t type)
 Returns name of the DHCPv6 message for a given type number. More...
 
static std::string makeLabel (const DuidPtr duid, const uint32_t transid, const HWAddrPtr &hwaddr)
 Returns text representation of the given packet identifiers. More...
 
static std::string makeLabel (const DuidPtr duid, const HWAddrPtr &hwaddr)
 Returns text representation of the given packet identifiers. More...
 
- Public Attributes inherited from isc::dhcp::Pkt6
std::vector< RelayInforelay_info_
 Relay information. More...
 
- Public Attributes inherited from isc::dhcp::Pkt
ClientClasses classes_
 Classes this packet belongs to. More...
 
OptionBuffer data_
 Unparsed data (in received packets). More...
 
isc::dhcp::OptionCollection options_
 Collection of options present in this message. More...
 
ClientClasses required_classes_
 Classes which are required to be evaluated. More...
 
- Static Public Attributes inherited from isc::dhcp::Pkt6
static const size_t DHCPV6_PKT_HDR_LEN = 4
 specifies non-relayed DHCPv6 packet header length (over UDP) More...
 
static const size_t DHCPV6_RELAY_HDR_LEN = 34
 specifies relay DHCPv6 packet header length (over UDP) More...
 
- Protected Member Functions inherited from isc::dhcp::Pkt6
uint16_t calculateRelaySizes ()
 Calculates overhead for all relays defined for this message. More...
 
uint16_t directLen () const
 Calculates size of the message as if it was not relayed at all. More...
 
virtual HWAddrPtr getMACFromDocsisCMTS ()
 Attempts to extract MAC/Hardware address from DOCSIS options. More...
 
virtual HWAddrPtr getMACFromDocsisModem ()
 Attempts to extract MAC/Hardware address from DOCSIS options inserted by the modem itself. More...
 
virtual HWAddrPtr getMACFromDUID ()
 Extract MAC/Hardware address from client-id. More...
 
virtual HWAddrPtr getMACFromIPv6RelayOpt ()
 Extract MAC/Hardware address from client link-layer address. More...
 
virtual HWAddrPtr getMACFromRemoteIdRelayOption ()
 Attempts to obtain MAC address from remote-id relay option. More...
 
virtual HWAddrPtr getMACFromSrcLinkLocalAddr ()
 Attempts to generate MAC/Hardware address from IPv6 link-local address. More...
 
OptionPtr getNonCopiedAnyRelayOption (const uint16_t option_code, const RelaySearchOrder &order) const
 Returns pointer to an instance of specified option. More...
 
OptionCollection getNonCopiedOptions (const uint16_t opt_type) const
 Returns all option instances of specified type without copying. More...
 
OptionPtr getNonCopiedRelayOption (const uint16_t opt_type, const uint8_t relay_level) const
 Returns pointer to an option inserted by relay agent. More...
 
uint16_t getRelayOverhead (const RelayInfo &relay) const
 Calculates overhead introduced in specified relay. More...
 
void packTCP ()
 Builds on wire packet for TCP transmission. More...
 
void packUDP ()
 Builds on wire packet for UDP transmission. More...
 
void unpackMsg (OptionBuffer::const_iterator begin, OptionBuffer::const_iterator end)
 Unpacks direct (non-relayed) message. More...
 
void unpackRelayMsg ()
 Unpacks relayed message (RELAY-FORW or RELAY-REPL). More...
 
void unpackTCP ()
 Parses on-wire form of TCP DHCPv6 packet. More...
 
void unpackUDP ()
 Parses on-wire form of UDP DHCPv6 packet. More...
 
- Protected Member Functions inherited from isc::dhcp::Pkt
 Pkt (uint32_t transid, const isc::asiolink::IOAddress &local_addr, const isc::asiolink::IOAddress &remote_addr, uint16_t local_port, uint16_t remote_port)
 Constructor. More...
 
 Pkt (const uint8_t *buf, uint32_t len, const isc::asiolink::IOAddress &local_addr, const isc::asiolink::IOAddress &remote_addr, uint16_t local_port, uint16_t remote_port)
 Constructor. More...
 
HWAddrPtr getMACFromIPv6 (const isc::asiolink::IOAddress &addr)
 Attempts to convert IPv6 address into MAC. More...
 
OptionPtr getNonCopiedOption (const uint16_t type) const
 Returns the first option of specified type without copying. More...
 
- Protected Attributes inherited from isc::dhcp::Pkt6
uint8_t msg_type_
 DHCPv6 message type. More...
 
DHCPv6Proto proto_
 UDP (usually) or TCP (bulk leasequery or failover) More...
 
- Protected Attributes inherited from isc::dhcp::Pkt
isc::util::OutputBuffer buffer_out_
 Output buffer (used during message transmission) More...
 
bool copy_retrieved_options_
 Indicates if a copy of the retrieved option should be returned when Pkt::getOption is called. More...
 
std::string iface_
 Name of the network interface the packet was received/to be sent over. More...
 
int64_t ifindex_
 Interface index. More...
 
isc::asiolink::IOAddress local_addr_
 Local IP (v4 or v6) address. More...
 
uint16_t local_port_
 local TDP or UDP port More...
 
isc::asiolink::IOAddress remote_addr_
 Remote IP address. More...
 
HWAddrPtr remote_hwaddr_
 
uint16_t remote_port_
 remote TCP or UDP port More...
 
boost::posix_time::ptime timestamp_
 packet timestamp More...
 
uint32_t transid_
 Transaction-id (32 bits for v4, 24 bits for v6) More...
 
- Protected Attributes inherited from isc::hooks::CalloutHandleAssociate
CalloutHandlePtr callout_handle_
 Callout handle stored. More...
 

Detailed Description

PerfPkt6 (DHCPv6 packet)

This class extends the functionality of isc::dhcp::Pkt6 by adding the ability to specify an options offset in the DHCP message and so override the options' contents. This is particularly useful when we create a packet object using a template file (i.e. do not build it dynamically). The client class should read the data from the template file and pass it to this class as a buffer.

The contents of such packet can be later partially replaced: in particular, selected options and the transaction ID can be altered. (The transaction ID and its offset in the template file is passed via the constructor.)

In order to replace the contents of options, the client class has to create a collection of LocalizedOption by adding them using dhcp::Pkt6::addOption.

Note
If you don't use template files, simply use constructors inherited from parent class and the isc::dhcp::Option type instead.

Definition at line 41 of file perf_pkt6.h.

Member Typedef Documentation

◆ LocalizedOptionPtr

Localized option pointer type.

Definition at line 45 of file perf_pkt6.h.

Constructor & Destructor Documentation

◆ PerfPkt6()

isc::perfdhcp::PerfPkt6::PerfPkt6 ( const uint8_t *  buf,
size_t  len,
size_t  transid_offset = 1,
uint32_t  transid = 0 
)

Constructor, used to create messages from packet template files.

Creates a new DHCPv6 message using the provided buffer. The transaction ID and its offset are specified via this constructor. The transaction ID is stored in outgoing message when client class calls PerfPkt6::rawPack. Transaction id offset value is used for incoming and outgoing messages to identify transaction ID field's position in incoming and outgoing messages.

Parameters
bufbuffer holding contents of the message (this can be directly read from template file).
lenlength of the data in the buffer.
transid_offsettransaction id offset in a message.
transidtransaction id to be stored in outgoing message.

Definition at line 25 of file perf_pkt6.cc.

References isc::dhcp::Pkt::setTransid().

+ Here is the call graph for this function:

Member Function Documentation

◆ getTransidOffset()

size_t isc::perfdhcp::PerfPkt6::getTransidOffset ( ) const
inline

Returns transaction id offset in packet buffer.

Returns
Transaction ID offset in the packet buffer.

Definition at line 71 of file perf_pkt6.h.

References rawPack(), rawUnpack(), and writeAt().

Referenced by rawPack(), and rawUnpack().

+ Here is the call graph for this function:

◆ rawPack()

bool isc::perfdhcp::PerfPkt6::rawPack ( )

Prepares on-wire format from raw buffer.

The method copies the buffer provided in constructor to the output buffer and replaces the transaction ID and selected options with new data.

Note
Use this method to prepare an on-wire DHCPv6 message when you use template packets that require replacement of selected options' contents before sending.
Returns
false ID pack operation failed.

Definition at line 35 of file perf_pkt6.cc.

References isc::dhcp::Pkt::buffer_out_, isc::dhcp::Pkt::data_, isc::dhcp::Pkt::getTransid(), getTransidOffset(), isc::dhcp::Pkt::options_, isc::perfdhcp::PktTransform::pack(), and isc::dhcp::Option::V6.

Referenced by getTransidOffset().

+ Here is the call graph for this function:

◆ rawUnpack()

bool isc::perfdhcp::PerfPkt6::rawUnpack ( )

Handles limited binary packet parsing for packets with custom offsets of options and transaction id.

This method handles the parsing of packets that have custom offsets of options or transaction ID. Use isc::dhcp::Pkt4::addOption to specify which options to parse. Options should be of the isc::perfdhcp::LocalizedOption type with offset values provided. Each added option will be updated with actual data read from the binary packet buffer.

Returns
false if unpack operation failed.

Definition at line 45 of file perf_pkt6.cc.

References isc::dhcp::Pkt::data_, isc::dhcp::Pkt::getTransid(), getTransidOffset(), isc::dhcp::Pkt::options_, isc::dhcp::Pkt::setTransid(), isc::perfdhcp::PktTransform::unpack(), and isc::dhcp::Option::V6.

Referenced by getTransidOffset().

+ Here is the call graph for this function:

◆ writeAt()

void isc::perfdhcp::PerfPkt6::writeAt ( size_t  dest_pos,
std::vector< uint8_t >::iterator  first,
std::vector< uint8_t >::iterator  last 
)

Replace contents of buffer with data.

Function replaces part of the buffer with data from vector.

Parameters
dest_posposition in buffer where data is replaced.
firstbeginning of data range in source vector.
lastend of data range in source vector.

Definition at line 59 of file perf_pkt6.cc.

References isc::dhcp::Pkt::data_, and isc::perfdhcp::PktTransform::writeAt().

Referenced by getTransidOffset().

+ Here is the call graph for this function:

◆ writeValueAt()

template<typename T >
void isc::perfdhcp::PerfPkt6::writeValueAt ( size_t  dest_pos,
val 
)
inline

Replace contents of buffer with value.

Function replaces part of buffer with value.

Parameters
dest_posposition in buffer where value is to be written.
valvalue to be written.

Definition at line 118 of file perf_pkt6.h.

References isc::dhcp::Pkt::data_.


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