# yaml-language-server: $schema=https://www.schemastore.org/any.json %YAML 1.1 --- # Suricata configuration file. In addition to the comments describing all # options in this file, full documentation can be found at: # https://docs.suricata.io/en/latest/configuration/suricata-yaml.html # This configuration file was generated by Suricata 8.0.0-dev. suricata-version: "8.0" ## ## Step 1: Inform Suricata about your network ## vars: # more specific is better for alert accuracy and performance address-groups: HOME_NET: "[192.168.0.0/16,10.0.0.0/8,172.16.0.0/12]" #HOME_NET: "[192.168.0.0/16]" #HOME_NET: "[10.0.0.0/8]" #HOME_NET: "[172.16.0.0/12]" #HOME_NET: "any" EXTERNAL_NET: "!$HOME_NET" #EXTERNAL_NET: "any" HTTP_SERVERS: "$HOME_NET" SMTP_SERVERS: "$HOME_NET" SQL_SERVERS: "$HOME_NET" DNS_SERVERS: "$HOME_NET" TELNET_SERVERS: "$HOME_NET" AIM_SERVERS: "$EXTERNAL_NET" DC_SERVERS: "$HOME_NET" DNP3_SERVER: "$HOME_NET" DNP3_CLIENT: "$HOME_NET" MODBUS_CLIENT: "$HOME_NET" MODBUS_SERVER: "$HOME_NET" ENIP_CLIENT: "$HOME_NET" ENIP_SERVER: "$HOME_NET" port-groups: HTTP_PORTS: "80" SHELLCODE_PORTS: "!80" ORACLE_PORTS: 1521 SSH_PORTS: 22 DNP3_PORTS: 20000 MODBUS_PORTS: 502 FILE_DATA_PORTS: "[$HTTP_PORTS,110,143]" FTP_PORTS: 21 GENEVE_PORTS: 6081 VXLAN_PORTS: 4789 TEREDO_PORTS: 3544 SIP_PORTS: "[5060, 5061]" ## ## Step 2: Select outputs to enable ## # The default logging directory. Any log or output file will be # placed here if it's not specified with a full path name. This can be # overridden with the -l command line parameter. default-log-dir: /usr/local/var/log/suricata/ # Global stats configuration stats: enabled: yes # The interval field (in seconds) controls the interval at # which stats are updated in the log. interval: 5 # Add decode events to stats. #decoder-events: yes # Decoder event prefix in stats. Has been 'decoder' before, but that leads # to missing events in the eve.stats records. See issue #2225. #decoder-events-prefix: "decoder.event" # Add stream events as stats. #stream-events: no exception-policy: #per-app-proto-errors: no # default: no. yes will log errors for # each app-proto. Warning: VERY verbose # Configure the type of alert (and other) logging you would like. outputs: # a line based alerts log similar to Snort's fast.log - fast: enabled: no filename: fast.log append: yes #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram' # Extensible Event Format (nicknamed EVE) event log in JSON format - eve-log: enabled: yes filetype: regular #regular|syslog|unix_dgram|unix_stream|redis filename: eve.json append: no # Enable for multi-threaded eve.json output; output files are amended with # an identifier, e.g., eve.9.json threaded: no #prefix: "@cee: " # prefix to prepend to each log entry # the following are valid when type: syslog above #identity: "suricata" #facility: local5 #level: Info ## possible levels: Emergency, Alert, Critical, ## Error, Warning, Notice, Info, Debug #ethernet: no # log ethernet header in events when available #redis: # server: 127.0.0.1 # port: 6379 # async: yes ## if redis replies are read asynchronously # mode: list ## possible values: list|lpush (default), rpush, channel|publish # ## lpush and rpush are using a Redis list. "list" is an alias for lpush # ## publish is using a Redis channel. "channel" is an alias for publish # key: suricata ## key or channel to use (default to suricata) # Redis pipelining set up. This will enable to only do a query every # 'batch-size' events. This should lower the latency induced by network # connection at the cost of some memory. There is no flushing implemented # so this setting should be reserved to high traffic Suricata deployments. # pipelining: # enabled: yes ## set enable to yes to enable query pipelining # batch-size: 10 ## number of entries to keep in buffer # Include top level metadata. Default yes. #metadata: no # include the name of the input pcap file in pcap file processing mode pcap-file: no # Community Flow ID # Adds a 'community_id' field to EVE records. These are meant to give # records a predictable flow ID that can be used to match records to # output of other tools such as Zeek (Bro). # # Takes a 'seed' that needs to be same across sensors and tools # to make the id less predictable. # enable/disable the community id feature. community-id: no # Seed value for the ID output. Valid values are 0-65535. community-id-seed: 0 # HTTP X-Forwarded-For support by adding an extra field or overwriting # the source or destination IP address (depending on flow direction) # with the one reported in the X-Forwarded-For HTTP header. This is # helpful when reviewing alerts for traffic that is being reverse # or forward proxied. xff: enabled: no # Two operation modes are available: "extra-data" and "overwrite". mode: extra-data # Two proxy deployments are supported: "reverse" and "forward". In # a "reverse" deployment the IP address used is the last one, in a # "forward" deployment the first IP address is used. deployment: reverse # Header name where the actual IP address will be reported. If more # than one IP address is present, the last IP address will be the # one taken into consideration. header: X-Forwarded-For types: - alert: # payload: yes # enable dumping payload in Base64 # payload-buffer-size: 4 KiB # max size of payload buffer to output in eve-log # payload-printable: yes # enable dumping payload in printable (lossy) format # payload-length: yes # enable dumping payload length, including the gaps # packet: yes # enable dumping of packet (without stream segments) # metadata: no # enable inclusion of app layer metadata with alert. Default yes # If you want metadata, use: # metadata: # Include the decoded application layer (ie. http, dns) #app-layer: yes # Log the current state of the flow record. #flow: yes #rule: # Log the metadata field from the rule in a structured # format. #metadata: yes # Log the raw rule text. #raw: no #reference: no # include reference information from the rule # http-body: yes # Requires metadata; enable dumping of HTTP body in Base64 # http-body-printable: yes # Requires metadata; enable dumping of HTTP body in printable format # websocket-payload: yes # Requires metadata; enable dumping of WebSocket Payload in Base64 # websocket-payload-printable: yes # Requires metadata; enable dumping of WebSocket Payload in printable format # Enable the logging of tagged packets for rules using the # "tag" keyword. tagged-packets: yes # Enable logging the final action taken on a packet by the engine # (e.g: the alert may have action 'allowed' but the verdict be # 'drop' due to another alert. That's the engine's verdict) # verdict: yes # app layer frames - frame: # disabled by default as this is very verbose. enabled: no # payload-buffer-size: 4 KiB # max size of frame payload buffer to output in eve-log - anomaly: # Anomaly log records describe unexpected conditions such # as truncated packets, packets with invalid IP/UDP/TCP # length values, and other events that render the packet # invalid for further processing or describe unexpected # behavior on an established stream. Networks which # experience high occurrences of anomalies may experience # packet processing degradation. # # Anomalies are reported for the following: # 1. Decode: Values and conditions that are detected while # decoding individual packets. This includes invalid or # unexpected values for low-level protocol lengths as well # as stream related events (TCP 3-way handshake issues, # unexpected sequence number, etc). # 2. Stream: This includes stream related events (TCP # 3-way handshake issues, unexpected sequence number, # etc). # 3. Application layer: These denote application layer # specific conditions that are unexpected, invalid or are # unexpected given the application monitoring state. # # By default, anomaly logging is enabled. When anomaly # logging is enabled, applayer anomaly reporting is # also enabled. enabled: yes # # Choose one or more types of anomaly logging and whether to enable # logging of the packet header for packet anomalies. types: # decode: no # stream: no # applayer: yes #packethdr: no - http: extended: no # enable this for extended logging information # custom allows additional HTTP fields to be included in eve-log. # the example below adds three additional fields when uncommented #custom: [Accept-Encoding, Accept-Language, Authorization] # set this value to one and only one from {both, request, response} # to dump all HTTP headers for every HTTP request and/or response # dump-all-headers: none - dns: # Suricata 8.0 uses a new DNS logging format, to keep with # the old format while you upgrade the version can be set # to 2. See https://docs.suricata.io/en/latest/upgrade/8.0-dns-logging-changes.html #version: 3 # Enable/disable this logger. Default: enabled. enabled: no # Control logging of requests and responses: # - requests: enable logging of DNS queries # - responses: enable logging of DNS answers # By default both requests and responses are logged. #requests: no #responses: no # Format of answer logging: # - detailed: array item per answer # - grouped: answers aggregated by type # Default: all #formats: [detailed, grouped] # DNS record types to log, based on the query type. # Default: all. #types: [a, aaaa, cname, mx, ns, ptr, txt] - tls: extended: no # enable this for extended logging information # output TLS transaction where the session is resumed using a # session id #session-resumption: no # custom controls which TLS fields that are included in eve-log #custom: [subject, issuer, session_resumed, serial, fingerprint, sni, version, not_before, not_after, certificate, chain, ja3, ja3s, ja4, subjectaltname] - files: force-magic: no # force logging magic on all logged files # force logging of checksums, available hash functions are md5, # sha1 and sha256 #force-hash: [md5] #- drop: # alerts: yes # log alerts that caused drops # flows: all # start or all: 'start' logs only a single drop # # per flow direction. All logs each dropped pkt. # Enable logging the final action taken on a packet by the engine # (will show more information in case of a drop caused by 'reject') # verdict: yes - smtp: #extended: yes # enable this for extended logging information # this includes: bcc, message-id, subject, x_mailer, user-agent # custom fields logging from the list: # reply-to, bcc, message-id, subject, x-mailer, user-agent, received, # x-originating-ip, in-reply-to, references, importance, priority, # sensitivity, organization, content-md5, date #custom: [received, x-mailer, x-originating-ip, relays, reply-to, bcc] # output md5 of fields: body, subject # for the body you need to set app-layer.protocols.smtp.mime.body-md5 # to yes #md5: [body, subject] #- dnp3 - websocket #- enip - ftp - rdp - nfs - smb - tftp - ike - dcerpc - krb5 - bittorrent-dht - snmp - rfb - sip - quic - ldap - arp: enabled: no # Many events can be logged. Disabled by default - dhcp: enabled: yes # When extended mode is on, all DHCP messages are logged # with full detail. When extended mode is off (the # default), just enough information to map a MAC address # to an IP address is logged. extended: no - ssh - mqtt: # passwords: yes # enable output of passwords # string-log-limit: 1KiB # limit size of logged strings in bytes. # Can be specified in KiB, MiB, GiB. Just a number # is parsed as bytes. Default is 1 KiB. # Use a value of 0 to disable limiting. # Note that the size is also bounded by # the maximum parsed message size (see # app-layer configuration) - http2 # dns over http2 - doh2 - pgsql: enabled: no # passwords: yes # enable output of passwords. Disabled by default - stats: totals: yes # stats for all threads merged together threads: no # per thread stats deltas: no # include delta values # Don't log stats counters that are zero. Default: yes #null-values: no # no will NOT log stats counters: 0 # bi-directional flows # - flow # uni-directional flows #- netflow # Metadata event type. Triggered whenever a pktvar is saved # and will include the pktvars, flowvars, flowbits and # flowints. #- metadata # EXPERIMENTAL per packet output giving TCP state tracking details # including internal state, flags, etc. # This output is experimental, meant for debugging and subject to # change in both config and output without any notice. - stream: # all: no # log all TCP packets event-set: no # log packets that have a decoder/stream event state-update: no # log packets triggering a TCP state update spurious-retransmission: no # log spurious retransmission packets # output module to store certificates chain to disk - tls-store: enabled: no #certs-log-dir: certs # directory to store the certificates files # Packet log... log packets in pcap format. 2 modes of operation: "normal" # and "multi". # # In normal mode a pcap file "filename" is created in the default-log-dir, # or as specified by "dir". # In multi mode, a file is created per thread. This will perform much # better, but will create multiple files where 'normal' would create one. # In multi mode the filename takes a few special variables: # - %n -- thread number # - %i -- thread id # - %t -- timestamp (secs or secs.usecs based on 'ts-format' # E.g. filename: pcap.%n.%t # # Note that it's possible to use directories, but the directories are not # created by Suricata. E.g. filename: pcaps/%n/log.%s will log into the # per thread directory. # # Also note that the limit and max-files settings are enforced per thread. # So the size limit when using 8 threads with 1000 MiB files and 2000 files # is: 8*1000*2000 ~ 16TiB. # # By default all packets are logged except: # - TCP streams beyond stream.reassembly.depth # - encrypted streams after the key exchange # - pcap-log: enabled: no filename: log.pcap # File size limit. Can be specified in kb, mb, gb. Just a number # is parsed as bytes. limit: 1000 MiB # If set to a value, ring buffer mode is enabled. Will keep maximum of # "max-files" of size "limit" max-files: 2000 # Compression algorithm for pcap files. Possible values: none, lz4. # Note also that on Windows, enabling compression will *increase* disk I/O. compression: none # Further options for lz4 compression. The compression level can be set # to a value between 0 and 16, where higher values result in higher # compression. #lz4-checksum: no #lz4-level: 0 mode: normal # normal or multi # Directory to place pcap files. If not provided the default log # directory will be used. #dir: /nsm_data/ #ts-format: usec # sec or usec second format (default) is filename.sec usec is filename.sec.usec use-stream-depth: no #If set to "yes" packets seen after reaching stream inspection depth are ignored. "no" logs all packets honor-pass-rules: no # If set to "yes", flows in which a pass rule matched will stop being logged. # Use "all" to log all packets or use "alerts" to log only alerted packets and flows or "tag" # to log only flow tagged via the "tag" keyword #conditional: all # a full alert log containing much information for signature writers # or for investigating suspected no positives. - alert-debug: enabled: no filename: alert-debug.log append: yes #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram' # Stats.log contains data from various counters of the Suricata engine. - stats: enabled: yes filename: stats.log append: no # append to file (yes) or overwrite it (no) totals: yes # stats for all threads merged together threads: no # per thread stats #null-values: yes # print counters that have value 0. Default: no # Output module for storing files on disk. Files are stored in # directory names consisting of the first 2 characters of the # SHA256 of the file. Each file is given its SHA256 as a filename. # # When a duplicate file is found, the timestamps on the existing file # are updated. # # Unlike the older filestore, metadata is not written by default # as each file should already have a "fileinfo" record in the # eve-log. If write-fileinfo is set to yes, then each file will have # one more associated .json files that consist of the fileinfo # record. A fileinfo file will be written for each occurrence of the # file seen using a filename suffix to ensure uniqueness. # # To prune the filestore directory see the "suricatactl filestore # prune" command which can delete files over a certain age. - file-store: version: 2 enabled: no # Set the directory for the filestore. Relative pathnames # are contained within the "default-log-dir". #dir: filestore # Write out a fileinfo record for each occurrence of a file. # Disabled by default as each occurrence is already logged # as a fileinfo record to the main eve-log. #write-fileinfo: yes # Force storing of all files. Default: no. #force-filestore: yes # Override the global stream-depth for sessions in which we want # to perform file extraction. Set to 0 for unlimited; otherwise, # must be greater than the global stream-depth value to be used. #stream-depth: 0 # Uncomment the following variable to define how many files can # remain open for filestore by Suricata. Default value is 0 which # means files get closed after each write to the file. #max-open-files: 1000 # Force logging of checksums: available hash functions are md5, # sha1 and sha256. Note that SHA256 is automatically forced by # the use of this output module as it uses the SHA256 as the # file naming scheme. #force-hash: [sha1, md5] # NOTE: X-Forwarded configuration is ignored if write-fileinfo is disabled # HTTP X-Forwarded-For support by adding an extra field or overwriting # the source or destination IP address (depending on flow direction) # with the one reported in the X-Forwarded-For HTTP header. This is # helpful when reviewing alerts for traffic that is being reverse # or forward proxied. xff: enabled: no # Two operation modes are available, "extra-data" and "overwrite". mode: extra-data # Two proxy deployments are supported, "reverse" and "forward". In # a "reverse" deployment the IP address used is the last one, in a # "forward" deployment the first IP address is used. deployment: reverse # Header name where the actual IP address will be reported. If more # than one IP address is present, the last IP address will be the # one taken into consideration. header: X-Forwarded-For - tcp-data: enabled: no type: file filename: tcp-data.log # Log HTTP body data after normalization, de-chunking and unzipping. # Two types: file or dir. # - file logs into a single logfile. # - dir creates 2 files per HTTP session and stores the # normalized data into them. # Use 'both' to enable both file and dir modes. # # Note: limited by the body limit settings - http-body-data: enabled: no type: file filename: http-data.log # Lua Output Support - execute lua script to generate alert and event # output. # Documented at: # https://docs.suricata.io/en/latest/output/lua-output.html - lua: enabled: no #scripts-dir: /etc/suricata/lua-output/ scripts: # - script1.lua # Logging configuration. This is not about logging IDS alerts/events, but # output about what Suricata is doing, like startup messages, errors, etc. logging: # The default log level: can be overridden in an output section. # Note that debug level logging will only be emitted if Suricata was # compiled with the --enable-debug configure option. # # This value is overridden by the SC_LOG_LEVEL env var. default-log-level: notice # The default output format. Optional parameter, should default to # something reasonable if not provided. Can be overridden in an # output section. You can leave this out to get the default. # # This console log format value can be overridden by the SC_LOG_FORMAT env var. #default-log-format: "%D: %S: %M" # # For the pre-7.0 log format use: #default-log-format: "[%i] %t [%S] - (%f:%l) <%d> (%n) -- " # A regex to filter output. Can be overridden in an output section. # Defaults to empty (no filter). # # This value is overridden by the SC_LOG_OP_FILTER env var. default-output-filter: # Requires libunwind to be available when Suricata is configured and built. # If a signal unexpectedly terminates Suricata, displays a brief diagnostic # message with the offending stacktrace if enabled. #stacktrace-on-signal: on # Define your logging outputs. If none are defined, or they are all # disabled you will get the default: console output. outputs: - console: enabled: yes # type: json - file: enabled: yes level: info filename: suricata.log # format: "[%i - %m] %z %d: %S: %M" # type: json - syslog: enabled: no facility: local5 format: "[%i] <%d> -- " # type: json dpdk: eal-params: # a: 0000:3b:00.0,0000:3b:00.1 #,mprq_en=1,rxqs_min_mprq=1,rxq_pkt_pad_en=1,rxq_cqe_comp_en=4,dv_flow_en=1 # a: 0000:05:00.0,rxq_cqe_comp_en=4,mprq_en=1,rxqs_min_mprq=1,mprq_log_stride_num=9,rxq_pkt_pad_en=1 proc-type: primary #vdev: 'net_bonding0,mode=0,slave=0000:af:00.0,slave=0000:af:00.1' # DPDK capture support # RX queues (and TX queues in IPS mode) are assigned to cores in 1:1 ratio capture-bypass: yes bypass-info-mp-size: 1048576 #262144 #524288 #2097151 bypass-ring-size: 32768 #32768 #16384 #256 #8192 bypass-ring-dequeue-burst-size: 32768 #32768 #16384 #64 #1024 interfaces: - interface: 0000:3b:00.0 # PCIe address of the NIC port threads: auto interrupt-mode: yes promisc: yes # promiscuous mode - capture all packets multicast: yes # enables also detection on multicast packets checksum-checks: no # if Suricata should validate checksums checksum-checks-offload: no # if possible offload checksum validation to the NIC (saves Suricata resources) mtu: 9600 # Set MTU of the device in bytes mempool-size: auto # 1048575 #65535 # The number of elements in the mbuf pool mempool-cache-size: auto #257 rx-descriptors: auto #8192 #2048 tx-descriptors: auto #8192 #2048 # 1024 copy-mode: none #ips copy-iface: none #0000:3b:00.0 # or PCIe address of the second interface # drop-filter: # - rule: "pattern eth / ipv4 / end" # - interface: 0000:3b:00.1 # PCIe address of the NIC port # threads: auto # interrupt-mode: yes # promisc: yes # promiscuous mode - capture all packets # multicast: yes # enables also detection on multicast packets # checksum-checks: no # if Suricata should validate checksums # checksum-checks-offload: no # if possible offload checksum validation to the NIC (saves Suricata resources) # mtu: 9600 # Set MTU of the device in bytes # mempool-size: auto # 1048575 #65535 # The number of elements in the mbuf pool # mempool-cache-size: auto #257 # rx-descriptors: auto #8192 #2048 # tx-descriptors: auto #8192 #2048 # 1024 # copy-mode: none #ips # copy-iface: none #0000:3b:00.0 # or PCIe address of the second interface # drop-filter: # - rule: "pattern eth / ipv4 dst is 11.11.11.11 / end" # - rule: "pattern eth / ipv4 / tcp src is 443 / end" # - rule: "pattern eth / ipv4 / tcp dst is 443 / end" - interface: default threads: 8 promisc: yes multicast: yes checksum-checks: yes checksum-checks-offload: yes mtu: 1500 vlan-strip-offload: yes rss-hash-functions: auto mempool-size: 65535 mempool-cache-size: 257 rx-descriptors: 1024 tx-descriptors: 1024 copy-mode: none copy-iface: none ## ## Step 4: App Layer Protocol configuration ## # Configure the app-layer parsers. # # The exception policy error-policy setting applies to all app-layer parsers. # Values can be "drop-flow", "pass-flow", "bypass", "drop-packet", "pass-packet", # "reject" or "ignore" (the default). # # The protocol's section details each protocol. # # The option "enabled" takes 3 values - "yes", "no", "detection-only". # "yes" enables both detection and the parser, "no" disables both, and # "detection-only" enables protocol detection only (parser disabled). app-layer: # error-policy: bypass protocols: telnet: enabled: yes rfb: enabled: yes detection-ports: dp: 5900, 5901, 5902, 5903, 5904, 5905, 5906, 5907, 5908, 5909 mqtt: enabled: yes # max-msg-length: 1 MiB # subscribe-topic-match-limit: 100 # unsubscribe-topic-match-limit: 100 # Maximum number of live MQTT transactions per flow # max-tx: 4096 krb5: enabled: yes bittorrent-dht: enabled: yes snmp: enabled: yes ike: enabled: yes tls: enabled: yes detection-ports: dp: 443 # Generate JA3/JA4 fingerprints from client hello. If not specified it # will be disabled by default, but enabled if rules require it. #ja3-fingerprints: auto #ja4-fingerprints: auto # What to do when the encrypted communications start: # - default: keep tracking TLS session, check for protocol anomalies, # inspect tls_* keywords. Disables inspection of unmodified # 'content' signatures. # - bypass: stop processing this flow as much as possible. No further # TLS parsing and inspection. Offload flow bypass to kernel # or hardware if possible. # - full: keep tracking and inspection as normal. Unmodified content # keyword signatures are inspected as well. # # For best performance, select 'bypass'. # encryption-handling: bypass pgsql: enabled: no # Stream reassembly size for PostgreSQL. By default, track it completely. stream-depth: 0 # Maximum number of live PostgreSQL transactions per flow # max-tx: 1024 dcerpc: enabled: yes # Maximum number of live DCERPC transactions per flow # max-tx: 1024 ftp: enabled: yes memcap: 128 mb websocket: #enabled: yes # Maximum used payload size, the rest is skipped # max-payload-size: 64 KiB rdp: #enabled: yes ssh: enabled: yes #hassh: yes doh2: enabled: yes http2: enabled: yes # Maximum number of live HTTP2 streams in a flow #max-streams: 4096 # Maximum headers table size #max-table-size: 65536 # Maximum reassembly size for header + continuation frames #max-reassembly-size: 102400 smtp: enabled: yes raw-extraction: no # Maximum number of live SMTP transactions per flow # max-tx: 256 # Configure SMTP-MIME Decoder mime: # Decode MIME messages from SMTP transactions # (may be resource intensive) # This field supersedes all others because it turns the entire # process on or off decode-mime: yes # Decode MIME entity bodies (ie. Base64, quoted-printable, etc.) decode-base64: yes decode-quoted-printable: yes # Maximum bytes per header data value stored in the data structure # (default is 2000) header-value-depth: 2000 # Extract URLs and save in state data structure extract-urls: yes # Scheme of URLs to extract # (default is [http]) #extract-urls-schemes: [http, https, ftp, mailto] # Log the scheme of URLs that are extracted # (default is no) #log-url-scheme: yes # Set to yes to compute the md5 of the mail body. You will then # be able to journalize it. body-md5: no # Configure inspected-tracker for file_data keyword inspected-tracker: content-limit: 100000 content-inspect-min-size: 32768 content-inspect-window: 4096 imap: enabled: detection-only pop3: enabled: detection-only smb: enabled: yes detection-ports: dp: 139, 445 # Maximum number of live SMB transactions per flow # max-tx: 1024 # Stream reassembly size for SMB streams. By default track it completely. #stream-depth: 0 nfs: enabled: yes # max-tx: 1024 tftp: enabled: yes dns: tcp: enabled: yes detection-ports: dp: 53 udp: enabled: yes detection-ports: dp: 53 http: enabled: yes # Byte Range Containers default settings # byterange: # memcap: 100 MiB # timeout: 60 # memcap: Maximum memory capacity for HTTP # Default is unlimited, values can be 64 MiB, e.g. # default-config: Used when no server-config matches # personality: List of personalities used by default # request-body-limit: Limit reassembly of request body for inspection # by http_client_body & pcre /P option. # response-body-limit: Limit reassembly of response body for inspection # by file_data, http_server_body & pcre /Q option. # # For advanced options, see the user guide # server-config: List of server configurations to use if address matches # address: List of IP addresses or networks for this block # personality: List of personalities used by this block # # Then, all the fields from default-config can be overloaded # # Currently Available Personalities: # Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0, # IIS_7_0, IIS_7_5, Apache_2 libhtp: default-config: personality: IDS # Can be specified in KiB, MiB, GiB. Just a number indicates # it's in bytes. request-body-limit: 100 KiB response-body-limit: 100 KiB # inspection limits request-body-minimal-inspect-size: 32 KiB request-body-inspect-window: 4 KiB response-body-minimal-inspect-size: 40 KiB response-body-inspect-window: 16 KiB # response body decompression (0 disables) response-body-decompress-layer-limit: 2 # auto will use http-body-inline mode in IPS mode, yes or no set it statically http-body-inline: auto # Decompress SWF files. Disabled by default. # Two types: 'deflate', 'lzma', 'both' will decompress deflate and lzma # compress-depth: # Specifies the maximum amount of data to decompress, # set 0 for unlimited. # decompress-depth: # Specifies the maximum amount of decompressed data to obtain, # set 0 for unlimited. swf-decompression: enabled: no type: both compress-depth: 100 KiB decompress-depth: 100 KiB # Use a random value for inspection sizes around the specified value. # This lowers the risk of some evasion techniques but could lead # to detection change between runs. It is set to 'yes' by default. #randomize-inspection-sizes: yes # If "randomize-inspection-sizes" is active, the value of various # inspection size will be chosen from the [1 - range%, 1 + range%] # range # Default value of "randomize-inspection-range" is 10. #randomize-inspection-range: 10 # decoding double-decode-path: no double-decode-query: no # Can enable LZMA decompression #lzma-enabled: no # Memory limit usage for LZMA decompression dictionary # Data is decompressed until dictionary reaches this size #lzma-memlimit: 1 MiB # Maximum decompressed size with a compression ratio # above 2048 (only LZMA can reach this ratio, deflate cannot) #compression-bomb-limit: 1 MiB # Maximum time spent decompressing a single transaction in usec #decompression-time-limit: 100000 # Maximum number of live transactions per flow #max-tx: 512 # Maximum used number of HTTP1 headers in one request or response #headers-limit: 1024 server-config: #- apache: # address: [192.168.1.0/24, 127.0.0.0/8, "::1"] # personality: Apache_2 # # Can be specified in KiB, MiB, GiB. Just a number indicates # # it's in bytes. # request-body-limit: 4096 # response-body-limit: 4096 # double-decode-path: no # double-decode-query: no #- iis7: # address: # - 192.168.0.0/24 # - 192.168.10.0/24 # personality: IIS_7_0 # # Can be specified in KiB, MiB, GiB. Just a number indicates # # it's in bytes. # request-body-limit: 4096 # response-body-limit: 4096 # double-decode-path: no # double-decode-query: no # Note: Modbus probe parser is minimalist due to the limited usage in the field. # Only Modbus message length (greater than Modbus header length) # and protocol ID (equal to 0) are checked in probing parser # It is important to enable detection port and define Modbus port # to avoid no positives modbus: # How many unanswered Modbus requests are considered a flood. # If the limit is reached, the app-layer-event:modbus.flooded; will match. #request-flood: 500 enabled: no detection-ports: dp: 502 # According to MODBUS Messaging on TCP/IP Implementation Guide V1.0b, it # is recommended to keep the TCP connection opened with a remote device # and not to open and close it for each MODBUS/TCP transaction. In that # case, it is important to set the depth of the stream reassembling as # unlimited (stream.reassembly.depth: 0) # Stream reassembly size for modbus. By default track it completely. stream-depth: 0 # DNP3 dnp3: enabled: no detection-ports: dp: 20000 # SCADA EtherNet/IP and CIP protocol support enip: enabled: no detection-ports: dp: 44818 sp: 44818 ntp: enabled: yes quic: enabled: yes dhcp: enabled: yes sip: #enabled: yes ldap: tcp: enabled: yes detection-ports: dp: 389 udp: enabled: yes detection-ports: dp: 389 # Maximum number of live LDAP transactions per flow # max-tx: 1024 # Limit for the maximum number of asn1 frames to decode (default 256) asn1-max-frames: 256 ############################################################################## ## ## Advanced settings below ## ############################################################################## ## ## Run Options ## # Run Suricata with a specific user-id and group-id: #run-as: # user: suri # group: suri security: # if yes, prevents process creation from Suricata by calling # setrlimit(RLIMIT_NPROC, 0) limit-noproc: yes # Use landlock security module under Linux landlock: enabled: no directories: #write: # - /usr/local/var/run/ # /usr and /etc folders are added to read list to allow # file magic to be used. read: - /usr/ - /etc/ - /usr/local/etc/suricata/ lua: # Allow Lua rules. Disabled by default. #allow-rules: no # Some logging modules will use that name in event as identifier. The default # value is the hostname #sensor-name: suricata # Default location of the pid file. The pid file is only used in # daemon mode (start Suricata with -D). If not running in daemon mode # the --pidfile command line option must be used to create a pid file. pid-file: /usr/local/etc/suricata.pid # Daemon working directory # Suricata will change directory to this one if provided # Default: "/" #daemon-directory: "/" # Umask. # Suricata will use this umask if it is provided. By default it will use the # umask passed on by the shell. #umask: 022 # Suricata core dump configuration. Limits the size of the core dump file to # approximately max-dump. The actual core dump size will be a multiple of the # page size. Core dumps that would be larger than max-dump are truncated. On # Linux, the actual core dump size may be a few pages larger than max-dump. # Setting max-dump to 0 disables core dumping. # Setting max-dump to 'unlimited' will give the full core dump file. # On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size # to be 'unlimited'. coredump: max-dump: unlimited # If the Suricata box is a router for the sniffed networks, set it to 'router'. If # it is a pure sniffing setup, set it to 'sniffer-only'. # If set to auto, the variable is internally switched to 'router' in IPS mode # and 'sniffer-only' in IDS mode. # This feature is currently only used by the reject* keywords. host-mode: auto # Number of packets preallocated per thread. The default is 1024. A higher number # will make sure each CPU will be more easily kept busy, but may negatively # impact caching. #max-pending-packets: 1024 # Runmode the engine should use. Please check --list-runmodes to get the available # runmodes for each packet acquisition method. Default depends on selected capture # method. 'workers' generally gives best performance. runmode: workers # Specifies the kind of flow load balancer used by the flow pinned autofp mode. # # Supported schedulers are: # # hash - Flow assigned to threads using the 5-7 tuple hash. # ippair - Flow assigned to threads using addresses only. # ftp-hash - Flow assigned to threads using the hash, except for FTP, so that # ftp-data flows will be handled by the same thread # #autofp-scheduler: hash # Preallocated size for each packet. Default is 1514 which is the classical # size for pcap on Ethernet. You should adjust this value to the highest # packet size (MTU + hardware header) on your system. #default-packet-size: 1514 # Unix command socket that can be used to pass commands to Suricata. # An external tool can then connect to get information from Suricata # or trigger some modifications of the engine. Set enabled to yes # to activate the feature. In auto mode, the feature will only be # activated in live capture mode. You can use the filename variable to set # the file name of the socket. unix-command: enabled: auto #filename: custom.socket # Magic file. The extension .mgc is added to the value here. #magic-file: /usr/share/file/magic #magic-file: # GeoIP2 database file. Specify path and filename of GeoIP2 database # if using rules with "geoip" rule option. #geoip-database: /usr/local/share/GeoLite2/GeoLite2-Country.mmdb legacy: uricontent: enabled ## ## Detection settings ## # Set the order of alerts based on actions # The default order is pass, drop, reject, alert # action-order: # - pass # - drop # - reject # - alert # Define maximum number of possible alerts that can be triggered for the same # packet. Default is 15 #packet-alert-max: 15 # Exception Policies # # Define a common behavior for all exception policies. # In IPS mode, the default is drop-flow. For cases when that's not possible, the # engine will fall to drop-packet. To fallback to old behavior (setting each of # them individually, or ignoring all), set this to ignore. # All values available for exception policies can be used, and there is one # extra option: auto - which means drop-flow or drop-packet (as explained above) # in IPS mode, and ignore in IDS mode. Exception policy values are: drop-packet, # drop-flow, reject, bypass, pass-packet, pass-flow, ignore (disable). exception-policy: auto # IP Reputation #reputation-categories-file: /usr/local/etc/suricata/iprep/categories.txt #default-reputation-path: /usr/local/etc/suricata/iprep #reputation-files: # - reputation.list # When run with the option --engine-analysis, the engine will read each of # the parameters below, and print reports for each of the enabled sections # and exit. The reports are printed to a file in the default log dir # given by the parameter "default-log-dir", with engine reporting # subsection below printing reports in its own report file. engine-analysis: # enables printing reports for fast-pattern for every rule. rules-fast-pattern: yes # enables printing reports for each rule rules: yes #recursion and match limits for PCRE where supported pcre: match-limit: 3500 match-limit-recursion: 1500 ## ## Advanced Traffic Tracking and Reconstruction Settings ## # Host specific policies for defragmentation and TCP stream # reassembly. The host OS lookup is done using a radix tree, just # like a routing table so the most specific entry matches. host-os-policy: # Make the default policy windows. windows: [0.0.0.0/0] bsd: [] bsd-right: [] old-linux: [] linux: [] old-solaris: [] solaris: [] hpux10: [] hpux11: [] irix: [] macos: [] vista: [] windows2k3: [] # Defrag settings: # The exception policy memcap-policy value can be "drop-packet", "pass-packet", # "reject" or "ignore" (which is the default). defrag: memcap: 32 MiB # memcap-policy: ignore hash-size: 131072 trackers: 131071 # number of defragmented flows to follow max-frags: 262143 # number of fragments to keep (higher than trackers) prealloc: yes timeout: 60 # Enable defrag per host settings # host-config: # # - dmz: # timeout: 30 # address: [192.168.1.0/24, 127.0.0.0/8, 1.1.1.0/24, 2.2.2.0/24, "1.1.1.1", "2.2.2.2", "::1"] # # - lan: # timeout: 45 # address: # - 192.168.0.0/24 # - 192.168.10.0/24 # - 172.16.14.0/24 # Flow settings: # By default, the reserved memory (memcap) for flows is 32 MiB. This is the limit # for flow allocation inside the engine. You can change this value to allow # more memory usage for flows. # The hash-size determines the size of the hash used to identify flows inside # the engine, and by default the value is 65536. # At startup, the engine can preallocate a number of flows, to get better # performance. The number of flows preallocated is 10000 by default. # emergency-recovery is the percentage of flows that the engine needs to # prune before clearing the emergency state. The emergency state is activated # when the memcap limit is reached, allowing new flows to be created, but # pruning them with the emergency timeouts (they are defined below). # If the memcap is reached, the engine will try to prune flows # with the default timeouts. If it doesn't find a flow to prune, it will set # the emergency bit and it will try again with more aggressive timeouts. # If that doesn't work, then it will try to kill the oldest flows using # last time seen flows. # The memcap can be specified in KiB, MiB, GiB. Just a number indicates it's # in bytes. # The exception policy memcap-policy can be "drop-packet", "pass-packet", # "reject" or "ignore" (which is the default). flow: memcap: 4 GiB #memcap-policy: ignore hash-size: 131072 #131072 prealloc: 1048576 emergency-recovery: 30 managers: 1 # default to one flow manager recyclers: 1 # default to one flow recycler thread bypass: delay: 10 # How many iterations of sleep (100 microseconds) and stats sync will Bypass Manager perform # This option controls the use of VLAN ids in the flow (anrd defrag) # hashing. Normally this should be enabled, but in some (broken) # setups where both sides of a flow are not tagged with the same VLAN # tag, we can ignore the VLAN id's in the flow hashing. vlan: use-for-tracking: yes # This option controls the use of livedev ids in the flow (and defrag) # hashing. This is enabled by default and should be disabled if # multiple live devices are used to capture traffic from the same network livedev: use-for-tracking: yes # Specific timeouts for flows. Here you can specify the timeouts that the # active flows will wait to transit from the current state to another, on each # protocol. The value of "new" determines the seconds to wait after a handshake or # stream startup before the engine frees the data of that flow it doesn't # change the state to established (usually if we don't receive more packets # of that flow). The value of "established" is the amount of # seconds that the engine will wait to free the flow if that time elapses # without receiving new packets or closing the connection. "closed" is the # amount of time to wait after a flow is closed (usually zero). "bypassed" # timeout controls locally bypassed flows. For these flows we don't do any other # tracking. If no packets have been seen after this timeout, the flow is discarded. # # There's an emergency mode that will become active under attack circumstances, # making the engine to check flow status faster. This configuration variables # use the prefix "emergency-" and work similar as the normal ones. # Some timeouts doesn't apply to all the protocols, like "closed", for udp and # icmp. flow-timeouts: default: new: 30 established: 300 closed: 100 bypassed: 100 emergency-new: 10 emergency-established: 10 emergency-closed: 0 emergency-bypassed: 2 tcp: new: 100 established: 100 bypassed: 100 closed: 100 emergency-new: 5 emergency-established: 10 emergency-closed: 10 emergency-bypassed: 2 udp: new: 30 established: 300 bypassed: 5 emergency-new: 10 emergency-established: 100 emergency-bypassed: 5 icmp: new: 30 established: 300 bypassed: 5 emergency-new: 10 emergency-established: 100 emergency-bypassed: 5 stream: memcap: 2 GiB #memcap-policy: ignore checksum-validation: no # reject incorrect csums midstream: no #midstream-policy: ignore async-oneside: no # don't enable async stream handling inline: auto bypass: yes # auto will use inline mode in IPS mode, yes or no set it statically reassembly: memcap: 2 GiB #memcap-policy: ignore depth: 1 MiB # reassemble 2 MiB into a stream toserver-chunk-size: 2560 toclient-chunk-size: 2560 randomize-chunk-size: yes # randomize-chunk-range: 10 #raw: yes #segment-prealloc: 2048 #check-overlap-different-data: yes # Host table: # # Host table is used by the tagging and per host thresholding subsystems. # host: hash-size: 4096 prealloc: 4096 memcap: 32 MiB # IP Pair table: # # Used by xbits 'ippair' tracking. # ippair: hash-size: 4096 prealloc: 4096 memcap: 32 MiB # Decoder settings decoder: # Teredo decoder is known to not be completely accurate # as it will sometimes detect non-teredo as teredo. teredo: enabled: yes # ports to look for Teredo. Max 4 ports. If no ports are given, or # the value is set to 'any', Teredo detection runs on _all_ UDP packets. ports: $TEREDO_PORTS # syntax: '[3544, 1234]' or '3533' or 'any'. # VXLAN decoder is assigned to up to 4 UDP ports. By default only the # IANA assigned port 4789 is enabled. vxlan: enabled: yes ports: $VXLAN_PORTS # syntax: '[8472, 4789]' or '4789'. # Geneve decoder is assigned to up to 4 UDP ports. By default only the # IANA assigned port 6081 is enabled. geneve: enabled: yes ports: $GENEVE_PORTS # syntax: '[6081, 1234]' or '6081'. # maximum number of decoder layers for a packet # max-layers: 16 ## ## Performance tuning and profiling ## # The detection engine builds internal groups of signatures. The engine # allows us to specify the profile to use for them, to manage memory in an # efficient way keeping good performance. For the profile keyword you # can use the words "low", "medium", "high" or "custom". If you use custom, # make sure to define the values in the "custom-values" section. # Usually you would prefer medium/high/low. # # "sgh mpm-context", indicates how the staging should allot mpm contexts for # the signature groups. "single" indicates the use of a single context for # all the signature group heads. "full" indicates a mpm-context for each # group head. "auto" lets the engine decide the distribution of contexts # based on the information the engine gathers on the patterns from each # group head. # # The option inspection-recursion-limit is used to limit the recursive calls # in the content inspection code. For certain payload-sig combinations, we # might end up taking too much time in the content inspection code. # If the argument specified is 0, the engine uses an internally defined # default limit. When a value is not specified, there are no limits on the recursion. detect: profile: medium custom-values: toclient-groups: 3 toserver-groups: 25 sgh-mpm-context: auto inspection-recursion-limit: 3000 sgh-mpm-caching: yes sgh-mpm-caching-path: /tmp/hs # maximum number of times a tx will get logged for a stream-only rule match # stream-tx-log-limit: 4 # If set to yes, the loading of signatures will be made after the capture # is started. This will limit the downtime in IPS mode. #delayed-detect: yes prefilter: # default prefiltering setting. "mpm" only creates MPM/fast_pattern # engines. "auto" also sets up prefilter engines for other keywords. # Use --list-keywords=all to see which keywords support prefiltering. default: mpm # the grouping values above control how many groups are created per # direction. Port priority setting forces that port to get its own group. # Very common ports will benefit, as well as ports with many expensive # rules. grouping: #tcp-priority-ports: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080 #udp-priority-ports: 53, 135, 5060 # Thresholding hash table settings. thresholds: hash-size: 16384 memcap: 16 MiB profiling: # Log the rules that made it past the prefilter stage, per packet # default is off. The threshold setting determines how many rules # must have made it past pre-filter for that rule to trigger the # logging. #inspect-logging-threshold: 200 grouping: dump-to-disk: no include-rules: no # very verbose include-mpm-stats: no # Select the multi pattern algorithm you want to run for scan/search the # in the engine. # # The supported algorithms are: # "ac" - Aho-Corasick, default implementation # "ac-bs" - Aho-Corasick, reduced memory implementation # "ac-ks" - Aho-Corasick, "Ken Steele" variant # "hs" - Hyperscan, available when built with Hyperscan support # # The default mpm-algo value of "auto" will use "hs" if Hyperscan is # available, "ac" otherwise. # # The mpm you choose also decides the distribution of mpm contexts for # signature groups, specified by the conf - "detect.sgh-mpm-context". # Selecting "ac" as the mpm would require "detect.sgh-mpm-context" # to be set to "single", because of ac's memory requirements, unless the # ruleset is small enough to fit in memory, in which case one can # use "full" with "ac". The rest of the mpms can be run in "full" mode. mpm-algo: hs # Select the matching algorithm you want to use for single-pattern searches. # # Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only # available if Suricata has been built with Hyperscan support). # # The default of "auto" will use "hs" if available, otherwise "bm". spm-algo: hs # Suricata is multi-threaded. Here the threading can be influenced. threading: set-cpu-affinity: yes # Tune cpu affinity of threads. Each family of threads can be bound # to specific CPUs. # # These 2 apply to the all runmodes: # management-cpu-set is used for flow timeout handling, counters # worker-cpu-set is used for 'worker' threads # # Additionally, for autofp these apply: # receive-cpu-set is used for capture threads # verdict-cpu-set is used for IPS verdict threads # cpu-affinity: - management-cpu-set: cpu: [ 0,2 ] # include only these CPUs in affinity settings - worker-cpu-set: #claret cpu: [ 4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38 ] #dpdk-test2 #cpu: [ 6,8,10,12,14,16,18 ] mode: "exclusive" # Use explicitly 3 threads and don't compute number by using # detect-thread-ratio variable: # threads: 3 prio: default: "high" # interface-specific-cpu-set: # - interface: "0000:05:00.1" # 0000:3b:00.0 # net_bonding0 # ens1f0 # cpu: [ 2,4,6,8,10,12,14,16,18 ] # mode: "exclusive" # prio: # high: [ "all" ] # default: "medium" #- verdict-cpu-set: # cpu: [ 0 ] # prio: # default: "high" # # By default Suricata creates one "detect" thread per available CPU/CPU core. # This setting allows controlling this behaviour. A ratio setting of 2 will # create 2 detect threads for each CPU/CPU core. So for a dual core CPU this # will result in 4 detect threads. If values below 1 are used, less threads # are created. So on a dual core CPU a setting of 0.5 results in 1 detect # thread being created. Regardless of the setting at a minimum 1 detect # thread will always be created. # detect-thread-ratio: 1.0 # # By default, the per-thread stack size is left to its default setting. If # the default thread stack size is too small, use the following configuration # setting to change the size. Note that if any thread's stack size cannot be # set to this value, a fatal error occurs. # # Generally, the per-thread stack-size should not exceed 8MB. #stack-size: 8 MiB # Profiling settings. Only effective if Suricata has been built with # the --enable-profiling configure flag. # profiling: # Run profiling for every X-th packet. The default is 1, which means we # profile every packet. If set to 1024, one packet is profiled for every # 1024 received. The sample rate must be a power of 2. #sample-rate: 1024 # rule profiling rules: # Profiling can be disabled here, but it will still have a # performance impact if compiled in. enabled: yes filename: rule_perf.log append: yes # Set active to yes to enable rules profiling at start # if set to no (default), the rules profiling will have to be started # via unix socket commands. #active:no # Sort options: ticks, avgticks, checks, matches, maxticks # If commented out all the sort options will be used. #sort: avgticks # Limit the number of sids for which stats are shown at exit (per sort). limit: 10 # output to json json: yes # per keyword profiling keywords: enabled: yes filename: keyword_perf.log append: yes prefilter: enabled: yes filename: prefilter_perf.log append: yes # per rulegroup profiling rulegroups: enabled: yes filename: rule_group_perf.log append: yes # packet profiling packets: # Profiling can be disabled here, but it will still have a # performance impact if compiled in. enabled: yes filename: packet_stats.log append: yes # per packet csv output csv: # Output can be disabled here, but it will still have a # performance impact if compiled in. enabled: no filename: packet_stats.csv # profiling of locking. Only available when Suricata was built with # --enable-profiling-locks. locks: enabled: no filename: lock_stats.log append: yes pcap-log: enabled: no filename: pcaplog_stats.log append: yes #nflog support nflog: # netlink multicast group # (the same as the iptables --nflog-group param) # Group 0 is used by the kernel, so you can't use it - group: 2 # netlink buffer size buffer-size: 18432 # put default value here - group: default # set number of packets to queue inside kernel qthreshold: 1 # set the delay before flushing packet in the kernel's queue qtimeout: 100 # netlink max buffer size max-size: 20000 ## ## Advanced Capture Options ## # General settings affecting packet capture capture: # disable NIC offloading. It's restored when Suricata exits. # Enabled by default. #disable-offloading: no # # disable checksum validation. Same as setting '-k none' on the # command-line. #checksum-validation: none # Netmap support # # Netmap operates with NIC directly in driver, so you need FreeBSD 11+ which has # built-in Netmap support or compile and install the Netmap module and appropriate # NIC driver for your Linux system. # To reach maximum throughput disable all receive-, segmentation-, # checksum- offloading on your NIC (using ethtool or similar). # Disabling TX checksum offloading is *required* for connecting OS endpoint # with NIC endpoint. # You can find more information at https://github.com/luigirizzo/netmap # ## ## Configure Suricata to load Suricata-Update managed rules. ## default-rule-path: /var/lib/suricata/rules rule-files: # - /var/lib/suricata/rules/suricata.rules