FTP Constant Enumerations

This module contains all constant enumerations of FTP implementations. Available enumerations include:

FTP_Command

FTP Commands [*]

FTP_ReturnCode

FTP Return Codes []

FTP Command

This module contains the constant enumeration for FTP Command, which is automatically generated from pcapkit.vendor.ftp.command.Command.

class pcapkit.const.ftp.command.Command(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: StrEnum

[Command] FTP Command

feat: Optional[FEATCode]

Feature code. Keyword returned in FEAT response line for this command/extension, c.f., RFC 5797#secion-2.2.

desc: Optional[str]

Brief description of command / extension.

type: CommandType

Type of “kind” of command, based on RFC 959#section-4.1.

conf: ConformanceRequirement

Expectation for support in modern FTP implementations.

ABOR: Command = 'ABOR'

Abort [RFC 959]

ACCT: Command = 'ACCT'

Account [RFC 959]

ADAT: Command = 'ADAT'

Authentication/Security Data [RFC 2228][RFC 2773][RFC 4217]

ALGS: Command = 'ALGS'

FTP64 ALG status [RFC 6384][Section 11]

ALLO: Command = 'ALLO'

Allocate [RFC 959]

APPE: Command = 'APPE'

Append (with create) [RFC 959]

AUTH: Command = 'AUTH'

Authentication/Security Mechanism [2][RFC 2773][RFC 4217]

CCC: Command = 'CCC'

Clear Command Channel [RFC 2228]

CDUP: Command = 'CDUP'

Change to Parent Directory [RFC 959]

CONF: Command = 'CONF'

Confidentiality Protected Command [RFC 2228]

CWD: Command = 'CWD'

Change Working Directory [RFC 959]

DELE: Command = 'DELE'

Delete File [RFC 959]

ENC: Command = 'ENC'

Privacy Protected Command [RFC 2228][RFC 2773][RFC 4217]

EPRT: Command = 'EPRT'

Extended Port [RFC 2428]

EPSV: Command = 'EPSV'

Extended Passive Mode [RFC 2428]

FEAT: Command = 'FEAT'

Feature Negotiation [RFC 2389]

HELP: Command = 'HELP'

Help [RFC 959]

HOST: Command = 'HOST'

Hostname [RFC 7151]

LANG: Command = 'LANG'

Language (for Server Messages) [RFC 2640]

LIST: Command = 'LIST'

List [RFC 959][RFC 1123]

LPRT: Command = 'LPRT'

Data Port [RFC 1545][RFC 1639]

LPSV: Command = 'LPSV'

Passive Mode [RFC 1545][RFC 1639]

MDTM: Command = 'MDTM'

File Modification Time [RFC 3659]

MIC: Command = 'MIC'

Integrity Protected Command [RFC 2228][RFC 2773][RFC 4217]

MKD: Command = 'MKD'

Make Directory [RFC 959]

MLSD: Command = 'MLSD'

List Directory (for machine) [RFC 3659]

MLST: Command = 'MLST'

List Single Object [RFC 3659]

MODE: Command = 'MODE'

Transfer Mode [RFC 959]

NLST: Command = 'NLST'

Name List [RFC 959][RFC 1123]

NOOP: Command = 'NOOP'

No-Op [RFC 959]

OPTS: Command = 'OPTS'

Options [RFC 2389]

PASS: Command = 'PASS'

Password [RFC 959]

PASV: Command = 'PASV'

Passive Mode [RFC 959][RFC 1123]

PBSZ: Command = 'PBSZ'

Protection Buffer Size [RFC 4217]

PORT: Command = 'PORT'

Data Port [RFC 959]

PROT: Command = 'PROT'

Data Channel Protection Level [RFC 4217]

PWD: Command = 'PWD'

Print Directory [RFC 959]

QUIT: Command = 'QUIT'

Logout [RFC 959]

REIN: Command = 'REIN'

Reinitialize [RFC 959]

REST: Command = 'REST'

Restart (for STREAM mode) [3][RFC 3659]

RETR: Command = 'RETR'

Retrieve [RFC 959]

RMD: Command = 'RMD'

Remove Directory [RFC 959]

RNFR: Command = 'RNFR'

Rename From [RFC 959]

RNTO: Command = 'RNTO'

Rename To [RFC 959][RFC Errata 5748]

SITE: Command = 'SITE'

Site Parameters [RFC 959][RFC 1123]

SIZE: Command = 'SIZE'

File Size [RFC 3659]

SMNT: Command = 'SMNT'

Structure Mount [RFC 959]

STAT: Command = 'STAT'

Status [RFC 959]

STOR: Command = 'STOR'

Store [RFC 959]

STOU: Command = 'STOU'

Store Unique [RFC 959][RFC 1123]

STRU: Command = 'STRU'

File Structure [RFC 959]

SYST: Command = 'SYST'

System [RFC 959]

TYPE: Command = 'TYPE'

Representation Type [4][RFC 959]

USER: Command = 'USER'

User Name [RFC 959]

XCUP: Command = 'XCUP'

None [RFC 775][RFC 1123]

XCWD: Command = 'XCWD'

None [RFC 775][RFC 1123]

XMKD: Command = 'XMKD'

None [RFC 775][RFC 1123]

XPWD: Command = 'XPWD'

None [RFC 775][RFC 1123]

XRMD: Command = 'XRMD'

None [RFC 775][RFC 1123]

TVFS: Command = 'TVFS'

Trivial Virtual File Store [RFC 3659]

classmethod _missing_(value)[source]

Lookup function used when value is not found.

Parameters:

value (str) – Value to get enum item.

Return type:

Command

static _generate_next_value_(name, start, count, last_values)

Return the lower-cased version of the member name.

FTP Server Return Code

This module contains the constant enumeration for FTP Server Return Code, which is automatically generated from pcapkit.vendor.ftp.return_code.ReturnCode.

class pcapkit.const.ftp.return_code.ReturnCode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

[ReturnCode] FTP Server Return Code

description: Optional[str]

Description of the return code.

kind: ResponseKind

Response kind.

group: GroupingInformation

Grouping information.

CODE_110: ReturnCode = 110

Restart marker replay. In this case, the text is exact and not left to the particular implementation; it must read: MARK yyyy = mmmm where yyyy is User-process data stream marker, and mmmm server’s equivalent marker (note the spaces between markers and “=”).

CODE_120: ReturnCode = 120

Service ready in nnn minutes.

CODE_125: ReturnCode = 125

Data connection already open; transfer starting.

CODE_150: ReturnCode = 150

File status okay; about to open data connection.

CODE_202: ReturnCode = 202

Command not implemented, superfluous at this site.

CODE_211: ReturnCode = 211

System status, or system help reply.

CODE_212: ReturnCode = 212

Directory status.

CODE_213: ReturnCode = 213

File status.

CODE_214: ReturnCode = 214

Help message. Explains how to use the server or the meaning of a particular non-standard command. This reply is useful only to the human user.

CODE_215: ReturnCode = 215

NAME system type. Where NAME is an official system name from the registry kept by IANA.

CODE_220: ReturnCode = 220

Service ready for new user.

CODE_221: ReturnCode = 221

Service closing control connection. Logged out if appropriate.

CODE_225: ReturnCode = 225

Data connection open; no transfer in progress.

CODE_226: ReturnCode = 226

Closing data connection. Requested file action successful (for example, file transfer or file abort).

CODE_227: ReturnCode = 227

Entering Passive Mode (h1,h2,h3,h4,p1,p2).

CODE_228: ReturnCode = 228

Entering Long Passive Mode (long address, port).

CODE_229: ReturnCode = 229

Entering Extended Passive Mode (|||port|).

CODE_230: ReturnCode = 230

User logged in, proceed.

CODE_232: ReturnCode = 232

User logged in, authorized by security data exchange.

CODE_234: ReturnCode = 234

Server accepts the security mechanism specified by the client; no security data needs to be exchanged.

CODE_235: ReturnCode = 235

Server accepts the security data given by the client; no further security data needs to be exchanged.

CODE_250: ReturnCode = 250

Requested file action was okay, completed.

CODE_331: ReturnCode = 331

User name okay, password needed.

CODE_332: ReturnCode = 332

No need account for login.

CODE_334: ReturnCode = 334

Server accepts the security mechanism specified by the client; some security data needs to be exchanged.

CODE_336: ReturnCode = 336

Username okay, password okay. Challenge is “… . “.

CODE_421: ReturnCode = 421

Service available, closing control connection. This may be a reply to any command if the service knows it must shut down.

CODE_425: ReturnCode = 425

Can’t open data connection.

CODE_426: ReturnCode = 426

Connection closed; transfer aborted.

CODE_430: ReturnCode = 430

Invalid username or password

CODE_431: ReturnCode = 431

Need some unavailable resource to process security.

CODE_434: ReturnCode = 434

Requested host unavailable.

CODE_450: ReturnCode = 450

Requested file action not taken.

CODE_451: ReturnCode = 451

Requested action aborted. Local error in processing.

CODE_452: ReturnCode = 452

Requested action not taken. Insufficient storage space in system. File unavailable (e.g., file busy).

CODE_501: ReturnCode = 501

Syntax error in parameters or arguments.

CODE_502: ReturnCode = 502

Command not implemented.

CODE_503: ReturnCode = 503

Bad sequence of commands.

CODE_504: ReturnCode = 504

Command not implemented for that parameter.

CODE_530: ReturnCode = 530

Not logged in.

CODE_532: ReturnCode = 532

Need account for storing files.

CODE_533: ReturnCode = 533

Command protection level denied for policy reasons.

CODE_534: ReturnCode = 534

Request denied for policy reasons.

CODE_535: ReturnCode = 535

Failed security check.

CODE_536: ReturnCode = 536

Data protection level not supported by security mechanism.

CODE_537: ReturnCode = 537

Command protection level not supported by security mechanism.

CODE_550: ReturnCode = 550

Requested action not taken. File unavailable (e.g., file not found, no access).

CODE_551: ReturnCode = 551

Requested action aborted. Page type unknown.

CODE_552: ReturnCode = 552

Requested file action aborted. Exceeded storage allocation (for current directory or dataset).

CODE_553: ReturnCode = 553

Requested action not taken. File name not allowed.

CODE_631: ReturnCode = 631

Integrity protected reply.

CODE_632: ReturnCode = 632

Confidentiality and integrity protected reply.

CODE_633: ReturnCode = 633

Confidentiality protected reply.

classmethod _missing_(value)[source]

Lookup function used when value is not found.

Parameters:

value (int) – Value to get enum item.

Return type:

ReturnCode

Footnotes