#include <RadiusLayer.h>

Inheritance diagram for pcpp::RadiusLayer:

Public Member Functions
	RadiusLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	RadiusLayer (uint8_t code, uint8_t id, const uint8_t *authenticator, uint8_t authenticatorArrSize)

	RadiusLayer (uint8_t code, uint8_t id, const std::string &authenticator)

	~RadiusLayer () override=default
	A d'tor for this layer, currently does nothing.

radius_header *	getRadiusHeader () const

std::string	getAuthenticatorValue () const

void	setAuthenticatorValue (const std::string &authValue)

RadiusAttribute	getFirstAttribute () const

RadiusAttribute	getNextAttribute (RadiusAttribute &attr) const

RadiusAttribute	getAttribute (uint8_t attrType) const

size_t	getAttributeCount () const

RadiusAttribute	addAttribute (const RadiusAttributeBuilder &attrBuilder)

RadiusAttribute	addAttributeAfter (const RadiusAttributeBuilder &attrBuilder, uint8_t prevAttrType)

bool	removeAttribute (uint8_t attrType)

bool	removeAllAttributes ()

size_t	getHeaderLen () const override

void	parseNextLayer () override
	Does nothing for this layer, RADIUS is always last.

void	computeCalculateFields () override
	Calculate and store the value of radius_header::length according to the layer size.

std::string	toString () const override

OsiModelLayer	getOsiModelLayer () const override

Public Member Functions inherited from pcpp::Layer
	~Layer () override

Layer *	getNextLayer () const

Layer *	getPrevLayer () const

ProtocolType	getProtocol () const

bool	isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const

uint8_t *	getData () const

size_t	getDataLen () const

uint8_t *	getLayerPayload () const

size_t	getLayerPayloadSize () const

bool	isAllocatedToPacket () const

void	copyData (uint8_t *toArr) const
	Copy the raw data of this layer to another array. More...

size_t	copyData (uint8_t *dest, size_t destSize) const
	Copy the raw data of this layer to another array, with a specified maximum size. More...

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static std::string	getRadiusMessageString (uint8_t radiusMessageCode)

static bool	isDataValid (const uint8_t *udpData, size_t udpDataLen)

static bool	isRadiusPort (uint16_t port)

Additional Inherited Members
Protected Member Functions inherited from pcpp::Layer
Packet *	getAttachedPacket ()
	Get a pointer to the Packet this layer is attached to (if any). More...

Packet const *	getAttachedPacket () const
	Get a pointer to the Packet this layer is attached to (if any). More...

void	allocData (size_t dataLen, bool zeroInit=true)
	Requests the layer to allocate a new data buffer of the specified length. More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack. No validation is performed on the data. More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack with a fallback option. More...

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool	canReinterpretAs (const uint8_t *data, size_t dataLen)
	Check if the data is large enough to reinterpret as a type. More...

Detailed Description

Represents a RADIUS (Remote Authentication Dial-In User Service) protocol layer

Constructor & Destructor Documentation

◆ RadiusLayer() [1/3]

pcpp::RadiusLayer::RadiusLayer	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

inline

A constructor that creates the layer from an existing packet raw data

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	A pointer to the previous layer
[in]	packet	A pointer to the Packet instance where layer will be stored in

◆ RadiusLayer() [2/3]

pcpp::RadiusLayer::RadiusLayer	(	uint8_t	code,
		uint8_t	id,
		const uint8_t *	authenticator,
		uint8_t	authenticatorArrSize
	)

A constructor that creates a new layer from scratch

Parameters

[in]	code	The RADIUS message code
[in]	id	The RADIUS message ID
[in]	authenticator	A pointer to a byte array containing the authenticator value
[in]	authenticatorArrSize	The authenticator byte array size. A valid size of the authenticator field is 16 bytes. If the provided size is less than that then the byte array will be copied to the packet but the missing bytes will stay zero. If the size is more than 16 bytes, only the first 16 bytes will be copied to the packet

◆ RadiusLayer() [3/3]

pcpp::RadiusLayer::RadiusLayer	(	uint8_t	code,
		uint8_t	id,
		const std::string &	authenticator
	)

A constructor that creates a new layer from scratch

Parameters

[in]	code	The RADIUS message code
[in]	id	The RADIUS message ID
[in]	authenticator	A hex string representing the authenticator value. A valid size of the authenticator field is 16 bytes. If the hex string represents an array that is smaller than this then the missing bytes in the packet's authenticator field will stay zero. If the hex string represents an array that is larger than 16 bytes, only the first 16 bytes will be copied to the packet

Member Function Documentation

◆ addAttribute()

RadiusAttribute pcpp::RadiusLayer::addAttribute ( const RadiusAttributeBuilder & attrBuilder )

Add a new RADIUS attribute at the end of the layer

Parameters

[in] attrBuilder A RadiusAttributeBuilder object that contains the requested attribute data to add

Returns: A RadiusAttribute object containing the newly added RADIUS attribute data or logical null (RadiusAttribute::isNull() == true) if addition failed

◆ addAttributeAfter()

RadiusAttribute pcpp::RadiusLayer::addAttributeAfter	(	const RadiusAttributeBuilder &	attrBuilder,
		uint8_t	prevAttrType
	)

Add a new RADIUS attribute after an existing one

Parameters

[in]	attrBuilder	A RadiusAttributeBuilder object that contains the requested attribute data to add
[in]	prevAttrType	The RADIUS attribute which the newly added attribute will come after

Returns: A RadiusAttribute object containing the newly added RADIUS attribute data or logical null (RadiusAttribute::isNull() == true) if addition failed

◆ getAttribute()

RadiusAttribute pcpp::RadiusLayer::getAttribute ( uint8_t attrType ) const

Get a RADIUS attribute by attribute type

Parameters

[in] attrType RADIUS attribute type

Returns: A RadiusAttribute object containing the first attribute data that matches this type, or logical null (RadiusAttribute::isNull() == true) if no such attribute found

◆ getAttributeCount()

size_t pcpp::RadiusLayer::getAttributeCount ( ) const

Returns: The number of RADIUS attributes in the packet

◆ getAuthenticatorValue()

std::string pcpp::RadiusLayer::getAuthenticatorValue ( ) const

Returns: A hex string representation of the radius_header::authenticator byte array value

◆ getFirstAttribute()

RadiusAttribute pcpp::RadiusLayer::getFirstAttribute ( ) const

Returns: The first RADIUS attribute in the packet. If there are no attributes the returned value will contain a logical null (RadiusAttribute::isNull() == true)

◆ getHeaderLen()

size_t pcpp::RadiusLayer::getHeaderLen ( ) const

overridevirtual

Returns: The size written in radius_header::length

Implements pcpp::Layer.

◆ getNextAttribute()

RadiusAttribute pcpp::RadiusLayer::getNextAttribute ( RadiusAttribute & attr ) const

Get the RADIUS attribute that comes after a given attribute. If the given attribute was the last one, the returned value will contain a logical null (RadiusAttribute::isNull() == true)

Parameters

[in] attr A given attribute

Returns: A RadiusAttribute object containing the attribute data that comes next, or logical null if the given attribute: (1) was the last one; (2) contains a logical null or (3) doesn't belong to this packet

◆ getOsiModelLayer()

OsiModelLayer pcpp::RadiusLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns: The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

◆ getRadiusHeader()

radius_header* pcpp::RadiusLayer::getRadiusHeader ( ) const

inline

Get a pointer to the RADIUS header. Notice this points directly to the data, so every change will change the actual packet data

Returns: A pointer to the radius_header object

◆ getRadiusMessageString()

static std::string pcpp::RadiusLayer::getRadiusMessageString ( uint8_t radiusMessageCode )

static

A static method that returns the RADIUS message string for a give message code. For example: the string "Access-Request" will be returned for code 1

Parameters

[in] radiusMessageCode RADIUS message code

Returns: RADIUS message string

◆ isDataValid()

static bool pcpp::RadiusLayer::isDataValid	(	const uint8_t *	udpData,
		size_t	udpDataLen
	)

static

The static method makes validation of UDP data

Parameters

[in]	udpData	The pointer to the UDP payload data. It points to the first byte of RADIUS header.
[in]	udpDataLen	The payload data size

Returns: True if the data is valid and can represent the RADIUS packet

◆ isRadiusPort()

bool pcpp::RadiusLayer::isRadiusPort ( uint16_t port )

inlinestatic

A static method that checks whether the port is considered as RADIUS

Parameters

[in] port The port number to be checked

◆ removeAllAttributes()

bool pcpp::RadiusLayer::removeAllAttributes ( )

Remove all RADIUS attributes in this layer

Returns: True if all attributes were successfully removed or false if removal failed for some reason

◆ removeAttribute()

bool pcpp::RadiusLayer::removeAttribute ( uint8_t attrType )

Remove an existing RADIUS attribute from the layer

Parameters

[in] attrType The RADIUS attribute type to remove

Returns: True if the RADIUS attribute was successfully removed or false if type wasn't found or if removal failed

◆ setAuthenticatorValue()

void pcpp::RadiusLayer::setAuthenticatorValue ( const std::string & authValue )

Setter for radius_header::authenticator

Parameters

[in] authValue A hex string representing the requested authenticator value

◆ toString()

std::string pcpp::RadiusLayer::toString ( ) const

overridevirtual

Returns: A string representation of the layer most important data (should look like the layer description in Wireshark)

Implements pcpp::Layer.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadiusLayer() [1/3]

◆ RadiusLayer() [2/3]

◆ RadiusLayer() [3/3]

Member Function Documentation

◆ addAttribute()

◆ addAttributeAfter()

◆ getAttribute()

◆ getAttributeCount()

◆ getAuthenticatorValue()

◆ getFirstAttribute()

◆ getHeaderLen()

◆ getNextAttribute()

◆ getOsiModelLayer()

◆ getRadiusHeader()

◆ getRadiusMessageString()

◆ isDataValid()

◆ isRadiusPort()

◆ removeAllAttributes()

◆ removeAttribute()

◆ setAuthenticatorValue()

◆ toString()