suricata
suricata.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 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 #include "suricata-common.h"
25 
26 #if HAVE_GETOPT_H
27 #include <getopt.h>
28 #endif
29 
30 #if HAVE_SIGNAL_H
31 #include <signal.h>
32 #endif
33 #ifndef OS_WIN32
34 #ifdef HAVE_SYS_RESOURCE_H
35 // setrlimit
36 #include <sys/resource.h>
37 #endif
38 #endif
39 
40 #include "suricata.h"
41 
42 #include "conf.h"
43 #include "conf-yaml-loader.h"
44 
45 #include "decode.h"
46 #include "defrag.h"
47 #include "flow.h"
48 #include "stream-tcp.h"
49 #include "ippair.h"
50 
51 #include "detect.h"
52 #include "detect-parse.h"
53 #include "detect-engine.h"
54 #include "detect-engine-address.h"
55 #include "detect-engine-alert.h"
56 #include "detect-engine-port.h"
57 #include "detect-engine-tag.h"
59 #include "detect-fast-pattern.h"
60 
61 #include "datasets.h"
62 
63 #include "feature.h"
64 
65 #include "flow-bypass.h"
66 #include "flow-manager.h"
67 #include "flow-timeout.h"
68 #include "flow-worker.h"
69 
70 #include "flow-bit.h"
71 #include "host-bit.h"
72 #include "ippair-bit.h"
73 
74 #include "app-layer.h"
75 #include "app-layer-parser.h"
76 #include "app-layer-htp.h"
77 #include "app-layer-htp-range.h"
78 
79 #include "output.h"
80 #include "output-filestore.h"
81 
82 #include "respond-reject.h"
83 
84 #include "runmode-af-packet.h"
85 #include "runmode-af-xdp.h"
86 #include "runmode-netmap.h"
87 #include "runmode-unittests.h"
88 
89 #include "source-nfq.h"
90 #include "source-nfq-prototypes.h"
91 #include "source-nflog.h"
92 #include "source-ipfw.h"
93 #include "source-lib.h"
94 #include "source-pcap.h"
95 #include "source-pcap-file.h"
97 #include "source-erf-file.h"
98 #include "source-erf-dag.h"
99 #include "source-af-packet.h"
100 #include "source-af-xdp.h"
101 #include "source-netmap.h"
102 #include "source-dpdk.h"
103 #include "source-windivert.h"
105 
106 #include "unix-manager.h"
107 
109 #include "util-threshold-config.h"
110 #include "util-reference-config.h"
111 
112 #include "tmqh-packetpool.h"
113 #include "tm-queuehandlers.h"
114 
115 #include "util-byte.h"
116 #include "util-conf.h"
117 #include "util-coredump-config.h"
118 #include "util-cpu.h"
119 #include "util-daemon.h"
120 #include "util-device.h"
121 #include "util-dpdk.h"
122 #include "util-ebpf.h"
123 #include "util-exception-policy.h"
124 #include "util-host-os-info.h"
125 #include "util-hugepages.h"
126 #include "util-ioctl.h"
127 #include "util-landlock.h"
128 #include "util-macset.h"
129 #include "util-flow-rate.h"
130 #include "util-misc.h"
131 #include "util-mpm-hs.h"
132 #include "util-path.h"
133 #include "util-pidfile.h"
134 #include "util-plugin.h"
135 #include "util-privs.h"
136 #include "util-profiling.h"
137 #include "util-proto-name.h"
138 #include "util-running-modes.h"
139 #include "util-signal.h"
140 #include "util-time.h"
141 #include "util-validate.h"
142 #include "util-var-name.h"
143 #ifdef SYSTEMD_NOTIFY
144 #include "util-systemd.h"
145 #endif
146 
147 #ifdef WINDIVERT
148 #include "decode-sll.h"
149 #include "win32-syscall.h"
150 #endif
151 
152 /*
153  * we put this here, because we only use it here in main.
154  */
155 volatile sig_atomic_t sigint_count = 0;
156 volatile sig_atomic_t sighup_count = 0;
157 volatile sig_atomic_t sigterm_count = 0;
158 volatile sig_atomic_t sigusr2_count = 0;
159 
160 /*
161  * Flag to indicate if the engine is at the initialization
162  * or already processing packets. 3 stages: SURICATA_INIT,
163  * SURICATA_RUNTIME and SURICATA_FINALIZE
164  */
165 SC_ATOMIC_DECLARE(unsigned int, engine_stage);
166 
167 /* Max packets processed simultaneously per thread. */
168 #define DEFAULT_MAX_PENDING_PACKETS 1024
169 
170 /** suricata engine control flags */
171 volatile uint8_t suricata_ctl_flags = 0;
172 
173 /** Engine mode: inline (ENGINE_MODE_IPS) or just
174  * detection mode (ENGINE_MODE_IDS by default) */
175 static enum EngineMode g_engine_mode = ENGINE_MODE_UNKNOWN;
176 
177 /** Host mode: set if box is sniffing only
178  * or is a router */
180 
181 /** Maximum packets to simultaneously process. */
183 
184 /** global indicating if detection is enabled */
186 
187 /** set caps or not */
188 bool sc_set_caps = false;
189 
190 bool g_system = false;
191 
192 /** disable randomness to get reproducible results across runs */
193 #ifndef AFLFUZZ_NO_RANDOM
195 #else
196 int g_disable_randomness = 1;
197 #endif
198 
199 /** determine (without branching) if we include the vlan_ids when hashing or
200  * comparing flows */
201 uint16_t g_vlan_mask = 0xffff;
202 
203 /** determine (without branching) if we include the livedev ids when hashing or
204  * comparing flows */
205 uint16_t g_livedev_mask = 0xffff;
206 
207 /** determine (without branching) if we include the recursion levels when hashing or
208  * comparing flows */
209 uint8_t g_recurlvl_mask = 0xff;
210 
211 /* flag to disable hashing almost globally, to be similar to disabling nss
212  * support */
213 bool g_disable_hashing = false;
214 
215 /* snapshot of the system's hugepages before system intitialization. */
217 
218 /** add per-proto app-layer error counters for exception policies stats? disabled by default */
220 
221 /** Suricata instance */
223 
224 int SuriHasSigFile(void)
225 {
226  return (suricata.sig_file != NULL);
227 }
228 
230 {
231  return (g_engine_mode == ENGINE_MODE_UNKNOWN);
232 }
233 
235 {
236  DEBUG_VALIDATE_BUG_ON(g_engine_mode == ENGINE_MODE_UNKNOWN);
237  return (g_engine_mode == ENGINE_MODE_IPS);
238 }
239 
241 {
242  DEBUG_VALIDATE_BUG_ON(g_engine_mode == ENGINE_MODE_UNKNOWN);
243  return (g_engine_mode == ENGINE_MODE_IDS);
244 }
245 
247 {
248  g_engine_mode = ENGINE_MODE_IPS;
249 }
250 
252 {
253  g_engine_mode = ENGINE_MODE_IDS;
254 }
255 
256 #ifdef UNITTESTS
258 {
260  return 1;
261 
262  return 0;
263 }
264 #endif
265 
267 {
268  return suricata.run_mode;
269 }
270 
271 void SCRunmodeSet(SCRunMode run_mode)
272 {
273  suricata.run_mode = run_mode;
274 }
275 
276 /** signal handlers
277  *
278  * WARNING: don't use the SCLog* API in the handlers. The API is complex
279  * with memory allocation possibly happening, calls to syslog, json message
280  * construction, etc.
281  */
282 
283 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
284 static void SignalHandlerSigint(/*@unused@*/ int sig)
285 {
286  sigint_count = 1;
287 }
288 static void SignalHandlerSigterm(/*@unused@*/ int sig)
289 {
290  sigterm_count = 1;
291 }
292 #ifndef OS_WIN32
293 #if HAVE_LIBUNWIND
294 #define UNW_LOCAL_ONLY
295 #include <libunwind.h>
296 static void SignalHandlerUnexpected(int sig_num, siginfo_t *info, void *context)
297 {
298  char msg[SC_LOG_MAX_LOG_MSG_LEN];
299  unw_cursor_t cursor;
300  /* Restore defaults for signals to avoid loops */
301  signal(SIGABRT, SIG_DFL);
302  signal(SIGSEGV, SIG_DFL);
303  int r;
304  if ((r = unw_init_local(&cursor, (unw_context_t *)(context)) != 0)) {
305  SCLogError("unable to obtain stack trace: unw_init_local: %s", unw_strerror(r));
306  goto terminate;
307  }
308 
309  char *temp = msg;
310  int cw = snprintf(temp, SC_LOG_MAX_LOG_MSG_LEN - (temp - msg), "stacktrace:sig %d:", sig_num);
311  temp += cw;
312  r = 1;
313  while (r > 0) {
314  if (unw_is_signal_frame(&cursor) == 0) {
315  unw_word_t off;
316  char name[256];
317  if (unw_get_proc_name(&cursor, name, sizeof(name), &off) == UNW_ENOMEM) {
318  cw = snprintf(temp, SC_LOG_MAX_LOG_MSG_LEN - (temp - msg), "[unknown]:");
319  } else {
320  cw = snprintf(
321  temp, SC_LOG_MAX_LOG_MSG_LEN - (temp - msg), "%s+0x%08" PRIx64, name, off);
322  }
323  temp += cw;
324  }
325 
326  r = unw_step(&cursor);
327  if (r > 0) {
328  cw = snprintf(temp, SC_LOG_MAX_LOG_MSG_LEN - (temp - msg), ";");
329  temp += cw;
330  }
331  }
332  SCLogError("%s", msg);
333 
334 terminate:
335  // Propagate signal to watchers, if any
336  kill(getpid(), sig_num);
337 }
338 #undef UNW_LOCAL_ONLY
339 #endif /* HAVE_LIBUNWIND */
340 #endif /* !OS_WIN32 */
341 #endif
342 
343 #ifndef OS_WIN32
344 /**
345  * SIGUSR2 handler. Just set sigusr2_count. The main loop will act on
346  * it.
347  */
348 static void SignalHandlerSigusr2(int sig)
349 {
350  if (sigusr2_count < 2)
351  sigusr2_count++;
352 }
353 
354 /**
355  * SIGHUP handler. Just set sighup_count. The main loop will act on
356  * it.
357  */
358 static void SignalHandlerSigHup(/*@unused@*/ int sig)
359 {
360  sighup_count = 1;
361 }
362 #endif
363 
365 {
366  TimeInit();
369  SCProtoNameInit();
370 }
371 
372 void GlobalsDestroy(void)
373 {
374  SCInstance *suri = &suricata;
376  HostShutdown();
377  HTPFreeConfig();
379 
381 
382  /* TODO this can do into it's own func */
384  if (de_ctx) {
387  }
389 
390  AppLayerDeSetup();
391  DatasetsSave();
392  DatasetsDestroy();
394  TagDestroyCtx();
395 
400  TimeDeinit();
401  SigTableCleanup();
402  TmqhCleanup();
404  ParseSizeDeinit();
406 
407 #ifdef HAVE_DPDK
408  DPDKCleanupEAL();
409 #endif
410 
411 #ifdef HAVE_AF_PACKET
413 #endif
414 
415 #ifdef NFQ
417 #endif
418 
419 #ifdef BUILD_HYPERSCAN
421 #endif
422 
423  SCConfDeInit();
424 
426 
428  SCFree(suri->pid_filename);
429  suri->pid_filename = NULL;
430 
433 }
434 
435 /**
436  * \brief Used to send OS specific notification of running threads
437  *
438  * \retval TmEcode TM_ECODE_OK on success; TM_ECODE_FAILED on failure.
439  */
440 static void OnNotifyRunning(void)
441 {
442 #ifdef SYSTEMD_NOTIFY
443  if (SystemDNotifyReady() < 0) {
444  SCLogWarning("failed to notify systemd");
445  }
446 #endif
447 }
448 
449 /** \brief make sure threads can stop the engine by calling this
450  * function. Purpose: pcap file mode needs to be able to tell the
451  * engine the file eof is reached. */
452 void EngineStop(void)
453 {
455 }
456 
457 /**
458  * \brief Used to indicate that the current task is done.
459  *
460  * This is mainly used by pcap-file to tell it has finished
461  * to treat a pcap files when running in unix-socket mode.
462  */
463 void EngineDone(void)
464 {
466 }
467 
468 static int SetBpfString(int argc, char *argv[])
469 {
470  char *bpf_filter = NULL;
471  uint32_t bpf_len = 0;
472  int tmpindex = 0;
473 
474  /* attempt to parse remaining args as bpf filter */
475  tmpindex = argc;
476  while(argv[tmpindex] != NULL) {
477  bpf_len+=strlen(argv[tmpindex]) + 1;
478  tmpindex++;
479  }
480 
481  if (bpf_len == 0)
482  return TM_ECODE_OK;
483 
484  bpf_filter = SCCalloc(1, bpf_len);
485  if (unlikely(bpf_filter == NULL))
486  return TM_ECODE_FAILED;
487 
488  tmpindex = optind;
489  while(argv[tmpindex] != NULL) {
490  strlcat(bpf_filter, argv[tmpindex],bpf_len);
491  if(argv[tmpindex + 1] != NULL) {
492  strlcat(bpf_filter," ", bpf_len);
493  }
494  tmpindex++;
495  }
496 
497  if(strlen(bpf_filter) > 0) {
498  if (SCConfSetFinal("bpf-filter", bpf_filter) != 1) {
499  SCLogError("Failed to set bpf filter.");
500  SCFree(bpf_filter);
501  return TM_ECODE_FAILED;
502  }
503  }
504  SCFree(bpf_filter);
505 
506  return TM_ECODE_OK;
507 }
508 
509 static void SetBpfStringFromFile(char *filename)
510 {
511  char *bpf_filter = NULL;
512  char *bpf_comment_tmp = NULL;
513  char *bpf_comment_start = NULL;
514  size_t bpf_len = 0;
515  SCStat st;
516  FILE *fp = NULL;
517  size_t nm = 0;
518 
519  fp = fopen(filename, "r");
520  if (fp == NULL) {
521  SCLogError("Failed to open file %s", filename);
522  exit(EXIT_FAILURE);
523  }
524 
525  if (SCFstatFn(fileno(fp), &st) != 0) {
526  SCLogError("Failed to stat file %s", filename);
527  exit(EXIT_FAILURE);
528  }
529  // st.st_size is signed on Windows
530  bpf_len = ((size_t)(st.st_size)) + 1;
531 
532  bpf_filter = SCCalloc(1, bpf_len);
533  if (unlikely(bpf_filter == NULL)) {
534  SCLogError("Failed to allocate buffer for bpf filter in file %s", filename);
535  exit(EXIT_FAILURE);
536  }
537 
538  nm = fread(bpf_filter, 1, bpf_len - 1, fp);
539  if ((ferror(fp) != 0) || (nm != (bpf_len - 1))) {
540  SCLogError("Failed to read complete BPF file %s", filename);
541  SCFree(bpf_filter);
542  fclose(fp);
543  exit(EXIT_FAILURE);
544  }
545  fclose(fp);
546  bpf_filter[nm] = '\0';
547 
548  if(strlen(bpf_filter) > 0) {
549  /*replace comments with space*/
550  bpf_comment_start = bpf_filter;
551  while((bpf_comment_tmp = strchr(bpf_comment_start, '#')) != NULL) {
552  while((*bpf_comment_tmp !='\0') &&
553  (*bpf_comment_tmp != '\r') && (*bpf_comment_tmp != '\n'))
554  {
555  *bpf_comment_tmp++ = ' ';
556  }
557  bpf_comment_start = bpf_comment_tmp;
558  }
559  /*remove remaining '\r' and '\n' */
560  while((bpf_comment_tmp = strchr(bpf_filter, '\r')) != NULL) {
561  *bpf_comment_tmp = ' ';
562  }
563  while((bpf_comment_tmp = strchr(bpf_filter, '\n')) != NULL) {
564  *bpf_comment_tmp = ' ';
565  }
566  /* cut trailing spaces */
567  while (strlen(bpf_filter) > 0 &&
568  bpf_filter[strlen(bpf_filter)-1] == ' ')
569  {
570  bpf_filter[strlen(bpf_filter)-1] = '\0';
571  }
572  if (strlen(bpf_filter) > 0) {
573  if (SCConfSetFinal("bpf-filter", bpf_filter) != 1) {
574  SCFree(bpf_filter);
575  FatalError("failed to set bpf filter");
576  }
577  }
578  }
579  SCFree(bpf_filter);
580 }
581 
582 static void PrintUsage(const char *progname)
583 {
584 #ifdef REVISION
585  printf("%s %s (%s)\n", PROG_NAME, PROG_VER, xstr(REVISION));
586 #else
587  printf("%s %s\n", PROG_NAME, PROG_VER);
588 #endif
589  printf("USAGE: %s [OPTIONS] [BPF FILTER]\n\n", progname);
590  printf("\t-c <path> : path to configuration file\n");
591  printf("\t-T : test configuration file (use with -c)\n");
592  printf("\t-i <dev or ip> : run in pcap live mode\n");
593  printf("\t-F <bpf filter file> : bpf filter file\n");
594  printf("\t-r <path> : run in pcap file/offline mode\n");
595 #ifdef NFQ
596  printf("\t-q <qid[:qid]> : run in inline nfqueue mode (use colon to specify a range of queues)\n");
597 #endif /* NFQ */
598 #ifdef IPFW
599  printf("\t-d <divert port> : run in inline ipfw divert mode\n");
600 #endif /* IPFW */
601  printf("\t-s <path> : path to signature file loaded in addition to suricata.yaml settings (optional)\n");
602  printf("\t-S <path> : path to signature file loaded exclusively (optional)\n");
603  printf("\t-l <dir> : default log directory\n");
604 #ifndef OS_WIN32
605  printf("\t-D : run as daemon\n");
606 #else
607  printf("\t--service-install : install as service\n");
608  printf("\t--service-remove : remove service\n");
609  printf("\t--service-change-params : change service startup parameters\n");
610 #endif /* OS_WIN32 */
611  printf("\t-k [all|none] : force checksum check (all) or disabled it (none)\n");
612  printf("\t-V : display Suricata version\n");
613  printf("\t-v : be more verbose (use multiple times to increase verbosity)\n");
614 #ifdef UNITTESTS
615  printf("\t-u : run the unittests and exit\n");
616  printf("\t-U, --unittest-filter=REGEX : filter unittests with a regex\n");
617  printf("\t--list-unittests : list unit tests\n");
618  printf("\t--fatal-unittests : enable fatal failure on unittest error\n");
619  printf("\t--unittests-coverage : display unittest coverage report\n");
620 #endif /* UNITTESTS */
621  printf("\t--firewall-rules-exclusive=<path> : path to firewall rule file loaded "
622  "exclusively\n");
623  printf("\t--list-app-layer-protos : list supported app layer protocols\n");
624  printf("\t--list-keywords[=all|csv|<kword>] : list keywords implemented by the engine\n");
625  printf("\t--list-runmodes : list supported runmodes\n");
626  printf("\t--runmode <runmode_id> : specific runmode modification the engine should run. The argument\n"
627  "\t supplied should be the id for the runmode obtained by running\n"
628  "\t --list-runmodes\n");
629  printf("\t--engine-analysis : print reports on analysis of different sections in the engine and exit.\n"
630  "\t Please have a look at the conf parameter engine-analysis on what reports\n"
631  "\t can be printed\n");
632  printf("\t--pidfile <file> : write pid to this file\n");
633  printf("\t--init-errors-fatal : enable fatal failure on signature init error\n");
634  printf("\t--disable-detection : disable detection engine\n");
635  printf("\t--dump-config : show the running configuration\n");
636  printf("\t--dump-features : display provided features\n");
637  printf("\t--build-info : display build information\n");
638  printf("\t--pcap[=<dev>] : run in pcap mode, no value select interfaces from suricata.yaml\n");
639  printf("\t--pcap-file-continuous : when running in pcap mode with a directory, continue checking directory for pcaps until interrupted\n");
640  printf("\t--pcap-file-delete : when running in replay mode (-r with directory or file), will delete pcap files that have been processed when done\n");
641  printf("\t--pcap-file-recursive : will descend into subdirectories when running in replay mode (-r)\n");
642  printf("\t--pcap-file-buffer-size : set read buffer size (setvbuf)\n");
643 #ifdef HAVE_PCAP_SET_BUFF
644  printf("\t--pcap-buffer-size : size of the pcap buffer value from 0 - %i\n",INT_MAX);
645 #endif /* HAVE_SET_PCAP_BUFF */
646 #ifdef HAVE_DPDK
647  printf("\t--dpdk : run in dpdk mode, uses interfaces from "
648  "suricata.yaml\n");
649 #endif
650 #ifdef HAVE_AF_PACKET
651  printf("\t--af-packet[=<dev>] : run in af-packet mode, no value select interfaces from suricata.yaml\n");
652 #endif
653 #ifdef HAVE_AF_XDP
654  printf("\t--af-xdp[=<dev>] : run in af-xdp mode, no value select "
655  "interfaces from suricata.yaml\n");
656 #endif
657 #ifdef HAVE_NETMAP
658  printf("\t--netmap[=<dev>] : run in netmap mode, no value select interfaces from suricata.yaml\n");
659 #endif
660 #ifdef HAVE_PFRING
661  printf("\t--pfring[=<dev>] : run in pfring mode, use interfaces from suricata.yaml\n");
662  printf("\t--pfring-int <dev> : run in pfring mode, use interface <dev>\n");
663  printf("\t--pfring-cluster-id <id> : pfring cluster id \n");
664  printf("\t--pfring-cluster-type <type> : pfring cluster type for PF_RING 4.1.2 and later cluster_round_robin|cluster_flow\n");
665 #endif /* HAVE_PFRING */
666  printf("\t--simulate-ips : force engine into IPS mode. Useful for QA\n");
667 #ifdef HAVE_LIBCAP_NG
668  printf("\t--user <user> : run suricata as this user after init\n");
669  printf("\t--group <group> : run suricata as this group after init\n");
670 #endif /* HAVE_LIBCAP_NG */
671  printf("\t--erf-in <path> : process an ERF file\n");
672 #ifdef HAVE_DAG
673  printf("\t--dag <dagX:Y> : process ERF records from DAG interface X, stream Y\n");
674 #endif
675 #ifdef BUILD_UNIX_SOCKET
676  printf("\t--unix-socket[=<file>] : use unix socket to control suricata work\n");
677 #endif
678 #ifdef WINDIVERT
679  printf("\t--windivert <filter> : run in inline WinDivert mode\n");
680  printf("\t--windivert-forward <filter> : run in inline WinDivert mode, as a gateway\n");
681 #endif
682 #ifdef HAVE_LIBNET11
683  printf("\t--reject-dev <dev> : send reject packets from this interface\n");
684 #endif
685  printf("\t--include <path> : additional configuration file\n");
686  printf("\t--set name=value : set a configuration value\n");
687  printf("\n");
688  printf("\nTo run the engine with default configuration on "
689  "interface eth0 with signature file \"signatures.rules\", run the "
690  "command as:\n\n%s -c suricata.yaml -s signatures.rules -i eth0 \n\n",
691  progname);
692 }
693 
694 static void PrintBuildInfo(void)
695 {
696  const char *bits;
697  const char *endian;
698  char features[2048] = "";
699  const char *tls;
700 
701  printf("This is %s version %s\n", PROG_NAME, GetProgramVersion());
702 #ifdef DEBUG
703  strlcat(features, "DEBUG ", sizeof(features));
704 #endif
705 #ifdef DEBUG_VALIDATION
706  strlcat(features, "DEBUG_VALIDATION ", sizeof(features));
707 #endif
708 #ifdef UNITTESTS
709  strlcat(features, "UNITTESTS ", sizeof(features));
710 #endif
711 #ifdef NFQ
712  strlcat(features, "NFQ ", sizeof(features));
713 #endif
714 #ifdef IPFW
715  strlcat(features, "IPFW ", sizeof(features));
716 #endif
717 #ifdef HAVE_PCAP_SET_BUFF
718  strlcat(features, "PCAP_SET_BUFF ", sizeof(features));
719 #endif
720 #ifdef HAVE_PFRING
721  strlcat(features, "PF_RING ", sizeof(features));
722 #endif
723 #ifdef HAVE_NAPATECH
724  strlcat(features, "NAPATECH ", sizeof(features));
725 #endif
726 #ifdef HAVE_AF_PACKET
727  strlcat(features, "AF_PACKET ", sizeof(features));
728 #endif
729 #ifdef HAVE_NETMAP
730  strlcat(features, "NETMAP ", sizeof(features));
731 #endif
732 #ifdef HAVE_PACKET_FANOUT
733  strlcat(features, "HAVE_PACKET_FANOUT ", sizeof(features));
734 #endif
735 #ifdef HAVE_DAG
736  strlcat(features, "DAG ", sizeof(features));
737 #endif
738 #ifdef HAVE_LIBCAP_NG
739  strlcat(features, "LIBCAP_NG ", sizeof(features));
740 #endif
741 #ifdef HAVE_LIBNET11
742  strlcat(features, "LIBNET1.1 ", sizeof(features));
743 #endif
744  strlcat(features, "HAVE_HTP_URI_NORMALIZE_HOOK ", sizeof(features));
745 #ifdef PCRE2_HAVE_JIT
746  strlcat(features, "PCRE_JIT ", sizeof(features));
747 #endif
748  /* For compatibility, just say we have HAVE_NSS. */
749  strlcat(features, "HAVE_NSS ", sizeof(features));
750  /* HTTP2_DECOMPRESSION is not an optional feature in this major version */
751  strlcat(features, "HTTP2_DECOMPRESSION ", sizeof(features));
752  /* Lua is now vendored in and always available. */
753  strlcat(features, "HAVE_LUA ", sizeof(features));
754 #ifdef HAVE_JA3
755  strlcat(features, "HAVE_JA3 ", sizeof(features));
756 #endif
757 #ifdef HAVE_JA4
758  strlcat(features, "HAVE_JA4 ", sizeof(features));
759 #endif
760  strlcat(features, "HAVE_LIBJANSSON ", sizeof(features));
761 #ifdef PROFILING
762  strlcat(features, "PROFILING ", sizeof(features));
763 #endif
764 #ifdef PROFILE_LOCKING
765  strlcat(features, "PROFILE_LOCKING ", sizeof(features));
766 #endif
767 #if defined(TLS_C11) || defined(TLS_GNU)
768  strlcat(features, "TLS ", sizeof(features));
769 #endif
770 #if defined(TLS_C11)
771  strlcat(features, "TLS_C11 ", sizeof(features));
772 #elif defined(TLS_GNU)
773  strlcat(features, "TLS_GNU ", sizeof(features));
774 #endif
775 #ifdef HAVE_MAGIC
776  strlcat(features, "MAGIC ", sizeof(features));
777 #endif
778  strlcat(features, "RUST ", sizeof(features));
779 #if defined(SC_ADDRESS_SANITIZER)
780  strlcat(features, "ASAN ", sizeof(features));
781 #endif
782 #if defined(HAVE_POPCNT64)
783  strlcat(features, "POPCNT64 ", sizeof(features));
784 #endif
785  if (strlen(features) == 0) {
786  strlcat(features, "none", sizeof(features));
787  }
788 
789  printf("Features: %s\n", features);
790 
791  /* SIMD stuff */
792  memset(features, 0x00, sizeof(features));
793 #if defined(__SSE4_2__)
794  strlcat(features, "SSE_4_2 ", sizeof(features));
795 #endif
796 #if defined(__SSE4_1__)
797  strlcat(features, "SSE_4_1 ", sizeof(features));
798 #endif
799 #if defined(__SSE3__)
800  strlcat(features, "SSE_3 ", sizeof(features));
801 #endif
802 #if defined(__SSE2__)
803  strlcat(features, "SSE_2 ", sizeof(features));
804 #endif
805  if (strlen(features) == 0) {
806  strlcat(features, "none", sizeof(features));
807  }
808  printf("SIMD support: %s\n", features);
809 
810  /* atomics stuff */
811  memset(features, 0x00, sizeof(features));
812 #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_1)
813  strlcat(features, "1 ", sizeof(features));
814 #endif
815 #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_2)
816  strlcat(features, "2 ", sizeof(features));
817 #endif
818 #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
819  strlcat(features, "4 ", sizeof(features));
820 #endif
821 #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_8)
822  strlcat(features, "8 ", sizeof(features));
823 #endif
824 #if defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_16)
825  strlcat(features, "16 ", sizeof(features));
826 #endif
827  if (strlen(features) == 0) {
828  strlcat(features, "none", sizeof(features));
829  } else {
830  strlcat(features, "byte(s)", sizeof(features));
831  }
832  printf("Atomic intrinsics: %s\n", features);
833 
834 #if __WORDSIZE == 64
835  bits = "64-bits";
836 #elif __WORDSIZE == 32
837  bits = "32-bits";
838 #else
839  bits = "<unknown>-bits";
840 #endif
841 
842 #if __BYTE_ORDER == __BIG_ENDIAN
843  endian = "Big-endian";
844 #elif __BYTE_ORDER == __LITTLE_ENDIAN
845  endian = "Little-endian";
846 #else
847  endian = "<unknown>-endian";
848 #endif
849 
850  printf("%s, %s architecture\n", bits, endian);
851 #ifdef __GNUC__
852  printf("GCC version %s, C version %"PRIiMAX"\n", __VERSION__, (intmax_t)__STDC_VERSION__);
853 #else
854  printf("C version %"PRIiMAX"\n", (intmax_t)__STDC_VERSION__);
855 #endif
856 
857 #if __SSP__ == 1
858  printf("compiled with -fstack-protector\n");
859 #endif
860 #if __SSP_ALL__ == 2
861  printf("compiled with -fstack-protector-all\n");
862 #endif
863 /*
864  * Workaround for special defines of _FORTIFY_SOURCE like
865  * FORTIFY_SOURCE=((defined __OPTIMIZE && OPTIMIZE > 0) ? 2 : 0)
866  * which is used by Gentoo for example and would result in the error
867  * 'defined' undeclared when _FORTIFY_SOURCE used via %d in printf func
868  *
869  */
870 #if _FORTIFY_SOURCE == 2
871  printf("compiled with _FORTIFY_SOURCE=2\n");
872 #elif _FORTIFY_SOURCE == 1
873  printf("compiled with _FORTIFY_SOURCE=1\n");
874 #elif _FORTIFY_SOURCE == 0
875  printf("compiled with _FORTIFY_SOURCE=0\n");
876 #endif
877 #ifdef CLS
878  printf("L1 cache line size (CLS)=%d\n", CLS);
879 #endif
880 #if defined(TLS_C11)
881  tls = "_Thread_local";
882 #elif defined(TLS_GNU)
883  tls = "__thread";
884 #else
885 #error "Unsupported thread local"
886 #endif
887  printf("thread local storage method: %s\n", tls);
888 
889  printf("compiled with %s\n", htp_get_version());
890  printf("\n");
891 #include "build-info.h"
892 }
893 
897 
899 {
900  /* commanders */
902  /* managers */
906  /* nfq */
910  /* ipfw */
914  /* pcap live */
917  /* pcap file */
920  /* af-packet */
923  /* af-xdp */
926  /* netmap */
929  /* dag file */
932  /* dag live */
935 
936  /* flow worker */
938  /* respond-reject */
940 
941  /* log api */
944 
946  /* nflog */
949 
950  /* windivert */
954 
955  /* Dpdk */
958 
959  /* Library */
961 }
962 
964 {
965  SCEnter();
966 
967  SCInstance *suri = &suricata;
968 
969  if (suri->conf_filename == NULL)
971 
972  if (SCConfYamlLoadFile(suri->conf_filename) != 0) {
973  /* Error already displayed. */
975  }
976 
977  if (suri->additional_configs) {
978  for (int i = 0; suri->additional_configs[i] != NULL; i++) {
979  SCLogConfig("Loading additional configuration file %s", suri->additional_configs[i]);
981  }
982  }
983 
985 }
986 
987 static TmEcode ParseInterfacesList(const int runmode, char *pcap_dev)
988 {
989  SCEnter();
990 
991  /* run the selected runmode */
992  if (runmode == RUNMODE_PCAP_DEV) {
993  if (strlen(pcap_dev) == 0) {
994  int ret = LiveBuildDeviceList("pcap");
995  if (ret == 0) {
996  SCLogError("No interface found in config for pcap");
998  }
999  }
1000  } else if (runmode == RUNMODE_PLUGIN) {
1001  if (strcmp(suricata.capture_plugin_name, "pfring") == 0) {
1002  /* Special handling for pfring. */
1003  if (strlen(pcap_dev)) {
1004  if (SCConfSetFinal("pfring.live-interface", pcap_dev) != 1) {
1005  SCLogError("Failed to set pfring.live-interface");
1007  }
1008  }
1009  }
1010 #ifdef HAVE_DPDK
1011  } else if (runmode == RUNMODE_DPDK) {
1012  char iface_selector[] = "dpdk.interfaces";
1013  int ret = LiveBuildDeviceList(iface_selector);
1014  if (ret == 0) {
1015  SCLogError("No interface found in config for %s", iface_selector);
1017  }
1018 #endif
1019 #ifdef HAVE_AF_PACKET
1020  } else if (runmode == RUNMODE_AFP_DEV) {
1021  /* iface has been set on command line */
1022  if (strlen(pcap_dev)) {
1023  if (SCConfSetFinal("af-packet.live-interface", pcap_dev) != 1) {
1024  SCLogError("Failed to set af-packet.live-interface");
1026  }
1027  } else {
1028  int ret = LiveBuildDeviceList("af-packet");
1029  if (ret == 0) {
1030  SCLogError("No interface found in config for af-packet");
1032  }
1033  }
1034 #endif
1035 #ifdef HAVE_AF_XDP
1036  } else if (runmode == RUNMODE_AFXDP_DEV) {
1037  /* iface has been set on command line */
1038  if (strlen(pcap_dev)) {
1039  if (SCConfSetFinal("af-xdp.live-interface", pcap_dev) != 1) {
1040  SCLogError("Failed to set af-xdp.live-interface");
1042  }
1043  } else {
1044  int ret = LiveBuildDeviceList("af-xdp");
1045  if (ret == 0) {
1046  SCLogError("No interface found in config for af-xdp");
1048  }
1049  }
1050 #endif
1051 #ifdef HAVE_NETMAP
1052  } else if (runmode == RUNMODE_NETMAP) {
1053  /* iface has been set on command line */
1054  if (strlen(pcap_dev)) {
1055  if (SCConfSetFinal("netmap.live-interface", pcap_dev) != 1) {
1056  SCLogError("Failed to set netmap.live-interface");
1058  }
1059  } else {
1060  int ret = LiveBuildDeviceList("netmap");
1061  if (ret == 0) {
1062  SCLogError("No interface found in config for netmap");
1064  }
1065  }
1066 #endif
1067 #ifdef HAVE_NFLOG
1068  } else if (runmode == RUNMODE_NFLOG) {
1069  int ret = LiveBuildDeviceListCustom("nflog", "group");
1070  if (ret == 0) {
1071  SCLogError("No group found in config for nflog");
1073  }
1074 #endif
1075  }
1076 
1078 }
1079 
1080 static void SCInstanceInit(SCInstance *suri, const char *progname)
1081 {
1082  memset(suri, 0x00, sizeof(*suri));
1083 
1084  suri->progname = progname;
1085  suri->run_mode = RUNMODE_UNKNOWN;
1086 
1087  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1088  suri->sig_file = NULL;
1089  suri->sig_file_exclusive = false;
1090  suri->pid_filename = NULL;
1091  suri->regex_arg = NULL;
1092 
1093  suri->keyword_info = NULL;
1094  suri->runmode_custom_mode = NULL;
1095 #ifndef OS_WIN32
1096  suri->user_name = NULL;
1097  suri->group_name = NULL;
1098  suri->do_setuid = false;
1099  suri->do_setgid = false;
1100 #endif /* OS_WIN32 */
1101  suri->userid = 0;
1102  suri->groupid = 0;
1103  suri->delayed_detect = 0;
1104  suri->daemon = 0;
1105  suri->offline = 0;
1106  suri->verbose = 0;
1107  /* use -1 as unknown */
1108  suri->checksum_validation = -1;
1109 #if HAVE_DETECT_DISABLED==1
1110  g_detect_disabled = suri->disabled_detect = 1;
1111 #else
1112  g_detect_disabled = suri->disabled_detect = 0;
1113 #endif
1114 }
1115 
1116 const char *GetDocURL(void)
1117 {
1118  const char *prog_ver = GetProgramVersion();
1119  if (strstr(prog_ver, "RELEASE") != NULL) {
1120  return DOC_URL "suricata-" PROG_VER;
1121  }
1122  return DOC_URL "latest";
1123 }
1124 
1125 /** \brief get string with program version
1126  *
1127  * Get the program version as passed to us from AC_INIT
1128  *
1129  * Add 'RELEASE' is no '-dev' in the version. Add the REVISION if passed
1130  * to us.
1131  *
1132  * Possible outputs:
1133  * release: '5.0.1 RELEASE'
1134  * dev with rev: '5.0.1-dev (64a789bbf 2019-10-18)'
1135  * dev w/o rev: '5.0.1-dev'
1136  */
1137 const char *GetProgramVersion(void)
1138 {
1139  if (strstr(PROG_VER, "-dev") == NULL) {
1140  return PROG_VER " RELEASE";
1141  } else {
1142 #ifdef REVISION
1143  return PROG_VER " (" xstr(REVISION) ")";
1144 #else
1145  return PROG_VER;
1146 #endif
1147  }
1148 }
1149 
1150 static TmEcode PrintVersion(void)
1151 {
1152  printf("This is %s version %s\n", PROG_NAME, GetProgramVersion());
1153  return TM_ECODE_OK;
1154 }
1155 
1156 static TmEcode LogVersion(SCInstance *suri)
1157 {
1158  const char *mode = suri->system ? "SYSTEM" : "USER";
1159  SCLogNotice("This is %s version %s running in %s mode",
1160  PROG_NAME, GetProgramVersion(), mode);
1161  return TM_ECODE_OK;
1162 }
1163 
1164 static void SCSetStartTime(SCInstance *suri)
1165 {
1166  memset(&suri->start_time, 0, sizeof(suri->start_time));
1167  gettimeofday(&suri->start_time, NULL);
1168 }
1169 
1170 static void SCPrintElapsedTime(struct timeval *start_time)
1171 {
1172  if (start_time == NULL)
1173  return;
1174  struct timeval end_time;
1175  memset(&end_time, 0, sizeof(end_time));
1176  gettimeofday(&end_time, NULL);
1177  uint64_t milliseconds = ((end_time.tv_sec - start_time->tv_sec) * 1000) +
1178  (((1000000 + end_time.tv_usec - start_time->tv_usec) / 1000) - 1000);
1179  SCLogInfo("time elapsed %.3fs", (float)milliseconds/(float)1000);
1180 }
1181 
1182 static int ParseCommandLineAfpacket(SCInstance *suri, const char *in_arg)
1183 {
1184 #ifdef HAVE_AF_PACKET
1185  if (suri->run_mode == RUNMODE_UNKNOWN) {
1186  suri->run_mode = RUNMODE_AFP_DEV;
1187  if (in_arg) {
1188  LiveRegisterDeviceName(in_arg);
1189  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1190  strlcpy(suri->pcap_dev, in_arg, sizeof(suri->pcap_dev));
1191  }
1192  } else if (suri->run_mode == RUNMODE_AFP_DEV) {
1193  if (in_arg) {
1194  LiveRegisterDeviceName(in_arg);
1195  } else {
1196  SCLogInfo("Multiple af-packet option without interface on each is useless");
1197  }
1198  } else {
1199  SCLogError("more than one run mode "
1200  "has been specified");
1201  PrintUsage(suri->progname);
1202  return TM_ECODE_FAILED;
1203  }
1204  return TM_ECODE_OK;
1205 #else
1206  SCLogError("AF_PACKET not enabled. On Linux "
1207  "host, make sure to pass --enable-af-packet to "
1208  "configure when building.");
1209  return TM_ECODE_FAILED;
1210 #endif
1211 }
1212 
1213 static int ParseCommandLineAfxdp(SCInstance *suri, const char *in_arg)
1214 {
1215 #ifdef HAVE_AF_XDP
1216  if (suri->run_mode == RUNMODE_UNKNOWN) {
1217  suri->run_mode = RUNMODE_AFXDP_DEV;
1218  if (in_arg) {
1219  LiveRegisterDeviceName(in_arg);
1220  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1221  strlcpy(suri->pcap_dev, in_arg, sizeof(suri->pcap_dev));
1222  }
1223  } else if (suri->run_mode == RUNMODE_AFXDP_DEV) {
1224  if (in_arg) {
1225  LiveRegisterDeviceName(in_arg);
1226  } else {
1227  SCLogInfo("Multiple af-xdp options without interface on each is useless");
1228  }
1229  } else {
1230  SCLogError("more than one run mode "
1231  "has been specified");
1232  PrintUsage(suri->progname);
1233  return TM_ECODE_FAILED;
1234  }
1235  return TM_ECODE_OK;
1236 #else
1237  SCLogError("AF_XDP not enabled. On Linux "
1238  "host, make sure correct libraries are installed,"
1239  " see documentation for information.");
1240  return TM_ECODE_FAILED;
1241 #endif
1242 }
1243 
1244 static int ParseCommandLineDpdk(SCInstance *suri, const char *in_arg)
1245 {
1246 #ifdef HAVE_DPDK
1247  if (suri->run_mode == RUNMODE_UNKNOWN) {
1248  suri->run_mode = RUNMODE_DPDK;
1249  } else if (suri->run_mode == RUNMODE_DPDK) {
1250  SCLogInfo("Multiple dpdk options have no effect on Suricata");
1251  } else {
1252  SCLogError("more than one run mode "
1253  "has been specified");
1254  PrintUsage(suri->progname);
1255  return TM_ECODE_FAILED;
1256  }
1257  return TM_ECODE_OK;
1258 #else
1259  SCLogError("DPDK not enabled. On Linux "
1260  "host, make sure to pass --enable-dpdk to "
1261  "configure when building.");
1262  return TM_ECODE_FAILED;
1263 #endif
1264 }
1265 
1266 static int ParseCommandLinePcapLive(SCInstance *suri, const char *in_arg)
1267 {
1268 #if defined(OS_WIN32) && !defined(HAVE_LIBWPCAP)
1269  /* If running on Windows without Npcap, bail early as live capture is not supported. */
1270  FatalError("Live capture not available. To support live capture compile against Npcap.");
1271 #endif
1272  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1273 
1274  if (in_arg != NULL) {
1275  /* some windows shells require escaping of the \ in \Device. Otherwise
1276  * the backslashes are stripped. We put them back here. */
1277  if (strlen(in_arg) > 9 && strncmp(in_arg, "DeviceNPF", 9) == 0) {
1278  snprintf(suri->pcap_dev, sizeof(suri->pcap_dev), "\\Device\\NPF%s", in_arg+9);
1279  } else {
1280  strlcpy(suri->pcap_dev, in_arg, sizeof(suri->pcap_dev));
1281  PcapTranslateIPToDevice(suri->pcap_dev, sizeof(suri->pcap_dev));
1282  }
1283 
1284  if (strcmp(suri->pcap_dev, in_arg) != 0) {
1285  SCLogInfo("translated %s to pcap device %s", in_arg, suri->pcap_dev);
1286  } else if (strlen(suri->pcap_dev) > 0 && isdigit((unsigned char)suri->pcap_dev[0])) {
1287  SCLogError("failed to find a pcap device for IP %s", in_arg);
1288  return TM_ECODE_FAILED;
1289  }
1290  }
1291 
1292  if (suri->run_mode == RUNMODE_UNKNOWN) {
1293  suri->run_mode = RUNMODE_PCAP_DEV;
1294  if (in_arg) {
1296  }
1297  } else if (suri->run_mode == RUNMODE_PCAP_DEV) {
1299  } else {
1300  SCLogError("more than one run mode "
1301  "has been specified");
1302  PrintUsage(suri->progname);
1303  return TM_ECODE_FAILED;
1304  }
1305  return TM_ECODE_OK;
1306 }
1307 
1308 /**
1309  * Helper function to check if log directory is writable
1310  */
1311 static bool IsLogDirectoryWritable(const char* str)
1312 {
1313  if (access(str, W_OK) == 0)
1314  return true;
1315  return false;
1316 }
1317 
1318 extern int g_skip_prefilter;
1319 
1320 TmEcode SCParseCommandLine(int argc, char **argv)
1321 {
1322  SCInstance *suri = &suricata;
1323  int opt;
1324 
1325  int dump_config = 0;
1326  int dump_features = 0;
1327  int list_app_layer_protocols = 0;
1328  int list_unittests = 0;
1329  int list_runmodes = 0;
1330  int list_keywords = 0;
1331  int build_info = 0;
1332  int conf_test = 0;
1333  int engine_analysis = 0;
1334  int ret = TM_ECODE_OK;
1335 
1336 #ifdef UNITTESTS
1337  coverage_unittests = 0;
1338  g_ut_modules = 0;
1339  g_ut_covered = 0;
1340 #endif
1341 
1342  // clang-format off
1343  struct option long_opts[] = {
1344  {"dump-config", 0, &dump_config, 1},
1345  {"dump-features", 0, &dump_features, 1},
1346  {"pfring", optional_argument, 0, 0},
1347  {"pfring-int", required_argument, 0, 0},
1348  {"pfring-cluster-id", required_argument, 0, 0},
1349  {"pfring-cluster-type", required_argument, 0, 0},
1350 #ifdef HAVE_DPDK
1351  {"dpdk", 0, 0, 0},
1352 #endif
1353  {"af-packet", optional_argument, 0, 0},
1354  {"af-xdp", optional_argument, 0, 0},
1355  {"netmap", optional_argument, 0, 0},
1356  {"pcap", optional_argument, 0, 0},
1357  {"pcap-file-continuous", 0, 0, 0},
1358  {"pcap-file-delete", 0, 0, 0},
1359  {"pcap-file-recursive", 0, 0, 0},
1360  {"pcap-file-buffer-size", required_argument, 0, 0},
1361  {"simulate-ips", 0, 0 , 0},
1362  {"no-random", 0, &g_disable_randomness, 1},
1363  {"strict-rule-keywords", optional_argument, 0, 0},
1364 
1365  {"capture-plugin", required_argument, 0, 0},
1366  {"capture-plugin-args", required_argument, 0, 0},
1367 
1368 #ifdef BUILD_UNIX_SOCKET
1369  {"unix-socket", optional_argument, 0, 0},
1370 #endif
1371  {"pcap-buffer-size", required_argument, 0, 0},
1372  {"unittest-filter", required_argument, 0, 'U'},
1373  {"list-app-layer-protos", 0, &list_app_layer_protocols, 1},
1374  {"list-unittests", 0, &list_unittests, 1},
1375  {"list-runmodes", 0, &list_runmodes, 1},
1376  {"list-keywords", optional_argument, &list_keywords, 1},
1377  {"runmode", required_argument, NULL, 0},
1378  {"engine-analysis", 0, &engine_analysis, 1},
1379 #ifdef OS_WIN32
1380  {"service-install", 0, 0, 0},
1381  {"service-remove", 0, 0, 0},
1382  {"service-change-params", 0, 0, 0},
1383 #endif /* OS_WIN32 */
1384  {"pidfile", required_argument, 0, 0},
1385  {"init-errors-fatal", 0, 0, 0},
1386  {"disable-detection", 0, 0, 0},
1387  {"disable-hashing", 0, 0, 0},
1388  {"fatal-unittests", 0, 0, 0},
1389  {"unittests-coverage", 0, &coverage_unittests, 1},
1390  {"user", required_argument, 0, 0},
1391  {"group", required_argument, 0, 0},
1392  {"erf-in", required_argument, 0, 0},
1393  {"dag", required_argument, 0, 0},
1394  {"build-info", 0, &build_info, 1},
1395  {"data-dir", required_argument, 0, 0},
1396 #ifdef WINDIVERT
1397  {"windivert", required_argument, 0, 0},
1398  {"windivert-forward", required_argument, 0, 0},
1399 #endif
1400 #ifdef HAVE_LIBNET11
1401  {"reject-dev", required_argument, 0, 0},
1402 #endif
1403  {"set", required_argument, 0, 0},
1404 #ifdef HAVE_NFLOG
1405  {"nflog", optional_argument, 0, 0},
1406 #endif
1407  {"simulate-packet-flow-memcap", required_argument, 0, 0},
1408  {"simulate-applayer-error-at-offset-ts", required_argument, 0, 0},
1409  {"simulate-applayer-error-at-offset-tc", required_argument, 0, 0},
1410  {"simulate-packet-loss", required_argument, 0, 0},
1411  {"simulate-packet-tcp-reassembly-memcap", required_argument, 0, 0},
1412  {"simulate-packet-tcp-ssn-memcap", required_argument, 0, 0},
1413  {"simulate-packet-defrag-memcap", required_argument, 0, 0},
1414  {"simulate-alert-queue-realloc-failure", 0, 0, 0},
1415 
1416  {"qa-skip-prefilter", 0, &g_skip_prefilter, 1 },
1417 
1418  {"firewall-rules-exclusive", required_argument, 0, 0},
1419 
1420  {"include", required_argument, 0, 0},
1421 
1422  {NULL, 0, NULL, 0}
1423  };
1424  // clang-format on
1425 
1426  /* getopt_long stores the option index here. */
1427  int option_index = 0;
1428 
1429  char short_opts[] = "c:TDhi:l:q:d:r:us:S:U:VF:vk:";
1430 
1431  while ((opt = getopt_long(argc, argv, short_opts, long_opts, &option_index)) != -1) {
1432  switch (opt) {
1433  case 0:
1434  if (strcmp((long_opts[option_index]).name , "pfring") == 0 ||
1435  strcmp((long_opts[option_index]).name , "pfring-int") == 0) {
1436 #ifdef HAVE_PFRING
1437  /* TODO: Which plugin? */
1438  suri->run_mode = RUNMODE_PLUGIN;
1439  suri->capture_plugin_name = "pfring";
1440  if (optarg != NULL) {
1441  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1442  strlcpy(suri->pcap_dev, optarg,
1443  ((strlen(optarg) < sizeof(suri->pcap_dev)) ?
1444  (strlen(optarg) + 1) : sizeof(suri->pcap_dev)));
1445  LiveRegisterDeviceName(optarg);
1446  }
1447 #else
1448  SCLogError("PF_RING not enabled. Make sure "
1449  "to pass --enable-pfring to configure when building.");
1450  return TM_ECODE_FAILED;
1451 #endif /* HAVE_PFRING */
1452  }
1453  else if(strcmp((long_opts[option_index]).name , "pfring-cluster-id") == 0){
1454 #ifdef HAVE_PFRING
1455  if (SCConfSetFinal("pfring.cluster-id", optarg) != 1) {
1456  SCLogError("failed to set pfring.cluster-id");
1457  return TM_ECODE_FAILED;
1458  }
1459 #else
1460  SCLogError("PF_RING not enabled. Make sure "
1461  "to pass --enable-pfring to configure when building.");
1462  return TM_ECODE_FAILED;
1463 #endif /* HAVE_PFRING */
1464  }
1465  else if(strcmp((long_opts[option_index]).name , "pfring-cluster-type") == 0){
1466 #ifdef HAVE_PFRING
1467  if (SCConfSetFinal("pfring.cluster-type", optarg) != 1) {
1468  SCLogError("failed to set pfring.cluster-type");
1469  return TM_ECODE_FAILED;
1470  }
1471 #else
1472  SCLogError("PF_RING not enabled. Make sure "
1473  "to pass --enable-pfring to configure when building.");
1474  return TM_ECODE_FAILED;
1475 #endif /* HAVE_PFRING */
1476  }
1477  else if (strcmp((long_opts[option_index]).name , "capture-plugin") == 0){
1478  suri->run_mode = RUNMODE_PLUGIN;
1479  suri->capture_plugin_name = optarg;
1480  }
1481  else if (strcmp((long_opts[option_index]).name , "capture-plugin-args") == 0){
1482  suri->capture_plugin_args = optarg;
1483  } else if (strcmp((long_opts[option_index]).name, "dpdk") == 0) {
1484  if (ParseCommandLineDpdk(suri, optarg) != TM_ECODE_OK) {
1485  return TM_ECODE_FAILED;
1486  }
1487  } else if (strcmp((long_opts[option_index]).name, "af-packet") == 0) {
1488  if (ParseCommandLineAfpacket(suri, optarg) != TM_ECODE_OK) {
1489  return TM_ECODE_FAILED;
1490  }
1491  } else if (strcmp((long_opts[option_index]).name, "af-xdp") == 0) {
1492  if (ParseCommandLineAfxdp(suri, optarg) != TM_ECODE_OK) {
1493  return TM_ECODE_FAILED;
1494  }
1495  } else if (strcmp((long_opts[option_index]).name, "netmap") == 0) {
1496 #ifdef HAVE_NETMAP
1497  if (suri->run_mode == RUNMODE_UNKNOWN) {
1498  suri->run_mode = RUNMODE_NETMAP;
1499  if (optarg) {
1500  LiveRegisterDeviceName(optarg);
1501  memset(suri->pcap_dev, 0, sizeof(suri->pcap_dev));
1502  strlcpy(suri->pcap_dev, optarg,
1503  ((strlen(optarg) < sizeof(suri->pcap_dev)) ?
1504  (strlen(optarg) + 1) : sizeof(suri->pcap_dev)));
1505  }
1506  } else if (suri->run_mode == RUNMODE_NETMAP) {
1507  if (optarg) {
1508  LiveRegisterDeviceName(optarg);
1509  } else {
1510  SCLogInfo("Multiple netmap option without interface on each is useless");
1511  break;
1512  }
1513  } else {
1514  SCLogError("more than one run mode "
1515  "has been specified");
1516  PrintUsage(argv[0]);
1517  return TM_ECODE_FAILED;
1518  }
1519 #else
1520  SCLogError("NETMAP not enabled.");
1521  return TM_ECODE_FAILED;
1522 #endif
1523  } else if (strcmp((long_opts[option_index]).name, "nflog") == 0) {
1524 #ifdef HAVE_NFLOG
1525  if (suri->run_mode == RUNMODE_UNKNOWN) {
1526  suri->run_mode = RUNMODE_NFLOG;
1527  LiveBuildDeviceListCustom("nflog", "group");
1528  }
1529 #else
1530  SCLogError("NFLOG not enabled.");
1531  return TM_ECODE_FAILED;
1532 #endif /* HAVE_NFLOG */
1533  } else if (strcmp((long_opts[option_index]).name, "pcap") == 0) {
1534  if (ParseCommandLinePcapLive(suri, optarg) != TM_ECODE_OK) {
1535  return TM_ECODE_FAILED;
1536  }
1537  } else if (strcmp((long_opts[option_index]).name, "simulate-ips") == 0) {
1538  SCLogInfo("Setting IPS mode");
1539  EngineModeSetIPS();
1540  } else if (strcmp((long_opts[option_index]).name, "init-errors-fatal") == 0) {
1541  if (SCConfSetFinal("engine.init-failure-fatal", "1") != 1) {
1542  SCLogError("failed to set engine init-failure-fatal");
1543  return TM_ECODE_FAILED;
1544  }
1545 #ifdef BUILD_UNIX_SOCKET
1546  } else if (strcmp((long_opts[option_index]).name , "unix-socket") == 0) {
1547  if (suri->run_mode == RUNMODE_UNKNOWN) {
1548  suri->run_mode = RUNMODE_UNIX_SOCKET;
1549  if (optarg) {
1550  if (SCConfSetFinal("unix-command.filename", optarg) != 1) {
1551  SCLogError("failed to set unix-command.filename");
1552  return TM_ECODE_FAILED;
1553  }
1554  }
1555  } else {
1556  SCLogError("more than one run mode "
1557  "has been specified");
1558  PrintUsage(argv[0]);
1559  return TM_ECODE_FAILED;
1560  }
1561 #endif
1562  }
1563  else if(strcmp((long_opts[option_index]).name, "list-app-layer-protocols") == 0) {
1564  /* listing all supported app layer protocols */
1565  }
1566  else if(strcmp((long_opts[option_index]).name, "list-unittests") == 0) {
1567 #ifdef UNITTESTS
1569 #else
1570  SCLogError("unit tests not enabled. Make sure to pass --enable-unittests to "
1571  "configure when building");
1572  return TM_ECODE_FAILED;
1573 #endif /* UNITTESTS */
1574  } else if (strcmp((long_opts[option_index]).name, "list-runmodes") == 0) {
1576  return TM_ECODE_OK;
1577  } else if (strcmp((long_opts[option_index]).name, "list-keywords") == 0) {
1578  if (optarg) {
1579  if (strcmp("short", optarg) != 0) {
1580  suri->keyword_info = optarg;
1581  }
1582  }
1583  } else if (strcmp((long_opts[option_index]).name, "runmode") == 0) {
1584  suri->runmode_custom_mode = optarg;
1585  } else if(strcmp((long_opts[option_index]).name, "engine-analysis") == 0) {
1586  // do nothing for now
1587  }
1588 #ifdef OS_WIN32
1589  else if(strcmp((long_opts[option_index]).name, "service-install") == 0) {
1590  suri->run_mode = RUNMODE_INSTALL_SERVICE;
1591  return TM_ECODE_OK;
1592  }
1593  else if(strcmp((long_opts[option_index]).name, "service-remove") == 0) {
1594  suri->run_mode = RUNMODE_REMOVE_SERVICE;
1595  return TM_ECODE_OK;
1596  }
1597  else if(strcmp((long_opts[option_index]).name, "service-change-params") == 0) {
1598  suri->run_mode = RUNMODE_CHANGE_SERVICE_PARAMS;
1599  return TM_ECODE_OK;
1600  }
1601 #endif /* OS_WIN32 */
1602  else if(strcmp((long_opts[option_index]).name, "pidfile") == 0) {
1603  suri->pid_filename = SCStrdup(optarg);
1604  if (suri->pid_filename == NULL) {
1605  SCLogError("strdup failed: %s", strerror(errno));
1606  return TM_ECODE_FAILED;
1607  }
1608  }
1609  else if(strcmp((long_opts[option_index]).name, "disable-detection") == 0) {
1610  g_detect_disabled = suri->disabled_detect = 1;
1611  } else if (strcmp((long_opts[option_index]).name, "disable-hashing") == 0) {
1612  g_disable_hashing = true;
1613  // for rust
1614  SCDisableHashing();
1615  } else if (strcmp((long_opts[option_index]).name, "fatal-unittests") == 0) {
1616 #ifdef UNITTESTS
1617  unittests_fatal = 1;
1618 #else
1619  SCLogError("unit tests not enabled. Make sure to pass --enable-unittests to "
1620  "configure when building");
1621  return TM_ECODE_FAILED;
1622 #endif /* UNITTESTS */
1623  } else if (strcmp((long_opts[option_index]).name, "user") == 0) {
1624 #ifndef HAVE_LIBCAP_NG
1625  SCLogError("libcap-ng is required to"
1626  " drop privileges, but it was not compiled into Suricata.");
1627  return TM_ECODE_FAILED;
1628 #else
1629  suri->user_name = optarg;
1630  suri->do_setuid = true;
1631 #endif /* HAVE_LIBCAP_NG */
1632  } else if (strcmp((long_opts[option_index]).name, "group") == 0) {
1633 #ifndef HAVE_LIBCAP_NG
1634  SCLogError("libcap-ng is required to"
1635  " drop privileges, but it was not compiled into Suricata.");
1636  return TM_ECODE_FAILED;
1637 #else
1638  suri->group_name = optarg;
1639  suri->do_setgid = true;
1640 #endif /* HAVE_LIBCAP_NG */
1641  } else if (strcmp((long_opts[option_index]).name, "erf-in") == 0) {
1642  suri->run_mode = RUNMODE_ERF_FILE;
1643  if (SCConfSetFinal("erf-file.file", optarg) != 1) {
1644  SCLogError("failed to set erf-file.file");
1645  return TM_ECODE_FAILED;
1646  }
1647  } else if (strcmp((long_opts[option_index]).name, "dag") == 0) {
1648 #ifdef HAVE_DAG
1649  if (suri->run_mode == RUNMODE_UNKNOWN) {
1650  suri->run_mode = RUNMODE_DAG;
1651  }
1652  else if (suri->run_mode != RUNMODE_DAG) {
1653  SCLogError("more than one run mode has been specified");
1654  PrintUsage(argv[0]);
1655  return TM_ECODE_FAILED;
1656  }
1657  LiveRegisterDeviceName(optarg);
1658 #else
1659  SCLogError("libdag and a DAG card are required"
1660  " to receive packets using --dag.");
1661  return TM_ECODE_FAILED;
1662 #endif /* HAVE_DAG */
1663  } else if (strcmp((long_opts[option_index]).name, "napatech") == 0) {
1664 #ifdef HAVE_NAPATECH
1665  suri->run_mode = RUNMODE_PLUGIN;
1666 #else
1667  SCLogError("libntapi and a Napatech adapter are required"
1668  " to capture packets using --napatech.");
1669  return TM_ECODE_FAILED;
1670 #endif /* HAVE_NAPATECH */
1671  } else if (strcmp((long_opts[option_index]).name, "pcap-buffer-size") == 0) {
1672 #ifdef HAVE_PCAP_SET_BUFF
1673  if (SCConfSetFinal("pcap.buffer-size", optarg) != 1) {
1674  SCLogError("failed to set pcap-buffer-size");
1675  return TM_ECODE_FAILED;
1676  }
1677 #else
1678  SCLogError("The version of libpcap you have"
1679  " doesn't support setting buffer size.");
1680 #endif /* HAVE_PCAP_SET_BUFF */
1681  } else if (strcmp((long_opts[option_index]).name, "build-info") == 0) {
1683  return TM_ECODE_OK;
1684  } else if (strcmp((long_opts[option_index]).name, "windivert-forward") == 0) {
1685 #ifdef WINDIVERT
1686  if (suri->run_mode == RUNMODE_UNKNOWN) {
1687  suri->run_mode = RUNMODE_WINDIVERT;
1688  if (WinDivertRegisterQueue(true, optarg) == -1) {
1689  exit(EXIT_FAILURE);
1690  }
1691  } else if (suri->run_mode == RUNMODE_WINDIVERT) {
1692  if (WinDivertRegisterQueue(true, optarg) == -1) {
1693  exit(EXIT_FAILURE);
1694  }
1695  } else {
1696  SCLogError("more than one run mode "
1697  "has been specified");
1698  PrintUsage(argv[0]);
1699  exit(EXIT_FAILURE);
1700  }
1701  }
1702  else if(strcmp((long_opts[option_index]).name, "windivert") == 0) {
1703  if (suri->run_mode == RUNMODE_UNKNOWN) {
1704  suri->run_mode = RUNMODE_WINDIVERT;
1705  if (WinDivertRegisterQueue(false, optarg) == -1) {
1706  exit(EXIT_FAILURE);
1707  }
1708  } else if (suri->run_mode == RUNMODE_WINDIVERT) {
1709  if (WinDivertRegisterQueue(false, optarg) == -1) {
1710  exit(EXIT_FAILURE);
1711  }
1712  } else {
1713  SCLogError("more than one run mode "
1714  "has been specified");
1715  PrintUsage(argv[0]);
1716  exit(EXIT_FAILURE);
1717  }
1718 #else
1719  SCLogError("WinDivert not enabled. Make sure to pass --enable-windivert to "
1720  "configure when building.");
1721  return TM_ECODE_FAILED;
1722 #endif /* WINDIVERT */
1723  } else if(strcmp((long_opts[option_index]).name, "reject-dev") == 0) {
1724 #ifdef HAVE_LIBNET11
1725  BUG_ON(optarg == NULL); /* for static analysis */
1726  extern char *g_reject_dev;
1727  extern uint16_t g_reject_dev_mtu;
1728  g_reject_dev = optarg;
1729  int mtu = GetIfaceMTU(g_reject_dev);
1730  if (mtu > 0) {
1731  g_reject_dev_mtu = (uint16_t)mtu;
1732  }
1733 #else
1734  SCLogError("Libnet 1.1 support not enabled. Compile Suricata with libnet support.");
1735  return TM_ECODE_FAILED;
1736 #endif
1737  }
1738  else if (strcmp((long_opts[option_index]).name, "set") == 0) {
1739  if (optarg != NULL) {
1740  /* Quick validation. */
1741  char *val = strchr(optarg, '=');
1742  if (val == NULL) {
1743  FatalError("Invalid argument for --set, must be key=val.");
1744  }
1745  if (!SCConfSetFromString(optarg, 1)) {
1746  FatalError("failed to set configuration value %s", optarg);
1747  }
1748  }
1749  }
1750  else if (strcmp((long_opts[option_index]).name, "pcap-file-continuous") == 0) {
1751  if (SCConfSetFinal("pcap-file.continuous", "true") != 1) {
1752  SCLogError("Failed to set pcap-file.continuous");
1753  return TM_ECODE_FAILED;
1754  }
1755  }
1756  else if (strcmp((long_opts[option_index]).name, "pcap-file-delete") == 0) {
1757  if (SCConfSetFinal("pcap-file.delete-when-done", "true") != 1) {
1758  SCLogError("Failed to set pcap-file.delete-when-done");
1759  return TM_ECODE_FAILED;
1760  }
1761  }
1762  else if (strcmp((long_opts[option_index]).name, "pcap-file-recursive") == 0) {
1763  if (SCConfSetFinal("pcap-file.recursive", "true") != 1) {
1764  SCLogError("failed to set pcap-file.recursive");
1765  return TM_ECODE_FAILED;
1766  }
1767  } else if (strcmp((long_opts[option_index]).name, "pcap-file-buffer-size") == 0) {
1768  if (SCConfSetFinal("pcap-file.buffer-size", optarg) != 1) {
1769  SCLogError("failed to set pcap-file.buffer-size");
1770  return TM_ECODE_FAILED;
1771  }
1772  } else if (strcmp((long_opts[option_index]).name, "data-dir") == 0) {
1773  if (optarg == NULL) {
1774  SCLogError("no option argument (optarg) for -d");
1775  return TM_ECODE_FAILED;
1776  }
1777 
1778  if (ConfigSetDataDirectory(optarg) != TM_ECODE_OK) {
1779  SCLogError("Failed to set data directory.");
1780  return TM_ECODE_FAILED;
1781  }
1782  if (ConfigCheckDataDirectory(optarg) != TM_ECODE_OK) {
1783  SCLogError("The data directory \"%s\""
1784  " supplied at the command-line (-d %s) doesn't "
1785  "exist. Shutting down the engine.",
1786  optarg, optarg);
1787  return TM_ECODE_FAILED;
1788  }
1789  suri->set_datadir = true;
1790  } else if (strcmp((long_opts[option_index]).name, "strict-rule-keywords") == 0) {
1791  if (optarg == NULL) {
1792  suri->strict_rule_parsing_string = SCStrdup("all");
1793  } else {
1794  suri->strict_rule_parsing_string = SCStrdup(optarg);
1795  }
1796  if (suri->strict_rule_parsing_string == NULL) {
1797  FatalError("failed to duplicate 'strict' string");
1798  }
1799  } else if (strcmp((long_opts[option_index]).name, "include") == 0) {
1800  if (suri->additional_configs == NULL) {
1801  suri->additional_configs = SCCalloc(2, sizeof(char *));
1802  if (suri->additional_configs == NULL) {
1803  FatalError(
1804  "Failed to allocate memory for additional configuration files: %s",
1805  strerror(errno));
1806  }
1807  suri->additional_configs[0] = optarg;
1808  } else {
1809  for (int i = 0;; i++) {
1810  if (suri->additional_configs[i] == NULL) {
1811  const char **additional_configs =
1812  SCRealloc(suri->additional_configs, (i + 2) * sizeof(char *));
1813  if (additional_configs == NULL) {
1814  FatalError("Failed to allocate memory for additional configuration "
1815  "files: %s",
1816  strerror(errno));
1817  } else {
1818  suri->additional_configs = additional_configs;
1819  }
1820  suri->additional_configs[i] = optarg;
1821  suri->additional_configs[i + 1] = NULL;
1822  break;
1823  }
1824  }
1825  }
1826  } else if (strcmp((long_opts[option_index]).name, "firewall-rules-exclusive") == 0) {
1827  if (suri->firewall_rule_file != NULL) {
1828  SCLogError("can't have multiple --firewall-rules-exclusive options");
1829  return TM_ECODE_FAILED;
1830  }
1831  suri->firewall_rule_file = optarg;
1832  suri->firewall_rule_file_exclusive = true;
1833  } else {
1835  (long_opts[option_index]).name, optarg);
1836  if (r < 0)
1837  return TM_ECODE_FAILED;
1838  }
1839  break;
1840  case 'c':
1841  suri->conf_filename = optarg;
1842  break;
1843  case 'T':
1844  conf_test = 1;
1845  if (SCConfSetFinal("engine.init-failure-fatal", "1") != 1) {
1846  SCLogError("failed to set engine init-failure-fatal");
1847  return TM_ECODE_FAILED;
1848  }
1849  break;
1850 #ifndef OS_WIN32
1851  case 'D':
1852  suri->daemon = 1;
1853  break;
1854 #endif /* OS_WIN32 */
1855  case 'h':
1856  suri->run_mode = RUNMODE_PRINT_USAGE;
1857  return TM_ECODE_OK;
1858  case 'i':
1859  if (optarg == NULL) {
1860  SCLogError("no option argument (optarg) for -i");
1861  return TM_ECODE_FAILED;
1862  }
1863 #ifdef HAVE_AF_PACKET
1864  if (ParseCommandLineAfpacket(suri, optarg) != TM_ECODE_OK) {
1865  return TM_ECODE_FAILED;
1866  }
1867 #else /* not afpacket */
1868  /* warn user if netmap is available */
1869 #if defined HAVE_NETMAP
1870  int i = 0;
1871 #ifdef HAVE_NETMAP
1872  i++;
1873 #endif
1874  SCLogWarning("faster capture "
1875  "option%s %s available:"
1876 #ifdef HAVE_NETMAP
1877  " NETMAP (--netmap=%s)"
1878 #endif
1879  ". Use --pcap=%s to suppress this warning",
1880  i == 1 ? "" : "s", i == 1 ? "is" : "are"
1881 #ifdef HAVE_NETMAP
1882  ,
1883  optarg
1884 #endif
1885  ,
1886  optarg);
1887 #endif /* have faster methods */
1888  if (ParseCommandLinePcapLive(suri, optarg) != TM_ECODE_OK) {
1889  return TM_ECODE_FAILED;
1890  }
1891 #endif
1892  break;
1893  case 'l':
1894  if (optarg == NULL) {
1895  SCLogError("no option argument (optarg) for -l");
1896  return TM_ECODE_FAILED;
1897  }
1898 
1899  if (ConfigSetLogDirectory(optarg) != TM_ECODE_OK) {
1900  SCLogError("Failed to set log directory.");
1901  return TM_ECODE_FAILED;
1902  }
1903  if (ConfigCheckLogDirectoryExists(optarg) != TM_ECODE_OK) {
1904  SCLogError("The logging directory \"%s\""
1905  " supplied at the command-line (-l %s) doesn't "
1906  "exist. Shutting down the engine.",
1907  optarg, optarg);
1908  return TM_ECODE_FAILED;
1909  }
1910  if (!IsLogDirectoryWritable(optarg)) {
1911  SCLogError("The logging directory \"%s\""
1912  " supplied at the command-line (-l %s) is not "
1913  "writable. Shutting down the engine.",
1914  optarg, optarg);
1915  return TM_ECODE_FAILED;
1916  }
1917  suri->set_logdir = true;
1918 
1919  break;
1920  case 'q':
1921 #ifdef NFQ
1922  if (suri->run_mode == RUNMODE_UNKNOWN) {
1923  suri->run_mode = RUNMODE_NFQ;
1924  EngineModeSetIPS();
1925  if (NFQParseAndRegisterQueues(optarg) == -1)
1926  return TM_ECODE_FAILED;
1927  } else if (suri->run_mode == RUNMODE_NFQ) {
1928  if (NFQParseAndRegisterQueues(optarg) == -1)
1929  return TM_ECODE_FAILED;
1930  } else {
1931  SCLogError("more than one run mode "
1932  "has been specified");
1933  PrintUsage(argv[0]);
1934  return TM_ECODE_FAILED;
1935  }
1936 #else
1937  SCLogError("NFQUEUE not enabled. Make sure to pass --enable-nfqueue to configure when "
1938  "building.");
1939  return TM_ECODE_FAILED;
1940 #endif /* NFQ */
1941  break;
1942  case 'd':
1943 #ifdef IPFW
1944  if (suri->run_mode == RUNMODE_UNKNOWN) {
1945  suri->run_mode = RUNMODE_IPFW;
1946  EngineModeSetIPS();
1947  if (IPFWRegisterQueue(optarg) == -1)
1948  return TM_ECODE_FAILED;
1949  } else if (suri->run_mode == RUNMODE_IPFW) {
1950  if (IPFWRegisterQueue(optarg) == -1)
1951  return TM_ECODE_FAILED;
1952  } else {
1953  SCLogError("more than one run mode "
1954  "has been specified");
1955  PrintUsage(argv[0]);
1956  return TM_ECODE_FAILED;
1957  }
1958 #else
1959  SCLogError("IPFW not enabled. Make sure to pass --enable-ipfw to configure when "
1960  "building.");
1961  return TM_ECODE_FAILED;
1962 #endif /* IPFW */
1963  break;
1964  case 'r':
1965  BUG_ON(optarg == NULL); /* for static analysis */
1966  if (suri->run_mode == RUNMODE_UNKNOWN) {
1967  suri->run_mode = RUNMODE_PCAP_FILE;
1968  } else {
1969  SCLogError("more than one run mode "
1970  "has been specified");
1971  PrintUsage(argv[0]);
1972  return TM_ECODE_FAILED;
1973  }
1974  SCStat buf;
1975  if (SCStatFn(optarg, &buf) != 0) {
1976  SCLogError("pcap file '%s': %s", optarg, strerror(errno));
1977  return TM_ECODE_FAILED;
1978  }
1979  if (SCConfSetFinal("pcap-file.file", optarg) != 1) {
1980  SCLogError("ERROR: Failed to set pcap-file.file\n");
1981  return TM_ECODE_FAILED;
1982  }
1983 
1984  break;
1985  case 's':
1986  if (suri->sig_file != NULL) {
1987  SCLogError("can't have multiple -s options or mix -s and -S.");
1988  return TM_ECODE_FAILED;
1989  }
1990  suri->sig_file = optarg;
1991  break;
1992  case 'S':
1993  if (suri->sig_file != NULL) {
1994  SCLogError("can't have multiple -S options or mix -s and -S.");
1995  return TM_ECODE_FAILED;
1996  }
1997  suri->sig_file = optarg;
1998  suri->sig_file_exclusive = true;
1999  break;
2000  case 'u':
2001 #ifdef UNITTESTS
2002  if (suri->run_mode == RUNMODE_UNKNOWN) {
2003  suri->run_mode = RUNMODE_UNITTEST;
2004  } else {
2005  SCLogError("more than one run mode has"
2006  " been specified");
2007  PrintUsage(argv[0]);
2008  return TM_ECODE_FAILED;
2009  }
2010 #else
2011  SCLogError("unit tests not enabled. Make sure to pass --enable-unittests to configure "
2012  "when building.");
2013  return TM_ECODE_FAILED;
2014 #endif /* UNITTESTS */
2015  break;
2016  case 'U':
2017 #ifdef UNITTESTS
2018  suri->regex_arg = optarg;
2019 
2020  if(strlen(suri->regex_arg) == 0)
2021  suri->regex_arg = NULL;
2022 #endif
2023  break;
2024  case 'V':
2026  return TM_ECODE_OK;
2027  case 'F':
2028  if (optarg == NULL) {
2029  SCLogError("no option argument (optarg) for -F");
2030  return TM_ECODE_FAILED;
2031  }
2032 
2033  SetBpfStringFromFile(optarg);
2034  break;
2035  case 'v':
2036  suri->verbose++;
2037  break;
2038  case 'k':
2039  if (optarg == NULL) {
2040  SCLogError("no option argument (optarg) for -k");
2041  return TM_ECODE_FAILED;
2042  }
2043  if (!strcmp("all", optarg))
2044  suri->checksum_validation = 1;
2045  else if (!strcmp("none", optarg))
2046  suri->checksum_validation = 0;
2047  else {
2048  SCLogError("option '%s' invalid for -k", optarg);
2049  return TM_ECODE_FAILED;
2050  }
2051  break;
2052  default:
2053  PrintUsage(argv[0]);
2054  return TM_ECODE_FAILED;
2055  }
2056  }
2057 
2058  if (suri->disabled_detect && (suri->sig_file != NULL || suri->firewall_rule_file != NULL)) {
2059  SCLogError("can't use -s/-S or --firewall-rules-exclusive when detection is disabled");
2060  return TM_ECODE_FAILED;
2061  }
2062 
2063  /* save the runmode from the command-line (if any) */
2064  suri->aux_run_mode = suri->run_mode;
2065 
2066  if (list_app_layer_protocols)
2068  if (list_keywords)
2070  if (list_unittests)
2072  if (dump_config)
2073  suri->run_mode = RUNMODE_DUMP_CONFIG;
2074  if (dump_features)
2076  if (conf_test)
2077  suri->run_mode = RUNMODE_CONF_TEST;
2078  if (engine_analysis)
2080 
2081  suri->offline = IsRunModeOffline(suri->run_mode);
2082  g_system = suri->system = IsRunModeSystem(suri->run_mode);
2083 
2084  ret = SetBpfString(optind, argv);
2085  if (ret != TM_ECODE_OK)
2086  return ret;
2087 
2088  return TM_ECODE_OK;
2089 }
2090 
2091 #ifdef OS_WIN32
2092 int WindowsInitService(int argc, char **argv)
2093 {
2094  if (SCRunningAsService()) {
2095  char path[MAX_PATH];
2096  char *p = NULL;
2097  strlcpy(path, argv[0], MAX_PATH);
2098  if ((p = strrchr(path, '\\'))) {
2099  *p = '\0';
2100  }
2101  if (!SetCurrentDirectory(path)) {
2102  SCLogError("Can't set current directory to: %s", path);
2103  return -1;
2104  }
2105  SCLogInfo("Current directory is set to: %s", path);
2106  SCServiceInit(argc, argv);
2107  }
2108 
2109  /* Windows socket subsystem initialization */
2110  WSADATA wsaData;
2111  if (0 != WSAStartup(MAKEWORD(2, 2), &wsaData)) {
2112  SCLogError("Can't initialize Windows sockets: %d", WSAGetLastError());
2113  return -1;
2114  }
2115 
2116  return 0;
2117 }
2118 #endif /* OS_WIN32 */
2119 
2120 static int MayDaemonize(SCInstance *suri)
2121 {
2122  if (suri->daemon == 1 && suri->pid_filename == NULL) {
2123  const char *pid_filename;
2124 
2125  if (SCConfGet("pid-file", &pid_filename) == 1) {
2126  SCLogInfo("Use pid file %s from config file.", pid_filename);
2127  } else {
2128  pid_filename = DEFAULT_PID_FILENAME;
2129  }
2130  /* The pid file name may be in config memory, but is needed later. */
2131  suri->pid_filename = SCStrdup(pid_filename);
2132  if (suri->pid_filename == NULL) {
2133  SCLogError("strdup failed: %s", strerror(errno));
2134  return TM_ECODE_FAILED;
2135  }
2136  }
2137 
2138  if (suri->pid_filename != NULL && SCPidfileTestRunning(suri->pid_filename) != 0) {
2139  SCFree(suri->pid_filename);
2140  suri->pid_filename = NULL;
2141  return TM_ECODE_FAILED;
2142  }
2143 
2144  if (suri->daemon == 1) {
2145  Daemonize();
2146  }
2147 
2148  if (suri->pid_filename != NULL) {
2149  if (SCPidfileCreate(suri->pid_filename) != 0) {
2150  SCFree(suri->pid_filename);
2151  suri->pid_filename = NULL;
2152  SCLogError("Unable to create PID file, concurrent run of"
2153  " Suricata can occur.");
2154  SCLogError("PID file creation WILL be mandatory for daemon mode"
2155  " in future version");
2156  }
2157  }
2158 
2159  return TM_ECODE_OK;
2160 }
2161 
2162 /* Initialize the user and group Suricata is to run as. */
2163 static int InitRunAs(SCInstance *suri)
2164 {
2165 #ifndef OS_WIN32
2166  /* Try to get user/group to run suricata as if
2167  command line as not decide of that */
2168  if (!suri->do_setuid && !suri->do_setgid) {
2169  const char *id;
2170  if (SCConfGet("run-as.user", &id) == 1) {
2171  suri->do_setuid = true;
2172  suri->user_name = id;
2173  }
2174  if (SCConfGet("run-as.group", &id) == 1) {
2175  suri->do_setgid = true;
2176  suri->group_name = id;
2177  }
2178  }
2179  /* Get the suricata user ID to given user ID */
2180  if (suri->do_setuid) {
2181  SCGetUserID(suri->user_name, suri->group_name, &suri->userid, &suri->groupid);
2182  sc_set_caps = true;
2183  /* Get the suricata group ID to given group ID */
2184  } else if (suri->do_setgid) {
2185  SCGetGroupID(suri->group_name, &suri->groupid);
2186  sc_set_caps = true;
2187  }
2188 #endif
2189  return TM_ECODE_OK;
2190 }
2191 
2192 static int InitSignalHandler(SCInstance *suri)
2193 {
2194  /* registering signals we use */
2195 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
2196  UtilSignalHandlerSetup(SIGINT, SignalHandlerSigint);
2197  UtilSignalHandlerSetup(SIGTERM, SignalHandlerSigterm);
2198 #if HAVE_LIBUNWIND
2199  int enabled;
2200  if (SCConfGetBool("logging.stacktrace-on-signal", &enabled) == 0) {
2201  enabled = 1;
2202  }
2203 
2204  if (enabled) {
2205  SCLogInfo("Preparing unexpected signal handling");
2206  struct sigaction stacktrace_action;
2207  memset(&stacktrace_action, 0, sizeof(stacktrace_action));
2208  stacktrace_action.sa_sigaction = SignalHandlerUnexpected;
2209  stacktrace_action.sa_flags = SA_SIGINFO;
2210  sigaction(SIGSEGV, &stacktrace_action, NULL);
2211  sigaction(SIGABRT, &stacktrace_action, NULL);
2212  }
2213 #endif /* HAVE_LIBUNWIND */
2214 #endif
2215 #ifndef OS_WIN32
2216  UtilSignalHandlerSetup(SIGHUP, SignalHandlerSigHup);
2217  UtilSignalHandlerSetup(SIGPIPE, SIG_IGN);
2218  UtilSignalHandlerSetup(SIGSYS, SIG_IGN);
2219 #endif /* OS_WIN32 */
2220 
2221  return TM_ECODE_OK;
2222 }
2223 
2224 /* initialization code for both the main modes and for
2225  * unix socket mode.
2226  *
2227  * Will be run once per pcap in unix-socket mode */
2228 void PreRunInit(const int runmode)
2229 {
2230  if (runmode == RUNMODE_UNIX_SOCKET)
2231  return;
2232 
2233  StatsInit();
2234 #ifdef PROFILE_RULES
2235  SCProfilingRulesGlobalInit();
2236 #endif
2237 #ifdef PROFILING
2241 #endif /* PROFILING */
2242 #ifdef PROFILE_RULES
2243  SCProfilingInit();
2244 #endif
2245  DefragInit();
2253 }
2254 
2255 /* tasks we need to run before packets start flowing,
2256  * but after we dropped privs */
2257 void PreRunPostPrivsDropInit(const int runmode)
2258 {
2259  if (runmode == RUNMODE_UNIX_SOCKET) {
2260  return;
2261  }
2262 
2265  DatasetsInit();
2267 }
2268 
2269 /** \brief clean up / shutdown code for packet modes
2270  *
2271  * Shuts down packet modes, so regular packet runmodes and the
2272  * per pcap mode in the unix socket. */
2273 void PostRunDeinit(const int runmode, struct timeval *start_time)
2274 {
2275  if (runmode == RUNMODE_UNIX_SOCKET)
2276  return;
2277 
2279 
2280  /* needed by FlowWorkToDoCleanup */
2281  PacketPoolInit();
2282 
2283  /* handle graceful shutdown of the flow engine, it's helper
2284  * threads and the packet threads */
2289  SCPrintElapsedTime(start_time);
2291 
2292  /* kill the stats threads */
2295 
2296  /* kill packet threads -- already in 'disabled' state */
2299 
2301 
2302  /* mgt and ppt threads killed, we can run non thread-safe
2303  * shutdown functions */
2306  RunModeShutDown();
2307  FlowShutdown();
2308  IPPairShutdown();
2309  HostCleanup();
2311  DefragDestroy();
2313 
2314  TmqResetQueues();
2315 #ifdef PROFILING
2317  SCProfilingDump();
2319 #endif
2320 }
2321 
2322 int SCStartInternalRunMode(int argc, char **argv)
2323 {
2324  SCInstance *suri = &suricata;
2325  /* Treat internal running mode */
2326  switch (suri->run_mode) {
2327  case RUNMODE_LIST_KEYWORDS:
2328  return ListKeywords(suri->keyword_info);
2330  if (suri->conf_filename != NULL) {
2331  return ListAppLayerProtocols(suri->conf_filename);
2332  } else {
2334  }
2335  case RUNMODE_PRINT_VERSION:
2336  PrintVersion();
2337  return TM_ECODE_DONE;
2339  PrintBuildInfo();
2340  return TM_ECODE_DONE;
2341  case RUNMODE_PRINT_USAGE:
2342  PrintUsage(argv[0]);
2343  return TM_ECODE_DONE;
2344  case RUNMODE_LIST_RUNMODES:
2346  return TM_ECODE_DONE;
2347  case RUNMODE_LIST_UNITTEST:
2348  RunUnittests(1, suri->regex_arg);
2349  case RUNMODE_UNITTEST:
2350  RunUnittests(0, suri->regex_arg);
2351 #ifdef OS_WIN32
2352  case RUNMODE_INSTALL_SERVICE:
2353  if (SCServiceInstall(argc, argv)) {
2354  return TM_ECODE_FAILED;
2355  }
2356  SCLogInfo("Suricata service has been successfully installed.");
2357  return TM_ECODE_DONE;
2358  case RUNMODE_REMOVE_SERVICE:
2359  if (SCServiceRemove()) {
2360  return TM_ECODE_FAILED;
2361  }
2362  SCLogInfo("Suricata service has been successfully removed.");
2363  return TM_ECODE_DONE;
2364  case RUNMODE_CHANGE_SERVICE_PARAMS:
2365  if (SCServiceChangeParams(argc, argv)) {
2366  return TM_ECODE_FAILED;
2367  }
2368  SCLogInfo("Suricata service startup parameters has been successfully changed.");
2369  return TM_ECODE_DONE;
2370 #endif /* OS_WIN32 */
2371  default:
2372  /* simply continue for other running mode */
2373  break;
2374  }
2375  return TM_ECODE_OK;
2376 }
2377 
2379 {
2380  SCInstance *suri = &suricata;
2381  switch (suri->run_mode) {
2382  case RUNMODE_UNKNOWN:
2383  PrintUsage(suri->progname);
2384  return TM_ECODE_FAILED;
2385  default:
2386  break;
2387  }
2388 
2389  if (!CheckValidDaemonModes(suri->daemon, suri->run_mode)) {
2390  return TM_ECODE_FAILED;
2391  }
2392 
2393  return TM_ECODE_OK;
2394 }
2395 
2396 static void SetupDelayedDetect(SCInstance *suri)
2397 {
2398  /* In offline mode delayed init of detect is a bad idea */
2399  if (suri->offline) {
2400  suri->delayed_detect = 0;
2401  } else {
2402  if (SCConfGetBool("detect.delayed-detect", &suri->delayed_detect) != 1) {
2403  SCConfNode *denode = NULL;
2404  SCConfNode *decnf = SCConfGetNode("detect-engine");
2405  if (decnf != NULL) {
2406  TAILQ_FOREACH(denode, &decnf->head, next) {
2407  if (strcmp(denode->val, "delayed-detect") == 0) {
2409  denode, "delayed-detect", &suri->delayed_detect);
2410  }
2411  }
2412  }
2413  }
2414  }
2415 
2416  SCLogConfig("Delayed detect %s", suri->delayed_detect ? "enabled" : "disabled");
2417  if (suri->delayed_detect) {
2418  SCLogInfo("Packets will start being processed before signatures are active.");
2419  }
2420 
2421 }
2422 
2423 static int LoadSignatures(DetectEngineCtx *de_ctx, SCInstance *suri)
2424 {
2426 
2427  if (SigLoadSignatures(de_ctx, suri->sig_file, suri->sig_file_exclusive) < 0) {
2428  SCLogError("Loading signatures failed.");
2429  if (de_ctx->failure_fatal)
2430  return TM_ECODE_FAILED;
2431  }
2432 
2433  return TM_ECODE_OK;
2434 }
2435 
2436 static int ConfigGetCaptureValue(SCInstance *suri)
2437 {
2438  /* Pull the max pending packets from the config, if not found fall
2439  * back on a sane default. */
2440  intmax_t tmp_max_pending_packets;
2441  if (SCConfGetInt("max-pending-packets", &tmp_max_pending_packets) != 1)
2442  tmp_max_pending_packets = DEFAULT_MAX_PENDING_PACKETS;
2443  if (tmp_max_pending_packets < 1 || tmp_max_pending_packets > 2147483648) {
2444  SCLogError("Maximum max-pending-packets setting is 2147483648 and must be greater than 0. "
2445  "Please check %s for errors",
2446  suri->conf_filename);
2447  return TM_ECODE_FAILED;
2448  } else {
2449  max_pending_packets = (uint32_t)tmp_max_pending_packets;
2450  }
2451 
2452  SCLogDebug("Max pending packets set to %" PRIu32, max_pending_packets);
2453 
2454  /* Pull the default packet size from the config, if not found fall
2455  * back on a sane default. */
2456  const char *temp_default_packet_size;
2457  if ((SCConfGet("default-packet-size", &temp_default_packet_size)) != 1) {
2458  int lthread;
2459  int nlive;
2460  int strip_trailing_plus = 0;
2461  switch (suri->run_mode) {
2462  case RUNMODE_AFP_DEV:
2463  /* For AF_PACKET we delay setting the
2464  * default-packet-size until we know more about the
2465  * configuration. */
2466  break;
2467 #ifdef WINDIVERT
2468  case RUNMODE_WINDIVERT: {
2469  /* by default, WinDivert collects from all devices */
2470  const int mtu = GetGlobalMTUWin32();
2471 
2472  if (mtu > 0) {
2473  /* SLL_HEADER_LEN is the longest header + 8 for VLAN */
2474  default_packet_size = mtu + SLL_HEADER_LEN + 8;
2475  break;
2476  }
2478  break;
2479  }
2480 #endif /* WINDIVERT */
2481  case RUNMODE_NETMAP:
2482  /* in netmap igb0+ has a special meaning, however the
2483  * interface really is igb0 */
2484  strip_trailing_plus = 1;
2485  /* fall through */
2486  case RUNMODE_PLUGIN:
2487  case RUNMODE_PCAP_DEV:
2488  case RUNMODE_AFXDP_DEV:
2489  nlive = LiveGetDeviceCount();
2490  for (lthread = 0; lthread < nlive; lthread++) {
2491  const char *live_dev = LiveGetDeviceName(lthread);
2492  char dev[128]; /* need to be able to support GUID names on Windows */
2493  (void)strlcpy(dev, live_dev, sizeof(dev));
2494 
2495  if (strip_trailing_plus) {
2496  size_t len = strlen(dev);
2497  if (len &&
2498  (dev[len-1] == '+' ||
2499  dev[len-1] == '^' ||
2500  dev[len-1] == '*'))
2501  {
2502  dev[len-1] = '\0';
2503  }
2504  }
2505  LiveDevice *ld = LiveGetDevice(dev);
2506  unsigned int iface_max_packet_size = GetIfaceMaxPacketSize(ld);
2507  if (iface_max_packet_size > default_packet_size)
2508  default_packet_size = iface_max_packet_size;
2509  }
2510  if (default_packet_size)
2511  break;
2512  /* fall through */
2513  default:
2515  }
2516  } else {
2517  if (ParseSizeStringU32(temp_default_packet_size, &default_packet_size) < 0) {
2518  SCLogError("Error parsing max-pending-packets "
2519  "from conf file - %s. Killing engine",
2520  temp_default_packet_size);
2521  return TM_ECODE_FAILED;
2522  }
2523  }
2524 
2525  SCLogDebug("Default packet size set to %"PRIu32, default_packet_size);
2526 
2527  return TM_ECODE_OK;
2528 }
2529 
2530 static void PostRunStartedDetectSetup(const SCInstance *suri)
2531 {
2532 #ifndef OS_WIN32
2533  /* registering signal handlers we use. We setup usr2 here, so that one
2534  * can't call it during the first sig load phase or while threads are still
2535  * starting up. */
2536  if (DetectEngineEnabled() && suri->delayed_detect == 0) {
2537  UtilSignalHandlerSetup(SIGUSR2, SignalHandlerSigusr2);
2538  UtilSignalUnblock(SIGUSR2);
2539  }
2540 #endif
2541  if (suri->delayed_detect) {
2542  /* force 'reload', this will load the rules and swap engines */
2543  DetectEngineReload(suri);
2544  SCLogNotice("Signature(s) loaded, Detect thread(s) activated.");
2545 #ifndef OS_WIN32
2546  UtilSignalHandlerSetup(SIGUSR2, SignalHandlerSigusr2);
2547  UtilSignalUnblock(SIGUSR2);
2548 #endif
2549  }
2550 }
2551 
2553 {
2554  DetectEngineCtx *de_ctx = NULL;
2555  if (!suri->disabled_detect) {
2556  SetupDelayedDetect(suri);
2557  int mt_enabled = 0;
2558  (void)SCConfGetBool("multi-detect.enabled", &mt_enabled);
2559  int default_tenant = 0;
2560  if (mt_enabled)
2561  (void)SCConfGetBool("multi-detect.default", &default_tenant);
2563  FatalError("initializing multi-detect "
2564  "detection engine contexts failed.");
2565  }
2566  if (suri->delayed_detect && suri->run_mode != RUNMODE_CONF_TEST) {
2568  } else if (mt_enabled && !default_tenant && suri->run_mode != RUNMODE_CONF_TEST) {
2570  } else {
2572  }
2573  if (de_ctx == NULL) {
2574  FatalError("initializing detection engine failed.");
2575  }
2576 
2578  if (LoadSignatures(de_ctx, suri) != TM_ECODE_OK)
2579  exit(EXIT_FAILURE);
2580  }
2581 
2582  gettimeofday(&de_ctx->last_reload, NULL);
2585  }
2586 }
2587 
2588 static void PostConfLoadedSetupHostMode(void)
2589 {
2590  const char *hostmode = NULL;
2591 
2592  if (SCConfGet("host-mode", &hostmode) == 1) {
2593  if (!strcmp(hostmode, "router")) {
2595  } else if (!strcmp(hostmode, "sniffer-only")) {
2597  } else {
2598  if (strcmp(hostmode, "auto") != 0) {
2599  WarnInvalidConfEntry("host-mode", "%s", "auto");
2600  }
2601  if (EngineModeIsIPS()) {
2603  } else {
2605  }
2606  }
2607  } else {
2608  if (EngineModeIsIPS()) {
2610  SCLogInfo("No 'host-mode': suricata is in IPS mode, using "
2611  "default setting 'router'");
2612  } else {
2614  SCLogInfo("No 'host-mode': suricata is in IDS mode, using "
2615  "default setting 'sniffer-only'");
2616  }
2617  }
2618 }
2619 
2620 static void SetupUserMode(SCInstance *suri)
2621 {
2622  /* apply 'user mode' config updates here */
2623  if (!suri->system) {
2624  if (!suri->set_logdir) {
2625  /* override log dir to current work dir" */
2626  if (ConfigSetLogDirectory((char *)".") != TM_ECODE_OK) {
2627  FatalError("could not set USER mode logdir");
2628  }
2629  }
2630  if (!suri->set_datadir) {
2631  /* override data dir to current work dir" */
2632  if (ConfigSetDataDirectory((char *)".") != TM_ECODE_OK) {
2633  FatalError("could not set USER mode datadir");
2634  }
2635  }
2636  }
2637 }
2638 
2639 /**
2640  * This function is meant to contain code that needs
2641  * to be run once the configuration has been loaded.
2642  */
2644 {
2645  /* load the pattern matchers */
2646  MpmTableSetup();
2647  SpmTableSetup();
2648 
2649  int disable_offloading;
2650  if (SCConfGetBool("capture.disable-offloading", &disable_offloading) == 0)
2651  disable_offloading = 1;
2652  if (disable_offloading) {
2654  } else {
2656  }
2657 
2658  if (suri->checksum_validation == -1) {
2659  const char *cv = NULL;
2660  if (SCConfGet("capture.checksum-validation", &cv) == 1) {
2661  if (strcmp(cv, "none") == 0) {
2662  suri->checksum_validation = 0;
2663  } else if (strcmp(cv, "all") == 0) {
2664  suri->checksum_validation = 1;
2665  }
2666  }
2667  }
2668  switch (suri->checksum_validation) {
2669  case 0:
2670  SCConfSet("stream.checksum-validation", "0");
2671  break;
2672  case 1:
2673  SCConfSet("stream.checksum-validation", "1");
2674  break;
2675  }
2676 
2677  if (suri->runmode_custom_mode) {
2678  SCConfSet("runmode", suri->runmode_custom_mode);
2679  }
2680 
2681  StorageInit();
2682 #ifdef HAVE_PACKET_EBPF
2683  if (suri->run_mode == RUNMODE_AFP_DEV) {
2684  EBPFRegisterExtension();
2686  }
2687 #endif
2689 
2692 
2693  SigTableInit();
2694 
2695 #ifdef HAVE_PLUGINS
2697 #endif
2698 
2699  LiveDeviceFinalize(); // must be after EBPF extension registration
2700 
2703  FatalError("IPS mode setup failed");
2704  }
2705 
2706  if (EngineModeIsUnknown()) { // if still uninitialized, set the default
2707  SCLogInfo("Setting engine mode to IDS mode by default");
2708  EngineModeSetIDS();
2709  }
2710 
2712 
2713  SCConfNode *eps = SCConfGetNode("stats.exception-policy");
2714  if (eps != NULL) {
2715  if (SCConfNodeChildValueIsTrue(eps, "per-app-proto-errors")) {
2717  }
2718  }
2719 
2720  /* Must occur prior to output mod registration
2721  and app layer setup. */
2723 
2724  AppLayerSetup();
2725 
2726  /* Suricata will use this umask if provided. By default it will use the
2727  umask passed on from the shell. */
2728  const char *custom_umask;
2729  if (SCConfGet("umask", &custom_umask) == 1) {
2730  uint16_t mask;
2731  if (StringParseUint16(&mask, 8, (uint16_t)strlen(custom_umask), custom_umask) > 0) {
2732  umask((mode_t)mask);
2733  }
2734  }
2735 
2736  if (ConfigGetCaptureValue(suri) != TM_ECODE_OK) {
2738  }
2739 
2740 #ifdef NFQ
2741  if (suri->run_mode == RUNMODE_NFQ)
2742  NFQInitConfig(false);
2743 #endif
2744 
2745  /* Load the Host-OS lookup. */
2747 
2748  if (suri->run_mode == RUNMODE_ENGINE_ANALYSIS) {
2749  SCLogInfo("== Carrying out Engine Analysis ==");
2750  const char *temp = NULL;
2751  if (SCConfGet("engine-analysis", &temp) == 0) {
2752  SCLogInfo("no engine-analysis parameter(s) defined in conf file. "
2753  "Please define/enable them in the conf to use this "
2754  "feature.");
2756  }
2757  }
2758 
2759  /* hardcoded initialization code */
2760  SigTableSetup(); /* load the rule keywords */
2762  TmqhSetup();
2763 
2764  TagInitCtx();
2766  ThresholdInit();
2767  HostBitInitCtx();
2768  IPPairBitInitCtx();
2769 
2770  if (DetectAddressTestConfVars() < 0) {
2771  SCLogError(
2772  "basic address vars test failed. Please check %s for errors", suri->conf_filename);
2774  }
2775  if (DetectPortTestConfVars() < 0) {
2776  SCLogError("basic port vars test failed. Please check %s for errors", suri->conf_filename);
2778  }
2779 
2782 
2783  StorageFinalize();
2784 
2785  TmModuleRunInit();
2786 
2787  if (MayDaemonize(suri) != TM_ECODE_OK)
2789 
2790  if (InitSignalHandler(suri) != TM_ECODE_OK)
2792 
2793  /* Check for the existence of the default logging directory which we pick
2794  * from suricata.yaml. If not found, shut the engine down */
2795  suri->log_dir = SCConfigGetLogDirectory();
2796 
2798  SCLogError("The logging directory \"%s\" "
2799  "supplied by %s (default-log-dir) doesn't exist. "
2800  "Shutting down the engine",
2801  suri->log_dir, suri->conf_filename);
2803  }
2804  if (!IsLogDirectoryWritable(suri->log_dir)) {
2805  SCLogError("The logging directory \"%s\" "
2806  "supplied by %s (default-log-dir) is not writable. "
2807  "Shutting down the engine",
2808  suri->log_dir, suri->conf_filename);
2810  }
2811 
2812  if (suri->disabled_detect) {
2813  SCLogConfig("detection engine disabled");
2814  /* disable raw reassembly */
2815  (void)SCConfSetFinal("stream.reassembly.raw", "false");
2816  }
2817 
2819 
2821 
2823 
2824  /* hostmode depends on engine mode being set */
2825  PostConfLoadedSetupHostMode();
2826 
2827  PreRunInit(suri->run_mode);
2828 
2830 }
2831 
2833 {
2834  SCInstance *suri = &suricata;
2835  while(1) {
2836  if (sigterm_count || sigint_count) {
2838  }
2839 
2841  SCLogNotice("Signal Received. Stopping engine.");
2842  break;
2843  }
2844 
2846 
2847  if (sighup_count > 0) {
2849  sighup_count--;
2850  }
2851 
2852  if (sigusr2_count > 0) {
2853  if (!(DetectEngineReloadIsStart())) {
2855  DetectEngineReload(suri);
2857  sigusr2_count--;
2858  }
2859 
2860  } else if (DetectEngineReloadIsStart()) {
2861  DetectEngineReload(suri);
2863  }
2864 
2865  usleep(10* 1000);
2866  }
2867 }
2868 
2869 /**
2870  * \brief Global initialization common to all runmodes.
2871  *
2872  * This can be used by fuzz targets.
2873  */
2874 
2875 int InitGlobal(void)
2876 {
2877  rs_init(&suricata_context);
2878 
2879  SC_ATOMIC_INIT(engine_stage);
2880 
2881  /* initialize the logging subsys */
2882  SCLogInitLogModule(NULL);
2883 
2884  SCSetThreadName("Suricata-Main");
2885 
2886  /* Ignore SIGUSR2 as early as possible. We redeclare interest
2887  * once we're done launching threads. The goal is to either die
2888  * completely or handle any and all SIGUSR2s correctly.
2889  */
2890 #ifndef OS_WIN32
2891  UtilSignalHandlerSetup(SIGUSR2, SIG_IGN);
2892  if (UtilSignalBlock(SIGUSR2)) {
2893  SCLogError("SIGUSR2 initialization error");
2894  return EXIT_FAILURE;
2895  }
2896 #endif
2897 
2898  ParseSizeInit();
2900 
2901  /* Initialize the configuration module. */
2902  SCConfInit();
2904 
2905  VarNameStoreInit();
2906 
2907  // zero all module storage
2908  memset(tmm_modules, 0, TMM_SIZE * sizeof(TmModule));
2909 
2910  return 0;
2911 }
2912 
2913 void SuricataPreInit(const char *progname)
2914 {
2915  SCInstanceInit(&suricata, progname);
2916 
2917  if (InitGlobal() != 0) {
2918  exit(EXIT_FAILURE);
2919  }
2920 }
2921 
2922 void SuricataInit(void)
2923 {
2924  /* Initializations for global vars, queues, etc (memsets, mutex init..) */
2926 
2928  SCConfDump();
2929  exit(EXIT_SUCCESS);
2930  }
2931 
2932  int tracking = 1;
2933  if (SCConfGetBool("vlan.use-for-tracking", &tracking) == 1 && !tracking) {
2934  /* Ignore vlan_ids when comparing flows. */
2935  g_vlan_mask = 0x0000;
2936  }
2937  SCLogDebug("vlan tracking is %s", tracking == 1 ? "enabled" : "disabled");
2938  if (SCConfGetBool("livedev.use-for-tracking", &tracking) == 1 && !tracking) {
2939  /* Ignore livedev id when comparing flows. */
2940  g_livedev_mask = 0x0000;
2941  }
2942  if (SCConfGetBool("decoder.recursion-level.use-for-tracking", &tracking) == 1 && !tracking) {
2943  /* Ignore recursion level when comparing flows. */
2944  g_recurlvl_mask = 0x00;
2945  }
2946  SetupUserMode(&suricata);
2947  InitRunAs(&suricata);
2948 
2949  /* Since our config is now loaded we can finish configurating the
2950  * logging module. */
2952 
2953  LogVersion(&suricata);
2956 
2958  SCLogInfo("Running suricata under test mode");
2959 
2960  if (ParseInterfacesList(suricata.aux_run_mode, suricata.pcap_dev) != TM_ECODE_OK) {
2961  exit(EXIT_FAILURE);
2962  }
2963 
2965  exit(EXIT_FAILURE);
2966  }
2967 
2969 
2970  /* Re-enable coredumps after privileges are dropped. */
2971  CoredumpEnable();
2972 
2975  }
2976 
2978 
2980 
2983  goto out;
2984  } else if (suricata.run_mode == RUNMODE_CONF_TEST){
2985  SCLogNotice("Configuration provided was successfully loaded. Exiting.");
2986  goto out;
2987  } else if (suricata.run_mode == RUNMODE_DUMP_FEATURES) {
2988  FeatureDump();
2989  goto out;
2990  }
2991 
2994 
2995  SCSetStartTime(&suricata);
2998  }
3001  return;
3002 
3003 out:
3004  GlobalsDestroy();
3005  exit(EXIT_SUCCESS);
3006 }
3007 
3009 {
3010  /* Update the engine stage/status flag */
3011  SC_ATOMIC_SET(engine_stage, SURICATA_DEINIT);
3012 
3015  /* kill remaining threads */
3017 }
3018 
3020 {
3021  /* Wait till all the threads have been initialized */
3024  FatalError("Engine initialization failed, "
3025  "aborting...");
3026  }
3027 
3028  int limit_nproc = 0;
3029  if (SCConfGetBool("security.limit-noproc", &limit_nproc) == 0) {
3030  limit_nproc = 0;
3031  }
3032 
3033 #if defined(SC_ADDRESS_SANITIZER)
3034  if (limit_nproc) {
3035  SCLogWarning(
3036  "\"security.limit-noproc\" (setrlimit()) not set when using address sanitizer");
3037  limit_nproc = 0;
3038  }
3039 #endif
3040 
3041  if (limit_nproc) {
3042 #if defined(HAVE_SYS_RESOURCE_H)
3043 #ifdef linux
3044  if (geteuid() == 0) {
3045  SCLogWarning("setrlimit has no effect when running as root.");
3046  }
3047 #endif
3048  struct rlimit r = { 0, 0 };
3049  if (setrlimit(RLIMIT_NPROC, &r) != 0) {
3050  SCLogWarning("setrlimit failed to prevent process creation.");
3051  }
3052 #else
3053  SCLogWarning("setrlimit unavailable.");
3054 #endif
3055  }
3056 
3057  SC_ATOMIC_SET(engine_stage, SURICATA_RUNTIME);
3059 
3060  /* Un-pause all the paused threads */
3062 
3063  /* Must ensure all threads are fully operational before continuing with init process */
3066  exit(EXIT_FAILURE);
3067  }
3068 
3069  /* Print notice and send OS specific notification of threads in running state */
3070  OnNotifyRunning();
3071 
3072  PostRunStartedDetectSetup(&suricata);
3073  if (suricata.run_mode == RUNMODE_DPDK) { // only DPDK uses hpages at the moment
3077  SystemHugepageSnapshotDestroy(postrun_snap);
3078  }
3079  SCPledge();
3080 }
RUNMODE_LIST_APP_LAYERS
@ RUNMODE_LIST_APP_LAYERS
Definition: runmodes.h:47
SCRunMode
enum SCRunModes SCRunMode
RUNMODE_ENGINE_ANALYSIS
@ RUNMODE_ENGINE_ANALYSIS
Definition: runmodes.h:55
DefragDestroy
void DefragDestroy(void)
Definition: defrag.c:1132
util-byte.h
TmModuleUnixManagerRegister
void TmModuleUnixManagerRegister(void)
Definition: unix-manager.c:1289
StatsReleaseResources
void StatsReleaseResources(void)
Releases the resources allotted by the Stats API.
Definition: counters.c:1263
source-nflog.h
TagInitCtx
void TagInitCtx(void)
Definition: detect-engine-tag.c:52
TmModuleReceiveIPFWRegister
void TmModuleReceiveIPFWRegister(void)
Registration Function for RecieveIPFW.
Definition: source-ipfw.c:150
flow-bypass.h
len
uint8_t len
Definition: app-layer-dnp3.h:2
SuricataMainLoop
void SuricataMainLoop(void)
Definition: suricata.c:2832
ExceptionSimulationCommandLineParser
int ExceptionSimulationCommandLineParser(const char *name, const char *arg)
Definition: util-exception-policy.c:384
SCInstance_::run_mode
enum SCRunModes run_mode
Definition: suricata.h:124
ippair.h
g_livedev_mask
uint16_t g_livedev_mask
Definition: suricata.c:205
SCInstance_::firewall_rule_file
char * firewall_rule_file
Definition: suricata.h:132
RUNMODE_AFXDP_DEV
@ RUNMODE_AFXDP_DEV
Definition: runmodes.h:37
app-layer-htp-range.h
AppLayerHtpNeedFileInspection
void AppLayerHtpNeedFileInspection(void)
Sets a flag that informs the HTP app layer that some module in the engine needs the http request file...
Definition: app-layer-htp.c:597
detect-engine.h
source-pcap.h
SCInstance_::groupid
uint32_t groupid
Definition: suricata.h:144
g_system
bool g_system
Definition: suricata.c:190
win32-syscall.h
SCInstance_::aux_run_mode
enum SCRunModes aux_run_mode
Definition: suricata.h:125
SCInstance_::daemon
int daemon
Definition: suricata.h:153
IPPairInitConfig
void IPPairInitConfig(bool quiet)
initialize the configuration
Definition: ippair.c:162
SCLogInitLogModule
void SCLogInitLogModule(SCLogInitData *sc_lid)
Initializes the logging module.
Definition: util-debug.c:1390
SLL_HEADER_LEN
#define SLL_HEADER_LEN
Definition: decode-sll.h:27
SCInstance_::checksum_validation
int checksum_validation
Definition: suricata.h:156
LiveDeviceListClean
int LiveDeviceListClean(void)
Definition: util-device.c:314
SCInstance_::do_setuid
bool do_setuid
Definition: suricata.h:140
DetectEngineDeReference
void DetectEngineDeReference(DetectEngineCtx **de_ctx)
Definition: detect-engine.c:4778
StorageInit
void StorageInit(void)
Definition: util-storage.c:70
SCInstance_::start_time
struct timeval start_time
Definition: suricata.h:159
IsRunModeOffline
bool IsRunModeOffline(enum SCRunModes run_mode_to_check)
Definition: runmodes.c:551
SC_ATOMIC_INIT
#define SC_ATOMIC_INIT(name)
wrapper for initializing an atomic variable.
Definition: util-atomic.h:314
prerun_snap
SystemHugepageSnapshot * prerun_snap
Definition: suricata.c:216
TmThreadContinueThreads
void TmThreadContinueThreads(void)
Unpauses all threads present in tv_root.
Definition: tm-threads.c:1962
RUNMODE_NFLOG
@ RUNMODE_NFLOG
Definition: runmodes.h:32
source-pcap-file.h
SCInstance_::do_setgid
bool do_setgid
Definition: suricata.h:141
CLS
#define CLS
Definition: suricata-common.h:61
stream-tcp.h
DetectEngineCtx_::type
enum DetectEngineType type
Definition: detect.h:1041
SigLoadSignatures
int SigLoadSignatures(DetectEngineCtx *de_ctx, char *sig_file, bool sig_file_exclusive)
Load signatures.
Definition: detect-engine-loader.c:368
runmode-af-packet.h
SCInstance_::group_name
const char * group_name
Definition: suricata.h:139
DetectEngineCtx_::firewall_rule_file_exclusive
const char * firewall_rule_file_exclusive
Definition: detect.h:1132
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
SC_ATOMIC_SET
#define SC_ATOMIC_SET(name, val)
Set the value for the atomic variable.
Definition: util-atomic.h:386
runmode-unittests.h
RUNMODE_UNKNOWN
@ RUNMODE_UNKNOWN
Definition: runmodes.h:28
TmqhSetup
void TmqhSetup(void)
Definition: tm-queuehandlers.c:39
SCConfGetRootNode
SCConfNode * SCConfGetRootNode(void)
Get the root configuration node.
Definition: conf.c:222
DetectEngineCtxInitStubForDD
DetectEngineCtx * DetectEngineCtxInitStubForDD(void)
Definition: detect-engine.c:2755
LiveDevRegisterExtension
void LiveDevRegisterExtension(void)
Definition: util-device.c:465
OutputTxShutdown
void OutputTxShutdown(void)
Definition: output-tx.c:666
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
AppLayerHtpPrintStats
void AppLayerHtpPrintStats(void)
Definition: app-layer-htp.c:2479
TVT_PPT
@ TVT_PPT
Definition: tm-threads-common.h:88
util-hugepages.h
StatsSetupPostConfigPreOutput
void StatsSetupPostConfigPreOutput(void)
Definition: counters.c:886
SCInstance_::runmode_custom_mode
char * runmode_custom_mode
Definition: suricata.h:136
util-coredump-config.h
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
SigTableSetup
void SigTableSetup(void)
Definition: detect-engine-register.c:515
TmModuleReceiveNFQRegister
void TmModuleReceiveNFQRegister(void)
Definition: source-nfq.c:169
LiveBuildDeviceList
int LiveBuildDeviceList(const char *runmode)
Definition: util-device.c:274
RunModeShutDown
void RunModeShutDown(void)
Definition: runmodes.c:569
SuricataInit
void SuricataInit(void)
Definition: suricata.c:2922
TM_ECODE_DONE
@ TM_ECODE_DONE
Definition: tm-threads-common.h:83
SCProtoNameInit
void SCProtoNameInit(void)
Definition: util-proto-name.c:417
SuricataPostInit
void SuricataPostInit(void)
Definition: suricata.c:3019
ippair-bit.h
RunModeDispatch
void RunModeDispatch(int runmode, const char *custom_mode, const char *capture_plugin_name, const char *capture_plugin_args)
Definition: runmodes.c:399
util-macset.h
sigint_count
volatile sig_atomic_t sigint_count
Definition: suricata.c:155
SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(unsigned int, engine_stage)
RUNMODE_NFQ
@ RUNMODE_NFQ
Definition: runmodes.h:31
TmModuleRunDeInit
void TmModuleRunDeInit(void)
Definition: tm-modules.c:119
TmThreadsUnsealThreads
void TmThreadsUnsealThreads(void)
Definition: tm-threads.c:2153
RegisterFlowBypassInfo
void RegisterFlowBypassInfo(void)
Definition: flow-util.c:237
SCSetThreadName
#define SCSetThreadName(n)
Definition: threads.h:303
SCConfYamlHandleInclude
int SCConfYamlHandleInclude(SCConfNode *parent, const char *filename)
Include a file in the configuration.
Definition: conf-yaml-loader.c:115
SURICATA_DEINIT
@ SURICATA_DEINIT
Definition: suricata.h:97
sc_set_caps
bool sc_set_caps
Definition: suricata.c:188
SCLogDeInitLogModule
void SCLogDeInitLogModule(void)
De-Initializes the logging module.
Definition: util-debug.c:1595
LiveDevice_
Definition: util-device.h:41
util-pidfile.h
TmModuleDecodeErfFileRegister
void TmModuleDecodeErfFileRegister(void)
Register the ERF file decoder module.
Definition: source-erf-file.c:98
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:920
StringParseUint16
int StringParseUint16(uint16_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:337
SigTableInit
void SigTableInit(void)
Definition: detect-engine-register.c:503
SURICATA_RUNTIME
@ SURICATA_RUNTIME
Definition: suricata.h:96
DetectEngineReloadSetIdle
void DetectEngineReloadSetIdle(void)
Definition: detect-engine.c:2177
SCInstance_::userid
uint32_t userid
Definition: suricata.h:143
source-windivert-prototypes.h
SCConfGet
int SCConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:350
DetectEngineGetCurrent
DetectEngineCtx * DetectEngineGetCurrent(void)
Definition: detect-engine.c:3987
EngineModeIsUnknown
int EngineModeIsUnknown(void)
Definition: suricata.c:229
VarNameStoreInit
void VarNameStoreInit(void)
TmModuleFlowRecyclerRegister
void TmModuleFlowRecyclerRegister(void)
Definition: flow-manager.c:1303
g_skip_prefilter
int g_skip_prefilter
Definition: detect-engine-mpm.c:1072
SCConfNodeChildValueIsTrue
int SCConfNodeChildValueIsTrue(const SCConfNode *node, const char *key)
Test if a configuration node has a true value.
Definition: conf.c:868
Daemonize
void Daemonize(void)
Daemonize the process.
Definition: util-daemon.c:101
UtilSignalHandlerSetup
void UtilSignalHandlerSetup(int sig, void(*handler)(int))
Definition: util-signal.c:60
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:252
TmModuleDecodeAFPRegister
void TmModuleDecodeAFPRegister(void)
Registration Function for DecodeAFP.
Definition: source-af-packet.c:599
TmModuleDecodeWinDivertRegister
void TmModuleDecodeWinDivertRegister(void)
Definition: source-windivert.c:74
SURICATA_STOP
#define SURICATA_STOP
Definition: suricata.h:89
DetectEngineAddToMaster
int DetectEngineAddToMaster(DetectEngineCtx *de_ctx)
Definition: detect-engine.c:4802
SCConfGetChildValueBool
int SCConfGetChildValueBool(const SCConfNode *base, const char *name, int *val)
Definition: conf.c:515
TmModuleStatsLoggerRegister
void TmModuleStatsLoggerRegister(void)
Definition: output-stats.c:169
RegisterAllModules
void RegisterAllModules(void)
Definition: suricata.c:898
ENGINE_MODE_IPS
@ ENGINE_MODE_IPS
Definition: suricata.h:104
DetectEngineMultiTenantSetup
int DetectEngineMultiTenantSetup(const bool unix_socket)
setup multi-detect / multi-tenancy
Definition: detect-engine.c:4439
flow-bit.h
SupportFastPatternForSigMatchTypes
void SupportFastPatternForSigMatchTypes(void)
Registers the keywords(SMs) that should be given fp support.
Definition: detect-fast-pattern.c:142
util-var-name.h
suricata_context
const SuricataContext suricata_context
Definition: rust-context.c:26
SCParseCommandLine
TmEcode SCParseCommandLine(int argc, char **argv)
Definition: suricata.c:1320
SCPledge
#define SCPledge(...)
Definition: util-privs.h:99
CheckValidDaemonModes
int CheckValidDaemonModes(int daemon, int mode)
Check for a valid combination daemon/mode.
Definition: util-daemon.c:177
SCGetGroupID
void SCGetGroupID(const char *group_name, uint32_t *gid)
Function to get the group ID from the specified group name.
Definition: util-privs.c:210
SCConfGetBool
int SCConfGetBool(const char *name, int *val)
Retrieve a configuration value as a boolean.
Definition: conf.c:497
unittests_fatal
int unittests_fatal
Definition: util-unittest.c:52
TmThreadDisableReceiveThreads
void TmThreadDisableReceiveThreads(void)
Disable all threads having the specified TMs.
Definition: tm-threads.c:1391
StatsInit
void StatsInit(void)
Initializes the perf counter api. Things are hard coded currently. More work to be done when we imple...
Definition: counters.c:876
util-privs.h
PreRunInit
void PreRunInit(const int runmode)
Definition: suricata.c:2228
SURICATA_DONE
#define SURICATA_DONE
Definition: suricata.h:91
MacSetRegisterFlowStorage
void MacSetRegisterFlowStorage(void)
Definition: util-macset.c:62
SuricataShutdown
void SuricataShutdown(void)
Definition: suricata.c:3008
SCInstance_::conf_filename
const char * conf_filename
Definition: suricata.h:163
GetIfaceMTU
int GetIfaceMTU(const char *dev)
output the link MTU
Definition: util-ioctl.c:81
GlobalsInitPreConfig
void GlobalsInitPreConfig(void)
Definition: suricata.c:364
TmModuleReceiveNetmapRegister
void TmModuleReceiveNetmapRegister(void)
Definition: source-netmap.c:74
PacketPoolPostRunmodes
void PacketPoolPostRunmodes(void)
Set the max_pending_return_packets value.
Definition: tmqh-packetpool.c:459
NFQInitConfig
void NFQInitConfig(bool quiet)
To initialize the NFQ global configuration data.
Definition: source-nfq.c:206
TmModuleReceiveWinDivertRegister
void TmModuleReceiveWinDivertRegister(void)
Definition: source-windivert.c:61
SystemHugepageSnapshot
Definition: util-hugepages.h:44
REVISION
#define REVISION
Definition: suricata-common.h:53
HOST_VERBOSE
#define HOST_VERBOSE
Definition: host.h:92
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:82
SCProfilingDestroy
void SCProfilingDestroy(void)
Free resources used by profiling.
Definition: util-profiling.c:276
AFPPeersListClean
void AFPPeersListClean(void)
Clean the global peers list.
Definition: source-af-packet.c:581
RunModeInitializeOutputs
void RunModeInitializeOutputs(void)
Definition: runmodes.c:759
DetectPortTestConfVars
int DetectPortTestConfVars(void)
Definition: detect-engine-port.c:1106
SCThresholdConfGlobalInit
void SCThresholdConfGlobalInit(void)
Definition: util-threshold-config.c:102
DecodeUnregisterCounters
void DecodeUnregisterCounters(void)
Definition: decode.c:576
SCInstance_::capture_plugin_name
const char * capture_plugin_name
Definition: suricata.h:167
SCConfYamlLoadFile
int SCConfYamlLoadFile(const char *filename)
Load configuration from a YAML file.
Definition: conf-yaml-loader.c:477
HostBitInitCtx
void HostBitInitCtx(void)
Definition: host-bit.c:49
EngineMode
EngineMode
Definition: suricata.h:101
SCInstance_::set_datadir
bool set_datadir
Definition: suricata.h:148
tmqh-packetpool.h
IsRunModeSystem
bool IsRunModeSystem(enum SCRunModes run_mode_to_check)
Definition: runmodes.c:538
g_ut_covered
int g_ut_covered
Definition: suricata.c:896
SCInstance_::capture_plugin_args
const char * capture_plugin_args
Definition: suricata.h:168
g_recurlvl_mask
uint8_t g_recurlvl_mask
Definition: suricata.c:209
TmModuleLoggerRegister
void TmModuleLoggerRegister(void)
Definition: output.c:859
TmThreadDisablePacketThreads
void TmThreadDisablePacketThreads(void)
Disable all packet threads.
Definition: tm-threads.c:1520
host_mode
uint8_t host_mode
Definition: suricata.c:179
TVT_MGMT
@ TVT_MGMT
Definition: tm-threads-common.h:89
FeatureDump
void FeatureDump(void)
Definition: feature.c:144
PacketPoolInit
void PacketPoolInit(void)
Definition: tmqh-packetpool.c:244
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:81
AppLayerDeSetup
int AppLayerDeSetup(void)
De initializes the app layer.
Definition: app-layer.c:1093
RUNMODE_UNIX_SOCKET
@ RUNMODE_UNIX_SOCKET
Definition: runmodes.h:42
strlcpy
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: util-strlcpyu.c:43
PcapTranslateIPToDevice
void PcapTranslateIPToDevice(char *pcap_dev, size_t len)
Definition: source-pcap.c:656
FlowDisableFlowRecyclerThread
void FlowDisableFlowRecyclerThread(void)
Used to disable flow recycler thread(s).
Definition: flow-manager.c:1231
SCRunmodeSet
void SCRunmodeSet(SCRunMode run_mode)
Set the current run mode.
Definition: suricata.c:271
ParseSizeInit
void ParseSizeInit(void)
Definition: util-misc.c:35
TmModuleDecodePcapFileRegister
void TmModuleDecodePcapFileRegister(void)
Definition: source-pcap-file.c:129
TmModuleBypassedFlowManagerRegister
void TmModuleBypassedFlowManagerRegister(void)
Definition: flow-bypass.c:218
IPPairShutdown
void IPPairShutdown(void)
shutdown the flow engine
Definition: ippair.c:290
source-erf-dag.h
SCConfInit
void SCConfInit(void)
Initialize the configuration system.
Definition: conf.c:120
util-signal.h
DetectParseFreeRegexes
void DetectParseFreeRegexes(void)
Definition: detect-parse.c:3418
SCConfDump
void SCConfDump(void)
Dump configuration to stdout.
Definition: conf.c:761
TmModuleDecodeNFLOGRegister
void TmModuleDecodeNFLOGRegister(void)
Definition: source-nflog.c:55
NFQParseAndRegisterQueues
int NFQParseAndRegisterQueues(const char *queues)
Parses and adds Netfilter queue(s).
Definition: source-nfq.c:879
RUNMODE_NETMAP
@ RUNMODE_NETMAP
Definition: runmodes.h:38
FlowInitConfig
void FlowInitConfig(bool quiet)
initialize the configuration
Definition: flow.c:543
AppLayerSetup
int AppLayerSetup(void)
Setup the app layer.
Definition: app-layer.c:1076
FeatureTrackingRegister
void FeatureTrackingRegister(void)
Definition: feature.c:152
TmModuleReceiveDPDKRegister
void TmModuleReceiveDPDKRegister(void)
Definition: source-dpdk.c:50
UnixManagerThreadSpawnNonRunmode
void UnixManagerThreadSpawnNonRunmode(const bool unix_socket_enabled)
Definition: unix-manager.c:1283
RunModeInitializeThreadSettings
void RunModeInitializeThreadSettings(void)
Definition: runmodes.c:944
StreamTcpInitConfig
void StreamTcpInitConfig(bool)
To initialize the stream global configuration data.
Definition: stream-tcp.c:488
ENGINE_MODE_UNKNOWN
@ ENGINE_MODE_UNKNOWN
Definition: suricata.h:102
app-layer-htp.h
util-flow-rate.h
datasets.h
GetIfaceMaxPacketSize
int GetIfaceMaxPacketSize(LiveDevice *ld)
output max packet size for a link
Definition: util-ioctl.c:120
SCRunmodeGet
SCRunMode SCRunmodeGet(void)
Get the current run mode.
Definition: suricata.c:266
TmModuleDecodeNetmapRegister
void TmModuleDecodeNetmapRegister(void)
Registration Function for DecodeNetmap.
Definition: source-netmap.c:84
PreRunPostPrivsDropInit
void PreRunPostPrivsDropInit(const int runmode)
Definition: suricata.c:2257
feature.h
decode.h
util-device.h
SigTableCleanup
void SigTableCleanup(void)
Definition: detect-engine-register.c:469
DetectEngineMoveToFreeList
int DetectEngineMoveToFreeList(DetectEngineCtx *de_ctx)
Definition: detect-engine.c:4862
sigterm_count
volatile sig_atomic_t sigterm_count
Definition: suricata.c:157
SURI_HOST_IS_ROUTER
@ SURI_HOST_IS_ROUTER
Definition: suricata.h:116
source-nfq.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
TmThreadWaitOnThreadInit
TmEcode TmThreadWaitOnThreadInit(void)
Used to check if all threads have finished their initialization. On finding an un-initialized thread,...
Definition: tm-threads.c:2001
TmModuleVerdictNFQRegister
void TmModuleVerdictNFQRegister(void)
Definition: source-nfq.c:184
AppLayerRegisterGlobalCounters
void AppLayerRegisterGlobalCounters(void)
HACK to work around our broken unix manager (re)init loop.
Definition: app-layer.c:1157
RunModeListRunmodes
void RunModeListRunmodes(void)
Lists all registered runmodes.
Definition: runmodes.c:247
strlcat
size_t strlcat(char *, const char *src, size_t siz)
Definition: util-strlcatu.c:45
util-cpu.h
suricata
SCInstance suricata
Definition: suricata.c:222
SCInstance_::unix_socket_enabled
bool unix_socket_enabled
Definition: suricata.h:149
LiveSetOffloadDisable
void LiveSetOffloadDisable(void)
Definition: util-device.c:71
StatsSetupPostConfigPostOutput
void StatsSetupPostConfigPostOutput(void)
Definition: counters.c:891
EngineModeSetIDS
void EngineModeSetIDS(void)
Definition: suricata.c:251
RUNMODE_LIST_KEYWORDS
@ RUNMODE_LIST_KEYWORDS
Definition: runmodes.h:46
SpmTableSetup
void SpmTableSetup(void)
Definition: util-spm.c:122
TmModuleReceiveAFPRegister
void TmModuleReceiveAFPRegister(void)
Registration Function for RecieveAFP.
Definition: source-af-packet.c:381
RUNMODE_UNITTEST
@ RUNMODE_UNITTEST
Definition: runmodes.h:41
LiveBuildDeviceListCustom
int LiveBuildDeviceListCustom(const char *runmode, const char *itemname)
Definition: util-device.c:279
util-exception-policy.h
LiveGetDevice
LiveDevice * LiveGetDevice(const char *name)
Get a pointer to the device at idx.
Definition: util-device.c:248
UnixSocketKillSocketThread
void UnixSocketKillSocketThread(void)
Definition: unix-manager.c:1279
TmModuleVerdictIPFWRegister
void TmModuleVerdictIPFWRegister(void)
Registration Function for VerdictIPFW.
Definition: source-ipfw.c:171
flow-worker.h
SCConfGetInt
int SCConfGetInt(const char *name, intmax_t *val)
Retrieve a configuration value as an integer.
Definition: conf.c:414
g_stats_eps_per_app_proto_errors
bool g_stats_eps_per_app_proto_errors
Definition: suricata.c:219
HttpRangeContainersInit
void HttpRangeContainersInit(void)
Definition: app-layer-htp-range.c:171
util-reference-config.h
DetectEngineCtx_::last_reload
struct timeval last_reload
Definition: detect.h:1087
SCInstance_::delayed_detect
int delayed_detect
Definition: suricata.h:151
TmModuleVerdictWinDivertRegister
void TmModuleVerdictWinDivertRegister(void)
Definition: source-windivert.c:68
DetectEngineCtx_::failure_fatal
bool failure_fatal
Definition: detect.h:921
SCInstance_::progname
const char * progname
Definition: suricata.h:162
HostCleanup
void HostCleanup(void)
Cleanup the host engine.
Definition: host.c:332
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
FlowDisableFlowManagerThread
void FlowDisableFlowManagerThread(void)
Used to disable flow manager thread(s).
Definition: flow-manager.c:132
RUNMODE_DAG
@ RUNMODE_DAG
Definition: runmodes.h:35
util-ebpf.h
SCInstance_::pcap_dev
char pcap_dev[128]
Definition: suricata.h:127
detect.h
UtilSignalUnblock
int UtilSignalUnblock(int signum)
Definition: util-signal.c:46
DetectEngineEnabled
int DetectEngineEnabled(void)
Check if detection is enabled.
Definition: detect-engine.c:3954
TmThreadClearThreadsFamily
void TmThreadClearThreadsFamily(int family)
Definition: tm-threads.c:1671
FlowRateRegisterFlowStorage
void FlowRateRegisterFlowStorage(void)
Definition: util-flow-rate.c:60
TmModuleRunInit
void TmModuleRunInit(void)
Definition: tm-modules.c:104
detect-engine-port.h
EngineModeSetIPS
void EngineModeSetIPS(void)
Definition: suricata.c:246
SCInstance_::user_name
const char * user_name
Definition: suricata.h:138
HTPAtExitPrintStats
void HTPAtExitPrintStats(void)
Print the stats of the HTTP requests.
Definition: app-layer-htp.c:1613
util-time.h
UtilSignalBlock
int UtilSignalBlock(int signum)
Definition: util-signal.c:29
SCProfilingPrefilterGlobalInit
void SCProfilingPrefilterGlobalInit(void)
Definition: util-profiling-prefilter.c:61
ThresholdDestroy
void ThresholdDestroy(void)
Definition: detect-engine-threshold.c:71
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
PostConfLoadedSetup
int PostConfLoadedSetup(SCInstance *suri)
Definition: suricata.c:2643
GetProgramVersion
const char * GetProgramVersion(void)
get string with program version
Definition: suricata.c:1137
engine_analysis
int engine_analysis
app-layer-parser.h
TmModuleReceivePcapFileRegister
void TmModuleReceivePcapFileRegister(void)
Definition: source-pcap-file.c:116
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:309
runmode-netmap.h
CoredumpLoadConfig
int32_t CoredumpLoadConfig(void)
Configures the core dump size.
Definition: util-coredump-config.c:90
detect-engine-tag.h
IPFWRegisterQueue
int IPFWRegisterQueue(char *queue)
Add an IPFW divert.
Definition: source-ipfw.c:698
xstr
#define xstr(s)
Definition: suricata-common.h:299
util-profiling.h
ListAppLayerProtocols
int ListAppLayerProtocols(const char *conf_filename)
Definition: util-running-modes.c:44
SCInstance_::offline
int offline
Definition: suricata.h:154
DatasetsDestroy
void DatasetsDestroy(void)
Definition: datasets.c:755
UtilCpuPrintSummary
void UtilCpuPrintSummary(void)
Print a summary of CPUs detected (configured and online)
Definition: util-cpu.c:140
profiling_packets_enabled
int profiling_packets_enabled
Definition: util-profiling.c:94
SystemDNotifyReady
int SystemDNotifyReady(void)
TmThreadKillThreads
void TmThreadKillThreads(void)
Definition: tm-threads.c:1599
OutputDeregisterAll
void OutputDeregisterAll(void)
Deregister all modules. Useful for a memory clean exit.
Definition: output.c:635
source-pcap-file-helper.h
PostConfLoadedDetectSetup
void PostConfLoadedDetectSetup(SCInstance *suri)
Definition: suricata.c:2552
EngineModeIsIDS
int EngineModeIsIDS(void)
Definition: suricata.c:240
RUNMODE_PLUGIN
@ RUNMODE_PLUGIN
Definition: runmodes.h:44
util-systemd.h
tmm_modules
TmModule tmm_modules[TMM_SIZE]
Definition: tm-modules.c:29
conf-yaml-loader.h
decode-sll.h
SCConfigGetLogDirectory
const char * SCConfigGetLogDirectory(void)
Definition: util-conf.c:38
coverage_unittests
int coverage_unittests
Definition: suricata.c:894
DatasetsSave
void DatasetsSave(void)
Definition: datasets.c:833
detect-engine-alert.h
conf.h
util-landlock.h
source-ipfw.h
TMM_SIZE
@ TMM_SIZE
Definition: tm-threads-common.h:76
source-netmap.h
OutputNotifyFileRotation
void OutputNotifyFileRotation(void)
Notifies all registered file rotation notification flags.
Definition: output.c:712
RUNMODE_WINDIVERT
@ RUNMODE_WINDIVERT
Definition: runmodes.h:43
StorageFinalize
int StorageFinalize(void)
Definition: util-storage.c:140
VarNameStoreDestroy
void VarNameStoreDestroy(void)
Definition: util-var-name.c:116
SCInstance_::verbose
int verbose
Definition: suricata.h:155
source-lib.h
TmEcode
TmEcode
Definition: tm-threads-common.h:80
source-windivert.h
TmModuleFlowWorkerRegister
void TmModuleFlowWorkerRegister(void)
Definition: flow-worker.c:797
name
const char * name
Definition: tm-threads.c:2135
max_pending_packets
uint32_t max_pending_packets
Definition: suricata.c:182
util-plugin.h
SCInstance_::additional_configs
const char ** additional_configs
Definition: suricata.h:164
flow-timeout.h
DEFAULT_PID_FILENAME
#define DEFAULT_PID_FILENAME
Definition: suricata.h:83
RUNMODE_AFP_DEV
@ RUNMODE_AFP_DEV
Definition: runmodes.h:36
sighup_count
volatile sig_atomic_t sighup_count
Definition: suricata.c:156
ConfigSetDataDirectory
TmEcode ConfigSetDataDirectory(char *name)
Definition: util-conf.c:66
TmModuleDecodeErfDagRegister
void TmModuleDecodeErfDagRegister(void)
Register the ERF file decoder module.
Definition: source-erf-dag.c:151
SCInstance_::set_logdir
bool set_logdir
Definition: suricata.h:147
SCDropMainThreadCaps
#define SCDropMainThreadCaps(...)
Definition: util-privs.h:90
TmModuleDebugList
void TmModuleDebugList(void)
Definition: tm-modules.c:31
TmModuleDecodeNFQRegister
void TmModuleDecodeNFQRegister(void)
Definition: source-nfq.c:192
util-proto-name.h
STREAM_VERBOSE
#define STREAM_VERBOSE
Definition: stream-tcp.h:35
defrag.h
SCProtoNameRelease
void SCProtoNameRelease(void)
Definition: util-proto-name.c:438
MpmTableSetup
void MpmTableSetup(void)
Definition: util-mpm.c:224
SCInstance_::log_dir
const char * log_dir
Definition: suricata.h:161
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:257
source-nfq-prototypes.h
SCPluginsLoad
void SCPluginsLoad(const char *capture_plugin_name, const char *capture_plugin_args)
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:224
TmModuleReceiveNFLOGRegister
void TmModuleReceiveNFLOGRegister(void)
Definition: source-nflog.c:49
DEFAULT_PACKET_SIZE
#define DEFAULT_PACKET_SIZE
Definition: decode.h:682
WarnInvalidConfEntry
#define WarnInvalidConfEntry(param_name, format, value)
Generic API that can be used by all to log an invalid conf entry.
Definition: util-misc.h:35
util-host-os-info.h
TmModuleReceiveErfFileRegister
void TmModuleReceiveErfFileRegister(void)
Register the ERF file receiver (reader) module.
Definition: source-erf-file.c:80
SCConfSetFromString
int SCConfSetFromString(const char *input, int final)
Set a configuration parameter from a string.
Definition: conf.c:264
RUNMODE_PRINT_USAGE
@ RUNMODE_PRINT_USAGE
Definition: runmodes.h:51
SCConfSetFinal
int SCConfSetFinal(const char *name, const char *val)
Set a final configuration value.
Definition: conf.c:318
TmModule_
Definition: tm-modules.h:43
SCRealloc
#define SCRealloc(ptr, sz)
Definition: util-mem.h:50
TmModuleDecodeAFXDPRegister
void TmModuleDecodeAFXDPRegister(void)
Registration Function for DecodeAFXDP.
Definition: source-af-xdp.c:91
default_packet_size
uint32_t default_packet_size
Definition: decode.c:77
tm-queuehandlers.h
SigTableApplyStrictCommandLineOption
void SigTableApplyStrictCommandLineOption(const char *str)
Definition: detect-parse.c:420
DETECT_ENGINE_TYPE_NORMAL
@ DETECT_ENGINE_TYPE_NORMAL
Definition: detect.h:902
PROG_NAME
#define PROG_NAME
Definition: suricata.h:70
TmThreadKillThreadsFamily
void TmThreadKillThreadsFamily(int family)
Definition: tm-threads.c:1570
detect-fast-pattern.h
FeatureTrackingRelease
void FeatureTrackingRelease(void)
Definition: feature.c:136
TmqhCleanup
void TmqhCleanup(void)
Clean up registration time allocs.
Definition: tm-queuehandlers.c:49
util-dpdk.h
util-conf.h
StreamTcpFreeConfig
void StreamTcpFreeConfig(bool quiet)
Definition: stream-tcp.c:859
source-dpdk.h
flow-manager.h
DecodeGlobalConfig
void DecodeGlobalConfig(void)
Definition: decode.c:1013
SCInstance_::strict_rule_parsing_string
char * strict_rule_parsing_string
Definition: suricata.h:165
SuriHasSigFile
int SuriHasSigFile(void)
Definition: suricata.c:224
suricata-common.h
DetectEngineCtxInitStubForMT
DetectEngineCtx * DetectEngineCtxInitStubForMT(void)
Definition: detect-engine.c:2750
util-path.h
util-daemon.h
LiveGetDeviceName
const char * LiveGetDeviceName(int number)
Get a pointer to the device name at idx.
Definition: util-device.c:184
FlowShutdown
void FlowShutdown(void)
shutdown the flow engine
Definition: flow.c:687
SCHInfoLoadFromConfig
void SCHInfoLoadFromConfig(void)
Load the host os policy information from the configuration.
Definition: util-host-os-info.c:281
DetectEngineBumpVersion
void DetectEngineBumpVersion(void)
Definition: detect-engine.c:3978
source-af-xdp.h
TmModuleFlowManagerRegister
void TmModuleFlowManagerRegister(void)
Definition: flow-manager.c:1289
SCStartInternalRunMode
int SCStartInternalRunMode(int argc, char **argv)
Definition: suricata.c:2322
SCPidfileTestRunning
int SCPidfileTestRunning(const char *pid_filename)
Check the Suricata pid file (used at the startup)
Definition: util-pidfile.c:105
HostShutdown
void HostShutdown(void)
shutdown the flow engine
Definition: host.c:296
DOC_URL
#define DOC_URL
Definition: suricata.h:85
SCFstatFn
#define SCFstatFn(fd, statbuf)
Definition: util-path.h:34
output-filestore.h
LiveSetOffloadWarn
void LiveSetOffloadWarn(void)
Definition: util-device.c:76
ParseSizeDeinit
void ParseSizeDeinit(void)
Definition: util-misc.c:54
util-classification-config.h
SCConfDeInit
void SCConfDeInit(void)
De-initializes the configuration system.
Definition: conf.c:703
RunModeRegisterRunModes
void RunModeRegisterRunModes(void)
Register all runmodes in the engine.
Definition: runmodes.c:221
SCStrdup
#define SCStrdup(s)
Definition: util-mem.h:56
FatalError
#define FatalError(...)
Definition: util-debug.h:502
SCProfilingDump
void SCProfilingDump(void)
Definition: util-profiling.c:311
TmModuleReceiveAFXDPRegister
void TmModuleReceiveAFXDPRegister(void)
Definition: source-af-xdp.c:77
EngineStop
void EngineStop(void)
make sure threads can stop the engine by calling this function. Purpose: pcap file mode needs to be a...
Definition: suricata.c:452
SCInstance_::sig_file
char * sig_file
Definition: suricata.h:128
RUNMODE_PRINT_VERSION
@ RUNMODE_PRINT_VERSION
Definition: runmodes.h:49
ParseSizeStringU32
int ParseSizeStringU32(const char *size, uint32_t *res)
Definition: util-misc.c:173
TmModuleReceiveErfDagRegister
void TmModuleReceiveErfDagRegister(void)
Register the ERF file receiver (reader) module.
Definition: source-erf-dag.c:133
IPPairBitInitCtx
void IPPairBitInitCtx(void)
Definition: ippair-bit.c:49
ConfigSetLogDirectory
TmEcode ConfigSetLogDirectory(const char *name)
Definition: util-conf.c:33
util-validate.h
TmModuleDecodeIPFWRegister
void TmModuleDecodeIPFWRegister(void)
Registration Function for DecodeIPFW.
Definition: source-ipfw.c:186
source-af-packet.h
ConfUnixSocketIsEnable
int ConfUnixSocketIsEnable(void)
Definition: util-conf.c:136
SCLogConfig
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
g_vlan_mask
uint16_t g_vlan_mask
Definition: suricata.c:201
RUNMODE_ERF_FILE
@ RUNMODE_ERF_FILE
Definition: runmodes.h:34
DatasetsInit
int DatasetsInit(void)
Definition: datasets.c:603
RUNMODE_DUMP_CONFIG
@ RUNMODE_DUMP_CONFIG
Definition: runmodes.h:52
sigusr2_count
volatile sig_atomic_t sigusr2_count
Definition: suricata.c:158
SystemHugepageSnapshotDestroy
void SystemHugepageSnapshotDestroy(SystemHugepageSnapshot *s)
Definition: util-hugepages.c:304
TmModuleDecodePcapRegister
void TmModuleDecodePcapRegister(void)
Registration Function for DecodePcap.
Definition: source-pcap.c:153
util-running-modes.h
SCLoadYamlConfig
TmEcode SCLoadYamlConfig(void)
Definition: suricata.c:963
unix-manager.h
runmode-af-xdp.h
str
#define str(s)
Definition: suricata-common.h:300
ConfigCheckDataDirectory
TmEcode ConfigCheckDataDirectory(const char *data_dir)
Definition: util-conf.c:99
SCConfGetNode
SCConfNode * SCConfGetNode(const char *name)
Get a SCConfNode by name.
Definition: conf.c:181
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
g_detect_disabled
int g_detect_disabled
Definition: suricata.c:185
DetectEngineReloadStart
int DetectEngineReloadStart(void)
Definition: detect-engine.c:2151
SCFree
#define SCFree(p)
Definition: util-mem.h:61
DEFAULT_CONF_FILE
#define DEFAULT_CONF_FILE
Definition: suricata.h:79
SC_LOG_MAX_LOG_MSG_LEN
#define SC_LOG_MAX_LOG_MSG_LEN
Definition: util-debug.h:84
AppLayerParserPostStreamSetup
void AppLayerParserPostStreamSetup(void)
Definition: app-layer-parser.c:270
TmModuleReceivePcapRegister
void TmModuleReceivePcapRegister(void)
Registration Function for ReceivePcap.
Definition: source-pcap.c:135
RUNMODE_DPDK
@ RUNMODE_DPDK
Definition: runmodes.h:39
SCGetUserID
void SCGetUserID(const char *user_name, const char *group_name, uint32_t *uid, uint32_t *gid)
Function to get the user and group ID from the specified user name.
Definition: util-privs.c:143
util-ioctl.h
detect-parse.h
RUNMODE_PCAP_DEV
@ RUNMODE_PCAP_DEV
Definition: runmodes.h:29
SCInstance_::system
bool system
Definition: suricata.h:146
SCInstance_::pid_filename
char * pid_filename
Definition: suricata.h:130
TmModuleRespondRejectRegister
void TmModuleRespondRejectRegister(void)
Definition: respond-reject.c:50
CoredumpEnable
void CoredumpEnable(void)
Enable coredumps on systems where coredumps can and need to be enabled.
Definition: util-coredump-config.c:57
RunUnittests
void RunUnittests(int list_unittests, const char *regex_arg)
Definition: runmode-unittests.c:231
source-erf-file.h
ConfigCheckLogDirectoryExists
TmEcode ConfigCheckLogDirectoryExists(const char *log_dir)
Definition: util-conf.c:56
SURI_HOST_IS_SNIFFER_ONLY
@ SURI_HOST_IS_SNIFFER_ONLY
Definition: suricata.h:115
SCConfSet
int SCConfSet(const char *name, const char *val)
Set a configuration value.
Definition: conf.c:239
TimeDeinit
void TimeDeinit(void)
Definition: util-time.c:87
PacketAlertTagInit
void PacketAlertTagInit(void)
Definition: detect-engine-alert.c:45
RunModeEngineIsIPS
int RunModeEngineIsIPS(int capture_mode, const char *runmode, const char *capture_plugin_name)
Definition: runmodes.c:369
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2760
TmModuleDecodeLibRegister
void TmModuleDecodeLibRegister(void)
register a "Decode" module for suricata as a library.
Definition: source-lib.c:107
EngineModeIsIPS
int EngineModeIsIPS(void)
Definition: suricata.c:234
SCProfilingKeywordsGlobalInit
void SCProfilingKeywordsGlobalInit(void)
Definition: util-profiling-keywords.c:61
suricata.h
EngineDone
void EngineDone(void)
Used to indicate that the current task is done.
Definition: suricata.c:463
SCInstance_::firewall_rule_file_exclusive
bool firewall_rule_file_exclusive
Definition: suricata.h:133
FLOW_QUIET
#define FLOW_QUIET
Definition: flow.h:43
GetDocURL
const char * GetDocURL(void)
Definition: suricata.c:1116
util-mpm-hs.h
PostRunDeinit
void PostRunDeinit(const int runmode, struct timeval *start_time)
clean up / shutdown code for packet modes
Definition: suricata.c:2273
HostInitConfig
void HostInitConfig(bool quiet)
initialize the configuration
Definition: host.c:168
TmThreadWaitOnThreadRunning
TmEcode TmThreadWaitOnThreadRunning(void)
Waits for all threads to be in a running state.
Definition: tm-threads.c:1893
HttpRangeContainersDestroy
void HttpRangeContainersDestroy(void)
Definition: app-layer-htp-range.c:204
RUNMODE_CONF_TEST
@ RUNMODE_CONF_TEST
Definition: runmodes.h:53
SCLogLoadConfig
void SCLogLoadConfig(int daemon, int verbose, uint32_t userid, uint32_t groupid)
Definition: util-debug.c:1420
DetectEngineReload
int DetectEngineReload(const SCInstance *suri)
Reload the detection engine.
Definition: detect-engine.c:4929
DEFAULT_MAX_PENDING_PACKETS
#define DEFAULT_MAX_PENDING_PACKETS
Definition: suricata.c:168
SCInstance_
Definition: suricata.h:123
DetectEngineClearMaster
void DetectEngineClearMaster(void)
Definition: detect-engine.c:4902
SetMasterExceptionPolicy
void SetMasterExceptionPolicy(void)
Definition: util-exception-policy.c:63
id
uint32_t id
Definition: detect-flowbits.c:933
TmThreadCheckThreadState
void TmThreadCheckThreadState(void)
Used to check the thread for certain conditions of failure.
Definition: tm-threads.c:1978
OutputFilestoreRegisterGlobalCounters
void OutputFilestoreRegisterGlobalCounters(void)
Definition: output-filestore.c:512
InitGlobal
int InitGlobal(void)
Global initialization common to all runmodes.
Definition: suricata.c:2875
SCInstance_::disabled_detect
int disabled_detect
Definition: suricata.h:152
LiveGetDeviceCount
int LiveGetDeviceCount(void)
Get the number of registered devices.
Definition: util-device.c:164
SystemHugepageSnapshotCreate
SystemHugepageSnapshot * SystemHugepageSnapshotCreate(void)
The function creates a snapshot of the system's hugepage usage per NUMA node and per hugepage size....
Definition: util-hugepages.c:323
SCProfilingSghsGlobalInit
void SCProfilingSghsGlobalInit(void)
Definition: util-profiling-rulegroups.c:61
SCPidfileCreate
int SCPidfileCreate(const char *pidfile)
Write a pid file (used at the startup) This commonly needed by the init scripts.
Definition: util-pidfile.c:42
LiveRegisterDeviceName
int LiveRegisterDeviceName(const char *dev)
Add a device for monitoring.
Definition: util-device.c:97
SCStatFn
#define SCStatFn(pathname, statbuf)
Definition: util-path.h:35
ENGINE_MODE_IDS
@ ENGINE_MODE_IDS
Definition: suricata.h:103
LiveDeviceFinalize
void LiveDeviceFinalize(void)
Definition: util-device.c:442
TmModuleDecodeDPDKRegister
void TmModuleDecodeDPDKRegister(void)
Registration Function for DecodeDPDK.
Definition: source-dpdk.c:64
SCInstance_::sig_file_exclusive
bool sig_file_exclusive
Definition: suricata.h:129
PROG_VER
#define PROG_VER
Definition: suricata.h:71
util-misc.h
PacketPoolDestroy
void PacketPoolDestroy(void)
Definition: tmqh-packetpool.c:274
HTPFreeConfig
void HTPFreeConfig(void)
Clears the HTTP server configuration memory used by HTP library.
Definition: app-layer-htp.c:1626
flow.h
LandlockSandboxing
void LandlockSandboxing(SCInstance *suri)
Definition: util-landlock.c:36
respond-reject.h
SCInstance_::regex_arg
char * regex_arg
Definition: suricata.h:131
ListKeywords
int ListKeywords(const char *keyword_info)
Definition: util-running-modes.c:32
SCLogNotice
#define SCLogNotice(...)
Macro used to log NOTICE messages.
Definition: util-debug.h:237
SuricataPreInit
void SuricataPreInit(const char *progname)
Definition: suricata.c:2913
RUNMODE_PCAP_FILE
@ RUNMODE_PCAP_FILE
Definition: runmodes.h:30
DPDKCleanupEAL
void DPDKCleanupEAL(void)
Definition: util-dpdk.c:28
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
RUNMODE_PRINT_BUILDINFO
@ RUNMODE_PRINT_BUILDINFO
Definition: runmodes.h:50
SCConfNode_
Definition: conf.h:32
SCPidfileRemove
void SCPidfileRemove(const char *pid_filename)
Remove the pid file (used at the startup)
Definition: util-pidfile.c:83
SCConfNode_::val
char * val
Definition: conf.h:34
ThresholdInit
void ThresholdInit(void)
Definition: detect-engine-threshold.c:66
TimeInit
void TimeInit(void)
Definition: util-time.c:79
SCInstance_::keyword_info
char * keyword_info
Definition: suricata.h:135
RUNMODE_LIST_UNITTEST
@ RUNMODE_LIST_UNITTEST
Definition: runmodes.h:54
NFQContextsClean
void NFQContextsClean(void)
Clean global contexts. Must be called on exit.
Definition: source-nfq.c:1300
SystemHugepageEvaluateHugepages
void SystemHugepageEvaluateHugepages(SystemHugepageSnapshot *pre_s, SystemHugepageSnapshot *post_s)
The function compares two hugepage snapshots and prints out recommendations for hugepage configuratio...
Definition: util-hugepages.c:363
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:102
SCFinalizeRunMode
int SCFinalizeRunMode(void)
Definition: suricata.c:2378
SCStat
struct stat SCStat
Definition: util-path.h:33
SCProfilingInit
void SCProfilingInit(void)
Initialize profiling.
Definition: util-profiling.c:133
g_ut_modules
int g_ut_modules
Definition: suricata.c:895
detect-engine-address.h
GlobalsDestroy
void GlobalsDestroy(void)
Definition: suricata.c:372
output.h
util-threshold-config.h
DefragInit
void DefragInit(void)
Definition: defrag.c:1112
DetectEngineReloadIsStart
int DetectEngineReloadIsStart(void)
Definition: detect-engine.c:2165
suricata_ctl_flags
volatile uint8_t suricata_ctl_flags
Definition: suricata.c:171
RUNMODE_IPFW
@ RUNMODE_IPFW
Definition: runmodes.h:33
host-bit.h
detect-engine-threshold.h
RUNMODE_LIST_RUNMODES
@ RUNMODE_LIST_RUNMODES
Definition: runmodes.h:48
app-layer.h
TagDestroyCtx
void TagDestroyCtx(void)
Destroy tag context hash tables.
Definition: detect-engine-tag.c:72
DetectAddressTestConfVars
int DetectAddressTestConfVars(void)
Definition: detect-engine-address.c:1217
g_disable_randomness
int g_disable_randomness
Definition: suricata.c:194
geteuid
#define geteuid()
Definition: win32-misc.h:41
FlowWorkToDoCleanup
void FlowWorkToDoCleanup(void)
Clean up all the flows that have unprocessed segments and have some work to do in the detection engin...
Definition: flow-timeout.c:422
MpmHSGlobalCleanup
void MpmHSGlobalCleanup(void)
RUNMODE_DUMP_FEATURES
@ RUNMODE_DUMP_FEATURES
Definition: runmodes.h:61
g_disable_hashing
bool g_disable_hashing
Definition: suricata.c:213
TmqResetQueues
void TmqResetQueues(void)
Definition: tm-queues.c:80