suricata
flow.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2013 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  */
23 
24 #ifndef __FLOW_H__
25 #define __FLOW_H__
26 
27 /* forward declaration for macset include */
28 typedef struct FlowStorageId FlowStorageId;
29 
30 #include "decode.h"
31 #include "util-time.h"
32 #include "util-exception-policy.h"
33 #include "util-var.h"
34 #include "util-optimize.h"
35 #include "app-layer-protos.h"
36 
37 /* Part of the flow structure, so we declare it here.
38  * The actual declaration is in app-layer-parser.c */
40 
41 #define FLOW_QUIET true
42 
43 #define TOSERVER 0
44 #define TOCLIENT 1
45 
46 /* per flow flags */
47 
48 /** At least one packet from the source address was seen */
49 #define FLOW_TO_SRC_SEEN BIT_U32(0)
50 /** At least one packet from the destination address was seen */
51 #define FLOW_TO_DST_SEEN BIT_U32(1)
52 
53 // vacancy
54 
55 /** Flow was inspected against IP-Only sigs in the toserver direction */
56 #define FLOW_TOSERVER_IPONLY_SET BIT_U32(3)
57 /** Flow was inspected against IP-Only sigs in the toclient direction */
58 #define FLOW_TOCLIENT_IPONLY_SET BIT_U32(4)
59 
60 /** Packet belonging to this flow should not be inspected at all */
61 #define FLOW_NOPACKET_INSPECTION BIT_U32(5)
62 /** Packet payloads belonging to this flow should not be inspected */
63 #define FLOW_NOPAYLOAD_INSPECTION BIT_U32(6)
64 
65 /** All packets in this flow should be dropped */
66 #define FLOW_ACTION_DROP BIT_U32(7)
67 
68 /** Sgh for toserver direction set (even if it's NULL) */
69 #define FLOW_SGH_TOSERVER BIT_U32(8)
70 /** Sgh for toclient direction set (even if it's NULL) */
71 #define FLOW_SGH_TOCLIENT BIT_U32(9)
72 
73 /** packet to server direction has been logged in drop file (only in IPS mode) */
74 #define FLOW_TOSERVER_DROP_LOGGED BIT_U32(10)
75 /** packet to client direction has been logged in drop file (only in IPS mode) */
76 #define FLOW_TOCLIENT_DROP_LOGGED BIT_U32(11)
77 
78 /** flow has alerts */
79 #define FLOW_HAS_ALERTS BIT_U32(12)
80 
81 /** Pattern matcher alproto detection done */
82 #define FLOW_TS_PM_ALPROTO_DETECT_DONE BIT_U32(13)
83 /** Probing parser alproto detection done */
84 #define FLOW_TS_PP_ALPROTO_DETECT_DONE BIT_U32(14)
85 /** Expectation alproto detection done */
86 #define FLOW_TS_PE_ALPROTO_DETECT_DONE BIT_U32(15)
87 /** Pattern matcher alproto detection done */
88 #define FLOW_TC_PM_ALPROTO_DETECT_DONE BIT_U32(16)
89 /** Probing parser alproto detection done */
90 #define FLOW_TC_PP_ALPROTO_DETECT_DONE BIT_U32(17)
91 /** Expectation alproto detection done */
92 #define FLOW_TC_PE_ALPROTO_DETECT_DONE BIT_U32(18)
93 #define FLOW_TIMEOUT_REASSEMBLY_DONE BIT_U32(19)
94 
95 /** flow is ipv4 */
96 #define FLOW_IPV4 BIT_U32(20)
97 /** flow is ipv6 */
98 #define FLOW_IPV6 BIT_U32(21)
99 
100 #define FLOW_PROTO_DETECT_TS_DONE BIT_U32(22)
101 #define FLOW_PROTO_DETECT_TC_DONE BIT_U32(23)
102 
103 /** Indicate that alproto detection for flow should be done again */
104 #define FLOW_CHANGE_PROTO BIT_U32(24)
105 
106 #define FLOW_WRONG_THREAD BIT_U32(25)
107 /** Protocol detection told us flow is picked up in wrong direction (midstream) */
108 #define FLOW_DIR_REVERSED BIT_U32(26)
109 /** Indicate that the flow did trigger an expectation creation */
110 #define FLOW_HAS_EXPECTATION BIT_U32(27)
111 
112 /** All packets in this flow should be passed */
113 #define FLOW_ACTION_PASS BIT_U32(28)
114 
115 #define FLOW_TS_APP_UPDATED BIT_U32(29)
116 #define FLOW_TC_APP_UPDATED BIT_U32(30)
117 
118 /* File flags */
119 
120 #define FLOWFILE_INIT 0
121 
122 /** no magic on files in this flow */
123 #define FLOWFILE_NO_MAGIC_TS BIT_U16(0)
124 #define FLOWFILE_NO_MAGIC_TC BIT_U16(1)
125 
126 /** even if the flow has files, don't store 'm */
127 #define FLOWFILE_NO_STORE_TS BIT_U16(2)
128 #define FLOWFILE_NO_STORE_TC BIT_U16(3)
129 /** no md5 on files in this flow */
130 #define FLOWFILE_NO_MD5_TS BIT_U16(4)
131 #define FLOWFILE_NO_MD5_TC BIT_U16(5)
132 
133 /** no sha1 on files in this flow */
134 #define FLOWFILE_NO_SHA1_TS BIT_U16(6)
135 #define FLOWFILE_NO_SHA1_TC BIT_U16(7)
136 
137 /** no sha256 on files in this flow */
138 #define FLOWFILE_NO_SHA256_TS BIT_U16(8)
139 #define FLOWFILE_NO_SHA256_TC BIT_U16(9)
140 
141 /** no size tracking of files in this flow */
142 #define FLOWFILE_NO_SIZE_TS BIT_U16(10)
143 #define FLOWFILE_NO_SIZE_TC BIT_U16(11)
144 
145 /** store files in the flow */
146 #define FLOWFILE_STORE_TS BIT_U16(12)
147 #define FLOWFILE_STORE_TC BIT_U16(13)
148 
149 #define FLOWFILE_NONE_TS (FLOWFILE_NO_MAGIC_TS | \
150  FLOWFILE_NO_STORE_TS | \
151  FLOWFILE_NO_MD5_TS | \
152  FLOWFILE_NO_SHA1_TS | \
153  FLOWFILE_NO_SHA256_TS| \
154  FLOWFILE_NO_SIZE_TS)
155 #define FLOWFILE_NONE_TC (FLOWFILE_NO_MAGIC_TC | \
156  FLOWFILE_NO_STORE_TC | \
157  FLOWFILE_NO_MD5_TC | \
158  FLOWFILE_NO_SHA1_TC | \
159  FLOWFILE_NO_SHA256_TC| \
160  FLOWFILE_NO_SIZE_TC)
161 #define FLOWFILE_NONE (FLOWFILE_NONE_TS|FLOWFILE_NONE_TC)
162 
163 #define FLOW_IS_IPV4(f) \
164  (((f)->flags & FLOW_IPV4) == FLOW_IPV4)
165 #define FLOW_IS_IPV6(f) \
166  (((f)->flags & FLOW_IPV6) == FLOW_IPV6)
167 
168 #define FLOW_GET_SP(f) \
169  ((f)->flags & FLOW_DIR_REVERSED) ? (f)->dp : (f)->sp;
170 #define FLOW_GET_DP(f) \
171  ((f)->flags & FLOW_DIR_REVERSED) ? (f)->sp : (f)->dp;
172 
173 #define FLOW_COPY_IPV4_ADDR_TO_PACKET(fa, pa) do { \
174  (pa)->family = AF_INET; \
175  (pa)->addr_data32[0] = (fa)->addr_data32[0]; \
176  } while (0)
177 
178 #define FLOW_COPY_IPV6_ADDR_TO_PACKET(fa, pa) do { \
179  (pa)->family = AF_INET6; \
180  (pa)->addr_data32[0] = (fa)->addr_data32[0]; \
181  (pa)->addr_data32[1] = (fa)->addr_data32[1]; \
182  (pa)->addr_data32[2] = (fa)->addr_data32[2]; \
183  (pa)->addr_data32[3] = (fa)->addr_data32[3]; \
184  } while (0)
185 
186 /* Set the IPv4 addressesinto the Addrs of the Packet.
187  * Make sure p->ip4h is initialized and validated.
188  *
189  * We set the rest of the struct to 0 so we can
190  * prevent using memset. */
191 #define FLOW_SET_IPV4_SRC_ADDR_FROM_PACKET(p, a) do { \
192  (a)->addr_data32[0] = (uint32_t)(p)->ip4h->s_ip_src.s_addr; \
193  (a)->addr_data32[1] = 0; \
194  (a)->addr_data32[2] = 0; \
195  (a)->addr_data32[3] = 0; \
196  } while (0)
197 
198 #define FLOW_SET_IPV4_DST_ADDR_FROM_PACKET(p, a) do { \
199  (a)->addr_data32[0] = (uint32_t)(p)->ip4h->s_ip_dst.s_addr; \
200  (a)->addr_data32[1] = 0; \
201  (a)->addr_data32[2] = 0; \
202  (a)->addr_data32[3] = 0; \
203  } while (0)
204 
205 /* Set the IPv6 addressesinto the Addrs of the Packet.
206  * Make sure p->ip6h is initialized and validated. */
207 #define FLOW_SET_IPV6_SRC_ADDR_FROM_PACKET(p, a) do { \
208  (a)->addr_data32[0] = (p)->ip6h->s_ip6_src[0]; \
209  (a)->addr_data32[1] = (p)->ip6h->s_ip6_src[1]; \
210  (a)->addr_data32[2] = (p)->ip6h->s_ip6_src[2]; \
211  (a)->addr_data32[3] = (p)->ip6h->s_ip6_src[3]; \
212  } while (0)
213 
214 #define FLOW_SET_IPV6_DST_ADDR_FROM_PACKET(p, a) do { \
215  (a)->addr_data32[0] = (p)->ip6h->s_ip6_dst[0]; \
216  (a)->addr_data32[1] = (p)->ip6h->s_ip6_dst[1]; \
217  (a)->addr_data32[2] = (p)->ip6h->s_ip6_dst[2]; \
218  (a)->addr_data32[3] = (p)->ip6h->s_ip6_dst[3]; \
219  } while (0)
220 
221 /* pkt flow flags */
222 #define FLOW_PKT_TOSERVER 0x01
223 #define FLOW_PKT_TOCLIENT 0x02
224 #define FLOW_PKT_ESTABLISHED 0x04
225 #define FLOW_PKT_TOSERVER_IPONLY_SET 0x08
226 #define FLOW_PKT_TOCLIENT_IPONLY_SET 0x10
227 #define FLOW_PKT_TOSERVER_FIRST 0x20
228 #define FLOW_PKT_TOCLIENT_FIRST 0x40
229 /** last pseudo packet in the flow. Can be used to trigger final clean,
230  * logging, etc. */
231 #define FLOW_PKT_LAST_PSEUDO 0x80
232 
233 #define FLOW_END_FLAG_STATE_NEW 0x01
234 #define FLOW_END_FLAG_STATE_ESTABLISHED 0x02
235 #define FLOW_END_FLAG_STATE_CLOSED 0x04
236 #define FLOW_END_FLAG_EMERGENCY 0x08
237 #define FLOW_END_FLAG_TIMEOUT 0x10
238 #define FLOW_END_FLAG_FORCED 0x20
239 #define FLOW_END_FLAG_SHUTDOWN 0x40
240 #define FLOW_END_FLAG_STATE_BYPASSED 0x80
241 
242 /** Mutex or RWLocks for the flow. */
243 //#define FLOWLOCK_RWLOCK
244 #define FLOWLOCK_MUTEX
245 
246 #ifdef FLOWLOCK_RWLOCK
247  #ifdef FLOWLOCK_MUTEX
248  #error Cannot enable both FLOWLOCK_RWLOCK and FLOWLOCK_MUTEX
249  #endif
250 #endif
251 
252 #ifdef FLOWLOCK_RWLOCK
253  #define FLOWLOCK_INIT(fb) SCRWLockInit(&(fb)->r, NULL)
254  #define FLOWLOCK_DESTROY(fb) SCRWLockDestroy(&(fb)->r)
255  #define FLOWLOCK_RDLOCK(fb) SCRWLockRDLock(&(fb)->r)
256  #define FLOWLOCK_WRLOCK(fb) SCRWLockWRLock(&(fb)->r)
257  #define FLOWLOCK_TRYRDLOCK(fb) SCRWLockTryRDLock(&(fb)->r)
258  #define FLOWLOCK_TRYWRLOCK(fb) SCRWLockTryWRLock(&(fb)->r)
259  #define FLOWLOCK_UNLOCK(fb) SCRWLockUnlock(&(fb)->r)
260 #elif defined FLOWLOCK_MUTEX
261  #define FLOWLOCK_INIT(fb) SCMutexInit(&(fb)->m, NULL)
262  #define FLOWLOCK_DESTROY(fb) SCMutexDestroy(&(fb)->m)
263  #define FLOWLOCK_RDLOCK(fb) SCMutexLock(&(fb)->m)
264  #define FLOWLOCK_WRLOCK(fb) SCMutexLock(&(fb)->m)
265  #define FLOWLOCK_TRYRDLOCK(fb) SCMutexTrylock(&(fb)->m)
266  #define FLOWLOCK_TRYWRLOCK(fb) SCMutexTrylock(&(fb)->m)
267  #define FLOWLOCK_UNLOCK(fb) SCMutexUnlock(&(fb)->m)
268 #else
269  #error Enable FLOWLOCK_RWLOCK or FLOWLOCK_MUTEX
270 #endif
271 
272 #define FLOW_IS_PM_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags & FLOW_TS_PM_ALPROTO_DETECT_DONE) : ((f)->flags & FLOW_TC_PM_ALPROTO_DETECT_DONE))
273 #define FLOW_IS_PP_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags & FLOW_TS_PP_ALPROTO_DETECT_DONE) : ((f)->flags & FLOW_TC_PP_ALPROTO_DETECT_DONE))
274 #define FLOW_IS_PE_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags & FLOW_TS_PE_ALPROTO_DETECT_DONE) : ((f)->flags & FLOW_TC_PE_ALPROTO_DETECT_DONE))
275 
276 #define FLOW_SET_PM_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags |= FLOW_TS_PM_ALPROTO_DETECT_DONE) : ((f)->flags |= FLOW_TC_PM_ALPROTO_DETECT_DONE))
277 #define FLOW_SET_PP_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags |= FLOW_TS_PP_ALPROTO_DETECT_DONE) : ((f)->flags |= FLOW_TC_PP_ALPROTO_DETECT_DONE))
278 #define FLOW_SET_PE_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags |= FLOW_TS_PE_ALPROTO_DETECT_DONE) : ((f)->flags |= FLOW_TC_PE_ALPROTO_DETECT_DONE))
279 
280 #define FLOW_RESET_PM_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags &= ~FLOW_TS_PM_ALPROTO_DETECT_DONE) : ((f)->flags &= ~FLOW_TC_PM_ALPROTO_DETECT_DONE))
281 #define FLOW_RESET_PP_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags &= ~FLOW_TS_PP_ALPROTO_DETECT_DONE) : ((f)->flags &= ~FLOW_TC_PP_ALPROTO_DETECT_DONE))
282 #define FLOW_RESET_PE_DONE(f, dir) (((dir) & STREAM_TOSERVER) ? ((f)->flags &= ~FLOW_TS_PE_ALPROTO_DETECT_DONE) : ((f)->flags &= ~FLOW_TC_PE_ALPROTO_DETECT_DONE))
283 
284 /* global flow config */
285 typedef struct FlowCnf_
286 {
287  uint32_t hash_rand;
288  uint32_t hash_size;
289  uint32_t prealloc;
290 
291  uint32_t timeout_new;
292  uint32_t timeout_est;
293 
295 
297 
298  SC_ATOMIC_DECLARE(uint64_t, memcap);
300 
301 /* Hash key for the flow hash */
302 typedef struct FlowKey_
303 {
306  uint8_t proto;
308  uint16_t livedev_id;
311 
312 typedef struct FlowAddress_ {
313  union {
314  uint32_t address_un_data32[4]; /* type-specific field */
315  uint16_t address_un_data16[8]; /* type-specific field */
316  uint8_t address_un_data8[16]; /* type-specific field */
319 
320 #define addr_data32 address.address_un_data32
321 #define addr_data16 address.address_un_data16
322 #define addr_data8 address.address_un_data8
323 
324 typedef unsigned short FlowStateType;
325 
326 /** Local Thread ID */
327 typedef uint16_t FlowThreadId;
328 
329 #include "util-storage.h"
330 
331 /**
332  * \brief Flow data structure.
333  *
334  * The flow is a global data structure that is created for new packets of a
335  * flow and then looked up for the following packets of a flow.
336  *
337  * Locking
338  *
339  * The flow is updated/used by multiple packets at the same time. This is why
340  * there is a flow-mutex. It's a mutex and not a spinlock because some
341  * operations on the flow can be quite expensive, thus spinning would be
342  * too expensive.
343  *
344  * The flow "header" (addresses, ports, proto, recursion level) are static
345  * after the initialization and remain read-only throughout the entire live
346  * of a flow. This is why we can access those without protection of the lock.
347  */
348 
349 typedef struct Flow_
350 {
351  /* flow "header", used for hashing and flow lookup. Static after init,
352  * so safe to look at without lock */
354  union {
355  Port sp; /**< tcp/udp source port */
356  struct {
357  uint8_t type; /**< icmp type */
358  uint8_t code; /**< icmp code */
360 
361  struct {
362  uint32_t spi; /**< esp spi */
363  } esp;
364  };
365  union {
366  Port dp; /**< tcp/udp destination port */
367  struct {
368  uint8_t type; /**< icmp type */
369  uint8_t code; /**< icmp code */
371  };
372  uint8_t proto;
375 
376  uint8_t vlan_idx;
377 
378  /* track toserver/toclient flow timeout needs */
379  union {
380  struct {
381  uint8_t ffr_ts:4;
382  uint8_t ffr_tc:4;
383  };
384  uint8_t ffr;
385  };
386 
387  /** timestamp in seconds of the moment this flow will timeout
388  * according to the timeout policy. Does *not* take emergency
389  * mode into account. */
390  uint32_t timeout_at;
391 
392  /** Thread ID for the stream/detect portion of this flow */
394 
395  struct Flow_ *next; /* (hash) list next */
396  /** Incoming interface */
398 
399  /** flow hash - the flow hash before hash table size mod. */
400  uint32_t flow_hash;
401 
402  /** timeout policy value in seconds to add to the lastts.tv_sec
403  * when a packet has been received. */
404  uint32_t timeout_policy;
405 
406  /* time stamp of last update (last packet). Set/updated under the
407  * flow and flow hash row locks, safe to read under either the
408  * flow lock or flow hash row lock. */
410 
412 
413  /** flow tenant id, used to setup flow timeout and stream pseudo
414  * packets with the correct tenant id set */
415  uint32_t tenant_id;
416 
419 
420  uint32_t flags; /**< generic flags */
421 
422  uint16_t file_flags; /**< file tracking/extraction flags */
423 
424  /** destination port to be used in protocol detection. This is meant
425  * for use with STARTTLS and HTTP CONNECT detection */
426  uint16_t protodetect_dp; /**< 0 if not used */
427 
428  /* Parent flow id for protocol like ftp */
429  int64_t parent_id;
430 
431 #ifdef FLOWLOCK_RWLOCK
432  SCRWLock r;
433 #elif defined FLOWLOCK_MUTEX
435 #else
436  #error Enable FLOWLOCK_RWLOCK or FLOWLOCK_MUTEX
437 #endif
438 
439  /** protocol specific data pointer, e.g. for TcpSession */
440  void *protoctx;
441 
442  /** mapping to Flow's protocol specific protocols for timeouts
443  and state and free functions. */
444  uint8_t protomap;
445 
446  uint8_t flow_end_flags;
447  /* coccinelle: Flow:flow_end_flags:FLOW_END_FLAG_ */
448 
449  AppProto alproto; /**< \brief application level protocol */
452 
453  /** original application level protocol. Used to indicate the previous
454  protocol when changing to another protocol , e.g. with STARTTLS. */
456  /** expected app protocol: used in protocol change/upgrade like in
457  * STARTTLS. */
459 
460  /** detection engine ctx version used to inspect this flow. Set at initial
461  * inspection. If it doesn't match the currently in use de_ctx, the
462  * stored sgh ptrs are reset. */
463  uint32_t de_ctx_version;
464 
465  /** ttl tracking */
470 
471  /** application level storage ptrs.
472  *
473  */
474  AppLayerParserState *alparser; /**< parser internal state */
475  void *alstate; /**< application layer state */
476 
477  /** toclient sgh for this flow. Only use when FLOW_SGH_TOCLIENT flow flag
478  * has been set. */
480  /** toserver sgh for this flow. Only use when FLOW_SGH_TOSERVER flow flag
481  * has been set. */
483 
484  /* pointer to the var list */
486 
487  struct FlowBucket_ *fb;
488 
490 
491  uint32_t todstpktcnt;
492  uint32_t tosrcpktcnt;
493  uint64_t todstbytecnt;
494  uint64_t tosrcbytecnt;
495 
498 
499 enum FlowState {
504 #ifdef CAPTURE_OFFLOAD
505  FLOW_STATE_CAPTURE_BYPASSED,
506 #endif
507 };
508 #ifdef CAPTURE_OFFLOAD
509 #define FLOW_STATE_SIZE 5
510 #else
511 #define FLOW_STATE_SIZE 4
512 #endif
513 
514 typedef struct FlowProtoTimeout_ {
515  uint32_t new_timeout;
516  uint32_t est_timeout;
517  uint32_t closed_timeout;
520 
521 typedef struct FlowProtoFreeFunc_ {
522  void (*Freefunc)(void *);
524 
525 typedef struct FlowBypassInfo_ {
526  bool (* BypassUpdate)(Flow *f, void *data, time_t tsec);
527  void (* BypassFree)(void *data);
528  void *bypass_data;
529  uint64_t tosrcpktcnt;
530  uint64_t tosrcbytecnt;
531  uint64_t todstpktcnt;
532  uint64_t todstbytecnt;
534 
535 #include "flow-queue.h"
536 
537 typedef struct FlowLookupStruct_ // TODO name
538 {
539  /** thread store of spare queues */
545 
546 /** \brief prepare packet for a life with flow
547  * Set PKT_WANTS_FLOW flag to indicate workers should do a flow lookup
548  * and calc the hash value to be used in the lookup and autofp flow
549  * balancing. */
550 void FlowSetupPacket(Packet *p);
552 void FlowInitConfig(bool);
553 void FlowReset(void);
554 void FlowShutdown(void);
555 void FlowSetIPOnlyFlag(Flow *, int);
556 void FlowSetHasAlertsFlag(Flow *);
557 int FlowHasAlerts(const Flow *);
558 bool FlowHasGaps(const Flow *, uint8_t way);
561 int FlowChangeProto(Flow *);
562 void FlowSwap(Flow *);
563 
564 void FlowRegisterTests(void);
565 int FlowSetProtoFreeFunc(uint8_t, void (*Free)(void *));
566 
567 static inline void FlowSetNoPacketInspectionFlag(Flow *);
568 static inline void FlowSetNoPayloadInspectionFlag(Flow *);
569 
570 int FlowGetPacketDirection(const Flow *, const Packet *);
571 
572 void FlowCleanupAppLayer(Flow *);
573 
574 void FlowUpdateState(Flow *f, enum FlowState s);
575 
576 int FlowSetMemcap(uint64_t size);
577 uint64_t FlowGetMemcap(void);
578 uint64_t FlowGetMemuse(void);
579 
581 void RegisterFlowBypassInfo(void);
582 
583 void FlowGetLastTimeAsParts(Flow *flow, uint64_t *secs, uint64_t *usecs);
584 uint32_t FlowGetFlags(Flow *flow);
585 uint16_t FlowGetSourcePort(Flow *flow);
586 uint16_t FlowGetDestinationPort(Flow *flow);
587 
588 /** ----- Inline functions ----- */
589 
590 static inline AppProto FlowGetAppProtocol(const Flow *f)
591 {
592  return f->alproto;
593 }
594 
595 static inline void *FlowGetAppState(const Flow *f)
596 {
597  return f->alstate;
598 }
599 
600 /** \brief Set the No Packet Inspection Flag without locking the flow.
601  *
602  * \param f Flow to set the flag in
603  */
604 static inline void FlowSetNoPacketInspectionFlag(Flow *f)
605 {
606  SCEnter();
607 
608  SCLogDebug("flow %p", f);
610 
611  SCReturn;
612 }
613 
614 /** \brief Set the No payload inspection Flag without locking the flow.
615  *
616  * \param f Flow to set the flag in
617  */
618 static inline void FlowSetNoPayloadInspectionFlag(Flow *f)
619 {
620  SCEnter();
621 
622  SCLogDebug("flow %p", f);
624 
625  SCReturn;
626 }
627 
628 /** \brief Reference the flow
629  * \note This should only be called once for a destination
630  * pointer */
631 static inline void FlowReference(Flow **d, Flow *f)
632 {
633  if (likely(f != NULL)) {
634 #ifdef DEBUG_VALIDATION
635  BUG_ON(*d == f);
636 #else
637  if (*d == f)
638  return;
639 #endif
640  *d = f;
641  }
642 }
643 
644 static inline void FlowDeReference(Flow **d)
645 {
646  if (likely(*d != NULL)) {
647  *d = NULL;
648  }
649 }
650 
651 /** \brief create a flow id that is as unique as possible
652  * \retval flow_id signed 64bit id
653  * \note signed because of the signedness of json_integer_t in
654  * the json output
655  */
656 static inline int64_t FlowGetId(const Flow *f)
657 {
658  int64_t id = (uint64_t)(SCTIME_SECS(f->startts) & 0x0000FFFF) << 48 |
659  (uint64_t)(SCTIME_USECS(f->startts) & 0x0000FFFF) << 32 | (int64_t)f->flow_hash;
660  /* reduce to 51 bits as JavaScript and even JSON often seem to
661  * max out there. */
662  id &= 0x7ffffffffffffLL;
663  return id;
664 }
665 
666 static inline void FlowSetEndFlags(Flow *f)
667 {
668  const int state = f->flow_state;
669  if (state == FLOW_STATE_NEW)
671  else if (state == FLOW_STATE_ESTABLISHED)
673  else if (state == FLOW_STATE_CLOSED)
675  else if (state == FLOW_STATE_LOCAL_BYPASSED)
677 #ifdef CAPTURE_OFFLOAD
678  else if (state == FLOW_STATE_CAPTURE_BYPASSED)
680 #endif
681 }
682 
683 static inline bool FlowIsBypassed(const Flow *f)
684 {
685  if (
686 #ifdef CAPTURE_OFFLOAD
687  f->flow_state == FLOW_STATE_CAPTURE_BYPASSED ||
688 #endif
690  return true;
691  }
692  return false;
693 }
694 
695 int FlowClearMemory(Flow *,uint8_t );
696 
697 AppProto FlowGetAppProtocol(const Flow *f);
698 void *FlowGetAppState(const Flow *f);
699 uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags);
700 
702 
703 #endif /* __FLOW_H__ */
FlowStorageId
Definition: flow-storage.h:31
Flow_::ffr_tc
uint8_t ffr_tc
Definition: flow.h:382
FlowLookupStruct_::work_queue
FlowQueuePrivate work_queue
Definition: flow.h:542
FlowSetMemcap
int FlowSetMemcap(uint64_t size)
Update memcap value.
Definition: flow.c:119
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1157
FlowBucket_
Definition: flow-hash.h:43
Flow_::ffr_ts
uint8_t ffr_ts
Definition: flow.h:381
Flow_::recursion_level
uint8_t recursion_level
Definition: flow.h:373
FlowAddress_
Definition: flow.h:312
FLOW_STATE_ESTABLISHED
@ FLOW_STATE_ESTABLISHED
Definition: flow.h:501
FlowLookupStruct_::dtv
DecodeThreadVars * dtv
Definition: flow.h:541
Flow_::icmp_d
struct Flow_::@119::@125 icmp_d
Flow_::startts
SCTime_t startts
Definition: flow.h:489
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1444
FlowKey_::src
Address src
Definition: flow.h:304
FLOW_END_FLAG_STATE_NEW
#define FLOW_END_FLAG_STATE_NEW
Definition: flow.h:233
FlowBypassInfo_
Definition: flow.h:525
FlowCnf_::emergency_recovery
uint32_t emergency_recovery
Definition: flow.h:294
FlowCnf_::hash_size
uint32_t hash_size
Definition: flow.h:288
FlowHandlePacket
void FlowHandlePacket(ThreadVars *, FlowLookupStruct *, Packet *)
Entry point for packet flow handling.
Definition: flow.c:533
FlowAddress_::address_un_data32
uint32_t address_un_data32[4]
Definition: flow.h:314
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
FlowLookupStruct
struct FlowLookupStruct_ FlowLookupStruct
Flow_::proto
uint8_t proto
Definition: flow.h:372
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:80
FlowInitConfig
void FlowInitConfig(bool)
initialize the configuration
Definition: flow.c:547
FlowGetPacketDirection
int FlowGetPacketDirection(const Flow *, const Packet *)
determine the direction of the packet compared to the flow
Definition: flow.c:315
FlowClearMemory
int FlowClearMemory(Flow *, uint8_t)
Function clear the flow memory before queueing it to spare flow queue.
Definition: flow.c:1113
Flow_
Flow data structure.
Definition: flow.h:350
Flow_::protomap
uint8_t protomap
Definition: flow.h:444
LiveDevice_
Definition: util-device.h:50
FlowProtoTimeout_
Definition: flow.h:514
FLOW_END_FLAG_STATE_ESTABLISHED
#define FLOW_END_FLAG_STATE_ESTABLISHED
Definition: flow.h:234
FLOW_NOPAYLOAD_INSPECTION
#define FLOW_NOPAYLOAD_INSPECTION
Definition: flow.h:63
FlowLookupStruct_
Definition: flow.h:538
Flow_::alproto_orig
AppProto alproto_orig
Definition: flow.h:455
Flow
struct Flow_ Flow
Flow data structure.
FLOW_END_FLAG_STATE_BYPASSED
#define FLOW_END_FLAG_STATE_BYPASSED
Definition: flow.h:240
FlowProtoTimeout_::bypassed_timeout
uint32_t bypassed_timeout
Definition: flow.h:518
FlowBypassInfo_::tosrcbytecnt
uint64_t tosrcbytecnt
Definition: flow.h:530
Address_
Definition: decode.h:115
FlowSetupPacket
void FlowSetupPacket(Packet *p)
prepare packet for a life with flow Set PKT_WANTS_FLOW flag to indicate workers should do a flow look...
Definition: flow-hash.c:520
Flow_::max_ttl_toserver
uint8_t max_ttl_toserver
Definition: flow.h:467
Flow_::dp
Port dp
Definition: flow.h:366
Flow_::protoctx
void * protoctx
Definition: flow.h:440
FlowUnsetChangeProtoFlag
void FlowUnsetChangeProtoFlag(Flow *)
Unset flag to indicate to change proto for the flow.
Definition: flow.c:223
util-var.h
Storage
Definition: util-storage.h:39
FlowCnf_::prealloc
uint32_t prealloc
Definition: flow.h:289
Flow_::flow_state
FlowStateType flow_state
Definition: flow.h:411
Flow_::spi
uint32_t spi
Definition: flow.h:362
Flow_::sgh_toserver
const struct SigGroupHead_ * sgh_toserver
Definition: flow.h:482
FlowLookupStruct_::emerg_spare_sync_stamp
uint32_t emerg_spare_sync_stamp
Definition: flow.h:543
Flow_::tosrcbytecnt
uint64_t tosrcbytecnt
Definition: flow.h:494
FlowConfig
struct FlowCnf_ FlowConfig
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:474
Flow_::dst
FlowAddress dst
Definition: flow.h:353
FlowProtoFreeFunc
struct FlowProtoFreeFunc_ FlowProtoFreeFunc
Flow_::fb
struct FlowBucket_ * fb
Definition: flow.h:487
FLOW_STATE_LOCAL_BYPASSED
@ FLOW_STATE_LOCAL_BYPASSED
Definition: flow.h:503
Flow_::min_ttl_toserver
uint8_t min_ttl_toserver
Definition: flow.h:466
Flow_::esp
struct Flow_::@117::@124 esp
Flow_::protodetect_dp
uint16_t protodetect_dp
Definition: flow.h:426
decode.h
FlowHasGaps
bool FlowHasGaps(const Flow *, uint8_t way)
Definition: flow.c:193
FlowBypassInfo_::todstbytecnt
uint64_t todstbytecnt
Definition: flow.h:532
FlowGetDestinationPort
uint16_t FlowGetDestinationPort(Flow *flow)
Get flow destination port.
Definition: flow.c:1236
AppLayerParserState_
Definition: app-layer-parser.c:138
RegisterFlowBypassInfo
void RegisterFlowBypassInfo(void)
Definition: flow-util.c:230
FlowBypassInfo_::BypassUpdate
bool(* BypassUpdate)(Flow *f, void *data, time_t tsec)
Definition: flow.h:526
FlowBypassInfo_::BypassFree
void(* BypassFree)(void *data)
Definition: flow.h:527
Flow_::todstpktcnt
uint32_t todstpktcnt
Definition: flow.h:491
FlowSetIPOnlyFlag
void FlowSetIPOnlyFlag(Flow *, int)
Set the IPOnly scanned flag for 'direction'.
Definition: flow.c:162
util-exception-policy.h
Flow_::lastts
SCTime_t lastts
Definition: flow.h:409
FlowSwap
void FlowSwap(Flow *)
swap the flow's direction
Definition: flow.c:284
FlowKey_::recursion_level
uint8_t recursion_level
Definition: flow.h:307
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
FlowShutdown
void FlowShutdown(void)
shutdown the flow engine
Definition: flow.c:695
FlowGetMemuse
uint64_t FlowGetMemuse(void)
Definition: flow.c:140
Flow_::flow_end_flags
uint8_t flow_end_flags
Definition: flow.h:446
FlowCnf_
Definition: flow.h:286
FlowState
FlowState
Definition: flow.h:499
FlowBypassInfo_::todstpktcnt
uint64_t todstpktcnt
Definition: flow.h:531
FlowProtoTimeout_::new_timeout
uint32_t new_timeout
Definition: flow.h:515
FlowProtoTimeout_::closed_timeout
uint32_t closed_timeout
Definition: flow.h:517
util-time.h
FlowBypassInfo_::bypass_data
void * bypass_data
Definition: flow.h:528
Flow_::m
SCMutex m
Definition: flow.h:434
FlowBypassInfo
struct FlowBypassInfo_ FlowBypassInfo
FlowCnf_::timeout_new
uint32_t timeout_new
Definition: flow.h:291
FlowKey_::livedev_id
uint16_t livedev_id
Definition: flow.h:308
Flow_::todstbytecnt
uint64_t todstbytecnt
Definition: flow.h:493
Flow_::icmp_s
struct Flow_::@117::@123 icmp_s
FlowGetLastTimeAsParts
void FlowGetLastTimeAsParts(Flow *flow, uint64_t *secs, uint64_t *usecs)
Get flow last time as individual values.
Definition: flow.c:1212
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:300
Flow_::sgh_toclient
const struct SigGroupHead_ * sgh_toclient
Definition: flow.h:479
ExceptionPolicy
ExceptionPolicy
Definition: util-exception-policy.h:27
FlowChangeProto
int FlowChangeProto(Flow *)
Check if change proto flag is set for flow.
Definition: flow.c:233
FlowThreadId
uint16_t FlowThreadId
Definition: flow.h:327
FlowKey_::sp
Port sp
Definition: flow.h:305
SCReturn
#define SCReturn
Definition: util-debug.h:273
Packet_
Definition: decode.h:430
Flow_::type
uint8_t type
Definition: flow.h:357
FlowRegisterTests
void FlowRegisterTests(void)
Function to register the Flow Unitests.
Definition: flow.c:1464
Port
uint16_t Port
Definition: decode.h:229
SCTime_t
Definition: util-time.h:40
FlowProtoFreeFunc_::Freefunc
void(* Freefunc)(void *)
Definition: flow.h:522
FlowAddress_::address_un_data16
uint16_t address_un_data16[8]
Definition: flow.h:315
FlowCnf_::hash_rand
uint32_t hash_rand
Definition: flow.h:287
Flow_::vlan_idx
uint8_t vlan_idx
Definition: flow.h:376
FlowHandlePacketUpdate
void FlowHandlePacketUpdate(Flow *f, Packet *p, ThreadVars *tv, DecodeThreadVars *dtv)
Update Packet and Flow.
Definition: flow.c:413
Flow_::min_ttl_toclient
uint8_t min_ttl_toclient
Definition: flow.h:468
FlowGetFlags
uint32_t FlowGetFlags(Flow *flow)
Get flow flags.
Definition: flow.c:1247
flow-queue.h
FlowCleanupAppLayer
void FlowCleanupAppLayer(Flow *)
Definition: flow.c:146
FlowBypassInfo_::tosrcpktcnt
uint64_t tosrcpktcnt
Definition: flow.h:529
Flow_::probing_parser_toclient_alproto_masks
uint32_t probing_parser_toclient_alproto_masks
Definition: flow.h:418
FlowCnf_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, memcap)
Flow_::flow_hash
uint32_t flow_hash
Definition: flow.h:400
Flow_::alproto_expect
AppProto alproto_expect
Definition: flow.h:458
GetFlowBypassInfoID
FlowStorageId GetFlowBypassInfoID(void)
Definition: flow-util.c:212
Flow_::src
FlowAddress src
Definition: flow.h:353
Flow_::flowvar
GenericVar * flowvar
Definition: flow.h:485
FlowReset
void FlowReset(void)
Definition: flow.c:677
Flow_::next
struct Flow_ * next
Definition: flow.h:395
Flow_::probing_parser_toserver_alproto_masks
uint32_t probing_parser_toserver_alproto_masks
Definition: flow.h:417
dtv
DecodeThreadVars * dtv
Definition: fuzz_decodepcapfile.c:33
FlowLookupStruct_::spare_queue
FlowQueuePrivate spare_queue
Definition: flow.h:540
FlowProtoTimeout
struct FlowProtoTimeout_ FlowProtoTimeout
Flow_::ffr
uint8_t ffr
Definition: flow.h:384
FlowStateType
unsigned short FlowStateType
Definition: flow.h:324
flags
uint8_t flags
Definition: decode-gre.h:0
FLOW_STATE_NEW
@ FLOW_STATE_NEW
Definition: flow.h:500
Flow_::code
uint8_t code
Definition: flow.h:358
GenericVar_
Definition: util-var.h:48
FlowAddress
struct FlowAddress_ FlowAddress
FlowKey_::dst
Address dst
Definition: flow.h:304
SCTIME_SECS
#define SCTIME_SECS(t)
Definition: util-time.h:57
VLAN_MAX_LAYERS
#define VLAN_MAX_LAYERS
Definition: decode-vlan.h:51
Flow_::max_ttl_toclient
uint8_t max_ttl_toclient
Definition: flow.h:469
Flow_::parent_id
int64_t parent_id
Definition: flow.h:429
FLOW_END_FLAG_STATE_CLOSED
#define FLOW_END_FLAG_STATE_CLOSED
Definition: flow.h:235
FlowCnf_::timeout_est
uint32_t timeout_est
Definition: flow.h:292
Flow_::timeout_policy
uint32_t timeout_policy
Definition: flow.h:404
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
Flow_::livedev
struct LiveDevice_ * livedev
Definition: flow.h:397
util-optimize.h
FlowQueuePrivate_
Definition: flow-queue.h:41
FlowCnf_::memcap_policy
enum ExceptionPolicy memcap_policy
Definition: flow.h:296
FlowAddress_::address_un_data8
uint8_t address_un_data8[16]
Definition: flow.h:316
FlowKey_::proto
uint8_t proto
Definition: flow.h:306
FLOW_STATE_CLOSED
@ FLOW_STATE_CLOSED
Definition: flow.h:502
DecodeThreadVars_
Structure to hold thread specific data for all decode modules.
Definition: decode.h:673
Flow_::alproto_ts
AppProto alproto_ts
Definition: flow.h:450
Flow_::alstate
void * alstate
Definition: flow.h:475
Flow_::flags
uint32_t flags
Definition: flow.h:420
SCRWLock
#define SCRWLock
Definition: threads-debug.h:363
FlowGetMemcap
uint64_t FlowGetMemcap(void)
Return memcap value.
Definition: flow.c:134
FlowKey_
Definition: flow.h:303
app-layer-protos.h
Flow_::vlan_id
uint16_t vlan_id[VLAN_MAX_LAYERS]
Definition: flow.h:374
likely
#define likely(expr)
Definition: util-optimize.h:32
FLOW_NOPACKET_INSPECTION
#define FLOW_NOPACKET_INSPECTION
Definition: flow.h:61
FlowProtoTimeout_::est_timeout
uint32_t est_timeout
Definition: flow.h:516
Flow_::sp
Port sp
Definition: flow.h:355
FlowKey_::vlan_id
uint16_t vlan_id[VLAN_MAX_LAYERS]
Definition: flow.h:309
Flow_::alproto_tc
AppProto alproto_tc
Definition: flow.h:451
FlowSetChangeProtoFlag
void FlowSetChangeProtoFlag(Flow *)
Set flag to indicate to change proto for the flow.
Definition: flow.c:214
FlowAddress_::address
union FlowAddress_::@116 address
Flow_::file_flags
uint16_t file_flags
Definition: flow.h:422
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:449
FlowUpdateState
void FlowUpdateState(Flow *f, enum FlowState s)
Definition: flow.c:1178
Flow_::timeout_at
uint32_t timeout_at
Definition: flow.h:390
FlowKey_::dp
Port dp
Definition: flow.h:305
Flow_::storage
Storage storage[]
Definition: flow.h:496
FlowKey
struct FlowKey_ FlowKey
SCMutex
#define SCMutex
Definition: threads-debug.h:114
FlowSetProtoFreeFunc
int FlowSetProtoFreeFunc(uint8_t, void(*Free)(void *))
Function to set the function to get protocol specific flow state.
Definition: flow.c:1141
Flow_::tenant_id
uint32_t tenant_id
Definition: flow.h:415
Flow_::tosrcpktcnt
uint32_t tosrcpktcnt
Definition: flow.h:492
FlowSetHasAlertsFlag
void FlowSetHasAlertsFlag(Flow *)
Set flag to indicate that flow has alerts.
Definition: flow.c:173
util-storage.h
FlowGetSourcePort
uint16_t FlowGetSourcePort(Flow *flow)
Get flow source port.
Definition: flow.c:1224
Flow_::thread_id
FlowThreadId thread_id[2]
Definition: flow.h:393
FlowHasAlerts
int FlowHasAlerts(const Flow *)
Check if flow has alerts.
Definition: flow.c:184
SCTIME_USECS
#define SCTIME_USECS(t)
Definition: util-time.h:56
FlowProtoFreeFunc_
Definition: flow.h:521
Flow_::de_ctx_version
uint32_t de_ctx_version
Definition: flow.h:463