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