#include <LdapLayer.h>

Inheritance diagram for pcpp::LdapSearchRequestLayer:

Classes
class	DerefAliases

class	SearchRequestScope

Public Member Functions
	LdapSearchRequestLayer (uint16_t messageId, const std::string &baseObject, SearchRequestScope scope, DerefAliases derefAliases, uint8_t sizeLimit, uint8_t timeLimit, bool typesOnly, Asn1Record *filterRecord, const std::vector< std::string > &attributes, const std::vector< LdapControl > &controls=std::vector< LdapControl >())

std::string	getBaseObject () const

SearchRequestScope	getScope () const

DerefAliases	getDerefAlias () const

uint8_t	getSizeLimit () const

uint8_t	getTimeLimit () const

bool	getTypesOnly () const

Asn1Record *	getFilter () const

std::vector< std::string >	getAttributes () const

Public Member Functions inherited from pcpp::LdapLayer
	LdapLayer (uint16_t messageId, LdapOperationType operationType, const std::vector< Asn1Record * > &messageRecords, const std::vector< LdapControl > &controls=std::vector< LdapControl >())

Asn1SequenceRecord *	getRootAsn1Record () const

Asn1ConstructedRecord *	getLdapOperationAsn1Record () const

uint16_t	getMessageID () const

std::vector< LdapControl >	getControls () const

virtual LdapOperationType	getLdapOperationType () const

template<typename Method , typename ResultType >
bool	tryGet (Method method, ResultType &result)

void	parseNextLayer () override
	Tries to identify more LDAP messages in this packet if exist.

size_t	getHeaderLen () const override

void	computeCalculateFields () override
	Each layer can compute field values automatically using this method. This is an abstract method.

OsiModelLayer	getOsiModelLayer () const override

std::string	toString () 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

uint8_t *	getDataPtr (size_t offset=0) const override

Additional Inherited Members
Static Public Member Functions inherited from pcpp::LdapLayer
static bool	isLdapPort (uint16_t port)

static LdapLayer *	parseLdapMessage (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

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

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

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 LDAP search request operation

Constructor & Destructor Documentation

◆ LdapSearchRequestLayer()

pcpp::LdapSearchRequestLayer::LdapSearchRequestLayer	(	uint16_t	messageId,
		const std::string &	baseObject,
		SearchRequestScope	scope,
		DerefAliases	derefAliases,
		uint8_t	sizeLimit,
		uint8_t	timeLimit,
		bool	typesOnly,
		Asn1Record *	filterRecord,
		const std::vector< std::string > &	attributes,
		const std::vector< LdapControl > &	controls = `std::vector< LdapControl >()`
	)

A constructor to create a new LDAP search request message

Parameters

[in]	messageId	The LDAP message ID
[in]	baseObject	The base object for the LDAP search request entry
[in]	scope	The portion of the target subtree that should be considered
[in]	derefAliases	The alias dereferencing behavior, which indicates how the server should treat any aliases encountered while processing the search
[in]	sizeLimit	The maximum number of entries that should be returned from the search
[in]	timeLimit	The time limit for the search in seconds
[in]	typesOnly	If this is given a value of true, then it indicates that entries that match the search criteria should be returned containing only the attribute descriptions for the attributes contained in that entry but should not include the values for those attributes. If this is given a value of false, then it indicates that the attribute values should be included in the entries that are returned
[in]	filterRecord	The filter for the search. Please note that parsing for the search filter doesn't exist yet. Therefore, the expected input value should be a plain ASN.1 record
[in]	attributes	A set of attributes to request for inclusion in entries that match the search criteria and are returned to the client
[in]	controls	A vector of LDAP controls. This is an optional parameter, if not provided the message will be created without LDAP controls

Member Function Documentation

◆ getAttributes()

std::vector<std::string> pcpp::LdapSearchRequestLayer::getAttributes ( ) const

Returns: A list of search request attributes

◆ getBaseObject()

std::string pcpp::LdapSearchRequestLayer::getBaseObject ( ) const

Returns: The base object for the LDAP search request entry

◆ getDerefAlias()

DerefAliases pcpp::LdapSearchRequestLayer::getDerefAlias ( ) const

Returns: The alias dereferencing behavior

◆ getFilter()

Asn1Record* pcpp::LdapSearchRequestLayer::getFilter ( ) const

Returns: The filter for the search. Please note that parsing for the search filter doesn't exist yet. Therefore, the return value is a plain ASN.1 record

◆ getScope()

SearchRequestScope pcpp::LdapSearchRequestLayer::getScope ( ) const

Returns: The portion of the target subtree that should be considered

◆ getSizeLimit()

uint8_t pcpp::LdapSearchRequestLayer::getSizeLimit ( ) const

Returns: The maximum number of entries that should be returned from the search

◆ getTimeLimit()

uint8_t pcpp::LdapSearchRequestLayer::getTimeLimit ( ) const

Returns: The time limit for the search in seconds

◆ getTypesOnly()

bool pcpp::LdapSearchRequestLayer::getTypesOnly ( ) const

Returns: If this flag is true, then it indicates that entries that match the search criteria should be returned containing only the attribute descriptions for the attributes contained in that entry but should not include the values for those attributes. If this flag is false, then it indicates that the attribute values should be included in the entries that are returned

Classes

Public Member Functions

Additional Inherited Members