FtpLayer.h

Go to the documentation of this file.

#pragma once
 
#include "SingleCommandTextProtocol.h"
#include "PayloadLayer.h"
 
 
namespace pcpp
{
    class FtpLayer : public SingleCommandTextProtocol
    {
    protected:
        FtpLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : SingleCommandTextProtocol(data, dataLen, prevLayer, packet, FTPControl) {};
        FtpLayer(const std::string& command, const std::string& option)
            : SingleCommandTextProtocol(command, option, FTPControl) {};
 
    public:
        static bool isFtpPort(uint16_t port)
        {
            return port == 21;
        }
 
        static bool isFtpDataPort(uint16_t port)
        {
            return port == 20;
        }
 
        // overridden methods
 
        void parseNextLayer() override
        {}
 
        size_t getHeaderLen() const override
        {
            return m_DataLen;
        }
 
        void computeCalculateFields() override
        {}
 
        OsiModelLayer getOsiModelLayer() const override
        {
            return OsiModelApplicationLayer;
        }
    };
 
    class FtpRequestLayer : public FtpLayer
    {
    public:
        enum class FtpCommand : int
        {
            UNK,
            ABOR = ('A') | ('B' << 8) | ('O' << 16) | ('R' << 24),
            ACCT = ('A') | ('C' << 8) | ('C' << 16) | ('T' << 24),
            ADAT = ('A') | ('D' << 8) | ('A' << 16) | ('T' << 24),
            ALLO = ('A') | ('L' << 8) | ('L' << 16) | ('O' << 24),
            APPE = ('A') | ('P' << 8) | ('P' << 16) | ('E' << 24),
            AUTH = ('A') | ('U' << 8) | ('T' << 16) | ('H' << 24),
            AVBL = ('A') | ('V' << 8) | ('B' << 16) | ('L' << 24),
            CCC = ('C') | ('C' << 8) | ('C' << 16),
            CDUP = ('C') | ('D' << 8) | ('U' << 16) | ('P' << 24),
            CONF = ('C') | ('O' << 8) | ('N' << 16) | ('F' << 24),
            CSID = ('C') | ('S' << 8) | ('I' << 16) | ('D' << 24),
            CWD = ('C') | ('W' << 8) | ('D' << 16),
            DELE = ('D') | ('E' << 8) | ('L' << 16) | ('E' << 24),
            DSIZ = ('D') | ('S' << 8) | ('I' << 16) | ('Z' << 24),
            ENC = ('E') | ('N' << 8) | ('C' << 16),
            EPRT = ('E') | ('P' << 8) | ('R' << 16) | ('T' << 24),
            EPSV = ('E') | ('P' << 8) | ('S' << 16) | ('V' << 24),
            FEAT = ('F') | ('E' << 8) | ('A' << 16) | ('T' << 24),
            HELP = ('H') | ('E' << 8) | ('L' << 16) | ('P' << 24),
            HOST = ('H') | ('O' << 8) | ('S' << 16) | ('T' << 24),
            LANG = ('L') | ('A' << 8) | ('N' << 16) | ('G' << 24),
            LIST = ('L') | ('I' << 8) | ('S' << 16) | ('T' << 24),
            LPRT = ('L') | ('P' << 8) | ('R' << 16) | ('T' << 24),
            LPSV = ('L') | ('P' << 8) | ('S' << 16) | ('V' << 24),
            MDTM = ('M') | ('D' << 8) | ('T' << 16) | ('M' << 24),
            MFCT = ('M') | ('F' << 8) | ('C' << 16) | ('T' << 24),
            MFF = ('M') | ('F' << 8) | ('F' << 16),
            MFMT = ('M') | ('F' << 8) | ('M' << 16) | ('T' << 24),
            MIC = ('M') | ('I' << 8) | ('C' << 16),
            MKD = ('M') | ('K' << 8) | ('D' << 16),
            MLSD = ('M') | ('L' << 8) | ('S' << 16) | ('D' << 24),
            MLST = ('M') | ('L' << 8) | ('S' << 16) | ('T' << 24),
            MODE = ('M') | ('O' << 8) | ('D' << 16) | ('E' << 24),
            NLST = ('N') | ('L' << 8) | ('S' << 16) | ('T' << 24),
            NOOP = ('N') | ('O' << 8) | ('O' << 16) | ('P' << 24),
            OPTS = ('O') | ('P' << 8) | ('T' << 16) | ('S' << 24),
            PASS = ('P') | ('A' << 8) | ('S' << 16) | ('S' << 24),
            PASV = ('P') | ('A' << 8) | ('S' << 16) | ('V' << 24),
            PBSZ = ('P') | ('B' << 8) | ('S' << 16) | ('Z' << 24),
            PORT = ('P') | ('O' << 8) | ('R' << 16) | ('T' << 24),
            PROT = ('P') | ('R' << 8) | ('O' << 16) | ('T' << 24),
            PWD = ('P') | ('W' << 8) | ('D' << 16),
            QUIT = ('Q') | ('U' << 8) | ('I' << 16) | ('T' << 24),
            REIN = ('R') | ('E' << 8) | ('I' << 16) | ('N' << 24),
            REST = ('R') | ('E' << 8) | ('S' << 16) | ('T' << 24),
            RETR = ('R') | ('E' << 8) | ('T' << 16) | ('R' << 24),
            RMD = ('R') | ('M' << 8) | ('D' << 16),
            RMDA = ('R') | ('M' << 8) | ('D' << 16) | ('A' << 24),
            RNFR = ('R') | ('N' << 8) | ('F' << 16) | ('R' << 24),
            RNTO = ('R') | ('N' << 8) | ('T' << 16) | ('O' << 24),
            SITE = ('S') | ('I' << 8) | ('T' << 16) | ('E' << 24),
            SIZE = ('S') | ('I' << 8) | ('Z' << 16) | ('E' << 24),
            SMNT = ('S') | ('M' << 8) | ('N' << 16) | ('T' << 24),
            SPSV = ('S') | ('P' << 8) | ('S' << 16) | ('V' << 24),
            STAT = ('S') | ('T' << 8) | ('A' << 16) | ('T' << 24),
            STOR = ('S') | ('T' << 8) | ('O' << 16) | ('R' << 24),
            STOU = ('S') | ('T' << 8) | ('O' << 16) | ('U' << 24),
            STRU = ('S') | ('T' << 8) | ('R' << 16) | ('U' << 24),
            SYST = ('S') | ('Y' << 8) | ('S' << 16) | ('T' << 24),
            THMB = ('T') | ('H' << 8) | ('M' << 16) | ('B' << 24),
            TYPE = ('T') | ('Y' << 8) | ('P' << 16) | ('E' << 24),
            USER = ('U') | ('S' << 8) | ('E' << 16) | ('R' << 24),
            XCUP = ('X') | ('C' << 8) | ('U' << 16) | ('P' << 24),
            XMKD = ('X') | ('M' << 8) | ('K' << 16) | ('D' << 24),
            XPWD = ('X') | ('P' << 8) | ('W' << 16) | ('D' << 24),
            XRCP = ('X') | ('R' << 8) | ('C' << 16) | ('P' << 24),
            XRMD = ('X') | ('R' << 8) | ('M' << 16) | ('D' << 24),
            XRSQ = ('X') | ('R' << 8) | ('S' << 16) | ('Q' << 24),
            XSEM = ('X') | ('S' << 8) | ('E' << 16) | ('M' << 24),
            XSEN = ('X') | ('S' << 8) | ('E' << 16) | ('N' << 24)
        };
 
        FtpRequestLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : FtpLayer(data, dataLen, prevLayer, packet) {};
 
        explicit FtpRequestLayer(const FtpCommand& command, const std::string& option = "")
            : FtpLayer(getCommandAsString(command), option) {};
 
        bool setCommand(FtpCommand code);
 
        FtpCommand getCommand() const;
 
        std::string getCommandString() const;
 
        bool setCommandOption(const std::string& value);
 
        std::string getCommandOption(bool removeEscapeCharacters = true) const;
 
        static std::string getCommandInfo(FtpCommand code);
 
        static std::string getCommandAsString(FtpCommand code);
 
        // overridden methods
 
        std::string toString() const override;
 
        struct SerializedFields : Layer::SerializedFields
        {
            static std::vector<FieldDescriptor> all()
            {
                auto result = Layer::SerializedFields::all();
                std::initializer_list<FieldDescriptor> extra{ Command, CommandOption };
                std::copy(extra.begin(), extra.end(), std::back_inserter(result));
                return result;
            }
 
            static const FieldDescriptor Command;
 
            static const FieldDescriptor CommandOption;
        };
 
    protected:
        void serializeLayer(ObjectScope& serializer) const override;
    };
 
    class FtpResponseLayer : public FtpLayer
    {
    public:
        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
        };
 
        FtpResponseLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : FtpLayer(data, dataLen, prevLayer, packet) {};
 
        explicit FtpResponseLayer(const FtpStatusCode& code, const std::string& option = "")
            : FtpLayer(std::to_string(int(code)), 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;
 
        static std::string getStatusCodeAsString(FtpStatusCode code);
 
        // overridden methods
 
        std::string toString() const override;
 
        struct SerializedFields : Layer::SerializedFields
        {
            static std::vector<FieldDescriptor> all()
            {
                auto result = Layer::SerializedFields::all();
                std::initializer_list<FieldDescriptor> extra{ StatusCode, StatusCodeDescription, StatusOption,
                                                              MultiLine };
                std::copy(extra.begin(), extra.end(), std::back_inserter(result));
                return result;
            }
 
            static const FieldDescriptor StatusCode;
 
            static const FieldDescriptor StatusCodeDescription;
 
            static const FieldDescriptor StatusOption;
 
            static const FieldDescriptor MultiLine;
        };
 
    protected:
        void serializeLayer(ObjectScope& serializer) const override;
    };
 
    class FtpDataLayer : public PayloadLayer
    {
    public:
        FtpDataLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : PayloadLayer(data, dataLen, prevLayer, packet)
        {
            m_Protocol = FTPData;
        };
 
        std::string toString() const override;
    };
}  // namespace pcpp