suricata
|
Flow data structure. More...
#include <flow.h>
Flow data structure.
The flow is a global data structure that is created for new packets of a flow and then looked up for the following packets of a flow.
Locking
The flow is updated/used by multiple packets at the same time. This is why there is a flow-mutex. It's a mutex and not a spinlock because some operations on the flow can be quite expensive, thus spinning would be too expensive.
The flow "header" (addresses, ports, proto, recursion level) are static after the initialization and remain read-only throughout the entire live of a flow. This is why we can access those without protection of the lock.
union { ... } |
union { ... } |
union { ... } |
AppLayerParserState* Flow_::alparser |
application level storage ptrs. parser internal state
Definition at line 474 of file flow.h.
Referenced by AppLayerFrameDump(), AppLayerFramesFreeContainer(), AppLayerFramesGetContainer(), AppLayerFramesSetupContainer(), AppLayerParserParse(), AppLayerProtoDetectReset(), FlowCleanupAppLayer(), FlowForceReassemblyNeedReassembly(), LLVMFuzzerTestOneInput(), Prefilter(), and StreamTcpDisableAppLayer().
AppProto Flow_::alproto |
application level protocol
Definition at line 449 of file flow.h.
Referenced by AppLayerFramesSetupContainer(), AppLayerHandleTCPData(), AppLayerIncAllocErrorCounter(), AppLayerIncGapErrorCounter(), AppLayerIncInternalErrorCounter(), AppLayerIncParserErrorCounter(), AppLayerIncTxCounter(), AppLayerParserSetTransactionInspectId(), AppLayerParserStateCleanup(), AppLayerProtoDetectReset(), AppLayerRequestProtocolChange(), DetectEngineInspectBufferGeneric(), DetectRunFrameInspectRule(), DetectRunStoreStateTx(), EveAddAppProto(), FlowForceReassemblyNeedReassembly(), FrameJsonLogOneFrame(), LLVMFuzzerTestOneInput(), Prefilter(), RulesDumpMatchArray(), and RulesDumpTxMatchArray().
AppProto Flow_::alproto_expect |
expected app protocol: used in protocol change/upgrade like in STARTTLS.
Definition at line 458 of file flow.h.
Referenced by AppLayerRequestProtocolChange(), and EveAddAppProto().
AppProto Flow_::alproto_orig |
original application level protocol. Used to indicate the previous protocol when changing to another protocol , e.g. with STARTTLS.
Definition at line 455 of file flow.h.
Referenced by AppLayerRequestProtocolChange(), and EveAddAppProto().
AppProto Flow_::alproto_tc |
Definition at line 451 of file flow.h.
Referenced by AppLayerHandleTCPData(), AppLayerHandleUdp(), AppLayerProtoDetectReset(), AppLayerRequestProtocolChange(), and EveAddAppProto().
AppProto Flow_::alproto_ts |
Definition at line 450 of file flow.h.
Referenced by AppLayerHandleTCPData(), AppLayerHandleUdp(), AppLayerProtoDetectReset(), AppLayerRequestProtocolChange(), and EveAddAppProto().
void* Flow_::alstate |
application layer state
Definition at line 475 of file flow.h.
Referenced by DetectFileInspectGeneric(), FlowCleanupAppLayer(), FlowForceReassemblyNeedReassembly(), and SMTPProcessDataChunk().
uint32_t Flow_::de_ctx_version |
Port Flow_::dp |
tcp/udp destination port
Definition at line 366 of file flow.h.
Referenced by FlowGetDestinationPort(), FlowInit(), and LLVMFuzzerTestOneInput().
FlowAddress Flow_::dst |
Definition at line 353 of file flow.h.
Referenced by FlowInit(), and LLVMFuzzerTestOneInput().
struct { ... } Flow_::esp |
struct FlowBucket_* Flow_::fb |
uint8_t Flow_::ffr_tc |
Definition at line 382 of file flow.h.
Referenced by FlowForceReassemblyNeedReassembly().
uint8_t Flow_::ffr_ts |
Definition at line 381 of file flow.h.
Referenced by FlowForceReassemblyNeedReassembly().
uint16_t Flow_::file_flags |
file tracking/extraction flags
Definition at line 422 of file flow.h.
Referenced by FileFlowToFlags().
uint32_t Flow_::flags |
generic flags
Definition at line 420 of file flow.h.
Referenced by ExceptionPolicyParse(), FlowChangeProto(), FlowClearMemory(), FlowGetFlags(), FlowGetPacketDirection(), FlowHandlePacketUpdate(), FlowHasAlerts(), FlowInit(), FlowSetChangeProtoFlag(), FlowSetHasAlertsFlag(), FlowSetIPOnlyFlag(), FlowSwap(), FlowUnsetChangeProtoFlag(), LLVMFuzzerTestOneInput(), and StreamTcpReassembleHandleSegment().
uint32_t Flow_::flow_hash |
FlowStateType Flow_::flow_state |
Definition at line 411 of file flow.h.
Referenced by FlowHandlePacketUpdate(), FlowUpdateState(), and PacketBypassCallback().
GenericVar* Flow_::flowvar |
Definition at line 485 of file flow.h.
Referenced by EveAddMetadata(), FlowVarAddIdValue(), FlowVarAddIntNoLock(), FlowVarAddKeyValue(), FlowVarGet(), and FlowVarGetByKey().
struct { ... } Flow_::icmp_d |
struct { ... } Flow_::icmp_s |
Referenced by FlowInit().
SCTime_t Flow_::lastts |
Definition at line 409 of file flow.h.
Referenced by AppLayerExpectationCreate(), FlowGetLastTimeAsParts(), and FlowHandlePacketUpdate().
struct LiveDevice_* Flow_::livedev |
uint8_t Flow_::max_ttl_toserver |
Definition at line 467 of file flow.h.
Referenced by FlowInit().
uint8_t Flow_::min_ttl_toserver |
struct Flow_* Flow_::next |
Definition at line 395 of file flow.h.
Referenced by FlowGetExistingFlowFromFlowId(), FlowQueuePrivateAppendFlow(), FlowQueuePrivateAppendPrivate(), FlowQueuePrivateGetFromTop(), FlowQueuePrivatePrependFlow(), FlowReset(), FlowShutdown(), and StatsReleaseCounters().
uint32_t Flow_::probing_parser_toclient_alproto_masks |
Definition at line 418 of file flow.h.
Referenced by AppLayerProtoDetectReset(), and FlowSwap().
uint32_t Flow_::probing_parser_toserver_alproto_masks |
Definition at line 417 of file flow.h.
Referenced by AppLayerProtoDetectReset(), and FlowSwap().
uint8_t Flow_::proto |
Definition at line 372 of file flow.h.
Referenced by AppLayerFrameDump(), AppLayerFramesSetupContainer(), AppLayerParserParse(), AppLayerParserSetTransactionInspectId(), DetectEngineInspectBufferGeneric(), DetectRunFrameInspectRule(), DetectRunStoreStateTx(), FlowCleanupAppLayer(), FlowGetDisruptionFlags(), FlowHasGaps(), FlowInit(), FlowReset(), FlowShutdown(), FrameJsonLogOneFrame(), FramesPrune(), LLVMFuzzerTestOneInput(), StreamTcpAppLayerIsDisabled(), UTHAddStreamToFlow(), and UTHRemoveSessionFromFlow().
void* Flow_::protoctx |
protocol specific data pointer, e.g. for TcpSession
Definition at line 440 of file flow.h.
Referenced by AppLayerFrameDump(), AppLayerFramesSetupContainer(), AppLayerFramesSlide(), AppLayerParserTriggerRawStreamReassembly(), DetectEngineInspectStreamPayload(), FlowClearMemory(), FlowForceReassemblyNeedReassembly(), FlowGetDisruptionFlags(), FlowHasGaps(), FramesPrune(), LLVMFuzzerTestOneInput(), SMTPProcessDataChunk(), StreamTcpAppLayerIsDisabled(), StreamTcpDetectLogFlush(), StreamTcpDisableAppLayer(), StreamTcpPacket(), StreamTcpPruneSession(), StreamTcpReassembleDepthReached(), StreamTcpSegmentForEach(), StreamTcpSegmentForSession(), StreamTcpSessionPktFree(), UTHAddSessionToFlow(), UTHAddStreamToFlow(), and UTHRemoveSessionFromFlow().
uint16_t Flow_::protodetect_dp |
destination port to be used in protocol detection. This is meant for use with STARTTLS and HTTP CONNECT detection 0 if not used
Definition at line 426 of file flow.h.
Referenced by AppLayerRequestProtocolChange().
uint8_t Flow_::protomap |
mapping to Flow's protocol specific protocols for timeouts and state and free functions.
Definition at line 444 of file flow.h.
Referenced by AppLayerIncAllocErrorCounter(), AppLayerIncGapErrorCounter(), AppLayerIncInternalErrorCounter(), AppLayerIncParserErrorCounter(), AppLayerIncTxCounter(), AppLayerParserParse(), AppLayerParserStateCleanup(), and LLVMFuzzerTestOneInput().
uint8_t Flow_::recursion_level |
Definition at line 373 of file flow.h.
Referenced by FlowInit().
const struct SigGroupHead_* Flow_::sgh_toclient |
const struct SigGroupHead_* Flow_::sgh_toserver |
Port Flow_::sp |
tcp/udp source port
Definition at line 355 of file flow.h.
Referenced by FlowGetPacketDirection(), FlowGetSourcePort(), FlowInit(), and LLVMFuzzerTestOneInput().
FlowAddress Flow_::src |
Definition at line 353 of file flow.h.
Referenced by FlowGetPacketDirection(), FlowInit(), and LLVMFuzzerTestOneInput().
SCTime_t Flow_::startts |
Definition at line 489 of file flow.h.
Referenced by EveAddFlow().
Storage Flow_::storage[] |
Definition at line 496 of file flow.h.
Referenced by FlowAllocStorageById(), FlowFreeStorage(), FlowFreeStorageById(), FlowGetStorageById(), and FlowSetStorageById().
uint32_t Flow_::tenant_id |
FlowThreadId Flow_::thread_id[2] |
Thread ID for the stream/detect portion of this flow
Definition at line 393 of file flow.h.
Referenced by FlowForceReassemblyForFlow().
uint32_t Flow_::timeout_at |
timestamp in seconds of the moment this flow will timeout according to the timeout policy. Does not take emergency mode into account.
Definition at line 390 of file flow.h.
Referenced by FlowHandlePacketUpdate().
uint32_t Flow_::timeout_policy |
timeout policy value in seconds to add to the lastts.tv_sec when a packet has been received.
Definition at line 404 of file flow.h.
Referenced by FlowHandlePacketUpdate().
uint64_t Flow_::todstbytecnt |
Definition at line 493 of file flow.h.
Referenced by EveAddFlow(), and FlowHandlePacketUpdate().
uint32_t Flow_::todstpktcnt |
Definition at line 491 of file flow.h.
Referenced by EveAddFlow(), FlowForceReassemblyForFlow(), and FlowHandlePacketUpdate().
uint64_t Flow_::tosrcbytecnt |
Definition at line 494 of file flow.h.
Referenced by EveAddFlow().
uint32_t Flow_::tosrcpktcnt |
Definition at line 492 of file flow.h.
Referenced by EveAddFlow().
uint16_t Flow_::vlan_id[VLAN_MAX_LAYERS] |
Definition at line 374 of file flow.h.
Referenced by FlowInit().
uint8_t Flow_::vlan_idx |
Definition at line 376 of file flow.h.
Referenced by FlowInit().