suricata
app-layer-smtp.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2010 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 __APP_LAYER_SMTP_H__
25 #define __APP_LAYER_SMTP_H__
26 
27 #include "decode-events.h"
28 #include "util-decode-mime.h"
29 #include "queue.h"
30 #include "util-streaming-buffer.h"
31 #include "rust.h"
32 
33 enum {
43 
44  /* MIME Events */
55 
56  /* Invalid behavior or content */
59 };
60 
61 typedef struct SMTPString_ {
62  uint8_t *str;
63  uint16_t len;
64 
67 
68 typedef struct SMTPTransaction_ {
69  /** id of this tx, starting at 0 */
70  uint64_t tx_id;
71 
72  AppLayerTxData tx_data;
73 
74  int done;
75  /** the first message contained in the session */
77  /** the last message contained in the session */
79  /** the mime decoding parser state */
81 
82  AppLayerDecoderEvents *decoder_events; /**< per tx events */
84 
85  /* MAIL FROM parameters */
86  uint8_t *mail_from;
87  uint16_t mail_from_len;
88 
89  TAILQ_HEAD(, SMTPString_) rcpt_to_list; /**< rcpt to string list */
90 
93 
94 typedef struct SMTPConfig {
95 
98  uint32_t content_limit;
101 
103 
106 
107 typedef struct SMTPState_ {
109  TAILQ_HEAD(, SMTPTransaction_) tx_list; /**< transaction list */
110  uint64_t tx_cnt;
113 
114  /* current input that is being parsed */
115  const uint8_t *input;
116  int32_t input_len;
117  uint8_t direction;
118 
119  /* --parser details-- */
120  /** current line extracted by the parser from the call to SMTPGetline() */
121  const uint8_t *current_line;
122  /** length of the line in current_line. Doesn't include the delimiter */
125 
126  /** used to indicate if the current_line buffer is a malloced buffer. We
127  * use a malloced buffer, if a line is fragmented */
128  uint8_t *tc_db;
129  int32_t tc_db_len;
131  /** we have see LF for the currently parsed line */
133 
134  /** used to indicate if the current_line buffer is a malloced buffer. We
135  * use a malloced buffer, if a line is fragmented */
136  uint8_t *ts_db;
137  int32_t ts_db_len;
139  /** we have see LF for the currently parsed line */
141 
142  /** var to indicate parser state */
143  uint8_t parser_state;
144  /** current command in progress */
146  /** bdat chunk len */
147  uint32_t bdat_chunk_len;
148  /** bdat chunk idx */
149  uint32_t bdat_chunk_idx;
150 
151  /* the request commands are store here and the reply handler uses these
152  * stored command in the buffer to match the reply(ies) with the command */
153  /** the command buffer */
154  uint8_t *cmds;
155  /** the buffer length */
156  uint16_t cmds_buffer_len;
157  /** no of commands stored in the above buffer */
158  uint16_t cmds_cnt;
159  /** index of the command in the buffer, currently in inspection by reply
160  * handler */
161  uint16_t cmds_idx;
162 
163  /* HELO of HELO message content */
164  uint16_t helo_len;
165  uint8_t *helo;
166 
167  /* SMTP Mime decoding and file extraction */
168  /** the list of files sent to the server */
170  uint32_t file_track_id;
172 
173 /* Create SMTP config structure */
174 extern SMTPConfig smtp_config;
175 
176 int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state);
177 void *SMTPStateAlloc(void *orig_state, AppProto proto_orig);
178 void RegisterSMTPParsers(void);
179 void SMTPParserCleanup(void);
180 void SMTPParserRegisterTests(void);
181 
182 #endif /* __APP_LAYER_SMTP_H__ */
SMTPConfig::content_limit
uint32_t content_limit
Definition: app-layer-smtp.h:98
SMTPState_
Definition: app-layer-smtp.h:107
SMTPState_::ts_db_len
int32_t ts_db_len
Definition: app-layer-smtp.h:137
FileContainer_
Definition: util-file.h:100
len
uint8_t len
Definition: app-layer-dnp3.h:2
SMTP_DECODER_EVENT_TLS_REJECTED
@ SMTP_DECODER_EVENT_TLS_REJECTED
Definition: app-layer-smtp.h:41
SMTPState_::cmds_cnt
uint16_t cmds_cnt
Definition: app-layer-smtp.h:158
SMTPProcessDataChunk
int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state)
Definition: app-layer-smtp.c:408
SMTPTransaction_::msg_tail
MimeDecEntity * msg_tail
Definition: app-layer-smtp.h:78
DetectEngineState_
Definition: detect-engine-state.h:92
SMTPState_::bdat_chunk_idx
uint32_t bdat_chunk_idx
Definition: app-layer-smtp.h:149
SMTPState_::current_line_len
int32_t current_line_len
Definition: app-layer-smtp.h:123
SMTPState_::current_line
const uint8_t * current_line
Definition: app-layer-smtp.h:121
SMTPState_::current_line_delimiter_len
uint8_t current_line_delimiter_len
Definition: app-layer-smtp.h:124
SMTPTransaction_::mime_state
MimeDecParseState * mime_state
Definition: app-layer-smtp.h:80
SMTPParserRegisterTests
void SMTPParserRegisterTests(void)
Definition: app-layer-smtp.c:5308
SMTPConfig
Definition: app-layer-smtp.h:94
SMTPState_::tc_current_line_db
uint8_t tc_current_line_db
Definition: app-layer-smtp.h:130
SMTPTransaction_::msg_head
MimeDecEntity * msg_head
Definition: app-layer-smtp.h:76
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
SMTPState_::tc_db
uint8_t * tc_db
Definition: app-layer-smtp.h:128
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:73
SMTPState_::input_len
int32_t input_len
Definition: app-layer-smtp.h:116
SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:36
SMTP_DECODER_EVENT_INVALID_REPLY
@ SMTP_DECODER_EVENT_INVALID_REPLY
Definition: app-layer-smtp.h:34
SMTPState_::toserver_last_data_stamp
uint64_t toserver_last_data_stamp
Definition: app-layer-smtp.h:112
SMTPStateAlloc
void * SMTPStateAlloc(void *orig_state, AppProto proto_orig)
Definition: app-layer-smtp.c:1435
SMTPState_::tx_cnt
uint64_t tx_cnt
Definition: app-layer-smtp.h:110
SMTPState_::cmds_idx
uint16_t cmds_idx
Definition: app-layer-smtp.h:161
SMTPString
struct SMTPString_ SMTPString
rust.h
SMTPTransaction_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPTransaction_) next
SMTPState_::ts_current_line_lf_seen
uint8_t ts_current_line_lf_seen
Definition: app-layer-smtp.h:140
SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
@ SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
Definition: app-layer-smtp.h:38
SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
@ SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
Definition: app-layer-smtp.h:35
SMTPState_::direction
uint8_t direction
Definition: app-layer-smtp.h:117
AppLayerDecoderEvents_
Data structure to store app layer decoder events.
Definition: app-layer-events.h:34
SMTPState_::tc_db_len
int32_t tc_db_len
Definition: app-layer-smtp.h:129
SMTPConfig::content_inspect_min_size
uint32_t content_inspect_min_size
Definition: app-layer-smtp.h:99
SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
Definition: app-layer-smtp.h:51
SMTPParserCleanup
void SMTPParserCleanup(void)
Free memory allocated for global SMTP parser state.
Definition: app-layer-smtp.c:1840
SMTP_DECODER_EVENT_MIME_PARSE_FAILED
@ SMTP_DECODER_EVENT_MIME_PARSE_FAILED
Definition: app-layer-smtp.h:45
SMTP_DECODER_EVENT_MIME_LONG_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_LINE
Definition: app-layer-smtp.h:49
SMTP_DECODER_EVENT_MIME_INVALID_BASE64
@ SMTP_DECODER_EVENT_MIME_INVALID_BASE64
Definition: app-layer-smtp.h:47
RegisterSMTPParsers
void RegisterSMTPParsers(void)
Register the SMTP Protocol parser.
Definition: app-layer-smtp.c:1782
SMTPState_::helo
uint8_t * helo
Definition: app-layer-smtp.h:165
SMTPConfig::decode_mime
int decode_mime
Definition: app-layer-smtp.h:96
SMTPTransaction_::done
int done
Definition: app-layer-smtp.h:74
SMTPTransaction_::tx_data
AppLayerTxData tx_data
Definition: app-layer-smtp.h:72
SMTPState_::parser_state
uint8_t parser_state
Definition: app-layer-smtp.h:143
SMTPTransaction_::mail_from
uint8_t * mail_from
Definition: app-layer-smtp.h:86
SMTPState_::input
const uint8_t * input
Definition: app-layer-smtp.h:115
SMTPState_::curr_tx
SMTPTransaction * curr_tx
Definition: app-layer-smtp.h:108
SMTPConfig
struct SMTPConfig SMTPConfig
SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:37
SMTPTransaction_
Definition: app-layer-smtp.h:68
SMTPConfig::raw_extraction
int raw_extraction
Definition: app-layer-smtp.h:102
SMTPState_::current_command
uint8_t current_command
Definition: app-layer-smtp.h:145
SMTPState
struct SMTPState_ SMTPState
queue.h
SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
@ SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
Definition: app-layer-smtp.h:58
SMTPTransaction_::mail_from_len
uint16_t mail_from_len
Definition: app-layer-smtp.h:87
SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
Definition: app-layer-smtp.h:39
decode-events.h
MimeDecConfig
Structure for containing configuration options.
Definition: util-decode-mime.h:94
SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
Definition: app-layer-smtp.h:50
SMTPString_::len
uint16_t len
Definition: app-layer-smtp.h:63
SMTPState_::helo_len
uint16_t helo_len
Definition: app-layer-smtp.h:164
SMTP_DECODER_EVENT_MIME_LONG_FILENAME
@ SMTP_DECODER_EVENT_MIME_LONG_FILENAME
Definition: app-layer-smtp.h:54
SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
@ SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
Definition: app-layer-smtp.h:40
SMTPState_::toserver_data_count
uint64_t toserver_data_count
Definition: app-layer-smtp.h:111
SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
@ SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
Definition: app-layer-smtp.h:53
SMTPState_::cmds
uint8_t * cmds
Definition: app-layer-smtp.h:154
SMTPTransaction_::tx_id
uint64_t tx_id
Definition: app-layer-smtp.h:70
util-streaming-buffer.h
SMTPState_::files_ts
FileContainer * files_ts
Definition: app-layer-smtp.h:169
util-decode-mime.h
SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
@ SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
Definition: app-layer-smtp.h:42
SMTPState_::bdat_chunk_len
uint32_t bdat_chunk_len
Definition: app-layer-smtp.h:147
SMTP_DECODER_EVENT_DUPLICATE_FIELDS
@ SMTP_DECODER_EVENT_DUPLICATE_FIELDS
Definition: app-layer-smtp.h:57
SMTPString_
Definition: app-layer-smtp.h:61
smtp_config
SMTPConfig smtp_config
Definition: app-layer-smtp.c:240
StreamingBufferConfig_
Definition: util-streaming-buffer.h:67
MimeDecParseState
Structure contains the current state of the MIME parser.
Definition: util-decode-mime.h:187
SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
Definition: app-layer-smtp.h:52
SMTPTransaction_::decoder_events
AppLayerDecoderEvents * decoder_events
Definition: app-layer-smtp.h:82
SMTPState_::ts_db
uint8_t * ts_db
Definition: app-layer-smtp.h:136
SMTPConfig::mime_config
MimeDecConfig mime_config
Definition: app-layer-smtp.h:97
SMTPString_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPString_) next
SMTP_DECODER_EVENT_MIME_INVALID_QP
@ SMTP_DECODER_EVENT_MIME_INVALID_QP
Definition: app-layer-smtp.h:48
SMTPTransaction_::TAILQ_HEAD
TAILQ_HEAD(, SMTPString_) rcpt_to_list
SMTPConfig::sbcfg
StreamingBufferConfig sbcfg
Definition: app-layer-smtp.h:104
SMTPState_::TAILQ_HEAD
TAILQ_HEAD(, SMTPTransaction_) tx_list
SMTPTransaction_::de_state
DetectEngineState * de_state
Definition: app-layer-smtp.h:83
SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
@ SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
Definition: app-layer-smtp.h:46
SMTPString_::str
uint8_t * str
Definition: app-layer-smtp.h:62
SMTPState_::file_track_id
uint32_t file_track_id
Definition: app-layer-smtp.h:170
SMTPTransaction
struct SMTPTransaction_ SMTPTransaction
SMTPState_::cmds_buffer_len
uint16_t cmds_buffer_len
Definition: app-layer-smtp.h:156
SMTPState_::ts_current_line_db
uint8_t ts_current_line_db
Definition: app-layer-smtp.h:138
SMTPState_::tc_current_line_lf_seen
uint8_t tc_current_line_lf_seen
Definition: app-layer-smtp.h:132
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:100