Class for representing the response messages of FTP Layer. More...

#include <FtpLayer.h>

Inheritance diagram for pcpp::FtpResponseLayer:

Classes
struct	SerializedFields

Public Types
enum class	FtpStatusCode : int { UNKNOWN , RESTART_MARKER = 110 , SERVICE_READY_IN_MIN = 120 , DATA_ALREADY_OPEN_START_TRANSFER = 125 , FILE_OK = 150 , COMMAND_OK = 200 , COMMAND_NOT_IMPLEMENTED_SUPERFLUOUS = 202 , SYSTEM_STATUS = 211 , DIR_STATUS = 212 , FILE_STATUS = 213 , HELP_MESSAGE = 214 , NAME_SYSTEM_TYPE = 215 , SERVICE_READY_FOR_USER = 220 , SERVICE_CLOSING_CONTROL = 221 , DATA_OPEN_NO_TRANSFER = 225 , CLOSING_DATA = 226 , ENTERING_PASSIVE = 227 , ENTERING_EXTENDED_PASSIVE = 229 , USER_LOG_IN_PROCEED = 230 , USER_LOG_IN_AUTHORIZED = 232 , SEC_DATA_EXCHANGE_COMPLETE = 234 , SEC_DATA_EXCHANGE_COMPLETE_SUCCESS = 235 , REQ_FILE_OK_COMPLETE = 250 , PATHNAME_CREATED = 257 , USER_OK_NEED_PASSWORD = 331 , NEED_ACCOUNT = 332 , REQ_SEC_MECHANISM_OK = 334 , SEC_IS_ACCEPTABLE = 335 , USER_OK_NEED_PASS_CHALLENGE = 336 , FILE_PENDING_ACTION = 350 , SERVICE_NOT_AVAILABLE = 421 , CANT_OPEN_DATA_CONNECTION = 425 , CONNECTION_CLOSED = 426 , NEED_UNAVAILABLE_RESOURCE_TO_SEC = 431 , REQ_FILE_ACTION_NOT_TAKEN = 450 , REQ_ACTION_ABORTED = 451 , REQ_ACTION_NOT_TAKEN = 452 , SYNTAX_ERROR_COMMAND_UNRECOGNIZED = 500 , SYNTAX_ERROR_PARAMETER_OR_ARGUMENT = 501 , COMMAND_NOT_IMPLEMENTED = 502 , BAD_SEQUENCE_COMMANDS = 503 , COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER = 504 , NETWORK_PROTOCOL_NOT_SUPPORTED = 522 , NOT_LOGGED_IN = 530 , NEED_ACCOUNT_FOR_STORE_FILE = 532 , COMMAND_PROTECTION_DENIED = 533 , REQUEST_DENIED = 534 , FAILED_SEC_CHECK = 535 , REQ_PROT_LEVEL_NOT_SUPPORTED = 536 , COMMAND_PROTECTION_LEVEL_NOT_SUPPORTED = 537 , FILE_UNAVAILABLE = 550 , PAGE_TYPE_UNKNOWN = 551 , EXCEED_STORAGE_ALLOCATION = 552 , FILENAME_NOT_ALLOWED = 553 , INTEGRITY_PROTECTED = 631 , CONFIDENTIALITY_AND_INTEGRITY_PROTECTED = 632 , CONFIDENTIALITY_PROTECTED = 633 }
	Enum for FTP response codes. More...

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

	FtpResponseLayer (const FtpStatusCode &code, const std::string &option="")

bool	setStatusCode (FtpStatusCode code)

FtpStatusCode	getStatusCode () const

std::string	getStatusCodeString () const

bool	setStatusOption (const std::string &value)

std::string	getStatusOption (bool removeEscapeCharacters=true) const

std::string	toString () const override

Public Member Functions inherited from pcpp::FtpLayer
void	parseNextLayer () override
	FTP is the always last so does nothing for this layer.

size_t	getHeaderLen () const override

void	computeCalculateFields () override
	Does nothing for this layer.

OsiModelLayer	getOsiModelLayer () const override

Public Member Functions inherited from pcpp::SingleCommandTextProtocol
bool	isMultiLine () const

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

void	serialize (ISerializer &serializer) const

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static std::string	getStatusCodeAsString (FtpStatusCode code)

Static Public Member Functions inherited from pcpp::FtpLayer
static bool	isFtpPort (uint16_t port)

static bool	isFtpDataPort (uint16_t port)

Static Public Member Functions inherited from pcpp::SingleCommandTextProtocol
static bool	isDataValid (const uint8_t *data, size_t dataSize)

Protected Member Functions
void	serializeLayer (ObjectScope &serializer) const override

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

Additional Inherited Members
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

Class for representing the response messages of FTP Layer.

Member Enumeration Documentation

◆ FtpStatusCode

enum pcpp::FtpResponseLayer::FtpStatusCode : int

strong

Enum for FTP response codes.

Enumerator
UNKNOWN	Unknown status code.
RESTART_MARKER	Restart marker reply.
SERVICE_READY_IN_MIN	Service ready in nnn minutes.
DATA_ALREADY_OPEN_START_TRANSFER	Data connection already open; transfer starting.
FILE_OK	File status okay; about to open data connection.
COMMAND_OK	Command okay.
COMMAND_NOT_IMPLEMENTED_SUPERFLUOUS	Command not implemented, superfluous at this site.
SYSTEM_STATUS	System status, or system help reply.
DIR_STATUS	Directory status.
FILE_STATUS	File status.
HELP_MESSAGE	Help message.
NAME_SYSTEM_TYPE	NAME system type.
SERVICE_READY_FOR_USER	Service ready for new user.
SERVICE_CLOSING_CONTROL	Service closing control connection.
DATA_OPEN_NO_TRANSFER	Data connection open; no transfer in progress.
CLOSING_DATA	Closing data connection.
ENTERING_PASSIVE	Entering Passive Mode.
ENTERING_EXTENDED_PASSIVE	Entering Extended Passive Mode.
USER_LOG_IN_PROCEED	User logged in, proceed.
USER_LOG_IN_AUTHORIZED	User logged in, authorized by security data exchange.
SEC_DATA_EXCHANGE_COMPLETE	Security data exchange complete.
SEC_DATA_EXCHANGE_COMPLETE_SUCCESS	Security data exchange completed successfully.
REQ_FILE_OK_COMPLETE	Requested file action okay, completed.
PATHNAME_CREATED	PATHNAME created.
USER_OK_NEED_PASSWORD	User name okay, need password.
NEED_ACCOUNT	Need account for login.
REQ_SEC_MECHANISM_OK	Requested security mechanism is ok.
SEC_IS_ACCEPTABLE	Security data is acceptable, more is required.
USER_OK_NEED_PASS_CHALLENGE	Username okay, need password. Challenge is ...
FILE_PENDING_ACTION	Requested file action pending further information.
SERVICE_NOT_AVAILABLE	Service not available, closing control connection.
CANT_OPEN_DATA_CONNECTION	Can't open data connection.
CONNECTION_CLOSED	Connection closed; transfer aborted.
NEED_UNAVAILABLE_RESOURCE_TO_SEC	Need some unavailable resource to process security.
REQ_FILE_ACTION_NOT_TAKEN	Requested file action not taken.
REQ_ACTION_ABORTED	Requested action aborted: local error in processing.
REQ_ACTION_NOT_TAKEN	Requested action not taken. Insufficient storage space in system.
SYNTAX_ERROR_COMMAND_UNRECOGNIZED	Syntax error, command unrecognized.
SYNTAX_ERROR_PARAMETER_OR_ARGUMENT	Syntax error in parameters or arguments.
COMMAND_NOT_IMPLEMENTED	Command not implemented.
BAD_SEQUENCE_COMMANDS	Bad sequence of commands.
COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER	Command not implemented for that parameter.
NETWORK_PROTOCOL_NOT_SUPPORTED	Network protocol not supported.
NOT_LOGGED_IN	Not logged in.
NEED_ACCOUNT_FOR_STORE_FILE	Need account for storing files.
COMMAND_PROTECTION_DENIED	Command protection level denied for policy reasons.
REQUEST_DENIED	Request denied for policy reasons.
FAILED_SEC_CHECK	Failed security check (hash, sequence, etc)
REQ_PROT_LEVEL_NOT_SUPPORTED	Requested PROT level not supported by mechanism.
COMMAND_PROTECTION_LEVEL_NOT_SUPPORTED	Command protection level not supported by security mechanism.
FILE_UNAVAILABLE	Requested action not taken: File unavailable.
PAGE_TYPE_UNKNOWN	Requested action aborted: page type unknown.
EXCEED_STORAGE_ALLOCATION	Requested file action aborted: Exceeded storage allocation.
FILENAME_NOT_ALLOWED	Requested action not taken: File name not allowed.
INTEGRITY_PROTECTED	Integrity protected reply.
CONFIDENTIALITY_AND_INTEGRITY_PROTECTED	Confidentiality and integrity protected reply.
CONFIDENTIALITY_PROTECTED	Confidentiality protected reply.

Constructor & Destructor Documentation

◆ FtpResponseLayer() [1/2]

pcpp::FtpResponseLayer::FtpResponseLayer	(	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

◆ FtpResponseLayer() [2/2]

pcpp::FtpResponseLayer::FtpResponseLayer	(	const FtpStatusCode &	code,
		const std::string &	option = `""`
	)

inlineexplicit

A constructor that creates layer with provided input values

Parameters

[in]	code	Status code
[in]	option	Argument of the status code

Member Function Documentation

◆ getStatusCode()

FtpStatusCode pcpp::FtpResponseLayer::getStatusCode ( ) const

Get the status code of response message

Returns: FtpStatusCode Value of the status code

◆ getStatusCodeAsString()

static std::string pcpp::FtpResponseLayer::getStatusCodeAsString ( FtpStatusCode code )

static

Convert the status code to readable string

Parameters

[in] code Status code to convert

Returns: std::string Returns the status info as readable string

◆ getStatusCodeString()

std::string pcpp::FtpResponseLayer::getStatusCodeString ( ) const

Get the status code of response message as string

Returns: std::string Value of the status code as string

◆ getStatusOption()

std::string pcpp::FtpResponseLayer::getStatusOption ( bool removeEscapeCharacters = true ) const

Get the argument of response message

Parameters

[in] removeEscapeCharacters Whether non-alphanumerical characters should be removed or not

Returns: std::string Value of argument

◆ serializeLayer()

void pcpp::FtpResponseLayer::serializeLayer ( ObjectScope & serializer ) const

overrideprotectedvirtual

Serializes the layer's data into a provided serializer object. This is used for generating serialized representations (like JSON) of the packet layers. This method should be overridden by derived layers to provide specific serialization logic.

Parameters

[in] serializer The object scope serializer to which the layer details should be written.

Reimplemented from pcpp::Layer.

◆ setStatusCode()

bool pcpp::FtpResponseLayer::setStatusCode ( FtpStatusCode code )

Set the status code of response message

Parameters

[in] code Value to set status code

Returns: True if the operation is successful, false otherwise

◆ setStatusOption()

bool pcpp::FtpResponseLayer::setStatusOption ( const std::string & value )

Set the argument of response message

Parameters

[in] value Value to set argument

Returns: True if the operation is successful, false otherwise

◆ toString()

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

overridevirtual

Returns: Returns the protocol info as readable string

Implements pcpp::Layer.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FtpStatusCode

Constructor & Destructor Documentation

◆ FtpResponseLayer() [1/2]

◆ FtpResponseLayer() [2/2]

Member Function Documentation

◆ getStatusCode()

◆ getStatusCodeAsString()

◆ getStatusCodeString()

◆ getStatusOption()

◆ serializeLayer()

◆ setStatusCode()

◆ setStatusOption()

◆ toString()