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  /* For line >= 4KB */
61 };
62 
63 typedef struct SMTPString_ {
64  uint8_t *str;
65  uint16_t len;
66 
69 
70 typedef struct SMTPTransaction_ {
71  /** id of this tx, starting at 0 */
72  uint64_t tx_id;
73 
74  AppLayerTxData tx_data;
75 
76  int done;
77  /** the first message contained in the session */
79  /** the last message contained in the session */
81  /** the mime decoding parser state */
83 
84  /* MAIL FROM parameters */
85  uint8_t *mail_from;
86  uint16_t mail_from_len;
87 
88  TAILQ_HEAD(, SMTPString_) rcpt_to_list; /**< rcpt to string list */
89 
92 
93 typedef struct SMTPConfig {
94 
97  uint32_t content_limit;
100 
102 
105 
106 typedef struct SMTPState_ {
108  TAILQ_HEAD(, SMTPTransaction_) tx_list; /**< transaction list */
109  uint64_t tx_cnt;
112 
113  /* If rest of the bytes should be discarded in case of long line w/o LF */
115 
116  /** var to indicate parser state */
117  uint8_t parser_state;
118  /** current command in progress */
120  /** bdat chunk len */
121  uint32_t bdat_chunk_len;
122  /** bdat chunk idx */
123  uint32_t bdat_chunk_idx;
124 
125  /* the request commands are store here and the reply handler uses these
126  * stored command in the buffer to match the reply(ies) with the command */
127  /** the command buffer */
128  uint8_t *cmds;
129  /** the buffer length */
130  uint16_t cmds_buffer_len;
131  /** no of commands stored in the above buffer */
132  uint16_t cmds_cnt;
133  /** index of the command in the buffer, currently in inspection by reply
134  * handler */
135  uint16_t cmds_idx;
136 
137  /* HELO of HELO message content */
138  uint16_t helo_len;
139  uint8_t *helo;
140 
141  /* SMTP Mime decoding and file extraction */
142  /** the list of files sent to the server */
144  uint32_t file_track_id;
146 
147 /* Create SMTP config structure */
148 extern SMTPConfig smtp_config;
149 
150 int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state);
151 void *SMTPStateAlloc(void *orig_state, AppProto proto_orig);
152 void RegisterSMTPParsers(void);
153 void SMTPParserCleanup(void);
154 void SMTPParserRegisterTests(void);
155 
156 #endif /* __APP_LAYER_SMTP_H__ */
SMTPConfig::content_limit
uint32_t content_limit
Definition: app-layer-smtp.h:97
SMTPState_
Definition: app-layer-smtp.h:106
FileContainer_
Definition: util-file.h:110
len
uint8_t len
Definition: app-layer-dnp3.h:2
SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
@ SMTP_DECODER_EVENT_MIME_MALFORMED_MSG
Definition: app-layer-smtp.h:46
SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
@ SMTP_DECODER_EVENT_INVALID_PIPELINED_SEQUENCE
Definition: app-layer-smtp.h:38
SMTPState_::cmds_cnt
uint16_t cmds_cnt
Definition: app-layer-smtp.h:132
SMTPProcessDataChunk
int SMTPProcessDataChunk(const uint8_t *chunk, uint32_t len, MimeDecParseState *state)
Definition: app-layer-smtp.c:477
SMTPTransaction_::msg_tail
MimeDecEntity * msg_tail
Definition: app-layer-smtp.h:80
SMTPState_::bdat_chunk_idx
uint32_t bdat_chunk_idx
Definition: app-layer-smtp.h:123
SMTPTransaction_::mime_state
MimeDecParseState * mime_state
Definition: app-layer-smtp.h:82
SMTPParserRegisterTests
void SMTPParserRegisterTests(void)
Definition: app-layer-smtp.c:4334
SMTPConfig
Definition: app-layer-smtp.h:93
SMTPTransaction_::msg_head
MimeDecEntity * msg_head
Definition: app-layer-smtp.h:78
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:80
SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_COMMAND_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:36
SMTPConfig::decode_mime
bool decode_mime
Definition: app-layer-smtp.h:95
SMTPState_::toserver_last_data_stamp
uint64_t toserver_last_data_stamp
Definition: app-layer-smtp.h:111
SMTPStateAlloc
void * SMTPStateAlloc(void *orig_state, AppProto proto_orig)
Definition: app-layer-smtp.c:1429
SMTPState_::tx_cnt
uint64_t tx_cnt
Definition: app-layer-smtp.h:109
SMTP_DECODER_EVENT_INVALID_REPLY
@ SMTP_DECODER_EVENT_INVALID_REPLY
Definition: app-layer-smtp.h:34
SMTPState_::cmds_idx
uint16_t cmds_idx
Definition: app-layer-smtp.h:135
SMTPString
struct SMTPString_ SMTPString
rust.h
SMTP_DECODER_EVENT_MIME_INVALID_QP
@ SMTP_DECODER_EVENT_MIME_INVALID_QP
Definition: app-layer-smtp.h:48
SMTPTransaction_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPTransaction_) next
SMTPConfig::content_inspect_min_size
uint32_t content_inspect_min_size
Definition: app-layer-smtp.h:98
SMTPConfig::raw_extraction
bool raw_extraction
Definition: app-layer-smtp.h:101
SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
@ SMTP_DECODER_EVENT_UNPARSABLE_CONTENT
Definition: app-layer-smtp.h:58
SMTP_DECODER_EVENT_MIME_LONG_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_LINE
Definition: app-layer-smtp.h:49
SMTPParserCleanup
void SMTPParserCleanup(void)
Free memory allocated for global SMTP parser state.
Definition: app-layer-smtp.c:1794
SMTP_DECODER_EVENT_TLS_REJECTED
@ SMTP_DECODER_EVENT_TLS_REJECTED
Definition: app-layer-smtp.h:41
SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_NAME
Definition: app-layer-smtp.h:51
RegisterSMTPParsers
void RegisterSMTPParsers(void)
Register the SMTP Protocol parser.
Definition: app-layer-smtp.c:1740
SMTPState_::helo
uint8_t * helo
Definition: app-layer-smtp.h:139
SMTP_DECODER_EVENT_MIME_PARSE_FAILED
@ SMTP_DECODER_EVENT_MIME_PARSE_FAILED
Definition: app-layer-smtp.h:45
SMTPTransaction_::done
int done
Definition: app-layer-smtp.h:76
SMTPTransaction_::tx_data
AppLayerTxData tx_data
Definition: app-layer-smtp.h:74
SMTPState_::parser_state
uint8_t parser_state
Definition: app-layer-smtp.h:117
SMTPTransaction_::mail_from
uint8_t * mail_from
Definition: app-layer-smtp.h:85
SMTPState_::curr_tx
SMTPTransaction * curr_tx
Definition: app-layer-smtp.h:107
SMTPConfig
struct SMTPConfig SMTPConfig
SMTPTransaction_
Definition: app-layer-smtp.h:70
SMTPState_::current_command
uint8_t current_command
Definition: app-layer-smtp.h:119
SMTPState
struct SMTPState_ SMTPState
queue.h
SMTPTransaction_::mail_from_len
uint16_t mail_from_len
Definition: app-layer-smtp.h:86
SMTP_DECODER_EVENT_MIME_INVALID_BASE64
@ SMTP_DECODER_EVENT_MIME_INVALID_BASE64
Definition: app-layer-smtp.h:47
decode-events.h
MimeDecConfig
Structure for containing configuration options.
Definition: util-decode-mime.h:95
SMTPString_::len
uint16_t len
Definition: app-layer-smtp.h:65
SMTPState_::helo_len
uint16_t helo_len
Definition: app-layer-smtp.h:138
SMTPState_::toserver_data_count
uint64_t toserver_data_count
Definition: app-layer-smtp.h:110
SMTPState_::cmds
uint8_t * cmds
Definition: app-layer-smtp.h:128
SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
@ SMTP_DECODER_EVENT_MIME_LONG_ENC_LINE
Definition: app-layer-smtp.h:50
SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_MAX_REPLY_LINE_LEN_EXCEEDED
Definition: app-layer-smtp.h:37
SMTPTransaction_::tx_id
uint64_t tx_id
Definition: app-layer-smtp.h:72
util-streaming-buffer.h
SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
@ SMTP_DECODER_EVENT_BDAT_CHUNK_LEN_EXCEEDED
Definition: app-layer-smtp.h:39
SMTPState_::files_ts
FileContainer * files_ts
Definition: app-layer-smtp.h:143
util-decode-mime.h
SMTPState_::bdat_chunk_len
uint32_t bdat_chunk_len
Definition: app-layer-smtp.h:121
SMTP_DECODER_EVENT_DUPLICATE_FIELDS
@ SMTP_DECODER_EVENT_DUPLICATE_FIELDS
Definition: app-layer-smtp.h:57
SMTPString_
Definition: app-layer-smtp.h:63
smtp_config
SMTPConfig smtp_config
Definition: app-layer-smtp.c:243
StreamingBufferConfig_
Definition: util-streaming-buffer.h:64
MimeDecParseState
Structure contains the current state of the MIME parser.
Definition: util-decode-mime.h:189
SMTPConfig::mime_config
MimeDecConfig mime_config
Definition: app-layer-smtp.h:96
SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
@ SMTP_DECODER_EVENT_NO_SERVER_WELCOME_MESSAGE
Definition: app-layer-smtp.h:40
SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
@ SMTP_DECODER_EVENT_UNABLE_TO_MATCH_REPLY_WITH_REQUEST
Definition: app-layer-smtp.h:35
SMTPString_::TAILQ_ENTRY
TAILQ_ENTRY(SMTPString_) next
SMTPTransaction_::TAILQ_HEAD
TAILQ_HEAD(, SMTPString_) rcpt_to_list
SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
@ SMTP_DECODER_EVENT_DATA_COMMAND_REJECTED
Definition: app-layer-smtp.h:42
SMTPConfig::sbcfg
StreamingBufferConfig sbcfg
Definition: app-layer-smtp.h:103
SMTPState_::TAILQ_HEAD
TAILQ_HEAD(, SMTPTransaction_) tx_list
SMTP_DECODER_EVENT_MIME_LONG_FILENAME
@ SMTP_DECODER_EVENT_MIME_LONG_FILENAME
Definition: app-layer-smtp.h:54
SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
@ SMTP_DECODER_EVENT_MIME_BOUNDARY_TOO_LONG
Definition: app-layer-smtp.h:53
SMTPString_::str
uint8_t * str
Definition: app-layer-smtp.h:64
SMTPState_::file_track_id
uint32_t file_track_id
Definition: app-layer-smtp.h:144
SMTPTransaction
struct SMTPTransaction_ SMTPTransaction
SMTP_DECODER_EVENT_TRUNCATED_LINE
@ SMTP_DECODER_EVENT_TRUNCATED_LINE
Definition: app-layer-smtp.h:60
SMTPState_::cmds_buffer_len
uint16_t cmds_buffer_len
Definition: app-layer-smtp.h:130
MimeDecEntity
This represents the MIME Entity (or also top level message) in a child-sibling tree.
Definition: util-decode-mime.h:136
SMTPConfig::content_inspect_window
uint32_t content_inspect_window
Definition: app-layer-smtp.h:99
SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
@ SMTP_DECODER_EVENT_MIME_LONG_HEADER_VALUE
Definition: app-layer-smtp.h:52
SMTPState_::discard_till_lf
bool discard_till_lf
Definition: app-layer-smtp.h:114