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-var.h"
32 #include "util-atomic.h"
33 #include "util-device.h"
34 #include "detect-tag.h"
35 #include "util-macset.h"
36 #include "util-optimize.h"
37 
38 /* Part of the flow structure, so we declare it here.
39  * The actual declaration is in app-layer-parser.c */
41 
42 #define FLOW_QUIET true
43 #define FLOW_VERBOSE false
44 
45 #define TOSERVER 0
46 #define TOCLIENT 1
47 
48 /* per flow flags */
49 
50 /** At least one packet from the source address was seen */
51 #define FLOW_TO_SRC_SEEN BIT_U32(0)
52 /** At least one packet from the destination address was seen */
53 #define FLOW_TO_DST_SEEN BIT_U32(1)
54 /** Don't return this from the flow hash. It has been replaced. */
55 #define FLOW_TCP_REUSED BIT_U32(2)
56 
57 /** Flow was inspected against IP-Only sigs in the toserver direction */
58 #define FLOW_TOSERVER_IPONLY_SET BIT_U32(3)
59 /** Flow was inspected against IP-Only sigs in the toclient direction */
60 #define FLOW_TOCLIENT_IPONLY_SET BIT_U32(4)
61 
62 /** Packet belonging to this flow should not be inspected at all */
63 #define FLOW_NOPACKET_INSPECTION BIT_U32(5)
64 /** Packet payloads belonging to this flow should not be inspected */
65 #define FLOW_NOPAYLOAD_INSPECTION BIT_U32(6)
66 
67 /** All packets in this flow should be dropped */
68 #define FLOW_ACTION_DROP BIT_U32(7)
69 
70 /** Sgh for toserver direction set (even if it's NULL) */
71 #define FLOW_SGH_TOSERVER BIT_U32(8)
72 /** Sgh for toclient direction set (even if it's NULL) */
73 #define FLOW_SGH_TOCLIENT BIT_U32(9)
74 
75 /** packet to server direction has been logged in drop file (only in IPS mode) */
76 #define FLOW_TOSERVER_DROP_LOGGED BIT_U32(10)
77 /** packet to client direction has been logged in drop file (only in IPS mode) */
78 #define FLOW_TOCLIENT_DROP_LOGGED BIT_U32(11)
79 
80 /** flow has alerts */
81 #define FLOW_HAS_ALERTS BIT_U32(12)
82 
83 /** Pattern matcher alproto detection done */
84 #define FLOW_TS_PM_ALPROTO_DETECT_DONE BIT_U32(13)
85 /** Probing parser alproto detection done */
86 #define FLOW_TS_PP_ALPROTO_DETECT_DONE BIT_U32(14)
87 /** Expectation alproto detection done */
88 #define FLOW_TS_PE_ALPROTO_DETECT_DONE BIT_U32(15)
89 /** Pattern matcher alproto detection done */
90 #define FLOW_TC_PM_ALPROTO_DETECT_DONE BIT_U32(16)
91 /** Probing parser alproto detection done */
92 #define FLOW_TC_PP_ALPROTO_DETECT_DONE BIT_U32(17)
93 /** Expectation alproto detection done */
94 #define FLOW_TC_PE_ALPROTO_DETECT_DONE BIT_U32(18)
95 #define FLOW_TIMEOUT_REASSEMBLY_DONE BIT_U32(19)
96 
97 /** flow is ipv4 */
98 #define FLOW_IPV4 BIT_U32(20)
99 /** flow is ipv6 */
100 #define FLOW_IPV6 BIT_U32(21)
101 
102 #define FLOW_PROTO_DETECT_TS_DONE BIT_U32(22)
103 #define FLOW_PROTO_DETECT_TC_DONE BIT_U32(23)
104 
105 /** Indicate that alproto detection for flow should be done again */
106 #define FLOW_CHANGE_PROTO BIT_U32(24)
107 
108 #define FLOW_WRONG_THREAD BIT_U32(25)
109 /** Protocol detection told us flow is picked up in wrong direction (midstream) */
110 #define FLOW_DIR_REVERSED BIT_U32(26)
111 /** Indicate that the flow did trigger an expectation creation */
112 #define FLOW_HAS_EXPECTATION BIT_U32(27)
113 
114 /* File flags */
115 
116 #define FLOWFILE_INIT 0
117 
118 /** no magic on files in this flow */
119 #define FLOWFILE_NO_MAGIC_TS BIT_U16(0)
120 #define FLOWFILE_NO_MAGIC_TC BIT_U16(1)
121 
122 /** even if the flow has files, don't store 'm */
123 #define FLOWFILE_NO_STORE_TS BIT_U16(2)
124 #define FLOWFILE_NO_STORE_TC BIT_U16(3)
125 /** no md5 on files in this flow */
126 #define FLOWFILE_NO_MD5_TS BIT_U16(4)
127 #define FLOWFILE_NO_MD5_TC BIT_U16(5)
128 
129 /** no sha1 on files in this flow */
130 #define FLOWFILE_NO_SHA1_TS BIT_U16(6)
131 #define FLOWFILE_NO_SHA1_TC BIT_U16(7)
132 
133 /** no sha256 on files in this flow */
134 #define FLOWFILE_NO_SHA256_TS BIT_U16(8)
135 #define FLOWFILE_NO_SHA256_TC BIT_U16(9)
136 
137 /** no size tracking of files in this flow */
138 #define FLOWFILE_NO_SIZE_TS BIT_U16(10)
139 #define FLOWFILE_NO_SIZE_TC BIT_U16(11)
140 
141 #define FLOWFILE_NONE_TS (FLOWFILE_NO_MAGIC_TS | \
142  FLOWFILE_NO_STORE_TS | \
143  FLOWFILE_NO_MD5_TS | \
144  FLOWFILE_NO_SHA1_TS | \
145  FLOWFILE_NO_SHA256_TS| \
146  FLOWFILE_NO_SIZE_TS)
147 #define FLOWFILE_NONE_TC (FLOWFILE_NO_MAGIC_TC | \
148  FLOWFILE_NO_STORE_TC | \
149  FLOWFILE_NO_MD5_TC | \
150  FLOWFILE_NO_SHA1_TC | \
151  FLOWFILE_NO_SHA256_TC| \
152  FLOWFILE_NO_SIZE_TC)
153 #define FLOWFILE_NONE (FLOWFILE_NONE_TS|FLOWFILE_NONE_TC)
154 
155 #define FLOW_IS_IPV4(f) \
156  (((f)->flags & FLOW_IPV4) == FLOW_IPV4)
157 #define FLOW_IS_IPV6(f) \
158  (((f)->flags & FLOW_IPV6) == FLOW_IPV6)
159 
160 #define FLOW_GET_SP(f) \
161  ((f)->flags & FLOW_DIR_REVERSED) ? (f)->dp : (f)->sp;
162 #define FLOW_GET_DP(f) \
163  ((f)->flags & FLOW_DIR_REVERSED) ? (f)->sp : (f)->dp;
164 
165 #define FLOW_COPY_IPV4_ADDR_TO_PACKET(fa, pa) do { \
166  (pa)->family = AF_INET; \
167  (pa)->addr_data32[0] = (fa)->addr_data32[0]; \
168  } while (0)
169 
170 #define FLOW_COPY_IPV6_ADDR_TO_PACKET(fa, pa) do { \
171  (pa)->family = AF_INET6; \
172  (pa)->addr_data32[0] = (fa)->addr_data32[0]; \
173  (pa)->addr_data32[1] = (fa)->addr_data32[1]; \
174  (pa)->addr_data32[2] = (fa)->addr_data32[2]; \
175  (pa)->addr_data32[3] = (fa)->addr_data32[3]; \
176  } while (0)
177 
178 /* Set the IPv4 addressesinto the Addrs of the Packet.
179  * Make sure p->ip4h is initialized and validated.
180  *
181  * We set the rest of the struct to 0 so we can
182  * prevent using memset. */
183 #define FLOW_SET_IPV4_SRC_ADDR_FROM_PACKET(p, a) do { \
184  (a)->addr_data32[0] = (uint32_t)(p)->ip4h->s_ip_src.s_addr; \
185  (a)->addr_data32[1] = 0; \
186  (a)->addr_data32[2] = 0; \
187  (a)->addr_data32[3] = 0; \
188  } while (0)
189 
190 #define FLOW_SET_IPV4_DST_ADDR_FROM_PACKET(p, a) do { \
191  (a)->addr_data32[0] = (uint32_t)(p)->ip4h->s_ip_dst.s_addr; \
192  (a)->addr_data32[1] = 0; \
193  (a)->addr_data32[2] = 0; \
194  (a)->addr_data32[3] = 0; \
195  } while (0)
196 
197 /* clear the address structure by setting all fields to 0 */
198 #define FLOW_CLEAR_ADDR(a) do { \
199  (a)->addr_data32[0] = 0; \
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 max_flows;
290  uint32_t prealloc;
291 
292  uint32_t timeout_new;
293  uint32_t timeout_est;
294 
298 
299  SC_ATOMIC_DECLARE(uint64_t, memcap);
301 
302 /* Hash key for the flow hash */
303 typedef struct FlowKey_
304 {
307  uint8_t proto;
309  uint16_t vlan_id[2];
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 FlowRefCount;
325 
326 typedef unsigned short FlowStateType;
327 
328 /** Local Thread ID */
329 typedef uint16_t FlowThreadId;
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;
374  uint16_t vlan_id[2];
375  /** how many references exist to this flow *right now*
376  *
377  * On receiving a packet the counter is incremented while the flow
378  * bucked is locked, which is also the case on timeout pruning.
379  */
381 
382  uint8_t vlan_idx;
383 
384  /* track toserver/toclient flow timeout needs */
385  union {
386  struct {
387  uint8_t ffr_ts:4;
388  uint8_t ffr_tc:4;
389  };
390  uint8_t ffr;
391  };
392 
393  /** timestamp in seconds of the moment this flow will timeout
394  * according to the timeout policy. Does *not* take emergency
395  * mode into account. */
396  uint32_t timeout_at;
397 
398  /** Thread ID for the stream/detect portion of this flow */
400 
401  struct Flow_ *next; /* (hash) list next */
402  /** Incoming interface */
404 
405  /** flow hash - the flow hash before hash table size mod. */
406  uint32_t flow_hash;
407 
408  /* time stamp of last update (last packet). Set/updated under the
409  * flow and flow hash row locks, safe to read under either the
410  * flow lock or flow hash row lock. */
411  struct timeval lastts;
412 
413  /* end of flow "header" */
414 
415  /** timeout policy value in seconds to add to the lastts.tv_sec
416  * when a packet has been received. */
417  uint32_t timeout_policy;
418 
420 
421  /** flow tenant id, used to setup flow timeout and stream pseudo
422  * packets with the correct tenant id set */
423  uint32_t tenant_id;
424 
427 
428  uint32_t flags; /**< generic flags */
429 
430  uint16_t file_flags; /**< file tracking/extraction flags */
431 
432  /** destination port to be used in protocol detection. This is meant
433  * for use with STARTTLS and HTTP CONNECT detection */
434  uint16_t protodetect_dp; /**< 0 if not used */
435 
436  /* Parent flow id for protocol like ftp */
437  int64_t parent_id;
438 
439 #ifdef FLOWLOCK_RWLOCK
440  SCRWLock r;
441 #elif defined FLOWLOCK_MUTEX
443 #else
444  #error Enable FLOWLOCK_RWLOCK or FLOWLOCK_MUTEX
445 #endif
446 
447  /** protocol specific data pointer, e.g. for TcpSession */
448  void *protoctx;
449 
450  /** mapping to Flow's protocol specific protocols for timeouts
451  and state and free functions. */
452  uint8_t protomap;
453 
454  uint8_t flow_end_flags;
455  /* coccinelle: Flow:flow_end_flags:FLOW_END_FLAG_ */
456 
457  AppProto alproto; /**< \brief application level protocol */
460 
461  /** original application level protocol. Used to indicate the previous
462  protocol when changing to another protocol , e.g. with STARTTLS. */
464  /** expected app protocol: used in protocol change/upgrade like in
465  * STARTTLS. */
467 
468  /** detection engine ctx version used to inspect this flow. Set at initial
469  * inspection. If it doesn't match the currently in use de_ctx, the
470  * stored sgh ptrs are reset. */
471  uint32_t de_ctx_version;
472 
473  /** ttl tracking */
478 
479  /** application level storage ptrs.
480  *
481  */
482  AppLayerParserState *alparser; /**< parser internal state */
483  void *alstate; /**< application layer state */
484 
485  /** toclient sgh for this flow. Only use when FLOW_SGH_TOCLIENT flow flag
486  * has been set. */
488  /** toserver sgh for this flow. Only use when FLOW_SGH_TOSERVER flow flag
489  * has been set. */
491 
492  /* pointer to the var list */
494 
495  struct FlowBucket_ *fb;
496 
497  struct timeval startts;
498 
499  uint32_t todstpktcnt;
500  uint32_t tosrcpktcnt;
501  uint64_t todstbytecnt;
502  uint64_t tosrcbytecnt;
504 
505 enum FlowState {
510 #ifdef CAPTURE_OFFLOAD
511  FLOW_STATE_CAPTURE_BYPASSED,
512 #endif
513 };
514 
515 typedef struct FlowProtoTimeout_ {
516  uint32_t new_timeout;
517  uint32_t est_timeout;
518  uint32_t closed_timeout;
521 
522 typedef struct FlowProtoFreeFunc_ {
523  void (*Freefunc)(void *);
525 
526 typedef struct FlowBypassInfo_ {
527  bool (* BypassUpdate)(Flow *f, void *data, time_t tsec);
528  void (* BypassFree)(void *data);
529  void *bypass_data;
530  uint64_t tosrcpktcnt;
531  uint64_t tosrcbytecnt;
532  uint64_t todstpktcnt;
533  uint64_t todstbytecnt;
535 
536 #include "flow-queue.h"
537 
538 typedef struct FlowLookupStruct_ // TODO name
539 {
540  /** thread store of spare queues */
546 
547 /** \brief prepare packet for a life with flow
548  * Set PKT_WANTS_FLOW flag to incidate workers should do a flow lookup
549  * and calc the hash value to be used in the lookup and autofp flow
550  * balancing. */
551 void FlowSetupPacket(Packet *p);
553 void FlowInitConfig(bool);
554 void FlowPrintQueueInfo (void);
555 void FlowShutdown(void);
556 void FlowSetIPOnlyFlag(Flow *, int);
557 void FlowSetHasAlertsFlag(Flow *);
558 int FlowHasAlerts(const Flow *);
561 int FlowChangeProto(Flow *);
562 void FlowSwap(Flow *);
563 
564 void FlowRegisterTests (void);
565 int FlowSetProtoTimeout(uint8_t ,uint32_t ,uint32_t ,uint32_t);
566 int FlowSetProtoEmergencyTimeout(uint8_t ,uint32_t ,uint32_t ,uint32_t);
567 int FlowSetProtoFreeFunc (uint8_t , void (*Free)(void *));
569 
571 
572 static inline void FlowSetNoPacketInspectionFlag(Flow *);
573 static inline void FlowSetNoPayloadInspectionFlag(Flow *);
574 
575 int FlowGetPacketDirection(const Flow *, const Packet *);
576 
577 void FlowCleanupAppLayer(Flow *);
578 
579 void FlowUpdateState(Flow *f, enum FlowState s);
580 
581 int FlowSetMemcap(uint64_t size);
582 uint64_t FlowGetMemcap(void);
583 uint64_t FlowGetMemuse(void);
584 
586 void RegisterFlowBypassInfo(void);
587 
588 void FlowGetLastTimeAsParts(Flow *flow, uint64_t *secs, uint64_t *usecs);
589 
590 /** ----- Inline functions ----- */
591 
592 /** \brief Set the No Packet Inspection Flag without locking the flow.
593  *
594  * \param f Flow to set the flag in
595  */
596 static inline void FlowSetNoPacketInspectionFlag(Flow *f)
597 {
598  SCEnter();
599 
600  SCLogDebug("flow %p", f);
602 
603  SCReturn;
604 }
605 
606 /** \brief Set the No payload inspection Flag without locking the flow.
607  *
608  * \param f Flow to set the flag in
609  */
610 static inline void FlowSetNoPayloadInspectionFlag(Flow *f)
611 {
612  SCEnter();
613 
614  SCLogDebug("flow %p", f);
616 
617  SCReturn;
618 }
619 
620 /**
621  * \brief increase the use count of a flow
622  *
623  * \param f flow to decrease use count for
624  */
625 static inline void FlowIncrUsecnt(Flow *f)
626 {
627  if (f == NULL)
628  return;
629 
630  f->use_cnt++;
631 }
632 
633 /**
634  * \brief decrease the use count of a flow
635  *
636  * \param f flow to decrease use count for
637  */
638 static inline void FlowDecrUsecnt(Flow *f)
639 {
640  if (f == NULL)
641  return;
642 
643  f->use_cnt--;
644 }
645 
646 /** \brief Reference the flow, bumping the flows use_cnt
647  * \note This should only be called once for a destination
648  * pointer */
649 static inline void FlowReference(Flow **d, Flow *f)
650 {
651  if (likely(f != NULL)) {
652 #ifdef DEBUG_VALIDATION
653  BUG_ON(*d == f);
654 #else
655  if (*d == f)
656  return;
657 #endif
658  FlowIncrUsecnt(f);
659  *d = f;
660  }
661 }
662 
663 static inline void FlowDeReference(Flow **d)
664 {
665  if (likely(*d != NULL)) {
666  FlowDecrUsecnt(*d);
667  *d = NULL;
668  }
669 }
670 
671 /** \brief create a flow id that is as unique as possible
672  * \retval flow_id signed 64bit id
673  * \note signed because of the signedness of json_integer_t in
674  * the json output
675  */
676 static inline int64_t FlowGetId(const Flow *f)
677 {
678  int64_t id = (int64_t)f->flow_hash << 31 |
679  (int64_t)(f->startts.tv_sec & 0x0000FFFF) << 16 |
680  (int64_t)(f->startts.tv_usec & 0x0000FFFF);
681  /* reduce to 51 bits as Javascript and even JSON often seem to
682  * max out there. */
683  id &= 0x7ffffffffffffLL;
684  return id;
685 }
686 
687 static inline void FlowSetEndFlags(Flow *f)
688 {
689  const int state = f->flow_state;
690  if (state == FLOW_STATE_NEW)
692  else if (state == FLOW_STATE_ESTABLISHED)
694  else if (state == FLOW_STATE_CLOSED)
696  else if (state == FLOW_STATE_LOCAL_BYPASSED)
698 #ifdef CAPTURE_OFFLOAD
699  else if (state == FLOW_STATE_CAPTURE_BYPASSED)
701 #endif
702 }
703 
704 int FlowClearMemory(Flow *,uint8_t );
705 
707 void *FlowGetAppState(const Flow *f);
708 uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags);
709 
711 
712 #endif /* __FLOW_H__ */
FlowStorageId
Definition: flow-storage.h:32
Flow_::ffr_tc
uint8_t ffr_tc
Definition: flow.h:388
FlowLookupStruct_::work_queue
FlowQueuePrivate work_queue
Definition: flow.h:543
FlowSetMemcap
int FlowSetMemcap(uint64_t size)
Update memcap value.
Definition: flow.c:115
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1114
FlowBucket_
Definition: flow-hash.h:41
Flow_::ffr_ts
uint8_t ffr_ts
Definition: flow.h:387
Flow_::recursion_level
uint8_t recursion_level
Definition: flow.h:373
FlowSetProtoEmergencyTimeout
int FlowSetProtoEmergencyTimeout(uint8_t, uint32_t, uint32_t, uint32_t)
FlowAddress_
Definition: flow.h:312
FLOW_STATE_ESTABLISHED
@ FLOW_STATE_ESTABLISHED
Definition: flow.h:507
FlowLookupStruct_::dtv
DecodeThreadVars * dtv
Definition: flow.h:542
Flow_::startts
struct timeval startts
Definition: flow.h:497
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1336
FlowKey_::src
Address src
Definition: flow.h:305
FLOW_END_FLAG_STATE_NEW
#define FLOW_END_FLAG_STATE_NEW
Definition: flow.h:233
FlowBypassInfo_
Definition: flow.h:526
FlowCnf_::emergency_recovery
uint32_t emergency_recovery
Definition: flow.h:297
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:500
FlowAddress_::address_un_data32
uint32_t address_un_data32[4]
Definition: flow.h:314
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
FlowUpdateSpareFlows
int FlowUpdateSpareFlows(void)
FlowLookupStruct
struct FlowLookupStruct_ FlowLookupStruct
Flow_::proto
uint8_t proto
Definition: flow.h:372
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:77
FlowInitConfig
void FlowInitConfig(bool)
initialize the configuration
Definition: flow.c:516
FlowGetPacketDirection
int FlowGetPacketDirection(const Flow *, const Packet *)
determine the direction of the packet compared to the flow
Definition: flow.c:292
FlowClearMemory
int FlowClearMemory(Flow *, uint8_t)
Function clear the flow memory before queueing it to spare flow queue.
Definition: flow.c:1060
util-macset.h
Flow_
Flow data structure.
Definition: flow.h:350
Flow_::protomap
uint8_t protomap
Definition: flow.h:452
LiveDevice_
Definition: util-device.h:40
FlowProtoTimeout_
Definition: flow.h:515
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:65
FlowLookupStruct_
Definition: flow.h:539
Flow_::alproto_orig
AppProto alproto_orig
Definition: flow.h:463
Flow_::vlan_id
uint16_t vlan_id[2]
Definition: flow.h:374
Flow
struct Flow_ Flow
Flow data structure.
FLOW_END_FLAG_STATE_BYPASSED
#define FLOW_END_FLAG_STATE_BYPASSED
Definition: flow.h:240
Flow_::use_cnt
FlowRefCount use_cnt
Definition: flow.h:380
FlowProtoTimeout_::bypassed_timeout
uint32_t bypassed_timeout
Definition: flow.h:519
FlowBypassInfo_::tosrcbytecnt
uint64_t tosrcbytecnt
Definition: flow.h:531
FlowCnf_::emerg_timeout_new
uint32_t emerg_timeout_new
Definition: flow.h:295
Address_
Definition: decode.h:119
FlowSetupPacket
void FlowSetupPacket(Packet *p)
prepare packet for a life with flow Set PKT_WANTS_FLOW flag to incidate workers should do a flow look...
Definition: flow-hash.c:431
Flow_::max_ttl_toserver
uint8_t max_ttl_toserver
Definition: flow.h:475
Flow_::dp
Port dp
Definition: flow.h:366
FlowGetAppState
void * FlowGetAppState(const Flow *f)
Definition: flow.c:1102
detect-tag.h
Flow_::protoctx
void * protoctx
Definition: flow.h:448
FlowUnsetChangeProtoFlag
void FlowUnsetChangeProtoFlag(Flow *)
Unset flag to indicate to change proto for the flow.
Definition: flow.c:202
util-var.h
FlowCnf_::prealloc
uint32_t prealloc
Definition: flow.h:290
Flow_::flow_state
FlowStateType flow_state
Definition: flow.h:419
Flow_::spi
uint32_t spi
Definition: flow.h:362
Flow_::sgh_toserver
const struct SigGroupHead_ * sgh_toserver
Definition: flow.h:490
FlowLookupStruct_::emerg_spare_sync_stamp
uint32_t emerg_spare_sync_stamp
Definition: flow.h:544
Flow_::tosrcbytecnt
uint64_t tosrcbytecnt
Definition: flow.h:502
FlowConfig
struct FlowCnf_ FlowConfig
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:482
Flow_::dst
FlowAddress dst
Definition: flow.h:353
FlowProtoFreeFunc
struct FlowProtoFreeFunc_ FlowProtoFreeFunc
Flow_::fb
struct FlowBucket_ * fb
Definition: flow.h:495
FLOW_STATE_LOCAL_BYPASSED
@ FLOW_STATE_LOCAL_BYPASSED
Definition: flow.h:509
Flow_::min_ttl_toserver
uint8_t min_ttl_toserver
Definition: flow.h:474
Flow_::protodetect_dp
uint16_t protodetect_dp
Definition: flow.h:434
decode.h
util-device.h
FlowBypassInfo_::todstbytecnt
uint64_t todstbytecnt
Definition: flow.h:533
AppLayerParserState_
Definition: app-layer-parser.c:155
RegisterFlowBypassInfo
void RegisterFlowBypassInfo(void)
Definition: flow-util.c:238
FlowBypassInfo_::BypassUpdate
bool(* BypassUpdate)(Flow *f, void *data, time_t tsec)
Definition: flow.h:527
FlowBypassInfo_::BypassFree
void(* BypassFree)(void *data)
Definition: flow.h:528
Flow_::todstpktcnt
uint32_t todstpktcnt
Definition: flow.h:499
FlowSetProtoTimeout
int FlowSetProtoTimeout(uint8_t, uint32_t, uint32_t, uint32_t)
FlowSetIPOnlyFlag
void FlowSetIPOnlyFlag(Flow *, int)
Set the IPOnly scanned flag for 'direction'.
Definition: flow.c:158
FlowSwap
void FlowSwap(Flow *)
swap the flow's direction
Definition: flow.c:261
FlowKey_::recursion_level
uint8_t recursion_level
Definition: flow.h:308
SCEnter
#define SCEnter(...)
Definition: util-debug.h:300
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
FlowShutdown
void FlowShutdown(void)
shutdown the flow engine
Definition: flow.c:644
FlowGetMemuse
uint64_t FlowGetMemuse(void)
Definition: flow.c:136
Flow_::flow_end_flags
uint8_t flow_end_flags
Definition: flow.h:454
FlowCnf_
Definition: flow.h:286
FlowState
FlowState
Definition: flow.h:505
FlowBypassInfo_::todstpktcnt
uint64_t todstpktcnt
Definition: flow.h:532
FlowProtoTimeout_::new_timeout
uint32_t new_timeout
Definition: flow.h:516
util-atomic.h
FlowProtoTimeout_::closed_timeout
uint32_t closed_timeout
Definition: flow.h:518
FlowBypassInfo_::bypass_data
void * bypass_data
Definition: flow.h:529
Flow_::m
SCMutex m
Definition: flow.h:442
FlowBypassInfo
struct FlowBypassInfo_ FlowBypassInfo
FlowCnf_::timeout_new
uint32_t timeout_new
Definition: flow.h:292
Flow_::todstbytecnt
uint64_t todstbytecnt
Definition: flow.h:501
FlowGetLastTimeAsParts
void FlowGetLastTimeAsParts(Flow *flow, uint64_t *secs, uint64_t *usecs)
Get flow last time as individual values.
Definition: flow.c:1168
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:277
Flow_::sgh_toclient
const struct SigGroupHead_ * sgh_toclient
Definition: flow.h:487
FlowPrintQueueInfo
void FlowPrintQueueInfo(void)
FlowChangeProto
int FlowChangeProto(Flow *)
Check if change proto flag is set for flow.
Definition: flow.c:212
FlowThreadId
uint16_t FlowThreadId
Definition: flow.h:329
FlowKey_::sp
Port sp
Definition: flow.h:306
SCReturn
#define SCReturn
Definition: util-debug.h:302
Packet_
Definition: decode.h:416
Flow_::type
uint8_t type
Definition: flow.h:357
FlowRegisterTests
void FlowRegisterTests(void)
Function to register the Flow Unitests.
Definition: flow.c:1387
Port
uint16_t Port
Definition: decode.h:243
FlowKey_::vlan_id
uint16_t vlan_id[2]
Definition: flow.h:309
FlowProtoFreeFunc_::Freefunc
void(* Freefunc)(void *)
Definition: flow.h:523
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:382
FlowHandlePacketUpdate
void FlowHandlePacketUpdate(Flow *f, Packet *p, ThreadVars *tv, DecodeThreadVars *dtv)
Update Packet and Flow.
Definition: flow.c:389
Flow_::min_ttl_toclient
uint8_t min_ttl_toclient
Definition: flow.h:476
flow-queue.h
FlowCleanupAppLayer
void FlowCleanupAppLayer(Flow *)
Definition: flow.c:142
FlowBypassInfo_::tosrcpktcnt
uint64_t tosrcpktcnt
Definition: flow.h:530
Flow_::probing_parser_toclient_alproto_masks
uint32_t probing_parser_toclient_alproto_masks
Definition: flow.h:426
FlowCnf_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, memcap)
Flow_::flow_hash
uint32_t flow_hash
Definition: flow.h:406
Flow_::alproto_expect
AppProto alproto_expect
Definition: flow.h:466
GetFlowBypassInfoID
FlowStorageId GetFlowBypassInfoID(void)
Definition: flow-util.c:220
Flow_::src
FlowAddress src
Definition: flow.h:353
Flow_::flowvar
GenericVar * flowvar
Definition: flow.h:493
Flow_::next
struct Flow_ * next
Definition: flow.h:401
Flow_::probing_parser_toserver_alproto_masks
uint32_t probing_parser_toserver_alproto_masks
Definition: flow.h:425
dtv
DecodeThreadVars * dtv
Definition: fuzz_decodepcapfile.c:30
Flow_::lastts
struct timeval lastts
Definition: flow.h:411
FlowLookupStruct_::spare_queue
FlowQueuePrivate spare_queue
Definition: flow.h:541
FlowProtoTimeout
struct FlowProtoTimeout_ FlowProtoTimeout
Flow_::ffr
uint8_t ffr
Definition: flow.h:390
FlowCnf_::emerg_timeout_est
uint32_t emerg_timeout_est
Definition: flow.h:296
FlowStateType
unsigned short FlowStateType
Definition: flow.h:326
flags
uint8_t flags
Definition: decode-gre.h:0
FLOW_STATE_NEW
@ FLOW_STATE_NEW
Definition: flow.h:506
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:305
FlowCnf_::max_flows
uint32_t max_flows
Definition: flow.h:289
Flow_::max_ttl_toclient
uint8_t max_ttl_toclient
Definition: flow.h:477
Flow_::parent_id
int64_t parent_id
Definition: flow.h:437
FLOW_END_FLAG_STATE_CLOSED
#define FLOW_END_FLAG_STATE_CLOSED
Definition: flow.h:235
Flow_::icmp_d
struct Flow_::@114::@120 icmp_d
FlowCnf_::timeout_est
uint32_t timeout_est
Definition: flow.h:293
Flow_::timeout_policy
uint32_t timeout_policy
Definition: flow.h:417
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:29
Flow_::icmp_s
struct Flow_::@112::@118 icmp_s
Flow_::livedev
struct LiveDevice_ * livedev
Definition: flow.h:403
util-optimize.h
FlowQueuePrivate_
Definition: flow-queue.h:41
FlowAddress_::address_un_data8
uint8_t address_un_data8[16]
Definition: flow.h:316
FlowKey_::proto
uint8_t proto
Definition: flow.h:307
FLOW_STATE_CLOSED
@ FLOW_STATE_CLOSED
Definition: flow.h:508
DecodeThreadVars_
Structure to hold thread specific data for all decode modules.
Definition: decode.h:640
Flow_::alproto_ts
AppProto alproto_ts
Definition: flow.h:458
Flow_::alstate
void * alstate
Definition: flow.h:483
Flow_::flags
uint32_t flags
Definition: flow.h:428
FlowAddress_::address
union FlowAddress_::@111 address
FlowGetAppProtocol
AppProto FlowGetAppProtocol(const Flow *f)
Definition: flow.c:1097
SCRWLock
#define SCRWLock
Definition: threads-debug.h:363
FlowGetMemcap
uint64_t FlowGetMemcap(void)
Return memcap value.
Definition: flow.c:130
FlowKey_
Definition: flow.h:304
likely
#define likely(expr)
Definition: util-optimize.h:32
FLOW_NOPACKET_INSPECTION
#define FLOW_NOPACKET_INSPECTION
Definition: flow.h:63
FlowProtoTimeout_::est_timeout
uint32_t est_timeout
Definition: flow.h:517
Flow_::sp
Port sp
Definition: flow.h:355
FlowRefCount
unsigned short FlowRefCount
Definition: flow.h:324
Flow_::alproto_tc
AppProto alproto_tc
Definition: flow.h:459
FlowSetChangeProtoFlag
void FlowSetChangeProtoFlag(Flow *)
Set flag to indicate to change proto for the flow.
Definition: flow.c:193
Flow_::file_flags
uint16_t file_flags
Definition: flow.h:430
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:457
FlowUpdateState
void FlowUpdateState(Flow *f, enum FlowState s)
Definition: flow.c:1135
Flow_::timeout_at
uint32_t timeout_at
Definition: flow.h:396
FlowKey_::dp
Port dp
Definition: flow.h:306
FlowUpdateQueue
void FlowUpdateQueue(Flow *)
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:1088
Flow_::tenant_id
uint32_t tenant_id
Definition: flow.h:423
Flow_::tosrcpktcnt
uint32_t tosrcpktcnt
Definition: flow.h:500
FlowSetHasAlertsFlag
void FlowSetHasAlertsFlag(Flow *)
Set flag to indicate that flow has alerts.
Definition: flow.c:169
Flow_::thread_id
FlowThreadId thread_id[2]
Definition: flow.h:399
FlowHasAlerts
int FlowHasAlerts(const Flow *)
Check if flow has alerts.
Definition: flow.c:180
FlowProtoFreeFunc_
Definition: flow.h:522
Flow_::de_ctx_version
uint32_t de_ctx_version
Definition: flow.h:471
Flow_::esp
struct Flow_::@112::@119 esp