suricata
stream-tcp.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 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 Victor Julien <victor@inliniac.net>
22  * \author Gurvinder Singh <gurvindersinghdahiya@gmail.com>
23  */
24 
25 #ifndef __STREAM_TCP_H__
26 #define __STREAM_TCP_H__
27 
28 #include "stream-tcp-private.h"
29 
30 #include "stream.h"
31 #include "stream-tcp-reassemble.h"
32 #include "suricata.h"
33 
34 #define STREAM_VERBOSE false
35 /* Flag to indicate that the checksum validation for the stream engine
36  has been enabled */
37 #define STREAMTCP_INIT_FLAG_CHECKSUM_VALIDATION BIT_U8(0)
38 #define STREAMTCP_INIT_FLAG_DROP_INVALID BIT_U8(1)
39 #define STREAMTCP_INIT_FLAG_BYPASS BIT_U8(2)
40 #define STREAMTCP_INIT_FLAG_INLINE BIT_U8(3)
41 
42 /*global flow data*/
43 typedef struct TcpStreamCnf_ {
44  /** stream tracking
45  *
46  * max stream mem usage
47  */
48  SC_ATOMIC_DECLARE(uint64_t, memcap);
49  SC_ATOMIC_DECLARE(uint64_t, reassembly_memcap); /**< max memory usage for stream reassembly */
50 
51  uint16_t stream_init_flags; /**< new stream flags will be initialized to this */
52 
53  /* coccinelle: TcpStreamCnf:flags:STREAMTCP_INIT_ */
54  uint8_t flags;
56 
57  uint32_t prealloc_sessions; /**< ssns to prealloc per stream thread */
58  uint32_t prealloc_segments; /**< segments to prealloc per stream thread */
59  bool midstream;
62  uint8_t max_syn_queued;
63 
64  uint32_t reassembly_depth; /**< Depth until when we reassemble the stream */
65 
68 
72 
73  /* default to "LINUX" timestamp behavior if true*/
75 
78 
79 typedef struct StreamTcpThread_ {
81 
84  /** sessions not picked up because memcap was reached */
88  /** pseudo packets processed */
90  /** pseudo packets failed to setup */
92  /** packets rejected because their csum is invalid */
94  /** midstream pickups */
96  /** wrong thread */
98  /** ack for unseen data */
100 
101  /** tcp reassembly thread data */
104 
106 void StreamTcpInitConfig(bool);
107 void StreamTcpFreeConfig(bool);
108 void StreamTcpRegisterTests (void);
109 
111 
112 void StreamTcpInitMemuse(void);
113 void StreamTcpIncrMemuse(uint64_t);
114 void StreamTcpDecrMemuse(uint64_t);
115 int StreamTcpSetMemcap(uint64_t);
116 uint64_t StreamTcpGetMemcap(void);
117 int StreamTcpCheckMemcap(uint64_t);
118 uint64_t StreamTcpMemuseCounter(void);
120 
121 int StreamTcpSegmentForEach(const Packet *p, uint8_t flag,
122  StreamSegmentCallback CallbackFunc,
123  void *data);
125  const Packet *p, uint8_t flag, StreamSegmentCallback CallbackFunc, void *data);
127 void TcpSessionSetReassemblyDepth(TcpSession *ssn, uint32_t size);
128 
129 typedef int (*StreamReassembleRawFunc)(
130  void *data, const uint8_t *input, const uint32_t input_len, const uint64_t offset);
131 
133  void *cb_data, const uint64_t offset, const bool eof);
134 int StreamReassembleLog(TcpSession *ssn, TcpStream *stream,
135  StreamReassembleRawFunc Callback, void *cb_data,
136  uint64_t progress_in,
137  uint64_t *progress_out, bool eof);
138 int StreamReassembleRaw(TcpSession *ssn, const Packet *p,
139  StreamReassembleRawFunc Callback, void *cb_data,
140  uint64_t *progress_out, bool respect_inspect_depth);
141 void StreamReassembleRawUpdateProgress(TcpSession *ssn, Packet *p, const uint64_t progress);
142 
144 
145 const char *StreamTcpStateAsString(const enum TcpState);
146 const char *StreamTcpSsnStateAsString(const TcpSession *ssn);
147 
148 /** ------- Inline functions: ------ */
149 
150 /**
151  * \brief If we are on IPS mode, and got a drop action triggered from
152  * the IP only module, or from a reassembled msg and/or from an
153  * applayer detection, then drop the rest of the packets of the
154  * same stream and avoid inspecting it any further
155  * \param p pointer to the Packet to check
156  * \retval 1 if we must drop this stream
157  * \retval 0 if the stream still legal
158  */
159 static inline int StreamTcpCheckFlowDrops(Packet *p)
160 {
161  /* If we are on IPS mode, and got a drop action triggered from
162  * the IP only module, or from a reassembled msg and/or from an
163  * applayer detection, then drop the rest of the packets of the
164  * same stream and avoid inspecting it any further */
165  if (EngineModeIsIPS() && (p->flow->flags & FLOW_ACTION_DROP))
166  return 1;
167 
168  return 0;
169 }
170 
171 enum {
172  /* stream has no segments for forced reassembly, nor for detection */
174  /* stream has no segments for forced reassembly, but only segments that
175  * have been sent for detection, but are stuck in the detection queues */
177 };
178 
180 uint8_t StreamNeedsReassembly(const TcpSession *ssn, uint8_t direction);
181 TmEcode StreamTcpThreadInit(ThreadVars *, void *, void **);
183 
185  PacketQueueNoLock *pq);
186 /* clear ssn and return to pool */
187 void StreamTcpSessionClear(void *ssnptr);
188 /* cleanup ssn, but don't free ssn */
190 /* cleanup stream, but don't free the stream */
191 void StreamTcpStreamCleanup(TcpStream *stream);
192 /* check if bypass is enabled */
193 int StreamTcpBypassEnabled(void);
194 bool StreamTcpInlineMode(void);
195 
196 int TcpSessionPacketSsnReuse(const Packet *p, const Flow *f, const void *tcp_ssn);
197 
198 void StreamTcpUpdateAppLayerProgress(TcpSession *ssn, char direction,
199  const uint32_t progress);
200 
201 uint64_t StreamTcpGetAcked(const TcpStream *stream);
202 uint64_t StreamTcpGetUsable(const TcpStream *stream, const bool eof);
203 uint64_t StreamDataRightEdge(const TcpStream *stream, const bool eof);
204 
205 void StreamTcpThreadCacheEnable(void);
206 void StreamTcpThreadCacheCleanup(void);
207 
208 #endif /* __STREAM_TCP_H__ */
209 
StreamReassembleRawFunc
int(* StreamReassembleRawFunc)(void *data, const uint8_t *input, const uint32_t input_len, const uint64_t offset)
Definition: stream-tcp.h:129
StreamTcpThread_::counter_tcp_midstream_pickups
uint16_t counter_tcp_midstream_pickups
Definition: stream-tcp.h:95
StreamSegmentCallback
int(* StreamSegmentCallback)(const Packet *, TcpSegment *, void *, const uint8_t *, uint32_t)
Definition: stream.h:36
TcpStream_
Definition: stream-tcp-private.h:106
TcpStreamCnf_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, memcap)
StreamTcpPacket
int StreamTcpPacket(ThreadVars *tv, Packet *p, StreamTcpThread *stt, PacketQueueNoLock *pq)
Definition: stream-tcp.c:5312
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
TcpStreamCnf
struct TcpStreamCnf_ TcpStreamCnf
StreamTcpSegmentForEach
int StreamTcpSegmentForEach(const Packet *p, uint8_t flag, StreamSegmentCallback CallbackFunc, void *data)
Definition: stream-tcp.c:6700
StreamTcpDecrMemuse
void StreamTcpDecrMemuse(uint64_t)
Definition: stream-tcp.c:131
StreamTcpCheckMemcap
int StreamTcpCheckMemcap(uint64_t)
Check if alloc'ing "size" would mean we're over memcap.
Definition: stream-tcp.c:164
StreamTcpReassembleConfigEnableOverlapCheck
void StreamTcpReassembleConfigEnableOverlapCheck(void)
Definition: stream-tcp-list.c:40
StreamTcpThread_
Definition: stream-tcp.h:79
TcpStreamCnf_::async_oneside
bool async_oneside
Definition: stream-tcp.h:60
TcpStreamCnf_::reassembly_depth
uint32_t reassembly_depth
Definition: stream-tcp.h:64
Flow_
Flow data structure.
Definition: flow.h:350
TcpStreamCnf_::flags
uint8_t flags
Definition: stream-tcp.h:54
StreamTcpThread_::counter_tcp_ssn_from_cache
uint16_t counter_tcp_ssn_from_cache
Definition: stream-tcp.h:86
StreamTcpThread_::counter_tcp_sessions
uint16_t counter_tcp_sessions
Definition: stream-tcp.h:83
StreamReassembleRaw
int StreamReassembleRaw(TcpSession *ssn, const Packet *p, StreamReassembleRawFunc Callback, void *cb_data, uint64_t *progress_out, bool respect_inspect_depth)
Definition: stream-tcp-reassemble.c:1856
TcpStreamCnf_::sbcnf
StreamingBufferConfig sbcnf
Definition: stream-tcp.h:76
StreamTcpMemuseCounter
uint64_t StreamTcpMemuseCounter(void)
Definition: stream-tcp.c:152
StreamTcpGetAcked
uint64_t StreamTcpGetAcked(const TcpStream *stream)
Definition: stream-tcp-reassemble.c:415
StreamTcpGetMemcap
uint64_t StreamTcpGetMemcap(void)
Return memcap value.
Definition: stream-tcp.c:192
StreamTcpSessionPktFree
void StreamTcpSessionPktFree(Packet *)
Function to return the stream segments back to the pool.
Definition: stream-tcp.c:278
TcpStreamCnf_::max_syn_queued
uint8_t max_syn_queued
Definition: stream-tcp.h:62
stream-tcp-reassemble.h
FLOW_ACTION_DROP
#define FLOW_ACTION_DROP
Definition: flow.h:66
TcpStreamCnf_
Definition: stream-tcp.h:43
TcpStreamCnf_::streaming_log_api
bool streaming_log_api
Definition: stream-tcp.h:61
TcpStreamCnf_::midstream_policy
enum ExceptionPolicy midstream_policy
Definition: stream-tcp.h:71
StreamTcpSessionClear
void StreamTcpSessionClear(void *ssnptr)
Function to return the stream back to the pool. It returns the segments in the stream to the segment ...
Definition: stream-tcp.c:249
PacketQueueNoLock_
simple fifo queue for packets
Definition: packet-queue.h:34
TcpState
TcpState
Definition: stream-tcp-private.h:150
STREAM_HAS_UNPROCESSED_SEGMENTS_NONE
@ STREAM_HAS_UNPROCESSED_SEGMENTS_NONE
Definition: stream-tcp.h:173
StreamTcpThread_::counter_tcp_ssn_memcap
uint16_t counter_tcp_ssn_memcap
Definition: stream-tcp.h:85
TcpStreamCnf_::ssn_memcap_policy
enum ExceptionPolicy ssn_memcap_policy
Definition: stream-tcp.h:69
StreamTcpBypassEnabled
int StreamTcpBypassEnabled(void)
Definition: stream-tcp.c:6842
StreamTcpIncrMemuse
void StreamTcpIncrMemuse(uint64_t)
Definition: stream-tcp.c:124
StreamTcpThreadInit
TmEcode StreamTcpThreadInit(ThreadVars *, void *, void **)
Definition: stream-tcp.c:5750
StreamTcpThread_::counter_tcp_wrong_thread
uint16_t counter_tcp_wrong_thread
Definition: stream-tcp.h:97
StreamTcpThread_::counter_tcp_invalid_checksum
uint16_t counter_tcp_invalid_checksum
Definition: stream-tcp.h:93
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
StreamTcpUpdateAppLayerProgress
void StreamTcpUpdateAppLayerProgress(TcpSession *ssn, char direction, const uint32_t progress)
update reassembly progress
Definition: stream-tcp.c:6429
StreamTcpStreamCleanup
void StreamTcpStreamCleanup(TcpStream *stream)
Definition: stream-tcp.c:198
StreamTcpInlineMode
bool StreamTcpInlineMode(void)
See if stream engine is operating in inline mode.
Definition: stream-tcp.c:6853
TcpStreamCnf_::liberal_timestamps
bool liberal_timestamps
Definition: stream-tcp.h:74
ExceptionPolicy
ExceptionPolicy
Definition: util-exception-policy.h:27
stream.h
StreamTcpDetectLogFlush
void StreamTcpDetectLogFlush(ThreadVars *tv, StreamTcpThread *stt, Flow *f, Packet *p, PacketQueueNoLock *pq)
create packets in both directions to flush out logging and detection before switching protocols....
Definition: stream-tcp.c:6676
TcpStreamCnf_::max_synack_queued
uint8_t max_synack_queued
Definition: stream-tcp.h:55
Packet_
Definition: decode.h:430
StreamTcpReassembleMemuseGlobalCounter
uint64_t StreamTcpReassembleMemuseGlobalCounter(void)
Definition: stream-tcp-reassemble.c:148
stream-tcp-private.h
StreamTcpRegisterTests
void StreamTcpRegisterTests(void)
Definition: stream-tcp.c:3401
TcpSessionSetReassemblyDepth
void TcpSessionSetReassemblyDepth(TcpSession *ssn, uint32_t size)
Definition: stream-tcp.c:6859
TmEcode
TmEcode
Definition: tm-threads-common.h:83
StreamTcpSessionCleanup
void StreamTcpSessionCleanup(TcpSession *ssn)
Session cleanup function. Does not free the ssn.
Definition: stream-tcp.c:225
StreamTcpThread_::counter_tcp_ssn_from_pool
uint16_t counter_tcp_ssn_from_pool
Definition: stream-tcp.h:87
StreamTcpThreadCacheCleanup
void StreamTcpThreadCacheCleanup(void)
Definition: stream-tcp-cache.c:134
StreamReassembleForFrame
int StreamReassembleForFrame(TcpSession *ssn, TcpStream *stream, StreamReassembleRawFunc Callback, void *cb_data, const uint64_t offset, const bool eof)
Definition: stream-tcp-reassemble.c:1844
TcpSessionPacketSsnReuse
int TcpSessionPacketSsnReuse(const Packet *p, const Flow *f, const void *tcp_ssn)
Definition: stream-tcp.c:5696
TcpStreamCnf_::reassembly_memcap_policy
enum ExceptionPolicy reassembly_memcap_policy
Definition: stream-tcp.h:70
StreamTcp
TmEcode StreamTcp(ThreadVars *, Packet *, void *, PacketQueueNoLock *)
Definition: stream-tcp.c:5708
StreamTcpInitConfig
void StreamTcpInitConfig(bool)
To initialize the stream global configuration data.
Definition: stream-tcp.c:359
StreamTcpThread_::counter_tcp_pseudo_failed
uint16_t counter_tcp_pseudo_failed
Definition: stream-tcp.h:91
Packet_::flow
struct Flow_ * flow
Definition: decode.h:469
StreamTcpThreadCacheEnable
void StreamTcpThreadCacheEnable(void)
enable segment cache. Should only be done for worker threads
Definition: stream-tcp-cache.c:48
STREAM_HAS_UNPROCESSED_SEGMENTS_NEED_ONLY_DETECTION
@ STREAM_HAS_UNPROCESSED_SEGMENTS_NEED_ONLY_DETECTION
Definition: stream-tcp.h:176
StreamTcpSsnStateAsString
const char * StreamTcpSsnStateAsString(const TcpSession *ssn)
Definition: stream-tcp.c:6909
StreamTcpStateAsString
const char * StreamTcpStateAsString(const enum TcpState)
Definition: stream-tcp.c:6868
StreamReassembleLog
int StreamReassembleLog(TcpSession *ssn, TcpStream *stream, StreamReassembleRawFunc Callback, void *cb_data, uint64_t progress_in, uint64_t *progress_out, bool eof)
Definition: stream-tcp-reassemble.c:1921
StreamTcpThread_::counter_tcp_active_sessions
uint16_t counter_tcp_active_sessions
Definition: stream-tcp.h:82
TcpStreamCnf_::prealloc_sessions
uint32_t prealloc_sessions
Definition: stream-tcp.h:57
stream_config
TcpStreamCnf stream_config
Definition: stream-tcp.c:115
TcpStreamCnf_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, reassembly_memcap)
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
StreamTcpThreadDeinit
TmEcode StreamTcpThreadDeinit(ThreadVars *tv, void *data)
Definition: stream-tcp.c:5818
TcpStreamCnf_::midstream
bool midstream
Definition: stream-tcp.h:59
TcpStreamCnf_::reassembly_toclient_chunk_size
uint16_t reassembly_toclient_chunk_size
Definition: stream-tcp.h:67
StreamingBufferConfig_
Definition: util-streaming-buffer.h:66
StreamTcpInitMemuse
void StreamTcpInitMemuse(void)
Definition: stream-tcp.c:119
StreamTcpThread
struct StreamTcpThread_ StreamTcpThread
StreamTcpGetUsable
uint64_t StreamTcpGetUsable(const TcpStream *stream, const bool eof)
Definition: stream-tcp-reassemble.c:430
StreamTcpSetMemcap
int StreamTcpSetMemcap(uint64_t)
Update memcap value.
Definition: stream-tcp.c:177
StreamDataRightEdge
uint64_t StreamDataRightEdge(const TcpStream *stream, const bool eof)
Definition: stream-tcp-reassemble.c:421
Flow_::flags
uint32_t flags
Definition: flow.h:420
StreamTcpThread_::counter_tcp_pseudo
uint16_t counter_tcp_pseudo
Definition: stream-tcp.h:89
StreamTcpThread_::ra_ctx
TcpReassemblyThreadCtx * ra_ctx
Definition: stream-tcp.h:102
TcpStreamCnf_::stream_init_flags
uint16_t stream_init_flags
Definition: stream-tcp.h:51
TcpReassemblyThreadCtx_
Definition: stream-tcp-reassemble.h:60
StreamTcpSegmentForSession
int StreamTcpSegmentForSession(const Packet *p, uint8_t flag, StreamSegmentCallback CallbackFunc, void *data)
Run callback function on each TCP segment in both directions of a session.
Definition: stream-tcp.c:6759
TcpStreamCnf_::prealloc_segments
uint32_t prealloc_segments
Definition: stream-tcp.h:58
EngineModeIsIPS
int EngineModeIsIPS(void)
Definition: suricata.c:229
suricata.h
TcpSession_
Definition: stream-tcp-private.h:283
StreamTcpThread_::ssn_pool_id
int ssn_pool_id
Definition: stream-tcp.h:80
StreamNeedsReassembly
uint8_t StreamNeedsReassembly(const TcpSession *ssn, uint8_t direction)
see what if any work the TCP session still needs
Definition: stream-tcp-reassemble.c:916
StreamTcpThread_::counter_tcp_ack_unseen_data
uint16_t counter_tcp_ack_unseen_data
Definition: stream-tcp.h:99
TcpStreamCnf_::reassembly_toserver_chunk_size
uint16_t reassembly_toserver_chunk_size
Definition: stream-tcp.h:66
StreamTcpFreeConfig
void StreamTcpFreeConfig(bool)
Definition: stream-tcp.c:690
StreamReassembleRawUpdateProgress
void StreamReassembleRawUpdateProgress(TcpSession *ssn, Packet *p, const uint64_t progress)
update stream engine after detection
Definition: stream-tcp-reassemble.c:1511