suricata
|
#include "suricata-common.h"
#include "suricata.h"
#include "packet.h"
#include "decode.h"
#include "detect.h"
#include "flow.h"
#include "flow-util.h"
#include "conf.h"
#include "conf-yaml-loader.h"
#include "threads.h"
#include "threadvars.h"
#include "tm-threads.h"
#include "util-pool.h"
#include "util-pool-thread.h"
#include "util-checksum.h"
#include "util-unittest.h"
#include "util-print.h"
#include "util-debug.h"
#include "util-device.h"
#include "stream-tcp-private.h"
#include "stream-tcp.h"
#include "stream-tcp-cache.h"
#include "stream-tcp-inline.h"
#include "stream-tcp-reassemble.h"
#include "stream-tcp-sack.h"
#include "stream-tcp-util.h"
#include "stream.h"
#include "pkt-var.h"
#include "host.h"
#include "app-layer.h"
#include "app-layer-parser.h"
#include "app-layer-protos.h"
#include "app-layer-htp-mem.h"
#include "util-host-os-info.h"
#include "util-privs.h"
#include "util-profiling.h"
#include "util-misc.h"
#include "util-validate.h"
#include "util-runmodes.h"
#include "util-random.h"
#include "util-exception-policy.h"
#include "util-time.h"
#include "source-pcap-file.h"
#include "action-globals.h"
#include "tests/stream-tcp.c"
Go to the source code of this file.
Macros | |
#define | STREAMTCP_DEFAULT_PREALLOC 2048 |
#define | STREAMTCP_DEFAULT_MEMCAP (64 * 1024 * 1024) /* 64mb */ |
#define | STREAMTCP_DEFAULT_REASSEMBLY_MEMCAP (256 * 1024 * 1024) /* 256mb */ |
#define | STREAMTCP_DEFAULT_TOSERVER_CHUNK_SIZE 2560 |
#define | STREAMTCP_DEFAULT_TOCLIENT_CHUNK_SIZE 2560 |
#define | STREAMTCP_DEFAULT_MAX_SYN_QUEUED 10 |
#define | STREAMTCP_DEFAULT_MAX_SYNACK_QUEUED 5 |
#define | StreamTcpUpdateLastAck(ssn, stream, ack) |
macro to update last_ack only if the new value is higher More... | |
#define | StreamTcpAsyncLastAckUpdate(ssn, stream) |
#define | StreamTcpUpdateNextSeq(ssn, stream, seq) |
#define | StreamTcpUpdateNextWin(ssn, stream, win) |
macro to update next_win only if the new value is higher More... | |
Functions | |
void | StreamTcpReturnStreamSegments (TcpStream *) |
return all segments in this stream into the pool(s) More... | |
void | StreamTcpInitConfig (bool quiet) |
To initialize the stream global configuration data. More... | |
int | StreamTcpGetFlowState (void *) |
void | StreamTcpSetOSPolicy (TcpStream *stream, Packet *p) |
Function to set the OS policy for the given stream based on the destination of the received packet. More... | |
uint64_t | StreamTcpReassembleMemuseGlobalCounter (void) |
SC_ATOMIC_DECLARE (uint64_t, st_memuse) | |
void | StreamTcpInitMemuse (void) |
void | StreamTcpIncrMemuse (uint64_t size) |
void | StreamTcpDecrMemuse (uint64_t size) |
uint64_t | StreamTcpMemuseCounter (void) |
int | StreamTcpCheckMemcap (uint64_t size) |
Check if alloc'ing "size" would mean we're over memcap. More... | |
int | StreamTcpSetMemcap (uint64_t size) |
Update memcap value. More... | |
uint64_t | StreamTcpGetMemcap (void) |
Return memcap value. More... | |
void | StreamTcpStreamCleanup (TcpStream *stream) |
void | StreamTcpSessionCleanup (TcpSession *ssn) |
Session cleanup function. Does not free the ssn. More... | |
void | StreamTcpSessionClear (void *ssnptr) |
Function to return the stream back to the pool. It returns the segments in the stream to the segment pool. More... | |
void | StreamTcpSessionPktFree (Packet *p) |
Function to return the stream segments back to the pool. More... | |
void | StreamTcpFreeConfig (bool quiet) |
int | StreamTcpPacket (ThreadVars *tv, Packet *p, StreamTcpThread *stt, PacketQueueNoLock *pq) |
bool | TcpSessionPacketSsnReuse (const Packet *p, const Flow *f, const void *tcp_ssn) |
TmEcode | StreamTcp (ThreadVars *tv, Packet *p, void *data, PacketQueueNoLock *pq) |
TmEcode | StreamTcpThreadInit (ThreadVars *tv, void *initdata, void **data) |
TmEcode | StreamTcpThreadDeinit (ThreadVars *tv, void *data) |
void | StreamTcpUpdateAppLayerProgress (TcpSession *ssn, char direction, const uint32_t progress) |
update reassembly progress More... | |
void | StreamTcpSetSessionNoReassemblyFlag (TcpSession *ssn, char direction) |
disable reassembly More... | |
void | StreamTcpSetDisableRawReassemblyFlag (TcpSession *ssn, char direction) |
Set the No reassembly flag for the given direction in given TCP session. More... | |
void | StreamTcpSetSessionBypassFlag (TcpSession *ssn) |
enable bypass More... | |
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. In IDS mode, create first in packet dir, 2nd in opposing In IPS mode, do the reverse. Flag TCP engine that data needs to be inspected regardless of how far we are wrt inspect limits. More... | |
int | StreamTcpSegmentForEach (const Packet *p, uint8_t flag, StreamSegmentCallback CallbackFunc, void *data) |
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. More... | |
int | StreamTcpBypassEnabled (void) |
bool | StreamTcpInlineMode (void) |
See if stream engine is operating in inline mode. More... | |
void | TcpSessionSetReassemblyDepth (TcpSession *ssn, uint32_t size) |
const char * | StreamTcpStateAsString (const enum TcpState state) |
const char * | StreamTcpSsnStateAsString (const TcpSession *ssn) |
TCP stream tracking and reassembly engine.
Definition in file stream-tcp.c.
#define STREAMTCP_DEFAULT_MAX_SYN_QUEUED 10 |
Definition at line 91 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_MAX_SYNACK_QUEUED 5 |
Definition at line 92 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_MEMCAP (64 * 1024 * 1024) /* 64mb */ |
Definition at line 87 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_PREALLOC 2048 |
Definition at line 86 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_REASSEMBLY_MEMCAP (256 * 1024 * 1024) /* 256mb */ |
Definition at line 88 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_TOCLIENT_CHUNK_SIZE 2560 |
Definition at line 90 of file stream-tcp.c.
#define STREAMTCP_DEFAULT_TOSERVER_CHUNK_SIZE 2560 |
Definition at line 89 of file stream-tcp.c.
#define StreamTcpAsyncLastAckUpdate | ( | ssn, | |
stream | |||
) |
Definition at line 1063 of file stream-tcp.c.
#define StreamTcpUpdateLastAck | ( | ssn, | |
stream, | |||
ack | |||
) |
macro to update last_ack only if the new value is higher
ssn | session |
stream | stream to update |
ack | ACK value to test and set |
Definition at line 1046 of file stream-tcp.c.
#define StreamTcpUpdateNextSeq | ( | ssn, | |
stream, | |||
seq | |||
) |
Definition at line 1074 of file stream-tcp.c.
#define StreamTcpUpdateNextWin | ( | ssn, | |
stream, | |||
win | |||
) |
macro to update next_win only if the new value is higher
ssn | session |
stream | stream to update |
win | window value to test and set |
Definition at line 1087 of file stream-tcp.c.
SC_ATOMIC_DECLARE | ( | uint64_t | , |
st_memuse | |||
) |
TmEcode StreamTcp | ( | ThreadVars * | tv, |
Packet * | p, | ||
void * | data, | ||
PacketQueueNoLock * | pq | ||
) |
Definition at line 5972 of file stream-tcp.c.
References DEBUG_VALIDATE_BUG_ON, Packet_::flow, FlowGetPacketDirection(), Packet_::pcap_cnt, Packet_::pkt_src, PktSrcToString(), SCLogDebug, t_pcapcnt, TM_ECODE_OK, TOSERVER, and unlikely.
int StreamTcpBypassEnabled | ( | void | ) |
Definition at line 7126 of file stream-tcp.c.
References TcpStreamCnf_::flags, stream_config, and STREAMTCP_INIT_FLAG_BYPASS.
int StreamTcpCheckMemcap | ( | uint64_t | size | ) |
Check if alloc'ing "size" would mean we're over memcap.
1 | if in bounds |
0 | if not in bounds |
Definition at line 266 of file stream-tcp.c.
References SC_ATOMIC_GET, and stream_config.
void StreamTcpDecrMemuse | ( | uint64_t | size | ) |
Definition at line 234 of file stream-tcp.c.
References BUG_ON, RunmodeIsUnittests(), SC_ATOMIC_GET, SC_ATOMIC_SUB, SCLogDebug, and StreamTcpMemuseCounter().
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. In IDS mode, create first in packet dir, 2nd in opposing In IPS mode, do the reverse. Flag TCP engine that data needs to be inspected regardless of how far we are wrt inspect limits.
Definition at line 6960 of file stream-tcp.c.
References TcpSession_::client, TcpStream_::flags, PKT_IS_TOSERVER, Flow_::protoctx, TcpSession_::server, STREAMTCP_STREAM_FLAG_TRIGGER_RAW, StreamTcpInlineMode(), and ts.
void StreamTcpFreeConfig | ( | bool | quiet | ) |
Definition at line 859 of file stream-tcp.c.
References SCMutexLock, and StreamTcpReassembleFree().
Referenced by StreamTcpUTDeinit().
int StreamTcpGetFlowState | ( | void * | ) |
uint64_t StreamTcpGetMemcap | ( | void | ) |
Return memcap value.
memcap | memcap value |
Definition at line 294 of file stream-tcp.c.
References SC_ATOMIC_GET, and stream_config.
void StreamTcpIncrMemuse | ( | uint64_t | size | ) |
Definition at line 228 of file stream-tcp.c.
References SC_ATOMIC_ADD, SCLogDebug, and StreamTcpMemuseCounter().
void StreamTcpInitConfig | ( | bool | quiet | ) |
To initialize the stream global configuration data.
quiet | It tells the mode of operation, if it is true nothing will be get printed. |
Definition at line 488 of file stream-tcp.c.
References TcpStreamCnf_::async_oneside, ConfGet(), ConfGetBool(), ConfGetInt(), ConfGetNode(), EngineModeIsIPS(), ExceptionPolicyMidstreamParse(), ExceptionPolicyParse(), FatalError, TcpStreamCnf_::flags, TcpStreamCnf_::midstream, TcpStreamCnf_::midstream_policy, ParseSizeStringU64(), TcpStreamCnf_::prealloc_sessions, TcpStreamCnf_::reassembly_memcap_policy, RunmodeIsUnittests(), SC_ATOMIC_GET, SC_ATOMIC_INIT, SC_ATOMIC_SET, SCLogDebug, SCLogError, SCLogWarning, TcpStreamCnf_::ssn_memcap_policy, stream_config, STREAMTCP_DEFAULT_MEMCAP, STREAMTCP_DEFAULT_PREALLOC, STREAMTCP_INIT_FLAG_BYPASS, STREAMTCP_INIT_FLAG_CHECKSUM_VALIDATION, STREAMTCP_INIT_FLAG_DROP_INVALID, STREAMTCP_INIT_FLAG_INLINE, TCP_STREAM_URGENT_DEFAULT, TCP_STREAM_URGENT_DROP, TCP_STREAM_URGENT_GAP, TCP_STREAM_URGENT_INLINE, TCP_STREAM_URGENT_OOB, TcpStreamCnf_::urgent_policy, and WarnInvalidConfEntry.
Referenced by PreRunInit(), and StreamTcpUTInit().
void StreamTcpInitMemuse | ( | void | ) |
Definition at line 223 of file stream-tcp.c.
References SC_ATOMIC_INIT.
Referenced by UtRunTests().
bool StreamTcpInlineMode | ( | void | ) |
See if stream engine is operating in inline mode.
0 | no |
1 | yes |
Definition at line 7137 of file stream-tcp.c.
References TcpStreamCnf_::flags, stream_config, and STREAMTCP_INIT_FLAG_INLINE.
Referenced by StreamDataRightEdge(), StreamReassembleRaw(), StreamReassembleRawHasDataReady(), and StreamTcpDetectLogFlush().
uint64_t StreamTcpMemuseCounter | ( | void | ) |
Definition at line 254 of file stream-tcp.c.
References SC_ATOMIC_GET.
Referenced by StreamTcpDecrMemuse(), and StreamTcpIncrMemuse().
int StreamTcpPacket | ( | ThreadVars * | tv, |
Packet * | p, | ||
StreamTcpThread * | stt, | ||
PacketQueueNoLock * | pq | ||
) |
Definition at line 5567 of file stream-tcp.c.
References DEBUG_ASSERT_FLOW_LOCKED, Packet_::flow, Packet_::pcap_cnt, Flow_::protoctx, SCEnter, and SCLogDebug.
uint64_t StreamTcpReassembleMemuseGlobalCounter | ( | void | ) |
Definition at line 150 of file stream-tcp-reassemble.c.
References SC_ATOMIC_GET.
Referenced by StreamTcpReassembleDecrMemuse(), and StreamTcpReassembleIncrMemuse().
void StreamTcpReturnStreamSegments | ( | TcpStream * | stream | ) |
return all segments in this stream into the pool(s)
stream | the stream to cleanup |
Definition at line 398 of file stream-tcp-reassemble.c.
References RB_FOREACH_SAFE, RB_REMOVE, TcpStream_::seg_tree, and StreamTcpSegmentReturntoPool().
Referenced by StreamTcpPruneSession(), StreamTcpSessionPktFree(), and StreamTcpStreamCleanup().
int StreamTcpSegmentForEach | ( | const Packet * | p, |
uint8_t | flag, | ||
StreamSegmentCallback | CallbackFunc, | ||
void * | data | ||
) |
Definition at line 6984 of file stream-tcp.c.
References TcpSession_::client, cnt, TcpStreamCnf_::flags, Packet_::flow, TcpStream_::last_ack, PKT_IS_PSEUDOPKT, Flow_::protoctx, RB_FOREACH, TcpStream_::sb, TcpSegment::sbseg, SCLogDebug, TcpStream_::seg_tree, TcpSegment::seq, SEQ_GEQ, TcpSession_::server, stream_config, STREAM_DUMP_TOSERVER, StreamingBufferSegmentGetData(), and STREAMTCP_INIT_FLAG_INLINE.
Referenced by StreamSegmentForEach().
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 at line 7043 of file stream-tcp.c.
References TcpSession_::client, cnt, Packet_::flow, TcpSegment::pcap_hdr_storage, Flow_::protoctx, RB_MIN, TcpStream_::sb, TcpSegment::sbseg, SCLogDebug, SCTIME_CMP_LT, TcpStream_::seg_tree, TcpSession_::server, StreamingBufferSegmentGetData(), and TcpSegmentPcapHdrStorage_::ts.
Referenced by StreamSegmentForSession().
void StreamTcpSessionCleanup | ( | TcpSession * | ssn | ) |
Session cleanup function. Does not free the ssn.
ssn | tcp session |
Definition at line 327 of file stream-tcp.c.
References TcpSession_::client, SCEnter, TcpSession_::server, and StreamTcpStreamCleanup().
Referenced by StreamTcpSessionClear(), StreamTcpUTClearSession(), and UTHRemoveSessionFromFlow().
void StreamTcpSessionClear | ( | void * | ssnptr | ) |
Function to return the stream back to the pool. It returns the segments in the stream to the segment pool.
This function is called when the flow is destroyed, so it should free everything related to the tcp session. So including the app layer data.
ssn | Void ptr to the ssn. |
Definition at line 351 of file stream-tcp.c.
References pool_id, TcpSession_::pool_id, SCEnter, SCMutexLock, StreamTcpSessionCleanup(), and StreamTcpThreadCacheReturnSession().
void StreamTcpSessionPktFree | ( | Packet * | p | ) |
Function to return the stream segments back to the pool.
p | Packet used to identify the stream. |
Definition at line 380 of file stream-tcp.c.
References TcpSession_::client, Packet_::flow, Flow_::protoctx, SCEnter, SCReturn, TcpSession_::server, and StreamTcpReturnStreamSegments().
void StreamTcpSetDisableRawReassemblyFlag | ( | TcpSession * | ssn, |
char | direction | ||
) |
Set the No reassembly flag for the given direction in given TCP session.
ssn | TCP Session to set the flag in |
direction | direction to set the flag in: 0 toserver, 1 toclient |
Definition at line 6744 of file stream-tcp.c.
References TcpSession_::client, TcpStream_::flags, TcpSession_::server, and STREAMTCP_STREAM_FLAG_NEW_RAW_DISABLED.
int StreamTcpSetMemcap | ( | uint64_t | size | ) |
Update memcap value.
size | new memcap value |
Definition at line 279 of file stream-tcp.c.
References SC_ATOMIC_GET, SC_ATOMIC_SET, and stream_config.
Function to set the OS policy for the given stream based on the destination of the received packet.
stream | TcpStream of which os_policy needs to set |
p | Packet which is used to set the os policy |
Definition at line 1007 of file stream-tcp.c.
Referenced by StreamTcpReassembleHandleSegmentHandleData().
void StreamTcpSetSessionBypassFlag | ( | TcpSession * | ssn | ) |
enable bypass
ssn | TCP Session to set the flag in |
direction | direction to set the flag in: 0 toserver, 1 toclient |
Definition at line 6755 of file stream-tcp.c.
References TcpSession_::flags, and STREAMTCP_FLAG_BYPASS.
void StreamTcpSetSessionNoReassemblyFlag | ( | TcpSession * | ssn, |
char | direction | ||
) |
disable reassembly
Disable app layer and set raw inspect to no longer accept new data. Stream engine will then fully disable raw after last inspection.
ssn | TCP Session to set the flag in |
direction | direction to set the flag in: 0 toserver, 1 toclient |
Definition at line 6728 of file stream-tcp.c.
References TcpSession_::client, TcpStream_::flags, TcpSession_::flags, TcpSession_::server, STREAMTCP_FLAG_APP_LAYER_DISABLED, and STREAMTCP_STREAM_FLAG_NEW_RAW_DISABLED.
const char* StreamTcpSsnStateAsString | ( | const TcpSession * | ssn | ) |
Definition at line 7191 of file stream-tcp.c.
References TcpSession_::state, and StreamTcpStateAsString().
const char* StreamTcpStateAsString | ( | const enum TcpState | state | ) |
Definition at line 7150 of file stream-tcp.c.
References TCP_CLOSE_WAIT, TCP_CLOSED, TCP_CLOSING, TCP_ESTABLISHED, TCP_FIN_WAIT1, TCP_FIN_WAIT2, TCP_LAST_ACK, TCP_NONE, TCP_SYN_RECV, TCP_SYN_SENT, and TCP_TIME_WAIT.
Referenced by StreamTcpSsnStateAsString().
void StreamTcpStreamCleanup | ( | TcpStream * | stream | ) |
Definition at line 300 of file stream-tcp.c.
References TcpStream_::sb, TcpStreamCnf_::sbcnf, stream_config, StreamingBufferClear(), StreamTcpReturnStreamSegments(), and StreamTcpSackFreeList().
Referenced by StreamTcpSessionCleanup(), and StreamTcpUTClearStream().
TmEcode StreamTcpThreadDeinit | ( | ThreadVars * | tv, |
void * | data | ||
) |
Definition at line 6102 of file stream-tcp.c.
References StreamTcpThread_::ra_ctx, SCEnter, SCFree, SCReturnInt, StreamTcpReassembleFreeThreadCtx(), and TM_ECODE_OK.
TmEcode StreamTcpThreadInit | ( | ThreadVars * | tv, |
void * | initdata, | ||
void ** | data | ||
) |
Definition at line 6014 of file stream-tcp.c.
References StreamTcpThread_::counter_tcp_active_sessions, StreamTcpThread_::counter_tcp_sessions, StreamTcpThread_::counter_tcp_ssn_from_cache, StreamTcpThread_::counter_tcp_ssn_from_pool, StreamTcpThread_::counter_tcp_ssn_memcap, StreamTcpThread_::counter_tcp_ssn_memcap_eps, ExceptionPolicySetStatsCounters(), SCCalloc, SCEnter, SCReturnInt, TcpStreamCnf_::ssn_memcap_policy, StreamTcpThread_::ssn_pool_id, StatsRegisterCounter(), stream_config, stream_memcap_eps_stats, StreamTcpThreadCacheEnable(), TM_ECODE_FAILED, tv, and unlikely.
void StreamTcpUpdateAppLayerProgress | ( | TcpSession * | ssn, |
char | direction, | ||
const uint32_t | progress | ||
) |
update reassembly progress
ssn | TCP Session |
direction | direction to set the flag in: 0 toserver, 1 toclient |
Definition at line 6708 of file stream-tcp.c.
References TcpStream_::app_progress_rel, TcpSession_::client, SCLogDebug, TcpSession_::server, and STREAM_APP_PROGRESS.
Definition at line 5960 of file stream-tcp.c.
References Packet_::proto.
void TcpSessionSetReassemblyDepth | ( | TcpSession * | ssn, |
uint32_t | size | ||
) |
Definition at line 7143 of file stream-tcp.c.
References TcpSession_::reassembly_depth.
int g_detect_disabled |
global indicating if detection is enabled
Definition at line 183 of file suricata.c.
PoolThread* ssn_pool = NULL |
Definition at line 213 of file stream-tcp.c.
Referenced by StreamTcpThreadCacheReturnSession().
TcpStreamCnf stream_config |
Definition at line 219 of file stream-tcp.c.
Referenced by StreamTcpBypassEnabled(), StreamTcpCheckMemcap(), StreamTcpGetMemcap(), StreamTcpInitConfig(), StreamTcpInlineMode(), StreamTcpPruneSession(), StreamTcpReassembleCheckMemcap(), StreamTcpReassembleGetMemcap(), StreamTcpReassembleRealloc(), StreamTcpReassembleSetMemcap(), StreamTcpSegmentForEach(), StreamTcpSetMemcap(), StreamTcpStreamCleanup(), StreamTcpThreadInit(), StreamTcpUTDeinit(), StreamTcpUTInitInline(), and UTHAddStreamToFlow().
ExceptionPolicyStatsSetts stream_memcap_eps_stats |
Definition at line 95 of file stream-tcp.c.
Referenced by StreamTcpThreadInit().
ExceptionPolicyStatsSetts stream_midstream_disabled_eps_stats |
Definition at line 173 of file stream-tcp.c.
ExceptionPolicyStatsSetts stream_midstream_enabled_eps_stats |
Definition at line 147 of file stream-tcp.c.
ExceptionPolicyStatsSetts stream_reassembly_memcap_eps_stats |
Definition at line 121 of file stream-tcp.c.
thread_local uint64_t t_pcapcnt |
Definition at line 80 of file stream-tcp-reassemble.c.
Referenced by StreamTcp(), and StreamTcpReassembleCheckMemcap().