suricata-common.h File Reference

#include <pcre.h>
#include <jansson.h>
#include "util-optimize.h"
#include <htp/htp.h>
#include "threads.h"
#include "tm-threads-common.h"
#include "util-debug.h"
#include "util-error.h"
#include "util-mem.h"
#include "detect-engine-alert.h"
#include "util-path.h"
#include "util-conf.h"

Include dependency graph for suricata-common.h:

Go to the source code of this file.

Macros
#define	TRUE   1
#define	FALSE   0
#define	_GNU_SOURCE
#define	__USE_GNU
#define	CLS   64
#define	JSON_ESCAPE_SLASH   0
#define	json_boolean(val)   SCJsonBool((val))
#define	xstr(s)   str(s)
#define	str(s)   #s
#define	BUG_ON(x)
#define	SigIntId   uint32_t
#define	PatIntId   uint32_t
#define	__WORDSIZE   32
#define	pcre_free_study   pcre_free
#define	MIN(x, y)   (((x)<(y))?(x):(y))
#define	MAX(x, y)   (((x)<(y))?(y):(x))
#define	BIT_U8(n)   ((uint8_t)(1 << (n)))
#define	BIT_U16(n)   ((uint16_t)(1 << (n)))
#define	BIT_U32(n)   (1UL << (n))
#define	BIT_U64(n)   (1ULL << (n))
#define	WARN_UNUSED   __attribute__((warn_unused_result))
#define	SCNtohl(x)   (uint32_t)ntohl((x))
#define	SCNtohs(x)   (uint16_t)ntohs((x))
#define	SWAP_FLAGS(flags, a, b)
#define	SWAP_VARS(type, a, b)
#define	ARRAY_SIZE(arr)   (sizeof(arr) / sizeof(arr[0]))

Typedefs
typedef enum PacketProfileDetectId_	PacketProfileDetectId

Enumerations
enum	PacketProfileDetectId_ {   PROF_DETECT_SETUP, PROF_DETECT_GETSGH, PROF_DETECT_IPONLY, PROF_DETECT_RULES,   PROF_DETECT_TX, PROF_DETECT_PF_PKT, PROF_DETECT_PF_PAYLOAD, PROF_DETECT_PF_TX,   PROF_DETECT_PF_SORT1, PROF_DETECT_PF_SORT2, PROF_DETECT_NONMPMLIST, PROF_DETECT_ALERT,   PROF_DETECT_TX_UPDATE, PROF_DETECT_CLEANUP, PROF_DETECT_SIZE }
enum	LoggerId {   LOGGER_UNDEFINED, LOGGER_DNS_TS, LOGGER_DNS_TC, LOGGER_HTTP,   LOGGER_TLS_STORE, LOGGER_TLS, LOGGER_JSON_DNS_TS, LOGGER_JSON_DNS_TC,   LOGGER_JSON_HTTP, LOGGER_JSON_SMTP, LOGGER_JSON_TLS, LOGGER_JSON_NFS,   LOGGER_JSON_TFTP, LOGGER_JSON_FTP, LOGGER_JSON_DNP3_TS, LOGGER_JSON_DNP3_TC,   LOGGER_JSON_SSH, LOGGER_JSON_SMB, LOGGER_JSON_IKEV2, LOGGER_JSON_KRB5,   LOGGER_JSON_DHCP, LOGGER_JSON_SNMP, LOGGER_JSON_SIP, LOGGER_JSON_TEMPLATE_RUST,   LOGGER_JSON_TEMPLATE, LOGGER_JSON_RDP, LOGGER_ALERT_DEBUG, LOGGER_ALERT_FAST,   LOGGER_UNIFIED2, LOGGER_ALERT_SYSLOG, LOGGER_DROP, LOGGER_JSON_ALERT,   LOGGER_JSON_ANOMALY, LOGGER_JSON_DROP, LOGGER_FILE_STORE, LOGGER_JSON_FILE,   LOGGER_TCP_DATA, LOGGER_JSON_FLOW, LOGGER_JSON_NETFLOW, LOGGER_STATS,   LOGGER_JSON_STATS, LOGGER_PRELUDE, LOGGER_PCAP, LOGGER_JSON_METADATA,   LOGGER_SIZE }

Functions
size_t	strlcat (char *, const char *src, size_t siz)
size_t	strlcpy (char *dst, const char *src, size_t siz)
char *	strptime (const char *__restrict, const char *__restrict, struct tm *__restrict)

Variables
int	coverage_unittests
int	g_ut_modules
int	g_ut_covered

Detailed Description

Author

Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

Common includes, etc.

Definition in file suricata-common.h.

Macro Definition Documentation

#define __USE_GNU

Definition at line 37 of file suricata-common.h.

#define __WORDSIZE   32

FreeBSD does not define WORDSIZE, but it uses __LONG_BIT Windows does not define __WORDSIZE, but it uses __X86 if not succesful yet try the data models

Definition at line 321 of file suricata-common.h.

#define _GNU_SOURCE

Definition at line 36 of file suricata-common.h.

#define ARRAY_SIZE

(

arr

)

(sizeof(arr) / sizeof(arr[0]))

Definition at line 498 of file suricata-common.h.

Referenced by EngineAnalysisRules(), and EngineAnalysisRules2().

#define BIT_U16

(

n

)

((uint16_t)(1 << (n)))

Definition at line 368 of file suricata-common.h.

#define BIT_U32

(

n

)

(1UL << (n))

Definition at line 369 of file suricata-common.h.

Referenced by DetectEngineStateResetTxs().

#define BIT_U64

(

n

)

(1ULL << (n))

Definition at line 370 of file suricata-common.h.

#define BIT_U8

(

n

)

((uint8_t)(1 << (n)))

Definition at line 367 of file suricata-common.h.

#define BUG_ON

(

x

)

Value:

do {      \
            if (((x))) {            \
                fprintf(stderr, "BUG at %s:%d(%s)\n", __FILE__, __LINE__, __func__);    \
                fprintf(stderr, "Code: '%s'\n", xstr((x)));                             \
                exit(EXIT_FAILURE); \
            }                       \
        } while(0)

Definition at line 265 of file suricata-common.h.

Referenced by AppLayerIncTxCounter(), AppLayerParserParse(), AppLayerParserStreamTruncated(), AppLayerProtoDetectConfProtoDetectionEnabled(), BypassedFlowManagerThreadSpawn(), DecodeDer(), DecodeRegisterPerfCounters(), DefragHashShutdown(), DefragTrackerDequeue(), DefragTrackerEnqueue(), DetectAddressInsert(), DetectAddressMapFree(), DetectAddressParseString(), DetectAppLayerInspectEngineRegister(), DetectAppLayerInspectEngineRegister2(), DetectAppLayerMpmRegister2(), DetectAppLayerMpmRegisterByParentId(), DetectBufferGetActiveList(), DetectBufferSetActiveList(), DetectBufferTypeCloseRegistration(), DetectBufferTypeGetByIdTransforms(), DetectBufferTypeGetNameById(), DetectBufferTypeMaxId(), DetectBufferTypeRegister(), DetectBufferTypeRegisterSetupCallback(), DetectBufferTypeRegisterValidateCallback(), DetectBufferTypeSupportsMpm(), DetectBufferTypeSupportsPacket(), DetectBufferTypeSupportsTransformations(), DetectContentPropagateLimits(), DetectDatarepBufferMatch(), DetectDatasetBufferMatch(), DetectEngineAppInspectionEngine2Signature(), DetectEngineAppInspectionEngineSignatureFree(), DetectEngineContentInspection(), DetectEngineDeReference(), DetectEngineInspectPktBufferGeneric(), DetectEngineResetMaxSigId(), DetectFilestoreRegister(), DetectFlowintMatch(), DetectFlowSetupImplicit(), DetectHttpClientBodyRegister(), DetectIpv4hdrRegister(), DetectIpv6hdrRegister(), DetectLoadersInit(), DetectLoaderThreadSpawn(), DetectLuaRegister(), DetectMpmInitializeAppMpms(), DetectMpmInitializePktMpms(), DetectPktInspectEngineRegister(), DetectPktMpmRegister(), DetectPktMpmRegisterByParentId(), DetectPortCmp(), DetectPortInsert(), DetectRegisterThreadCtxFuncs(), DetectRegisterThreadCtxGlobalFuncs(), DetectSetFastPatternAndItsId(), DetectSetupParseRegexes(), DetectTagRegister(), DetectTcphdrRegister(), DetectUdphdrRegister(), DetectUricontentRegister(), FileContainerSetTx(), FileForceHashParseCfg(), FlowDequeue(), FlowDisableFlowManagerThread(), FlowEnqueue(), FlowForceReassemblyForFlow(), FlowManagerThreadSpawn(), FlowRecyclerThreadSpawn(), FlowShutdown(), HostDequeue(), HostEnqueue(), HostShutdown(), HtpConfigRestoreBackup(), HttpHeaderGetBufferSpaceForTXID(), HttpXFFGetCfg(), InspectionBufferApplyTransforms(), IPPairDequeue(), IPPairEnqueue(), IPPairShutdown(), JsonBuildFileInfoRecord(), MimeDecParseFullMsg(), MpmAddPattern(), MpmStoreFree(), MpmStorePrepareBuffer(), OutputFlowLogThreadInit(), OutputRegisterFiledataLogger(), OutputRegisterFileLogger(), OutputRegisterPacketLogger(), OutputRegisterTxLogger(), OutputStatsLog(), PacketCreateMask(), PacketDequeue(), PacketPoolDestroy(), PacketPoolGetPacket(), PacketPoolInit(), PacketPoolInitEmpty(), PacketPoolReturnPacket(), PcapFileGlobalInit(), PrefilterInit(), RetrieveFPForSig(), RulesDumpMatchArray(), RunModeShutDown(), SCProfilingKeywordInitCounters(), SCProfilingKeywordThreadSetup(), SCProfilingPrefilterInitCounters(), SCProfilingRuleInitCounters(), SCProfilingSghInitCounters(), SCProtoNameInit(), SCThresholdConfInitContext(), SigAddressCleanupStage1(), SigGroupHeadBuildMatchArray(), SigGroupHeadBuildNonPrefilterArray(), SigMatchFree(), SigMatchList2DataArray(), SpmDestroyCtx(), SpmDestroyThreadCtx(), SpmInitCtx(), SpmInitGlobalThreadCtx(), SpmMakeThreadCtx(), SRepHostTimedOut(), SRepLoadCatFileFromFD(), StatsAddUI64(), StatsGetLocalCounterValue(), StatsIncr(), StatsInit(), StatsRegisterGlobalCounter(), StatsSetUI64(), StorageAllocById(), StorageAllocByIdPrealloc(), StorageFree(), StorageFreeAll(), StorageFreeById(), StorageGetById(), StorageSetById(), StreamingBufferAppend(), StreamingBufferFree(), StreamingBufferInsertAt(), StreamingBufferSBBGetDataAtOffset(), StreamNeedsReassembly(), StreamReassembleRawUpdateProgress(), StreamTcpDecrMemuse(), StreamTcpInlineSegmentCompare(), StreamTcpInlineSegmentReplacePacket(), StreamTcpReassembleDecrMemuse(), StreamTcpReassembleTriggerRawReassembly(), StreamTcpReassemblySetMinInspectDepth(), StringSet(), TagDestroyCtx(), TagTimeoutCheck(), TcpSegmentCompare(), THashCleanup(), THashDataQueueNew(), THashInit(), THashShutdown(), TmModuleDecodeAFPRegister(), TmThreadKillThreadsFamily(), TmThreadRemove(), TmThreadsRegisterThread(), TmThreadsSlotVarRun(), TmThreadWakeupDetectLoaderThreads(), UTHBuildFlow(), VarNameStoreLookupById(), VarNameStoreLookupByName(), and VarNameStoreSetupStaging().

#define CLS   64

Definition at line 45 of file suricata-common.h.

Referenced by EngineDone(), FlowInitConfig(), HostInitConfig(), IPPairInitConfig(), PrefilterAppendEngine(), PrefilterAppendPayloadEngine(), PrefilterAppendTxEngine(), and PrefilterSetupRuleGroup().

#define FALSE   0

Definition at line 34 of file suricata-common.h.

Referenced by AlertFastLogCondition(), AlertJsonHeader(), AppLayerParserSupportsFiles(), AppLayerParserSupportsTxDetectState(), DecodeIPV6FragHeader(), DefragInit(), DefragInitConfig(), DetectAckRegister(), DetectAddressLookupInHead(), DetectAppLayerEventRegister(), DetectBufferTypeSupportsMpmGetById(), DetectBufferTypeSupportsPacketGetById(), DetectContentPMATCHValidateCallback(), DetectDsizeRegister(), DetectFlagsSignatureNeedsSynOnlyPackets(), DetectFlowFree(), DetectFragBitsRegister(), DetectFragOffsetFree(), DetectHttpHHRegister(), DetectHttpMethodRegister(), DetectHttpRawHeaderRegister(), DetectIcmpIdFree(), DetectIcmpIdRegister(), DetectIcmpSeqFree(), DetectIcmpSeqRegister(), DetectICodeFree(), DetectIdFree(), DetectITypeFree(), DetectPortListsAreEqual(), DetectSeqRegister(), DetectTcpmssFree(), DetectTemplate2Free(), DetectTlsFingerprintRegister(), DetectTlsJa3HashRegister(), DetectTlsJa3SHashRegister(), DetectTlsSerialRegister(), DetectTtlFree(), FlowInitConfig(), GetProgramVersion(), HostInitConfig(), HTPFreeConfig(), IPPairInitConfig(), OutputRegisterTxLogger(), PostRunDeinit(), PrefilterSetupPacketHeader(), RegisterAllModules(), RunModeInitialize(), SCHInfoAddHostOSInfo(), SCProtoNameValid(), SigMatchList2DataArray(), StatsSetUI64(), StreamNeedsReassembly(), StreamReassembleRawHasDataReady(), TagTimeoutCheck(), TimeModeSetOffline(), TmValidateQueueState(), and Unified2Condition().

#define json_boolean

(

val

)

SCJsonBool((val))

Definition at line 245 of file suricata-common.h.

Referenced by EngineAnalysisRules2(), JsonAddFlow(), JsonBuildFileInfoRecord(), JsonDNP3LogRequest(), and JsonDNP3LogResponse().

#define JSON_ESCAPE_SLASH   0

Definition at line 241 of file suricata-common.h.

Referenced by EngineAnalysisRules2(), PacketCreateMask(), RulesDumpMatchArray(), SCConfLogOpenGeneric(), SCProfilingRulesGlobalInit(), and SCProfilingSghsGlobalInit().

#define MAX	(		x,
			y
	)		(((x)<(y))?(y):(x))

Definition at line 364 of file suricata-common.h.

Referenced by AppLayerParserDestroyProtocolParserLocalStorage(), AppLayerParserTransactionsCleanup(), DetectEngineAppInspectionEngineSignatureFree(), DetectFlowbitMatch(), DetectFlowbitsAnalyze(), FileTrackedSize(), FlowGetPacketDirection(), InspectionBufferMultipleForListGet(), IPPairCleanup(), MpmAddPattern(), PacketCreateMask(), PostRunDeinit(), PrefilterSetupRuleGroup(), SCLogLoadConfig(), SigGroupHeadBuildNonPrefilterArray(), SigGroupHeadCopySigs(), SSLVersionToString(), and VarNameStoreSetupStaging().

#define MIN	(		x,
			y
	)		(((x)<(y))?(x):(y))

Definition at line 360 of file suricata-common.h.

Referenced by DetectBase64DecodeDoMatch(), DetectContentPropagateLimits(), DetectEngineStateResetTxs(), DetectPcrePayloadMatch(), DetectPriorityRegister(), FileGetSwfDecompressedLen(), FileTrackedSize(), FlowGetPacketDirection(), InspectionBufferCopy(), IPPairCleanup(), printUUID(), RunModeSetLiveCaptureAutoFp(), SCProfilingRulesGlobalInit(), SigAddressPrepareStage1(), StreamReassembleRawUpdateProgress(), StreamTcpReassembleInsertSegment(), TLSGetIPInformations(), and TmThreadKillThreadsFamily().

#define PatIntId   uint32_t

same for pattern id's

Definition at line 283 of file suricata-common.h.

Referenced by AppLayerProtoDetectDeSetup(), AppLayerProtoDetectGetCtxThread(), and DetectSetFastPatternAndItsId().

#define pcre_free_study   pcre_free

darwin doesn't defined __BYTE_ORDER and friends, but BYTE_ORDER

Definition at line 356 of file suricata-common.h.

Referenced by DetectParseFreeRegexes(), DetectPcrePayloadMatch(), ParseSizeDeinit(), SCKernelVersionIsAtLeast(), and SCLogAllocLogInitData().

#define SCNtohl

(

x

)

(uint32_t)ntohl((x))

Definition at line 374 of file suricata-common.h.

Referenced by AddressIPv6Gt(), AddressIPv6GtU32(), AddressIPv6Lt(), AddressIPv6LtU32(), DecodeIPV6FragHeader(), DetectAddressCmpIPv4(), DetectAddressCutIPv4(), DetectAddressCutIPv6(), DetectAddressCutNotIPv4(), DetectAddressCutNotIPv6(), DetectAddressIsCompleteIPSpaceIPv4(), DetectAddressJoinIPv4(), DetectAddressJoinIPv6(), DetectAddressMatch(), DetectAddressMatchIPv4(), DetectAddressMatchIPv6(), DetectAddressParseString(), DetectRpcRegister(), DetectSignatureSetAppProto(), and StreamTcpSackUpdatePacket().

#define SCNtohs

(

x

)

(uint16_t)ntohs((x))

Definition at line 375 of file suricata-common.h.

Referenced by __attribute__(), DecodeERSPAN(), DecodeEthernet(), DecodeGRE(), DecodeICMPV6(), DecodeIPV4(), DecodeIPV6FragHeader(), DecodePPP(), DecodePPPOEDiscovery(), DecodePPPOESession(), DecodeSll(), DecodeVXLAN(), DetectCsumRegister(), DetectIcmpIdRegister(), DetectIcmpSeqRegister(), ReceiveErfDagLoop(), ReceiveErfFileLoop(), and UTHParseSignature().

#define SigIntId   uint32_t

type for the internal signature id. Since it's used in the matching engine extensively keeping this as small as possible reduces the overall memory footprint of the engine. Set to uint32_t if the engine needs to support more than 64k sigs.

Definition at line 280 of file suricata-common.h.

Referenced by DetectEngineResetMaxSigId(), IPOnlyCIDRListFree(), MpmAddPattern(), PmqSetup(), PrefilterAddSidsResize(), and SigMatchSignaturesGetSgh().

#define str

(

s

)

#s

Definition at line 256 of file suricata-common.h.

Referenced by AppLayerSetupCounters(), ByteExtractString(), ByteExtractStringInt8(), ByteExtractStringSigned(), CreateTimeString(), DatasetsDestroy(), DetectAddressParseString(), DetectAsn1Register(), DetectBase64DataRegister(), DetectBase64DecodeDoMatch(), DetectBypassRegister(), DetectBytejumpDoMatch(), DetectClasstypeRegister(), DetectContentDataParse(), DetectCsumRegister(), DetectDatarepBufferMatch(), DetectDatasetBufferMatch(), DetectDepthRegister(), DetectDistanceRegister(), DetectDnsQueryRegister(), DetectFileextRegister(), DetectFilemagicRegister(), DetectFileMd5Register(), DetectFilenameRegister(), DetectFileSha1Register(), DetectFileSha256Register(), DetectFilesizeRegister(), DetectFilestoreRegister(), DetectFlowbitMatch(), DetectFtpdataRegister(), DetectGeoipRegister(), DetectHttpClientBodyRegister(), DetectHttpCookieRegister(), DetectHttpHHRegister(), DetectHttpMethodRegister(), DetectHttpRawHeaderRegister(), DetectHttpServerBodyRegister(), DetectHttpStatCodeRegister(), DetectHttpStatMsgRegister(), DetectHttpUARegister(), DetectHttpUriSetup(), DetectL3ProtoRegister(), DetectLuaRegister(), DetectMsgRegister(), DetectOffsetRegister(), DetectPktDataRegister(), DetectProtoContainsProto(), DetectReferenceFree(), DetectSNMPCommunityRegister(), DetectSshSoftwareVersionRegister(), DetectSshVersionRegister(), DetectSslVersionRegister(), DetectTemplateBufferRegister(), DetectTemplateRustBufferRegister(), DetectTlsCertsRegister(), DetectTlsFingerprintRegister(), DetectTlsIssuerRegister(), DetectTlsJa3HashRegister(), DetectTlsJa3SHashRegister(), DetectTlsJa3SStringRegister(), DetectTlsJa3StringRegister(), DetectTlsRegister(), DetectTlsSerialRegister(), DetectTlsSniRegister(), DetectTlsSubjectRegister(), DetectTlsVersionRegister(), DetectUrilenValidateContent(), DetectWithinRegister(), DetectXbitMatchHost(), FTPMemcapGlobalCounter(), GetProgramVersion(), HtpConfigRestoreBackup(), JsonBuildFileInfoRecord(), Md5StrHash(), MimeDecParseFullMsg(), ParseSizeDeinit(), PoolPrintSaturation(), SCAsn1Decode(), SCClassConfDeInitContext(), SCLogAllocLogOPBuffer(), SCLogDeInitLogModule(), SCRadixPrintTree(), SCRConfDeInitContext(), Sha256StrHash(), ShortenString(), SMTPStateAlloc(), StatsToJSON(), TmqhOutputFlowIPPair(), TmqhOutputFlowSetupCtx(), and UnixSocketPcapFile().

#define SWAP_FLAGS	(		flags,
			a,
			b
	)

Value:

do {                                            \
        if (((flags) & ((a)|(b))) == (a)) {         \
            (flags) &= ~(a);                        \
            (flags) |= (b);                         \
        } else if (((flags) & ((a)|(b))) == (b)) {  \
            (flags) &= ~(b);                        \
            (flags) |= (a);                         \
        }                                           \
    } while(0)

Definition at line 378 of file suricata-common.h.

Referenced by AppLayerHandleUdp(), AppLayerIncTxCounter(), and FlowChangeProto().

#define SWAP_VARS	(		type,
			a,
			b
	)

Value:

do {                                \
        type t = (a);                   \
        (a) = (b);                      \
        (b) = t;                        \
    } while (0)

Definition at line 389 of file suricata-common.h.

Referenced by FlowChangeProto(), and FlowSwap().

#define TRUE   1

Definition at line 33 of file suricata-common.h.

Referenced by AlertFastLogCondition(), AlertFastLogger(), AlertJsonHeader(), AppLayerParserRestoreParserTable(), AppLayerParserSupportsFiles(), AppLayerParserSupportsTxDetectState(), DecodeIPV6FragHeader(), DetectAckRegister(), DetectAddressLookupInHead(), DetectAppLayerEventRegister(), DetectBufferRunValidateCallback(), DetectBufferTypeSupportsMpm(), DetectBufferTypeSupportsPacket(), DetectBypassRegister(), DetectContentPMATCHValidateCallback(), DetectDceIfaceRegister(), DetectDceOpnumRegister(), DetectDceStubDataRegister(), DetectDNP3Register(), DetectDnsQueryRegister(), DetectDsizeRegister(), DetectEngineInspectENIP(), DetectEngineInspectModbus(), DetectEngineStateResetTxs(), DetectFlagsSignatureNeedsSynOnlyPackets(), DetectFlowFree(), DetectFragBitsRegister(), DetectFragOffsetFree(), DetectFtpbounceRegister(), DetectHostbitFree(), DetectHttpHHRegister(), DetectHttpMethodRegister(), DetectHttpRawHeaderRegister(), DetectHttpRequestLineRegister(), DetectHttpResponseLineRegister(), DetectIcmpIdFree(), DetectIcmpIdRegister(), DetectIcmpSeqFree(), DetectIcmpSeqRegister(), DetectICodeFree(), DetectIdFree(), DetectITypeFree(), DetectLuaRegister(), DetectPcrePayloadMatch(), DetectPortListsAreEqual(), DetectSeqRegister(), DetectSshSoftwareVersionRegister(), DetectSshVersionRegister(), DetectTcpmssFree(), DetectTemplate2Free(), DetectTemplateRustBufferRegister(), DetectTlsFingerprintRegister(), DetectTlsJa3HashRegister(), DetectTlsJa3SHashRegister(), DetectTlsSerialRegister(), DetectTtlFree(), DetectUricontentRegister(), DetectUrilenValidateContent(), DetectXbitFree(), FTPParserCleanup(), GetProgramVersion(), HostBitList(), HtpConfigRestoreBackup(), HTPFileClose(), IPPairBitIsnotset(), JsonFiveTuple(), OutputRegisterPacketLogger(), PrefilterSetupPacketHeaderU8Hash(), PrefilterSetupRuleGroup(), RegisterDCERPCParsers(), RegisterDCERPCUDPParsers(), RegisterDNP3Parsers(), RegisterENIPTCPParsers(), RegisterModbusParsers(), RegisterSMBParsers(), RegisterSSHParsers(), RunModeInitialize(), SCHInfoAddHostOSInfo(), SCLogAllocLogOPBuffer(), SCProtoNameValid(), SigAddressPrepareStage1(), SigLoadSignatures(), SigMatchListSMBelongsTo(), SMTPParserCleanup(), SSLJA3IsEnabled(), StatsEnabled(), StreamReassembleRaw(), StreamTcpAppLayerIsDisabled(), StreamTcpPacket(), StreamTcpReassembleInsertSegment(), StreamTcpUTDeinit(), StreamTcpUTInit(), TagTimeoutCheck(), THashCleanup(), TimeGet(), TimeModeSetLive(), TimeSet(), TimeSetByThread(), TmValidateQueueState(), and Unified2Condition().

#define WARN_UNUSED   __attribute__((warn_unused_result))

Definition at line 372 of file suricata-common.h.

#define xstr

(

s

)

str(s)

Definition at line 255 of file suricata-common.h.

Referenced by EngineDone(), GetProgramVersion(), and ReceivePcapThreadInit().

Typedef Documentation

typedef enum PacketProfileDetectId_ PacketProfileDetectId

Enumeration Type Documentation

enum LoggerId

Note

update PacketProfileLoggertIdToString if you change anything here

Enumerator
LOGGER_UNDEFINED
LOGGER_DNS_TS
LOGGER_DNS_TC
LOGGER_HTTP
LOGGER_TLS_STORE
LOGGER_TLS
LOGGER_JSON_DNS_TS
LOGGER_JSON_DNS_TC
LOGGER_JSON_HTTP
LOGGER_JSON_SMTP
LOGGER_JSON_TLS
LOGGER_JSON_NFS
LOGGER_JSON_TFTP
LOGGER_JSON_FTP
LOGGER_JSON_DNP3_TS
LOGGER_JSON_DNP3_TC
LOGGER_JSON_SSH
LOGGER_JSON_SMB
LOGGER_JSON_IKEV2
LOGGER_JSON_KRB5
LOGGER_JSON_DHCP
LOGGER_JSON_SNMP
LOGGER_JSON_SIP
LOGGER_JSON_TEMPLATE_RUST
LOGGER_JSON_TEMPLATE
LOGGER_JSON_RDP
LOGGER_ALERT_DEBUG
LOGGER_ALERT_FAST
LOGGER_UNIFIED2
LOGGER_ALERT_SYSLOG
LOGGER_DROP
LOGGER_JSON_ALERT
LOGGER_JSON_ANOMALY
LOGGER_JSON_DROP
LOGGER_FILE_STORE
LOGGER_JSON_FILE
LOGGER_TCP_DATA
LOGGER_JSON_FLOW
LOGGER_JSON_NETFLOW
LOGGER_STATS
LOGGER_JSON_STATS
LOGGER_PRELUDE
LOGGER_PCAP
LOGGER_JSON_METADATA
LOGGER_SIZE

Definition at line 416 of file suricata-common.h.

enum PacketProfileDetectId_

Enumerator
PROF_DETECT_SETUP
PROF_DETECT_GETSGH
PROF_DETECT_IPONLY
PROF_DETECT_RULES
PROF_DETECT_TX
PROF_DETECT_PF_PKT
PROF_DETECT_PF_PAYLOAD
PROF_DETECT_PF_TX
PROF_DETECT_PF_SORT1
PROF_DETECT_PF_SORT2
PROF_DETECT_NONMPMLIST
PROF_DETECT_ALERT
PROF_DETECT_TX_UPDATE
PROF_DETECT_CLEANUP
PROF_DETECT_SIZE

Definition at line 396 of file suricata-common.h.

Function Documentation

size_t strlcat	(	char *	,
		const char *	src,
		size_t	siz
	)

Definition at line 45 of file util-strlcatu.c.

References dst, and src.

Referenced by Asn1DerGetIssuerDN(), Asn1DerGetSerial(), Asn1DerGetSubjectDN(), ConfDeInit(), ConfLoadCompleteIncludePath(), DatasetsDestroy(), DetectAppLayerMpmRegisterByParentId(), DetectEngineEventRegister(), DetectLoadCompleteSigPath(), DetectMpmInitializeAppMpms(), DetectMpmInitializePktMpms(), DetectMpmPreparePktMpms(), EngineDone(), hexdump(), RunmodeAutoFpCreatePickupQueuesString(), ShortenString(), SRepLoadFileFromFD(), SSLVersionToString(), and StringAsBase64().

Here is the caller graph for this function:

size_t strlcpy	(	char *	dst,
		const char *	src,
		size_t	siz
	)

Definition at line 43 of file util-strlcpyu.c.

References dst, and src.

Referenced by AddVariableToResolveList(), AFPPeersListCheck(), AlertFastLogger(), BytesToStringBuffer(), ConfGetNode(), ConfigSetDataDirectory(), ConfLoadCompleteIncludePath(), DatasetGet(), DatasetsInit(), DetectAddressParseString(), DetectAppLayerEventRegister(), DetectAppLayerMpmRegisterByParentId(), DetectBytejumpDoMatch(), DetectClasstypeRegister(), DetectContentDataParse(), DetectDatarepBufferMatch(), DetectDatasetBufferMatch(), DetectEngineInspectPktBufferGeneric(), DetectGeoipRegister(), DetectLoadCompleteSigPath(), DetectMetadataHashFree(), DetectMsgRegister(), DetectPcrePayloadMatch(), DetectTlsValidityRegister(), GetIfaceMaxPacketSize(), GetIfaceMTU(), GetIfaceRSSQueuesNum(), GetProgramVersion(), HtpConfigRestoreBackup(), JsonFiveTuple(), LiveGetDeviceNameName(), LogCustomFormatParse(), LogTcpDataLogInitCtx(), NapatechGetStreamConfig(), NapatechSetupTraffic(), NoWinDivertSupportExit(), OutputEngineStatsRuleset(), PcapFileDispatch(), PcapTranslateIPToDevice(), PoolPrintSaturation(), PortParse(), PostRunDeinit(), ReceiveAFPLoop(), ReceiveAFPThreadInit(), RegisterSSHParsers(), RunModeIdsAFPRegister(), RunModeIdsNetmapRegister(), RunModeIdsNflogRegister(), RunModeIdsPcapRegister(), RunModeIdsPfringRegister(), SCCreateDirectoryTree(), SCRadixAddKeyIPV4String(), SCRadixAddKeyIPV6String(), SCTimeToStringPattern(), SigMatchListSMBelongsTo(), SRepHostTimedOut(), SRepLoadCatFileFromFD(), SRepLoadFileFromFD(), StringAsBase64(), TmModuleDecodeNetmapRegister(), TmThreadCreate(), and UnixSocketPcapFile().

char* strptime	(	const char *	__restrict,
		const char *	__restrict,
		struct tm *	__restrict
	)

Definition at line 97 of file util-strptime.c.

References ALT_E, ALT_O, LEGAL_ALT, len, and TIME_MAX.

Referenced by SCStringPatternToTime().

Here is the caller graph for this function:

Variable Documentation

int coverage_unittests

Definition at line 860 of file suricata.c.

Referenced by GetProgramVersion(), MpmRegisterTests(), SigTableRegisterTests(), and TmModuleRegisterTests().

int g_ut_covered

Definition at line 862 of file suricata.c.

Referenced by MpmRegisterTests(), SigTableRegisterTests(), and TmModuleRegisterTests().

int g_ut_modules

Definition at line 861 of file suricata.c.

Referenced by MpmRegisterTests(), SigTableRegisterTests(), and TmModuleRegisterTests().