suricata
|
Go to the source code of this file.
Data Structures | |
struct | SCInstance_ |
Macros | |
#define | PROG_NAME "Suricata" |
#define | PROG_VER PACKAGE_VERSION |
#define | DEFAULT_CONF_FILE CONFIG_DIR "/suricata.yaml" |
#define | DEFAULT_PID_DIR LOCAL_STATE_DIR "/run/" |
#define | DEFAULT_PID_BASENAME "suricata.pid" |
#define | DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME |
#define | DOC_URL "https://docs.suricata.io/en/" |
#define | SURICATA_STOP (1 << 0) |
#define | SURICATA_DONE (1 << 2) |
#define | IS_SURI_HOST_MODE_SNIFFER_ONLY(host_mode) ((host_mode) == SURI_HOST_IS_SNIFFER_ONLY) |
Typedefs | |
typedef struct SCInstance_ | SCInstance |
Enumerations | |
enum | { SURICATA_INIT = 0, SURICATA_RUNTIME, SURICATA_DEINIT } |
enum | EngineMode { ENGINE_MODE_UNKNOWN, ENGINE_MODE_IDS, ENGINE_MODE_IPS } |
enum | { SURI_HOST_IS_SNIFFER_ONLY, SURI_HOST_IS_ROUTER } |
Functions | |
const char * | GetDocURL (void) |
void | EngineModeSetIPS (void) |
void | EngineModeSetIDS (void) |
int | EngineModeIsUnknown (void) |
int | EngineModeIsIPS (void) |
int | EngineModeIsIDS (void) |
void | GlobalsInitPreConfig (void) |
void | EngineStop (void) |
make sure threads can stop the engine by calling this function. Purpose: pcap file mode needs to be able to tell the engine the file eof is reached. More... | |
void | EngineDone (void) |
Used to indicate that the current task is done. More... | |
int | RunmodeIsUnittests (void) |
int | RunmodeGetCurrent (void) |
int | SuriHasSigFile (void) |
int | SuricataMain (int argc, char **argv) |
int | InitGlobal (void) |
Global initialization common to all runmodes. More... | |
int | PostConfLoadedSetup (SCInstance *suri) |
void | PostConfLoadedDetectSetup (SCInstance *suri) |
void | PreRunInit (const int runmode) |
void | PreRunPostPrivsDropInit (const int runmode) |
void | PostRunDeinit (const int runmode, struct timeval *start_time) |
void | RegisterAllModules (void) |
const char * | GetProgramVersion (void) |
get string with program version More... | |
Variables | |
volatile uint8_t | suricata_ctl_flags |
int | g_disable_randomness |
uint16_t | g_vlan_mask |
uint16_t | g_livedev_mask |
bool | g_disable_hashing |
int | run_mode |
Definition in file suricata.h.
#define DEFAULT_CONF_FILE CONFIG_DIR "/suricata.yaml" |
Definition at line 80 of file suricata.h.
#define DEFAULT_PID_BASENAME "suricata.pid" |
Definition at line 83 of file suricata.h.
#define DEFAULT_PID_DIR LOCAL_STATE_DIR "/run/" |
Definition at line 82 of file suricata.h.
#define DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME |
Definition at line 84 of file suricata.h.
#define DOC_URL "https://docs.suricata.io/en/" |
Definition at line 86 of file suricata.h.
#define IS_SURI_HOST_MODE_SNIFFER_ONLY | ( | host_mode | ) | ((host_mode) == SURI_HOST_IS_SNIFFER_ONLY) |
Definition at line 120 of file suricata.h.
#define PROG_NAME "Suricata" |
Definition at line 71 of file suricata.h.
#define PROG_VER PACKAGE_VERSION |
Definition at line 72 of file suricata.h.
#define SURICATA_DONE (1 << 2) |
packets capture ended
Definition at line 92 of file suricata.h.
#define SURICATA_STOP (1 << 0) |
gracefully stop the engine: process all outstanding packets first
Definition at line 91 of file suricata.h.
typedef struct SCInstance_ SCInstance |
anonymous enum |
Enumerator | |
---|---|
SURICATA_INIT | |
SURICATA_RUNTIME | |
SURICATA_DEINIT |
Definition at line 94 of file suricata.h.
anonymous enum |
Enumerator | |
---|---|
SURI_HOST_IS_SNIFFER_ONLY | |
SURI_HOST_IS_ROUTER |
Definition at line 114 of file suricata.h.
enum EngineMode |
Enumerator | |
---|---|
ENGINE_MODE_UNKNOWN | |
ENGINE_MODE_IDS | |
ENGINE_MODE_IPS |
Definition at line 101 of file suricata.h.
void EngineDone | ( | void | ) |
Used to indicate that the current task is done.
This is mainly used by pcap-file to tell it has finished to treat a pcap files when running in unix-socket mode.
Definition at line 454 of file suricata.c.
References suricata_ctl_flags, and SURICATA_DONE.
int EngineModeIsIDS | ( | void | ) |
Definition at line 235 of file suricata.c.
References DEBUG_VALIDATE_BUG_ON.
int EngineModeIsIPS | ( | void | ) |
Definition at line 229 of file suricata.c.
References DEBUG_VALIDATE_BUG_ON.
Referenced by AlertFastLogger(), AlertJsonHeader(), CaptureStatsSetup(), CaptureStatsUpdate(), EveAddVerdict(), ExceptionPolicyParse(), FlowHandlePacketUpdate(), and StreamTcpInitConfig().
int EngineModeIsUnknown | ( | void | ) |
Definition at line 224 of file suricata.c.
Referenced by PostConfLoadedSetup().
void EngineModeSetIDS | ( | void | ) |
Definition at line 246 of file suricata.c.
Referenced by ListAppLayerProtocols(), ListKeywords(), LLVMFuzzerTestOneInput(), PostConfLoadedSetup(), and RunUnittests().
void EngineModeSetIPS | ( | void | ) |
Definition at line 241 of file suricata.c.
void EngineStop | ( | void | ) |
make sure threads can stop the engine by calling this function. Purpose: pcap file mode needs to be able to tell the engine the file eof is reached.
Definition at line 443 of file suricata.c.
References suricata_ctl_flags, and SURICATA_STOP.
Referenced by ReceiveErfFileLoop().
const char* GetDocURL | ( | void | ) |
Definition at line 1107 of file suricata.c.
References DOC_URL, GetProgramVersion(), and PROG_VER.
const char* GetProgramVersion | ( | void | ) |
get string with program version
Get the program version as passed to us from AC_INIT
Add 'RELEASE' is no '-dev' in the version. Add the REVISION if passed to us.
Possible outputs: release: '5.0.1 RELEASE' dev with rev: '5.0.1-dev (64a789bbf 2019-10-18)' dev w/o rev: '5.0.1-dev'
Definition at line 1128 of file suricata.c.
References PROG_VER, and xstr.
Referenced by GetDocURL().
void GlobalsInitPreConfig | ( | void | ) |
Definition at line 354 of file suricata.c.
References FrameConfigInit(), SCProtoNameInit(), SCThresholdConfGlobalInit(), SupportFastPatternForSigMatchTypes(), and TimeInit().
Referenced by LLVMFuzzerTestOneInput(), and RunUnittests().
int InitGlobal | ( | void | ) |
Global initialization common to all runmodes.
This can be used by fuzz targets.
Definition at line 2849 of file suricata.c.
References ConfInit(), ParseSizeInit(), RunModeRegisterRunModes(), SC_ATOMIC_INIT, SCLogError, SCLogInitLogModule(), SCSetThreadName, suricata_context, tmm_modules, TMM_SIZE, UtilSignalBlock(), UtilSignalHandlerSetup(), and VarNameStoreInit().
Referenced by LLVMFuzzerTestOneInput().
void PostConfLoadedDetectSetup | ( | SCInstance * | suri | ) |
Definition at line 2534 of file suricata.c.
References de_ctx, and SCInstance_::disabled_detect.
int PostConfLoadedSetup | ( | SCInstance * | suri | ) |
This function is meant to contain code that needs to be run once the configuration has been loaded.
Definition at line 2625 of file suricata.c.
References AppLayerSetup(), SCInstance_::capture_plugin_args, SCInstance_::capture_plugin_name, SCInstance_::checksum_validation, ConfGet(), ConfGetBool(), ConfSet(), EngineModeIsUnknown(), EngineModeSetIDS(), LiveDeviceFinalize(), LiveDevRegisterExtension(), LiveSetOffloadDisable(), LiveSetOffloadWarn(), MacSetRegisterFlowStorage(), MpmTableSetup(), RegisterFlowBypassInfo(), SCInstance_::run_mode, RUNMODE_AFP_DEV, SCInstance_::runmode_custom_mode, RunModeEngineIsIPS(), SCLogInfo, SCPluginsLoad(), SCReturnInt, SetMasterExceptionPolicy(), SpmTableSetup(), StorageInit(), StringParseUint16(), suricata, and TM_ECODE_FAILED.
Referenced by LLVMFuzzerTestOneInput().
void PostRunDeinit | ( | const int | runmode, |
struct timeval * | start_time | ||
) |
Definition at line 2263 of file suricata.c.
References FlowDisableFlowManagerThread(), FlowForceReassembly(), PacketPoolInit(), RUNMODE_UNIX_SOCKET, TmThreadDisablePacketThreads(), and TmThreadDisableReceiveThreads().
Referenced by PreRunPostPrivsDropInit().
void PreRunInit | ( | const int | runmode | ) |
Definition at line 2212 of file suricata.c.
References AppLayerParserPostStreamSetup(), AppLayerRegisterGlobalCounters(), DefragInit(), FLOW_QUIET, FlowInitConfig(), HttpRangeContainersInit(), IPPairInitConfig(), OutputFilestoreRegisterGlobalCounters(), RUNMODE_UNIX_SOCKET, SCProfilingInit(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingRulesGlobalInit(), SCProfilingSghsGlobalInit(), StatsInit(), STREAM_VERBOSE, and StreamTcpInitConfig().
void PreRunPostPrivsDropInit | ( | const int | runmode | ) |
Definition at line 2241 of file suricata.c.
References DatasetsInit(), PostRunDeinit(), RUNMODE_PCAP_FILE, RUNMODE_UNIX_SOCKET, RunModeInitializeOutputs(), StatsSetupPostConfigPostOutput(), and StatsSetupPostConfigPreOutput().
void RegisterAllModules | ( | void | ) |
Definition at line 886 of file suricata.c.
References TmModuleBypassedFlowManagerRegister(), TmModuleDebugList(), TmModuleDecodeAFPRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleDecodeErfFileRegister(), TmModuleDecodeIPFWRegister(), TmModuleDecodeNetmapRegister(), TmModuleDecodeNFLOGRegister(), TmModuleDecodeNFQRegister(), TmModuleDecodePcapFileRegister(), TmModuleDecodePcapRegister(), TmModuleDecodePfringRegister(), TmModuleDecodeWinDivertRegister(), TmModuleFlowManagerRegister(), TmModuleFlowRecyclerRegister(), TmModuleFlowWorkerRegister(), TmModuleLoggerRegister(), TmModuleNapatechDecodeRegister(), TmModuleNapatechStreamRegister(), TmModuleReceiveAFPRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleReceiveIPFWRegister(), TmModuleReceiveNetmapRegister(), TmModuleReceiveNFLOGRegister(), TmModuleReceiveNFQRegister(), TmModuleReceivePcapFileRegister(), TmModuleReceivePcapRegister(), TmModuleReceivePfringRegister(), TmModuleReceiveWinDivertRegister(), TmModuleRespondRejectRegister(), TmModuleStatsLoggerRegister(), TmModuleUnixManagerRegister(), TmModuleVerdictIPFWRegister(), TmModuleVerdictNFQRegister(), and TmModuleVerdictWinDivertRegister().
Referenced by RunUnittests().
int RunmodeGetCurrent | ( | void | ) |
Definition at line 261 of file suricata.c.
References run_mode.
Referenced by ConfUnixSocketIsEnable(), RunModeGetMainMode(), and SigLoadSignatures().
int RunmodeIsUnittests | ( | void | ) |
Definition at line 252 of file suricata.c.
References run_mode, and RUNMODE_UNITTEST.
Referenced by AppLayerParserConfParserEnabled(), AppLayerProtoDetectConfProtoDetectionEnabledDefault(), DetectEngineThreadCtxInit(), RegisterDNP3Parsers(), RegisterENIPTCPParsers(), RegisterENIPUDPParsers(), RegisterTFTPParsers(), StreamTcpDecrMemuse(), StreamTcpInitConfig(), StreamTcpReassembleDecrMemuse(), StreamTcpThreadCacheReturnSegment(), and StreamTcpThreadCacheReturnSession().
int SuricataMain | ( | int | argc, |
char ** | argv | ||
) |
Definition at line 2886 of file suricata.c.
Referenced by main().
int SuriHasSigFile | ( | void | ) |
Definition at line 219 of file suricata.c.
References SCInstance_::sig_file, and suricata.
bool g_disable_hashing |
Definition at line 214 of file suricata.c.
Referenced by FileForceHashParseCfg(), and SSLEnableJA3().
int g_disable_randomness |
disable randomness to get reproducible results across runs
Definition at line 199 of file suricata.c.
Referenced by RandomGet().
uint16_t g_livedev_mask |
determine (without branching) if we include the livedev ids when hashing or comparing flows
Definition at line 210 of file suricata.c.
Referenced by FlowKeyGetHash().
uint16_t g_vlan_mask |
determine (without branching) if we include the vlan_ids when hashing or comparing flows
Definition at line 206 of file suricata.c.
Referenced by FlowGetIpPairProtoHash(), and FlowKeyGetHash().
int run_mode |
Run mode selected
Definition at line 176 of file suricata.c.
Referenced by RunmodeGetCurrent(), and RunmodeIsUnittests().
volatile uint8_t suricata_ctl_flags |
suricata engine control flags
Definition at line 173 of file suricata.c.
Referenced by EngineDone(), EngineStop(), ReceiveErfDagLoop(), ReceiveErfFileLoop(), and ReceivePfringLoop().