SmtpLayer.h

Go to the documentation of this file.

#ifndef PACKETPP_SMTP_LAYER
#define PACKETPP_SMTP_LAYER
 
#include "PayloadLayer.h"
#include "SingleCommandTextProtocol.h"
 
 
namespace pcpp
{
    class SmtpLayer : public SingleCommandTextProtocol
    {
    protected:
        SmtpLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : SingleCommandTextProtocol(data, dataLen, prevLayer, packet, SMTP) {};
 
        SmtpLayer(const std::string& command, const std::string& option)
            : SingleCommandTextProtocol(command, option, SMTP) {};
 
    public:
        static bool isSmtpPort(uint16_t port)
        {
            return port == 25 || port == 587;
        }
 
        // overridden methods
 
        void parseNextLayer() override
        {}
 
        size_t getHeaderLen() const override
        {
            return m_DataLen;
        }
 
        void computeCalculateFields() override
        {}
 
        OsiModelLayer getOsiModelLayer() const override
        {
            return OsiModelApplicationLayer;
        }
    };
 
    class SmtpRequestLayer : public SmtpLayer
    {
    public:
        enum class SmtpCommand : uint64_t
        {
            UNK,
            DATA = ('D') | ('A' << 8) | ('T' << 16) | ('A' << 24),
            EHLO = ('E') | ('H' << 8) | ('L' << 16) | ('O' << 24),
            EXPN = ('E') | ('X' << 8) | ('P' << 16) | ('N' << 24),
            HELO = ('H') | ('E' << 8) | ('L' << 16) | ('O' << 24),
            HELP = ('H') | ('E' << 8) | ('L' << 16) | ('P' << 24),
            MAIL = ('M') | ('A' << 8) | ('I' << 16) | ('L' << 24),
            NOOP = ('N') | ('O' << 8) | ('O' << 16) | ('P' << 24),
            QUIT = ('Q') | ('U' << 8) | ('I' << 16) | ('T' << 24),
            RCPT = ('R') | ('C' << 8) | ('P' << 16) | ('T' << 24),
            RSET = ('R') | ('S' << 8) | ('E' << 16) | ('T' << 24),
            VRFY = ('V') | ('R' << 8) | ('F' << 16) | ('Y' << 24),
            STARTTLS = (('S') | ('T' << 8) | ('A' << 16) | ('R' << 24) |
                        static_cast<uint64_t>(('T') | ('T' << 8) | ('L' << 16) | ('S' << 24)) << 32),
            TURN = ('T') | ('U' << 8) | ('R' << 16) | ('N' << 24),
            SEND = ('S') | ('E' << 8) | ('N' << 16) | ('D' << 24),
            SOML = ('S') | ('O' << 8) | ('M' << 16) | ('L' << 24),
            SAML = ('S') | ('A' << 8) | ('M' << 16) | ('L' << 24),
            AUTH = ('A') | ('U' << 8) | ('T' << 16) | ('H' << 24),
            ATRN = ('A') | ('T' << 8) | ('R' << 16) | ('N' << 24),
            BDAT = ('B') | ('D' << 8) | ('A' << 16) | ('T' << 24),
            ETRN = ('E') | ('T' << 8) | ('R' << 16) | ('N' << 24),
            XADR = ('X') | ('A' << 8) | ('D' << 16) | ('R' << 24),
            XCIR = ('X') | ('C' << 8) | ('I' << 16) | ('R' << 24),
            XSTA = ('X') | ('S' << 8) | ('T' << 16) | ('A' << 24),
            XGEN = ('X') | ('G' << 8) | ('E' << 16) | ('N' << 24)
        };
 
        SmtpRequestLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : SmtpLayer(data, dataLen, prevLayer, packet) {};
 
        explicit SmtpRequestLayer(const SmtpCommand& command, const std::string& option = "")
            : SmtpLayer(getCommandAsString(command), option) {};
 
        bool setCommand(SmtpCommand code);
 
        SmtpCommand getCommand() const;
 
        std::string getCommandString() const;
 
        bool setCommandOption(const std::string& value);
 
        std::string getCommandOption(bool removeEscapeCharacters = true) const;
 
        static std::string getCommandInfo(SmtpCommand code);
 
        static std::string getCommandAsString(SmtpCommand 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 SmtpResponseLayer : public SmtpLayer
    {
    public:
        enum class SmtpStatusCode : int
        {
            SYSTEM_STATUS = 211,
            HELP_MESSAGE = 214,
            SERVICE_READY = 220,
            SERVICE_CLOSE = 221,
            AUTH_SUCCESS = 235,
            COMPLETED = 250,
            WILL_FORWARD = 251,
            CANNOT_VERIFY = 252,
            AUTH_INPUT = 334,
            MAIL_INPUT = 354,
            SERVICE_UNAVAILABLE = 421,
            PASS_NEEDED = 432,
            MAILBOX_UNAVAILABLE_TEMP = 450,
            ABORT_LOCAL_ERROR = 451,
            INSUFFICIENT_STORAGE = 452,
            TEMP_AUTH_FAILED = 454,
            PARAM_NOT_ACCOMMODATED = 455,
            CMD_NOT_RECOGNIZED = 500,
            SYNTAX_ERROR_PARAM = 501,
            CMD_NOT_IMPLEMENTED = 502,
            CMD_BAD_SEQUENCE = 503,
            PARAM_NOT_IMPLEMENTED = 504,
            MAIL_NOT_ACCEPTED = 521,
            ENCRYPT_NEED = 523,
            AUTH_REQUIRED = 530,
            AUTH_TOO_WEAK = 534,
            AUTH_CRED_INVALID = 535,
            ENCRYPT_REQUIRED = 538,
            MAILBOX_UNAVAILABLE = 550,
            USER_NOT_LOCAL = 551,
            EXCEED_STORAGE = 552,
            NAME_NOT_ALLOWED = 553,
            TRANSACTION_FAIL = 554,
            DOMAIN_NOT_ACCEPT = 556
        };
 
        SmtpResponseLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : SmtpLayer(data, dataLen, prevLayer, packet) {};
 
        explicit SmtpResponseLayer(const SmtpStatusCode& code, const std::string& option = "")
            : SmtpLayer(std::to_string(int(code)), option) {};
 
        bool setStatusCode(SmtpStatusCode code);
 
        SmtpStatusCode getStatusCode() const;
 
        std::string getStatusCodeString() const;
 
        bool setStatusOption(const std::string& value);
 
        std::string getStatusOption(bool removeEscapeCharacters = true) const;
 
        static std::string getStatusCodeAsString(SmtpStatusCode 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;
    };
}  // namespace pcpp
 
#endif  // PACKETPP_SMTP_LAYER