suricata
app-layer-smtp.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2021 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Anoop Saldanha <anoopsaldanha@gmail.com>
22  */
23 
24 #ifndef SURICATA_APP_LAYER_SMTP_H
25 #define SURICATA_APP_LAYER_SMTP_H
26 
27 #include "util-decode-mime.h"
28 #include "util-streaming-buffer.h"
29 #include "rust.h"
30 
31 /* Limit till the data would be buffered in current line */
32 #define SMTP_LINE_BUFFER_LIMIT 4096
33 
34 enum {
45 
46  /* MIME Events */
57 
58  /* Invalid behavior or content */
61  /* For line >= 4KB */
63 };
64 
65 typedef struct SMTPString_ {
66  uint8_t *str;
67  uint16_t len;
68 
71 
72 typedef struct SMTPTransaction_ {
73  /** id of this tx, starting at 0 */
74  uint64_t tx_id;
75 
77 
78  /** the tx is complete and can be logged and cleaned */
79  bool done;
80  /** the tx has seen a DATA command */
81  // another DATA command within the same context
82  // will trigger an app-layer event.
83  bool is_data;
84  /** the first message contained in the session */
86  /** the last message contained in the session */
88  /** the mime decoding parser state */
90 
91  /* MAIL FROM parameters */
92  uint8_t *mail_from;
93  uint16_t mail_from_len;
94 
95  TAILQ_HEAD(, SMTPString_) rcpt_to_list; /**< rcpt to string list */
96 
98 
101 
102 typedef struct SMTPConfig {
103 
106  uint32_t content_limit;
109  uint64_t max_tx;
110 
112 
115 
116 typedef struct SMTPState_ {
117  AppLayerStateData state_data;
119  TAILQ_HEAD(, SMTPTransaction_) tx_list; /**< transaction list */
120  uint64_t tx_cnt;
123 
124  /* If rest of the bytes should be discarded in case of long line w/o LF */
127 
128  /** var to indicate parser state */
129  uint8_t parser_state;
130  /** current command in progress */
132  /** bdat chunk len */
133  uint32_t bdat_chunk_len;
134  /** bdat chunk idx */
135  uint32_t bdat_chunk_idx;
136 
137  /* the request commands are store here and the reply handler uses these
138  * stored command in the buffer to match the reply(ies) with the command */
139  /** the command buffer */
140  uint8_t *cmds;
141  /** the buffer length */
142  uint16_t cmds_buffer_len;
143  /** no of commands stored in the above buffer */
144  uint16_t cmds_cnt;
145  /** index of the command in the buffer, currently in inspection by reply
146  * handler */
147  uint16_t cmds_idx;
148 
149  /* HELO of HELO message content */
150  uint16_t helo_len;
151  uint8_t *helo;
152 
153  /* SMTP Mime decoding and file extraction */
154  /** the list of files sent to the server */
155  uint32_t file_track_id;
157 
158 /* Create SMTP config structure */
159 extern SMTPConfig smtp_config;
160 
161 int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state);
162 void *SMTPStateAlloc(void *orig_state, AppProto proto_orig);
163 void RegisterSMTPParsers(void);
164 void SMTPParserCleanup(void);
165 void SMTPParserRegisterTests(void);
166 
167 #endif /* SURICATA_APP_LAYER_SMTP_H */
SMTP_DECODER_EVENT_INVALID_REPLY
@ SMTP_DECODER_EVENT_INVALID_REPLY
Definition: app-layer-smtp.h:35
SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
@ SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
Definition: app-layer-smtp.h:55
SMTPConfig::content_limit
uint32_t content_limit
Definition: app-layer-smtp.h:106
SMTPState_
Definition: app-layer-smtp.h:116
SMTP_DECODER_EVENT_TRUNCATED_LINE
@ SMTP_DECODER_EVENT_TRUNCATED_LINE
Definition: app-layer-smtp.h:62
FileContainer_
Definition: util-file.h:113
len
uint8_t len
Definition: app-layer-dnp3.h:2
SMTPState_::cmds_cnt
uint16_t cmds_cnt
Definition: app-layer-smtp.h:144
SMTPProcessDataChunk
int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state)
Definition: app-layer-smtp.c:502
SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
@ SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
Definition: app-layer-smtp.h:41
SMTPTransaction_::msg_tail
MimeDecEntity * msg_tail
Definition: app-layer-smtp.h:87
SMTP_DECODER_EVENT_TLS_REJECTED
@ SMTP_DECODER_EVENT_TLS_REJECTED
Definition: app-layer-smtp.h:42
SMTPState_::bdat_chunk_idx
uint32_t bdat_chunk_idx
Definition: app-layer-smtp.h:135
SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:38
SMTPTransaction_::mime_state
MimeDecParseState * mime_state
Definition: app-layer-smtp.h:89
SMTPParserRegisterTests
void SMTPParserRegisterTests(void)
Definition: app-layer-smtp.c:4253
SMTPConfig
Definition: app-layer-smtp.h:102
SMTPTransaction_::msg_head
MimeDecEntity * msg_head
Definition: app-layer-smtp.h:85
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
SMTPState_::discard_till_lf_tc
bool discard_till_lf_tc
Definition: app-layer-smtp.h:126
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:80
SMTPConfig::decode_mime
bool decode_mime
Definition: app-layer-smtp.h:104
SMTPState_::toserver_last_data_stamp
uint64_t toserver_last_data_stamp
Definition: app-layer-smtp.h:122
SMTPStateAlloc
void * SMTPStateAlloc(void *orig_state, AppProto proto_orig)
Definition: app-layer-smtp.c:1523
SMTPState_::tx_cnt
uint64_t tx_cnt
Definition: app-layer-smtp.h:120
SMTPState_::cmds_idx
uint16_t cmds_idx
Definition: app-layer-smtp.h:147
SMTPString
struct SMTPString_ SMTPString
rust.h
SMTPTransaction_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPTransaction_) next
SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
@ SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
Definition: app-layer-smtp.h:43
SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
Definition: app-layer-smtp.h:53
SMTPConfig::content_inspect_min_size
uint32_t content_inspect_min_size
Definition: app-layer-smtp.h:107
SMTP_DECODER_EVENT_MIME_PARSE_FAILED
@ SMTP_DECODER_EVENT_MIME_PARSE_FAILED
Definition: app-layer-smtp.h:47
SMTPConfig::raw_extraction
bool raw_extraction
Definition: app-layer-smtp.h:111
SMTPParserCleanup
void SMTPParserCleanup(void)
Free memory allocated for global SMTP parser state.
Definition: app-layer-smtp.c:1918
SMTPState_::state_data
AppLayerStateData state_data
Definition: app-layer-smtp.h:117
RegisterSMTPParsers
void RegisterSMTPParsers(void)
Register the SMTP Protocol parser.
Definition: app-layer-smtp.c:1863
SMTPState_::helo
uint8_t * helo
Definition: app-layer-smtp.h:151
SMTPTransaction_::tx_data
AppLayerTxData tx_data
Definition: app-layer-smtp.h:76
SMTPState_::parser_state
uint8_t parser_state
Definition: app-layer-smtp.h:129
SMTPTransaction_::mail_from
uint8_t * mail_from
Definition: app-layer-smtp.h:92
SMTPState_::curr_tx
SMTPTransaction * curr_tx
Definition: app-layer-smtp.h:118
SMTP_DECODER_EVENT_MIME_INVALID_QP
@ SMTP_DECODER_EVENT_MIME_INVALID_QP
Definition: app-layer-smtp.h:50
SMTPState_::discard_till_lf_ts
bool discard_till_lf_ts
Definition: app-layer-smtp.h:125
SMTP_DECODER_EVENT_DUPLICATE_FIELDS
@ SMTP_DECODER_EVENT_DUPLICATE_FIELDS
Definition: app-layer-smtp.h:59
SMTPConfig
struct SMTPConfig SMTPConfig
SMTP_DECODER_EVENT_MIME_LONG_FILENAME
@ SMTP_DECODER_EVENT_MIME_LONG_FILENAME
Definition: app-layer-smtp.h:56
SMTPTransaction_
Definition: app-layer-smtp.h:72
SMTPState_::current_command
uint8_t current_command
Definition: app-layer-smtp.h:131
SMTPTransaction_::files_ts
FileContainer files_ts
Definition: app-layer-smtp.h:97
SMTPState
struct SMTPState_ SMTPState
SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
Definition: app-layer-smtp.h:40
SMTPTransaction_::mail_from_len
uint16_t mail_from_len
Definition: app-layer-smtp.h:93
SMTPConfig::max_tx
uint64_t max_tx
Definition: app-layer-smtp.h:109
SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
@ SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
Definition: app-layer-smtp.h:36
MimeDecConfig
Structure for containing configuration options.
Definition: util-decode-mime.h:91
SMTPString_::len
uint16_t len
Definition: app-layer-smtp.h:67
SMTPState_::helo_len
uint16_t helo_len
Definition: app-layer-smtp.h:150
SMTPState_::toserver_data_count
uint64_t toserver_data_count
Definition: app-layer-smtp.h:121
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1355
SMTPTransaction_::is_data
bool is_data
Definition: app-layer-smtp.h:83
SMTPState_::cmds
uint8_t * cmds
Definition: app-layer-smtp.h:140
SMTPTransaction_::tx_id
uint64_t tx_id
Definition: app-layer-smtp.h:74
util-streaming-buffer.h
util-decode-mime.h
SMTP_DECODER_EVENT_MIME_INVALID_BASE64
@ SMTP_DECODER_EVENT_MIME_INVALID_BASE64
Definition: app-layer-smtp.h:49
SMTPState_::bdat_chunk_len
uint32_t bdat_chunk_len
Definition: app-layer-smtp.h:133
SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
@ SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
Definition: app-layer-smtp.h:48
SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
Definition: app-layer-smtp.h:52
SMTPString_
Definition: app-layer-smtp.h:65
SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
@ SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
Definition: app-layer-smtp.h:60
smtp_config
SMTPConfig smtp_config
Definition: app-layer-smtp.c:246
StreamingBufferConfig_
Definition: util-streaming-buffer.h:65
MimeDecParseState
Structure contains the current state of the MIME parser.
Definition: util-decode-mime.h:186
SMTP_DECODER_EVENT_FAILED_PROTOCOL_CHANGE
@ SMTP_DECODER_EVENT_FAILED_PROTOCOL_CHANGE
Definition: app-layer-smtp.h:44
SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
@ SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
Definition: app-layer-smtp.h:39
SMTPConfig::mime_config
MimeDecConfig mime_config
Definition: app-layer-smtp.h:105
SMTP_DECODER_EVENT_MIME_LONG_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_LINE
Definition: app-layer-smtp.h:51
SMTPString_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPString_) next
SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:37
SMTPTransaction_::done
bool done
Definition: app-layer-smtp.h:79
SMTPTransaction_::TAILQ_HEAD
TAILQ_HEAD(, SMTPString_) rcpt_to_list
SMTPConfig::sbcfg
StreamingBufferConfig sbcfg
Definition: app-layer-smtp.h:113
SMTPState_::TAILQ_HEAD
TAILQ_HEAD(, SMTPTransaction_) tx_list
SMTPString_::str
uint8_t * str
Definition: app-layer-smtp.h:66
SMTPState_::file_track_id
uint32_t file_track_id
Definition: app-layer-smtp.h:155
SMTPTransaction
struct SMTPTransaction_ SMTPTransaction
SMTPState_::cmds_buffer_len
uint16_t cmds_buffer_len
Definition: app-layer-smtp.h:142
MimeDecEntity
This represents the MIME Entity (or also top level message) in a child-sibling tree.
Definition: util-decode-mime.h:132
SMTPConfig::content_inspect_window
uint32_t content_inspect_window
Definition: app-layer-smtp.h:108
SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
Definition: app-layer-smtp.h:54