zeek/src/analyzer/protocol/smtp/SMTP.h
Arne Welzel 6f05fbf2ce SMTP: Add enable_rfc822_msg_file_analysis
Enabling this option will instantiate a new fa_file instance for every
top-level RFC 822 message in an SMTP transaction.
2025-07-16 11:26:49 +02:00

101 lines
3.7 KiB
C++

// See the file "COPYING" in the main distribution directory for copyright.
#pragma once
#include <list>
#include "zeek/analyzer/protocol/mime/MIME.h"
#include "zeek/analyzer/protocol/tcp/ContentLine.h"
#include "zeek/analyzer/protocol/tcp/TCP.h"
#undef SMTP_CMD_DEF
#define SMTP_CMD_DEF(cmd) SMTP_CMD_##cmd,
namespace zeek::analyzer::smtp {
namespace detail {
class SMTP_BDAT_Analyzer;
enum SMTP_Cmd : uint8_t {
#include "SMTP_cmd.def"
};
// State is updated on every SMTP reply.
enum SMTP_State : uint8_t {
SMTP_CONNECTED, // 0: before the opening message
SMTP_INITIATED, // 1: after opening message 220, EHLO/HELO expected
SMTP_NOT_AVAILABLE, // 2: after opening message 554, etc.
SMTP_READY, // 3: after EHLO/HELO and reply 250
SMTP_MAIL_OK, // 4: after MAIL/SEND/SOML/SAML and 250, RCPT expected
SMTP_RCPT_OK, // 5: after one successful RCPT, DATA or more RCPT expected
SMTP_IN_DATA, // 6: after DATA
SMTP_AFTER_DATA, // 7: after . and before reply
SMTP_IN_AUTH, // 8: after AUTH and 334
SMTP_IN_TLS, // 9: after STARTTLS/X-ANONYMOUSTLS and 220
SMTP_QUIT, // 10: after QUIT
SMTP_AFTER_GAP, // 11: after a gap is detected
SMTP_GAP_RECOVERY, // 12: after the first reply after a gap
SMTP_IN_BDAT, // 13: receiving BDAT chunk via plain delivery
};
} // namespace detail
class SMTP_Analyzer final : public analyzer::tcp::TCP_ApplicationAnalyzer {
public:
explicit SMTP_Analyzer(Connection* conn);
~SMTP_Analyzer() override;
void Done() override;
void DeliverStream(int len, const u_char* data, bool orig) override;
void ConnectionFinished(bool half_finished) override;
void Undelivered(uint64_t seq, int len, bool orig) override;
void SkipData() { skip_data = true; } // skip delivery of data lines
static analyzer::Analyzer* Instantiate(Connection* conn) { return new SMTP_Analyzer(conn); }
protected:
void ProcessLine(int length, const char* line, bool orig);
void NewCmd(int cmd_code);
void NewReply(int reply_code, bool orig);
void ProcessExtension(int ext_len, const char* ext);
void ProcessData(int length, const char* line);
bool ProcessBdatArg(int arg_len, const char* arg, bool orig);
std::string Rfc822MsgDataIn(int len, const u_char* data);
void UpdateState(int cmd_code, int reply_code, bool orig);
void BeginData(bool orig, detail::SMTP_State new_state = detail::SMTP_IN_DATA);
void EndData();
int ParseCmd(int cmd_len, const char* cmd);
void RequestEvent(int cmd_len, const char* cmd, int arg_len, const char* arg);
void Unexpected(bool is_sender, const char* msg, int detail_len, const char* detail);
void UnexpectedCommand(int cmd_code, int reply_code);
void UnexpectedReply(int cmd_code, int reply_code);
void StartTLS();
bool orig_is_sender;
bool expect_sender, expect_recver;
bool pipelining; // whether pipelining is supported
int state;
int last_replied_cmd;
int first_cmd; // first un-replied SMTP cmd, or -1
int pending_reply; // code assoc. w/ multi-line reply, or 0
std::list<int> pending_cmd_q; // to support pipelining
bool skip_data; // whether to skip message body
String* line_after_gap; // last line before the first reply
// after a gap
std::unique_ptr<detail::SMTP_BDAT_Analyzer> bdat; // if set, BDAT chunk transfer active
analyzer::mime::MIME_Mail* mail;
std::string rfc822_msg_fuid; // fuid for mail data file analysis
private:
analyzer::tcp::ContentLine_Analyzer* cl_orig;
analyzer::tcp::ContentLine_Analyzer* cl_resp;
};
} // namespace zeek::analyzer::smtp