suricata
stream-tcp.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2024 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 SURICATA_STREAM_TCP_H
26 #define SURICATA_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"
34 
35 #define STREAM_VERBOSE false
36 /* Flag to indicate that the checksum validation for the stream engine
37  has been enabled */
38 #define STREAMTCP_INIT_FLAG_CHECKSUM_VALIDATION BIT_U8(0)
39 #define STREAMTCP_INIT_FLAG_DROP_INVALID BIT_U8(1)
40 #define STREAMTCP_INIT_FLAG_BYPASS BIT_U8(2)
41 #define STREAMTCP_INIT_FLAG_INLINE BIT_U8(3)
42 
43 /*global flow data*/
44 typedef struct TcpStreamCnf_ {
45  /** stream tracking
46  *
47  * max stream mem usage
48  */
49  SC_ATOMIC_DECLARE(uint64_t, memcap);
50  SC_ATOMIC_DECLARE(uint64_t, reassembly_memcap); /**< max memory usage for stream reassembly */
51 
52  uint16_t stream_init_flags; /**< new stream flags will be initialized to this */
53 
54  /* coccinelle: TcpStreamCnf:flags:STREAMTCP_INIT_ */
55  uint8_t flags;
57 
58  uint32_t prealloc_sessions; /**< ssns to prealloc per stream thread */
59  uint32_t prealloc_segments; /**< segments to prealloc per stream thread */
60  bool midstream;
63  uint8_t max_syn_queued;
64 
65  uint32_t reassembly_depth; /**< Depth until when we reassemble the stream */
66 
69 
73 
74  /* default to "LINUX" timestamp behavior if true*/
76 
79 
80 typedef struct StreamTcpThread_ {
82 
85  /** sessions not picked up because memcap was reached */
89  /** exception policy */
91  /** pseudo packets processed */
93  /** pseudo packets failed to setup */
95  /** packets rejected because their csum is invalid */
97  /** midstream pickups */
99  /** exception policy stats */
101  /** wrong thread */
103  /** ack for unseen data */
105 
106  /** tcp reassembly thread data */
109 
111 void StreamTcpInitConfig(bool);
112 void StreamTcpFreeConfig(bool);
113 void StreamTcpRegisterTests (void);
114 
116 
117 void StreamTcpInitMemuse(void);
118 void StreamTcpIncrMemuse(uint64_t);
119 void StreamTcpDecrMemuse(uint64_t);
120 int StreamTcpSetMemcap(uint64_t);
121 uint64_t StreamTcpGetMemcap(void);
122 int StreamTcpCheckMemcap(uint64_t);
123 uint64_t StreamTcpMemuseCounter(void);
125 
126 int StreamTcpSegmentForEach(const Packet *p, uint8_t flag,
127  StreamSegmentCallback CallbackFunc,
128  void *data);
130  const Packet *p, uint8_t flag, StreamSegmentCallback CallbackFunc, void *data);
132 void TcpSessionSetReassemblyDepth(TcpSession *ssn, uint32_t size);
133 
134 typedef int (*StreamReassembleRawFunc)(
135  void *data, const uint8_t *input, const uint32_t input_len, const uint64_t offset);
136 
138  void *cb_data, const uint64_t offset, const bool eof);
139 int StreamReassembleLog(const TcpSession *ssn, const TcpStream *stream,
140  StreamReassembleRawFunc Callback, void *cb_data, const uint64_t progress_in,
141  uint64_t *progress_out, const bool eof);
142 int StreamReassembleRaw(TcpSession *ssn, const Packet *p,
143  StreamReassembleRawFunc Callback, void *cb_data,
144  uint64_t *progress_out, bool respect_inspect_depth);
145 void StreamReassembleRawUpdateProgress(TcpSession *ssn, Packet *p, const uint64_t progress);
146 
148 
149 const char *StreamTcpStateAsString(const enum TcpState);
150 const char *StreamTcpSsnStateAsString(const TcpSession *ssn);
151 
152 /** ------- Inline functions: ------ */
153 
154 /**
155  * \brief If we are on IPS mode, and got a drop action triggered from
156  * the IP only module, or from a reassembled msg and/or from an
157  * applayer detection, then drop the rest of the packets of the
158  * same stream and avoid inspecting it any further
159  * \param p pointer to the Packet to check
160  * \retval 1 if we must drop this stream
161  * \retval 0 if the stream still legal
162  */
163 static inline int StreamTcpCheckFlowDrops(Packet *p)
164 {
165  /* If we are on IPS mode, and got a drop action triggered from
166  * the IP only module, or from a reassembled msg and/or from an
167  * applayer detection, then drop the rest of the packets of the
168  * same stream and avoid inspecting it any further */
169  if (EngineModeIsIPS() && (p->flow->flags & FLOW_ACTION_DROP))
170  return 1;
171 
172  return 0;
173 }
174 
175 enum {
176  /* stream has no segments for forced reassembly, nor for detection */
178  /* stream has no segments for forced reassembly, but only segments that
179  * have been sent for detection, but are stuck in the detection queues */
181 };
182 
184 uint8_t StreamNeedsReassembly(const TcpSession *ssn, uint8_t direction);
185 TmEcode StreamTcpThreadInit(ThreadVars *, void *, void **);
187 
189  PacketQueueNoLock *pq);
190 /* clear ssn and return to pool */
191 void StreamTcpSessionClear(void *ssnptr);
192 /* cleanup ssn, but don't free ssn */
194 /* cleanup stream, but don't free the stream */
195 void StreamTcpStreamCleanup(TcpStream *stream);
196 /* check if bypass is enabled */
197 int StreamTcpBypassEnabled(void);
198 bool StreamTcpInlineMode(void);
199 
200 bool TcpSessionPacketSsnReuse(const Packet *p, const Flow *f, const void *tcp_ssn);
201 
202 void StreamTcpUpdateAppLayerProgress(TcpSession *ssn, char direction,
203  const uint32_t progress);
204 
205 uint64_t StreamTcpGetUsable(const TcpStream *stream, const bool eof);
206 uint64_t StreamDataRightEdge(const TcpStream *stream, const bool eof);
207 
208 void StreamTcpThreadCacheEnable(void);
209 void StreamTcpThreadCacheCleanup(void);
210 
211 #endif /* SURICATA_STREAM_TCP_H */
StreamReassembleRawFunc
int(* StreamReassembleRawFunc)(void *data, const uint8_t *input, const uint32_t input_len, const uint64_t offset)
Definition: stream-tcp.h:134
StreamTcpThread_::counter_tcp_midstream_pickups
uint16_t counter_tcp_midstream_pickups
Definition: stream-tcp.h:98
StreamSegmentCallback
int(* StreamSegmentCallback)(const Packet *, TcpSegment *, void *, const uint8_t *, uint32_t)
Definition: stream.h:36
STREAM_HAS_UNPROCESSED_SEGMENTS_NEED_ONLY_DETECTION
@ STREAM_HAS_UNPROCESSED_SEGMENTS_NEED_ONLY_DETECTION
Definition: stream-tcp.h:180
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:5492
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:6904
StreamTcpDecrMemuse
void StreamTcpDecrMemuse(uint64_t)
Definition: stream-tcp.c:234
StreamTcpCheckMemcap
int StreamTcpCheckMemcap(uint64_t)
Check if alloc'ing "size" would mean we're over memcap.
Definition: stream-tcp.c:266
StreamTcpReassembleConfigEnableOverlapCheck
void StreamTcpReassembleConfigEnableOverlapCheck(void)
Definition: stream-tcp-list.c:40
StreamTcpThread_
Definition: stream-tcp.h:80
TcpStreamCnf_::async_oneside
bool async_oneside
Definition: stream-tcp.h:61
TcpStreamCnf_::reassembly_depth
uint32_t reassembly_depth
Definition: stream-tcp.h:65
Flow_
Flow data structure.
Definition: flow.h:360
TcpStreamCnf_::flags
uint8_t flags
Definition: stream-tcp.h:55
StreamTcpThread_::counter_tcp_ssn_from_cache
uint16_t counter_tcp_ssn_from_cache
Definition: stream-tcp.h:87
StreamTcpThread_::counter_tcp_sessions
uint16_t counter_tcp_sessions
Definition: stream-tcp.h:84
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:1853
TcpStreamCnf_::sbcnf
StreamingBufferConfig sbcnf
Definition: stream-tcp.h:77
StreamTcpMemuseCounter
uint64_t StreamTcpMemuseCounter(void)
Definition: stream-tcp.c:254
util-exception-policy-types.h
StreamTcpGetMemcap
uint64_t StreamTcpGetMemcap(void)
Return memcap value.
Definition: stream-tcp.c:294
StreamTcpSessionPktFree
void StreamTcpSessionPktFree(Packet *)
Function to return the stream segments back to the pool.
Definition: stream-tcp.c:380
TcpStreamCnf_::max_syn_queued
uint8_t max_syn_queued
Definition: stream-tcp.h:63
stream-tcp-reassemble.h
FLOW_ACTION_DROP
#define FLOW_ACTION_DROP
Definition: flow.h:69
TcpStreamCnf_
Definition: stream-tcp.h:44
TcpStreamCnf_::streaming_log_api
bool streaming_log_api
Definition: stream-tcp.h:62
TcpStreamCnf_::midstream_policy
enum ExceptionPolicy midstream_policy
Definition: stream-tcp.h:72
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:351
PacketQueueNoLock_
simple fifo queue for packets
Definition: packet-queue.h:34
TcpState
TcpState
Definition: stream-tcp-private.h:150
StreamTcpThread_::counter_tcp_ssn_memcap
uint16_t counter_tcp_ssn_memcap
Definition: stream-tcp.h:86
TcpStreamCnf_::ssn_memcap_policy
enum ExceptionPolicy ssn_memcap_policy
Definition: stream-tcp.h:70
ExceptionPolicyCounters_
Definition: util-exception-policy-types.h:43
StreamTcpBypassEnabled
int StreamTcpBypassEnabled(void)
Definition: stream-tcp.c:7046
StreamTcpIncrMemuse
void StreamTcpIncrMemuse(uint64_t)
Definition: stream-tcp.c:228
StreamTcpThreadInit
TmEcode StreamTcpThreadInit(ThreadVars *, void *, void **)
Definition: stream-tcp.c:5935
StreamTcpThread_::counter_tcp_wrong_thread
uint16_t counter_tcp_wrong_thread
Definition: stream-tcp.h:102
StreamTcpThread_::counter_tcp_invalid_checksum
uint16_t counter_tcp_invalid_checksum
Definition: stream-tcp.h:96
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:6628
StreamTcpStreamCleanup
void StreamTcpStreamCleanup(TcpStream *stream)
Definition: stream-tcp.c:300
StreamTcpInlineMode
bool StreamTcpInlineMode(void)
See if stream engine is operating in inline mode.
Definition: stream-tcp.c:7057
TcpStreamCnf_::liberal_timestamps
bool liberal_timestamps
Definition: stream-tcp.h:75
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:6880
TcpStreamCnf_::max_synack_queued
uint8_t max_synack_queued
Definition: stream-tcp.h:56
Packet_
Definition: decode.h:482
StreamTcpReassembleMemuseGlobalCounter
uint64_t StreamTcpReassembleMemuseGlobalCounter(void)
Definition: stream-tcp-reassemble.c:148
stream-tcp-private.h
StreamTcpRegisterTests
void StreamTcpRegisterTests(void)
Definition: stream-tcp.c:3405
TcpSessionSetReassemblyDepth
void TcpSessionSetReassemblyDepth(TcpSession *ssn, uint32_t size)
Definition: stream-tcp.c:7063
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:327
StreamTcpThread_::counter_tcp_ssn_from_pool
uint16_t counter_tcp_ssn_from_pool
Definition: stream-tcp.h:88
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:1841
TcpStreamCnf_::reassembly_memcap_policy
enum ExceptionPolicy reassembly_memcap_policy
Definition: stream-tcp.h:71
StreamTcp
TmEcode StreamTcp(ThreadVars *, Packet *, void *, PacketQueueNoLock *)
Definition: stream-tcp.c:5893
StreamTcpInitConfig
void StreamTcpInitConfig(bool)
To initialize the stream global configuration data.
Definition: stream-tcp.c:461
StreamTcpThread_::counter_tcp_pseudo_failed
uint16_t counter_tcp_pseudo_failed
Definition: stream-tcp.h:94
Packet_::flow
struct Flow_ * flow
Definition: decode.h:521
StreamTcpThreadCacheEnable
void StreamTcpThreadCacheEnable(void)
enable segment cache. Should only be done for worker threads
Definition: stream-tcp-cache.c:48
StreamTcpSsnStateAsString
const char * StreamTcpSsnStateAsString(const TcpSession *ssn)
Definition: stream-tcp.c:7111
StreamTcpStateAsString
const char * StreamTcpStateAsString(const enum TcpState)
Definition: stream-tcp.c:7070
StreamTcpThread_::counter_tcp_active_sessions
uint16_t counter_tcp_active_sessions
Definition: stream-tcp.h:83
TcpStreamCnf_::prealloc_sessions
uint32_t prealloc_sessions
Definition: stream-tcp.h:58
stream_config
TcpStreamCnf stream_config
Definition: stream-tcp.c:219
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:6022
TcpStreamCnf_::midstream
bool midstream
Definition: stream-tcp.h:60
TcpStreamCnf_::reassembly_toclient_chunk_size
uint16_t reassembly_toclient_chunk_size
Definition: stream-tcp.h:68
StreamingBufferConfig_
Definition: util-streaming-buffer.h:65
StreamTcpInitMemuse
void StreamTcpInitMemuse(void)
Definition: stream-tcp.c:223
StreamTcpThread
struct StreamTcpThread_ StreamTcpThread
StreamTcpGetUsable
uint64_t StreamTcpGetUsable(const TcpStream *stream, const bool eof)
Definition: stream-tcp-reassemble.c:425
StreamTcpSetMemcap
int StreamTcpSetMemcap(uint64_t)
Update memcap value.
Definition: stream-tcp.c:279
StreamDataRightEdge
uint64_t StreamDataRightEdge(const TcpStream *stream, const bool eof)
Definition: stream-tcp-reassemble.c:416
Flow_::flags
uint32_t flags
Definition: flow.h:430
StreamTcpThread_::counter_tcp_pseudo
uint16_t counter_tcp_pseudo
Definition: stream-tcp.h:92
StreamTcpThread_::ra_ctx
TcpReassemblyThreadCtx * ra_ctx
Definition: stream-tcp.h:107
TcpStreamCnf_::stream_init_flags
uint16_t stream_init_flags
Definition: stream-tcp.h:52
TcpReassemblyThreadCtx_
Definition: stream-tcp-reassemble.h:61
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:6963
TcpStreamCnf_::prealloc_segments
uint32_t prealloc_segments
Definition: stream-tcp.h:59
STREAM_HAS_UNPROCESSED_SEGMENTS_NONE
@ STREAM_HAS_UNPROCESSED_SEGMENTS_NONE
Definition: stream-tcp.h:177
StreamTcpThread_::counter_tcp_ssn_memcap_eps
ExceptionPolicyCounters counter_tcp_ssn_memcap_eps
Definition: stream-tcp.h:90
EngineModeIsIPS
int EngineModeIsIPS(void)
Definition: suricata.c:230
suricata.h
TcpSessionPacketSsnReuse
bool TcpSessionPacketSsnReuse(const Packet *p, const Flow *f, const void *tcp_ssn)
Definition: stream-tcp.c:5881
TcpSession_
Definition: stream-tcp-private.h:283
StreamTcpThread_::ssn_pool_id
int ssn_pool_id
Definition: stream-tcp.h:81
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:914
ExceptionPolicy
ExceptionPolicy
Definition: util-exception-policy-types.h:25
StreamTcpThread_::counter_tcp_ack_unseen_data
uint16_t counter_tcp_ack_unseen_data
Definition: stream-tcp.h:104
StreamTcpThread_::counter_tcp_midstream_eps
ExceptionPolicyCounters counter_tcp_midstream_eps
Definition: stream-tcp.h:100
TcpStreamCnf_::reassembly_toserver_chunk_size
uint16_t reassembly_toserver_chunk_size
Definition: stream-tcp.h:67
StreamTcpFreeConfig
void StreamTcpFreeConfig(bool)
Definition: stream-tcp.c:792
StreamReassembleRawUpdateProgress
void StreamReassembleRawUpdateProgress(TcpSession *ssn, Packet *p, const uint64_t progress)
update stream engine after detection
Definition: stream-tcp-reassemble.c:1506
StreamReassembleLog
int StreamReassembleLog(const TcpSession *ssn, const TcpStream *stream, StreamReassembleRawFunc Callback, void *cb_data, const uint64_t progress_in, uint64_t *progress_out, const bool eof)
Definition: stream-tcp-reassemble.c:1918