Project

General

Profile

Bug #2457

Suricata 4.0.4 exits with [ERRCODE: SC_ERR_FATAL(171)] - Re-entered profiling, exiting

Added by Jose Vila 4 months ago. Updated 22 days ago.

Status:
New
Priority:
Normal
Assignee:
Target version:
Affected Versions:
Effort:
Difficulty:

Description

Hello,

I upgraded Suricata from 4.0.3 to 4.0.4 but since then Suricata has failed and exited abruptly twice, both times with this error:

12/3/2018 -- 13:51:33 - <Error> - [ERRCODE: SC_ERR_FATAL(171)] - Re-entered profiling, exiting.
13/3/2018 -- 03:08:58 - <Error> - [ERRCODE: SC_ERR_FATAL(171)] - Re-entered profiling, exiting.

With 4.0.3 it was working fine, and I have not detected any other kind of problem in the device.

This is my build info:

# suricata --build-info
This is Suricata version 4.0.4 RELEASE
Features: PCAP_SET_BUFF PF_RING AF_PACKET HAVE_PACKET_FANOUT LIBCAP_NG LIBNET1.1 HAVE_HTP_URI_NORMALIZE_HOOK PCRE_JIT HAVE_NSS HAVE_LIBJANSSON PROFILING TLS MAGIC
SIMD support: SSE_4_2 SSE_4_1 SSE_3
Atomic intrisics: 1 2 4 8 16 byte(s)
64-bits, Little-endian architecture
GCC version 4.8.5 20150623 (Red Hat 4.8.5-16), C version 199901
compiled with -fstack-protector
compiled with _FORTIFY_SOURCE=2
L1 cache line size (CLS)=64
thread local storage method: __thread
compiled with LibHTP v0.5.26, linked against LibHTP v0.5.26

Suricata Configuration:
  AF_PACKET support:                       yes
  PF_RING support:                         yes
  NFQueue support:                         no
  NFLOG support:                           no
  IPFW support:                            no
  Netmap support:                          no
  DAG enabled:                             no
  Napatech enabled:                        no

  Unix socket enabled:                     yes
  Detection enabled:                       yes

  Libmagic support:                        yes
  libnss support:                          yes
  libnspr support:                         yes
  libjansson support:                      yes
  hiredis support:                         no
  hiredis async with libevent:             no
  Prelude support:                         no
  PCRE jit:                                yes
  LUA support:                             no
  libluajit:                               no
  libgeoip:                                yes
  Non-bundled htp:                         no
  Old barnyard2 support:                   yes
  CUDA enabled:                            no
  Hyperscan support:                       yes
  Libnet support:                          yes

  Rust support (experimental):             no
  Experimental Rust parsers:               no
  Rust strict mode:                        no

  Suricatasc install:                      yes

  Profiling enabled:                       yes
  Profiling locks enabled:                 no

Development settings:
  Coccinelle / spatch:                     no
  Unit tests enabled:                      no
  Debug output enabled:                    no
  Debug validation enabled:                no

Generic build parameters:
  Installation prefix:                     /usr/local/suricata-4.0.4
  Configuration directory:                 /etc/suricata/
  Log directory:                           /var/log/suricata/

  --prefix                                 /usr/local/suricata-4.0.4
  --sysconfdir                             /etc
  --localstatedir                          /var

  Host:                                    x86_64-pc-linux-gnu
  Compiler:                                gcc (exec name) / gcc (real)
  GCC Protect enabled:                     yes
  GCC march native enabled:                yes
  GCC Profile enabled:                     no
  Position Independent Executable enabled: no
  CFLAGS                                   -g -O2 -march=native
  PCAP_CFLAGS
  SECCFLAGS                                -fstack-protector -D_FORTIFY_SOURCE=2 -Wformat -Wformat-security

History

#1 Updated by Andreas Herz 4 months ago

  • Assignee set to OISF Dev
  • Priority changed from High to Normal
  • Target version set to Support

Can you paste the run command you are using for suricata and maybe the config file as well?

#2 Updated by Manolo Cabezabolo 22 days ago

The command is /usr/local/bin/suricata -c /etc/suricata/suricata.yaml --pfring -D

%YAML 1.1
---

  1. Suricata configuration file. In addition to the comments describing all
  2. options in this file, full documentation can be found at:
  3. https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Suricatayaml
##
  1. Step 1: inform Suricata about your network ##

vars: # more specifc is better for alert accuracy and performance
address-groups:
HOME_NET: .......
#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"
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:
.....
##
  1. Step 2: select the rules to enable or disable ##

include: rules.yaml

#default-rule-path: /etc/suricata/rules
#rule-files:
  1. - botcc.rules # - botcc.portgrouped.rules
  2. - ciarmy.rules
  3. - compromised.rules
  4. - drop.rules
  5. - dshield.rules
  6. - emerging-activex.rules
  7. - emerging-attack_response.rules
  8. - emerging-chat.rules
  9. - emerging-current_events.rules
  10. - emerging-dns.rules
  11. - emerging-dos.rules
  12. - emerging-exploit.rules
  13. - emerging-ftp.rules
  14. - emerging-games.rules
  15. - emerging-icmp_info.rules
  16. - emerging-icmp.rules
  17. - emerging-imap.rules
  18. - emerging-inappropriate.rules
  19. - emerging-info.rules
  20. - emerging-malware.rules
  21. - emerging-misc.rules
  22. - emerging-mobile_malware.rules
  23. - emerging-netbios.rules
  24. - emerging-p2p.rules
  25. - emerging-policy.rules
  26. - emerging-pop3.rules
  27. - emerging-rpc.rules
  28. - emerging-scada.rules
  29. - emerging-scada_special.rules
  30. - emerging-scan.rules
  31. - emerging-shellcode.rules
  32. - emerging-smtp.rules
  33. - emerging-snmp.rules
  34. - emerging-sql.rules
  35. - emerging-telnet.rules
  36. - emerging-tftp.rules
  37. - emerging-trojan.rules
  38. - emerging-user_agents.rules
  39. - emerging-voip.rules
  40. - emerging-web_client.rules
  41. - emerging-web_server.rules
  42. - emerging-web_specific_apps.rules
  43. - emerging-worm.rules
  44. - tor.rules
  45. - decoder-events.rules # available in suricata sources under rules dir
  46. - stream-events.rules # available in suricata sources under rules dir
  47. - http-events.rules # available in suricata sources under rules dir
  48. - smtp-events.rules # available in suricata sources under rules dir
  49. - dns-events.rules # available in suricata sources under rules dir
  50. - tls-events.rules # available in suricata sources under rules dir
  51. - modbus-events.rules # available in suricata sources under rules dir
  52. - app-layer-events.rules # available in suricata sources under rules dir
  53. - dnp3-events.rules # available in suricata sources under rules dir
  1. classification-file: /etc/suricata/classification.config
  2. reference-config-file: /etc/suricata/reference.config
  3. threshold-file: /etc/suricata/threshold.config
##
  1. Step 3: select outputs to enable ##
  1. The default logging directory. Any log or output file will be
  2. placed here if its not specified with a full path name. This can be
  3. overridden with the -l command line parameter.
    default-log-dir: /var/log/suricata/
  1. global stats configuration
    stats:
    enabled: yes # The interval field (in seconds) controls at what interval # the loggers are invoked.
    interval: 8
  1. 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: yes
    filename: fast.log
    append: yes
    #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
    1. 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
      filename: eve-alerts.json
      filemode: ...
      #rotate-interval: hour
      #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 # redis: # 127.0.0.1 # port: ... #6379 # mode: list ## possible values: list (default), channel # key: suricata-test ## 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 as to be reserved to high traffic suricata. # pipelining: # enabled: yes ## set enable to yes to enable query pipelining # batch-size: 10 ## number of entry to keep in buffer
      types:
      - alert:
      payload: yes # enable dumping payload in Base64 # payload-buffer-size: 4kb # max size of payload buffer to output in eve-log
      payload-printable: no #yes # enable dumping payload in printable (lossy) format
      packet: yes # enable dumping of packet (without stream segments)
      http: yes # enable dumping of http fields
      tls: yes # enable dumping of tls fields
      ssh: yes # enable dumping of ssh fields
      smtp: yes # enable dumping of smtp fields
      dnp3: yes # enable dumping of DNP3 fields
      1. Enable the logging of tagged packets for rules using the # "tag" keyword.
        tagged-packets: yes
      2. - alert:
      3. payload: yes
      4. payload-printable: no
      5. packet: yes
      6. http: yes
      7. tls: yes
      8. ssh: yes
      9. smtp: yes
      10. dnp3: yes
      1. HTTP X-Forwarded-For support by adding an extra field or overwriting
      2. the source or destination IP address (depending on flow direction)
      3. with the one reported in the X-Forwarded-For HTTP header. This is
      4. helpful when reviewing alerts for traffic that is being reverse
      5. or forward proxied.
        xff:
        enabled: yes # 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
        - eve-log:
        enabled: yes
        filetype: regular #regular|syslog|unix_dgram|unix_stream|redis
        filename: eve-others.json
        filemode: 644
        #rotate-interval: hour
        types:
      1. tagged-packets: yes
        1. xff:
        2. enabled: yes
        3. mode: extra-data
        4. deployment: reverse
        5. header: X-Forwarded-For
          - http:
          extended: yes # 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]
      2. - dns:
      3. # control logging of queries and answers
      4. # default yes, no to disable
      5. query: yes # enable logging of DNS queries
      6. answer: yes # enable logging of DNS answers
      7. # control which RR types are logged
      8. # all enabled if custom not specified
      9. #custom: [a, aaaa, cname, mx, ns, ptr, txt]
        - tls:
        extended: yes # enable this for extended logging information
      10. - files:
      11. force-magic: no # force logging magic on all logged files
      12. # force logging of checksums, available hash functions are md5,
      13. # sha1 and sha256
      14. #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.
        - 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] - ssh
        - eve-log:
        enabled: yes
        filetype: regular #regular|syslog|unix_dgram|unix_stream|redis
        filename: eve-stats.json
        filemode: 644
        #rotate-interval: day
        types:
        - stats:
        totals: yes # stats for all threads merged together
        threads: yes # per thread stats
        deltas: yes # include delta values
        1. bi-directional flows
          #- flow
        2. uni-directional flows
          #- netflow
          #- dnp3
    1. alert output for use with Barnyard2
      - unified2-alert:
      enabled: yes
      filename: unified2.alert
      1. File size limit. Can be specified in kb, mb, gb. Just a number
      2. is parsed as bytes.
        limit: 128mb
      1. Sensor ID field of unified2 alerts.
        #sensor-id: 0
      1. Include payload of packets related to alerts. Defaults to true, set to
      2. false if payload is not required.
        #payload: yes
      1. HTTP X-Forwarded-For support by adding the unified2 extra header or
      2. overwriting the source or destination IP address (depending on flow
      3. direction) with the one reported in the X-Forwarded-For HTTP header.
      4. This is helpful when reviewing alerts for traffic that is being reverse
      5. or forward proxied.
        xff:
        enabled: yes # Two operation modes are available, "extra-data" and "overwrite". Note # that in the "overwrite" mode, if the reported IP address in the HTTP # X-Forwarded-For header is of a different version of the packet # received, it will fall-back to "extra-data" mode.
        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
    1. a line based log of HTTP requests (no alerts)
      - http-log:
      enabled: no
      filename: http.log
      append: yes
      #extended: yes # enable this for extended logging information
      #custom: yes # enabled the custom logging format (defined by customformat)
      #customformat: "%{%D-%H:%M:%S}t.%z %{X-Forwarded-For}i %H %m %h %u %s %B %a:%p -> %A:%P"
      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
    1. a line based log of TLS handshake parameters (no alerts)
      - tls-log:
      enabled: no # Log TLS connections.
      filename: tls.log # File to store TLS logs.
      append: yes
      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
      #extended: yes # Log extended information like fingerprint
    1. output module to store certificates chain to disk
      - tls-store:
      enabled: no
      #certs-log-dir: certs # directory to store the certificates files
    1. a line based log of DNS requests and/or replies (no alerts)
      - dns-log:
      enabled: no
      filename: dns.log
      append: yes
      filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
    1. Packet log... log packets in pcap format. 3 modes of operation: "normal"
    2. "multi" and "sguil". #
    3. In normal mode a pcap file "filename" is created in the default-log-dir,
    4. or are as specified by "dir".
    5. In multi mode, a file is created per thread. This will perform much
    6. better, but will create multiple files where 'normal' would create one.
    7. In multi mode the filename takes a few special variables:
    8. - %n -- thread number
    9. - %i -- thread id
    10. - %t -- timestamp (secs or secs.usecs based on 'ts-format'
    11. E.g. filename: pcap.%n.%t #
    12. Note that it's possible to use directories, but the directories are not
    13. created by Suricata. E.g. filename: pcaps/%n/log.%s will log into the
    14. per thread directory. #
    15. Also note that the limit and max-files settings are enforced per thread.
    16. So the size limit when using 8 threads with 1000mb files and 2000 files
    17. is: 8*1000*2000 ~ 16TiB. #
    18. In Sguil mode "dir" indicates the base directory. In this base dir the
    19. pcaps are created in th directory structure Sguil expects: #
    20. $sguil-base-dir/YYYY-MM-DD/$filename.<timestamp> #
    21. By default all packets are logged except:
    22. - TCP streams beyond stream.reassembly.depth
    23. - encrypted streams after the key exchange #
      - pcap-log:
      enabled: no
      filename: log.pcap
      1. File size limit. Can be specified in kb, mb, gb. Just a number
      2. is parsed as bytes.
        limit: 1000mb
      1. If set to a value will enable ring buffer mode. Will keep Maximum of "max-files" of size "limit"
        max-files: 2000

      mode: normal # normal, multi or sguil.

      1. Directory to place pcap files. If not provided the default log
      2. directory will be used. Required for "sguil" mode.
        #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 stopped being logged.

    1. a full alerts log containing much information for signature writers
    2. or for investigating suspected false positives.
      - alert-debug:
      enabled: no
      filename: alert-debug.log
      append: yes
      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
    1. alert output to prelude (http://www.prelude-technologies.com/) only
    2. available if Suricata has been compiled with --enable-prelude
      - alert-prelude:
      enabled: no
      profile: suricata
      log-packet-content: no
      log-packet-header: yes
    1. Stats.log contains data from various counters of the suricata engine.
      - stats:
      enabled: yes
      filename: stats.log
      totals: yes # stats for all threads merged together
      threads: yes # per thread stats
      #null-values: yes # print counters that have value 0
    1. a line based alerts log similar to fast.log into syslog
      - syslog:
      enabled: no # reported identity to syslog. If ommited the program name (usually # suricata) will be used.
      #identity: "suricata"
      facility: local5
      #level: Info ## possible levels: Emergency, Alert, Critical, ## Error, Warning, Notice, Info, Debug
    1. a line based information for dropped packets in IPS mode
      - drop:
      enabled: no
      filename: drop.log
      append: yes
      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
    1. output module to store extracted files to disk #
    2. The files are stored to the log-dir in a format "file.<id>" where <id> is
    3. an incrementing number starting at 1. For each file "file.<id>" a meta
    4. file "file.<id>.meta" is created. #
    5. File extraction depends on a lot of things to be fully done:
    6. - file-store stream-depth. For optimal results, set this to 0 (unlimited)
    7. - http request / response body sizes. Again set to 0 for optimal results.
    8. - rules that contain the "filestore" keyword.
      - file-store:
      enabled: no # set to yes to enable
      log-dir: files # directory to store the files
      force-magic: no # force logging magic on all stored files # force logging of checksums, available hash functions are md5, # sha1 and sha256
      #force-hash: [md5]
      force-filestore: no # force storing of all files # override global stream-depth for sessions in which we want to # perform file extraction. Set to 0 for unlimited.
      #stream-depth: 0
      #waldo: file.waldo # waldo file to store the file_id across runs
    1. output module to log files tracked in a easily parsable json format
      - file-log:
      enabled: no
      filename: files-json.log
      append: yes
      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram' force-magic: no # force logging magic on all logged files
      1. force logging of checksums, available hash functions are md5,
      2. sha1 and sha256
        #force-hash: [md5]
    1. Log TCP data after stream normalization
    2. 2 types: file or dir. File logs into a single logfile. Dir creates
    3. 2 files per TCP session and stores the raw TCP data into them.
    4. Using 'both' will enable both file and dir modes. #
    5. Note: limited by stream.depth
      - tcp-data:
      enabled: no
      type: file
      filename: tcp-data.log
    1. Log HTTP body data after normalization, dechunking and unzipping.
    2. 2 types: file or dir. File logs into a single logfile. Dir creates
    3. 2 files per HTTP session and stores the normalized data into them.
    4. Using 'both' will enable both file and dir modes. #
    5. Note: limited by the body limit settings
      - http-body-data:
      enabled: no
      type: file
      filename: http-data.log
    1. Lua Output Support - execute lua script to generate alert and event
    2. output.
    3. Documented at:
    4. https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Lua_Output
      - lua:
      enabled: no
      #scripts-dir: /etc/suricata/lua-output/
      scripts: # - script1.lua
  1. Logging configuration. This is not about logging IDS alerts/events, but
  2. 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 overriden by the SC_LOG_LEVEL env var.
    default-log-level: notice
    1. The default output format. Optional parameter, should default to
    2. something reasonable if not provided. Can be overriden in an
    3. output section. You can leave this out to get the default. #
    4. This value is overriden by the SC_LOG_FORMAT env var.
      #default-log-format: "[%i] %t - (%f:%l) <%d> (%n) -- "
    1. A regex to filter output. Can be overridden in an output section.
    2. Defaults to empty (no filter). #
    3. This value is overriden by the SC_LOG_OP_FILTER env var.
      default-output-filter:
    1. Define your logging outputs. If none are defined, or they are all
    2. disabled you will get the default - console output.
      outputs:
      - console:
      enabled: yes # type: json
      - file:
      enabled: yes
      level: info
      filename: /var/log/suricata/suricata.log # type: json
      - syslog:
      enabled: no
      facility: local5
      format: "[%i] <%d> -- " # type: json
##
  1. Step 4: configure common capture settings ##
  2. See "Advanced Capture Options" below for more options, including NETMAP
  3. and PF_RING. ##
  1. Linux high speed capture support
    af-packet:
    - interface: p2p1 # Number of receive threads. "auto" uses the number of cores
    threads: 1 #auto # Default clusterid. AF_PACKET will load balance packets based on flow.
    cluster-id: 99 # Default AF_PACKET cluster type. AF_PACKET can load balance per flow or per hash. # This is only supported for Linux kernel > 3.1 # possible value are: # * cluster_round_robin: round robin load balancing # * cluster_flow: all packets of a given flow are send to the same socket # * cluster_cpu: all packets treated in kernel by a CPU are send to the same socket # * cluster_qm: all packets linked by network card to a RSS queue are sent to the same # socket. Requires at least Linux 3.14. # * cluster_random: packets are sent randomly to sockets but with an equipartition. # Requires at least Linux 3.14. # * cluster_rollover: kernel rotates between sockets filling each socket before moving # to the next. Requires at least Linux 3.10. # Recommended modes are cluster_flow on most boxes and cluster_cpu or cluster_qm on system # with capture card using RSS (require cpu affinity tuning and system irq tuning)
    cluster-type: cluster_flow # In some fragmentation case, the hash can not be computed. If "defrag" is set # to yes, the kernel will do the needed defragmentation before sending the packets.
    defrag: yes # After Linux kernel 3.10 it is possible to activate the rollover option: if a socket is # full then kernel will send the packet on the next socket with room available. This option # can minimize packet drop and increase the treated bandwidth on single intensive flow.
    #rollover: yes # To use the ring feature of AF_PACKET, set 'use-mmap' to yes
    #use-mmap: yes # Lock memory map to avoid it goes to swap. Be careful that over suscribing could lock # your system
    #mmap-locked: yes # Use experimental tpacket_v3 capture mode, only active if use-mmap is true
    #tpacket-v3: yes # Ring size will be computed with respect to max_pending_packets and number # of threads. You can set manually the ring size in number of packets by setting # the following value. If you are using flow cluster-type and have really network # intensive single-flow you could want to set the ring-size independently of the number # of threads:
    #ring-size: 2048 # Block size is used by tpacket_v3 only. It should set to a value high enough to contain # a decent number of packets. Size is in bytes so please consider your MTU. It should be # a power of 2 and it must be multiple of page size (usually 4096).
    #block-size: 32768 # tpacket_v3 block timeout: an open block is passed to userspace if it is not # filled after block-timeout milliseconds.
    #block-timeout: 10 # On busy system, this could help to set it to yes to recover from a packet drop # phase. This will result in some packets (at max a ring flush) being non treated.
    #use-emergency-flush: yes # recv buffer size, increase value could improve performance # buffer-size: 32768 # Set to yes to disable promiscuous mode # disable-promisc: no # Choose checksum verification mode for the interface. At the moment # of the capture, some packets may be with an invalid checksum due to # offloading to the network card of the checksum computation. # Possible values are: # - kernel: use indication sent by kernel for each packet (default) # - yes: checksum validation is forced # - no: checksum validation is disabled # - auto: suricata uses a statistical approach to detect when # checksum off-loading is used. # Warning: 'checksum-validation' must be set to yes to have any validation
    #checksum-checks: kernel # BPF filter to apply to this interface. The pcap filter syntax apply here.
    #bpf-filter: port 80 or udp # You can use the following variables to activate AF_PACKET tap or IPS mode. # If copy-mode is set to ips or tap, the traffic coming to the current # interface will be copied to the copy-iface interface. If 'tap' is set, the # copy is complete. If 'ips' is set, the packet matching a 'drop' action # will not be copied.
    #copy-mode: ips
    #copy-iface: eth1

    - interface: p2p2
    threads: 1
    cluster-id: 99
    cluster-type: cluster_flow
    defrag: yes

    1. Put default values here. These will be used for an interface that is not
    2. in the list above.
      - interface: default
      #threads: auto
      #use-mmap: no
      #rollover: yes
      #tpacket-v3: yes
  1. Cross platform libpcap capture support
    pcap:
    - interface: ... # On Linux, pcap will try to use mmaped capture and will use buffer-size # as total of memory used by the ring. So set this to something bigger # than 1% of your bandwidth.
    #buffer-size: 16777216
    #bpf-filter: "tcp and port 25" # Choose checksum verification mode for the interface. At the moment # of the capture, some packets may be with an invalid checksum due to # offloading to the network card of the checksum computation. # Possible values are: # - yes: checksum validation is forced # - no: checksum validation is disabled # - auto: suricata uses a statistical approach to detect when # checksum off-loading is used. (default) # Warning: 'checksum-validation' must be set to yes to have any validation
    #checksum-checks: auto # With some accelerator cards using a modified libpcap (like myricom), you # may want to have the same number of capture threads as the number of capture # rings. In this case, set up the threads variable to N to start N threads # listening on the same interface.
    #threads: 16 # set to no to disable promiscuous mode:
    #promisc: no # set snaplen, if not set it defaults to MTU if MTU can be known # via ioctl call and to full capture if not.
    #snaplen: 1518 # Put default values here
    - interface: default
    #checksum-checks: auto
  1. Settings for reading pcap files
    pcap-file: # Possible values are: # - yes: checksum validation is forced # - no: checksum validation is disabled # - auto: suricata uses a statistical approach to detect when # checksum off-loading is used. (default) # Warning: 'checksum-validation' must be set to yes to have checksum tested
    checksum-checks: auto
  1. See "Advanced Capture Options" below for more options, including NETMAP
  2. and PF_RING.
##
  1. Step 5: App Layer Protocol Configuration ##
  1. Configure the app-layer parsers. The protocols section details each
  2. protocol. #
  3. The option "enabled" takes 3 values - "yes", "no", "detection-only".
  4. "yes" enables both detection and the parser, "no" disables both, and
  5. "detection-only" enables protocol detection only (parser disabled).
    app-layer:
    protocols:
    tls:
    enabled: yes
    detection-ports:
    dp: 443,8443
    1. Completely stop processing TLS/SSL session after the handshake # completed. If bypass is enabled this will also trigger flow # bypass. If disabled (the default), TLS/SSL session is still # tracked for Heartbleed and other anomalies.
      #no-reassemble: yes
      dcerpc:
      enabled: yes
      ftp:
      enabled: yes
      ssh:
      enabled: yes
      smtp:
      enabled: yes # Configure SMTP-MIME Decoder
      mime: # Decode MIME messages from SMTP transactions # (may be resource intensive) # This field supercedes all others because it turns the entire # process on or off
      decode-mime: yes
    2. smb2 detection is disabled internally inside the engine.
      #smb2:
    3. enabled: yes
      dns: # memcaps. Globally and per flow/state.
      #global-memcap: 16mb
      #state-memcap: 512kb
    1. How many unreplied DNS requests are considered a flood.
    2. If the limit is reached, app-layer-event:dns.flooded; will match.
      #request-flood: 500
    tcp:
    enabled: yes
    detection-ports:
    dp: 53
    udp:
    enabled: yes
    detection-ports:
    dp: 53
    http:
    enabled: yes
    1. memcap: 64mb
    1. default-config: Used when no server-config matches
    2. personality: List of personalities used by default
    3. request-body-limit: Limit reassembly of request body for inspection
    4. by http_client_body & pcre /P option.
    5. response-body-limit: Limit reassembly of response body for inspection
    6. by file_data, http_server_body & pcre /Q option.
    7. double-decode-path: Double decode path section of the URI
    8. double-decode-query: Double decode query section of the URI
    9. response-body-decompress-layer-limit:
    10. Limit to how many layers of compression will be
    11. decompressed. Defaults to 2. #
    12. server-config: List of server configurations to use if address matches
    13. address: List of ip addresses or networks for this block
    14. personalitiy: List of personalities used by this block
    15. request-body-limit: Limit reassembly of request body for inspection
    16. by http_client_body & pcre /P option.
    17. response-body-limit: Limit reassembly of response body for inspection
    18. by file_data, http_server_body & pcre /Q option.
    19. double-decode-path: Double decode path section of the URI
    20. double-decode-query: Double decode query section of the URI #
    21. uri-include-all: Include all parts of the URI. By default the
    22. 'scheme', username/password, hostname and port
    23. are excluded. Setting this option to true adds
    24. all of them to the normalized uri as inspected
    25. by http_uri, urilen, pcre with /U and the other
    26. keywords that inspect the normalized uri.
    27. Note that this does not affect http_raw_uri.
    28. Also, note that including all was the default in
    29. 1.4 and 2.0beta1. #
    30. meta-field-limit: Hard size limit for request and response size
    31. limits. Applies to request line and headers,
    32. response line and headers. Does not apply to
    33. request or response bodies. Default is 18k.
    34. If this limit is reached an event is raised. #
    35. Currently Available Personalities:
    36. Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0,
    37. IIS_7_0, IIS_7_5, Apache_2
      libhtp:
      default-config:
      personality: IDS
      1. Can be specified in kb, mb, gb. Just a number indicates # it's in bytes.
        request-body-limit: 100kb
        response-body-limit: 100kb
      1. inspection limits
        request-body-minimal-inspect-size: 32kb
        request-body-inspect-window: 4kb
        response-body-minimal-inspect-size: 40kb
        response-body-inspect-window: 16kb
      1. response body decompression (0 disables)
        response-body-decompress-layer-limit: 2
      1. auto will use http-body-inline mode in IPS mode, yes or no set it statically
        http-body-inline: auto
      1. Take a random value for inspection sizes around the specified value.
      2. This lower the risk of some evasion technics but could lead
      3. detection change between runs. It is set to 'yes' by default.
        #randomize-inspection-sizes: yes
      4. If randomize-inspection-sizes is active, the value of various
      5. inspection size will be choosen in the [1 - range%, 1 + range%]
      6. range
      7. Default value of randomize-inspection-range is 10.
        #randomize-inspection-range: 10
      1. decoding
        double-decode-path: no
        double-decode-query: no

      server-config:

    38. apache:
      1. address: [192.168.1.0/24, 127.0.0.0/8, "::1"]
      2. personality: Apache_2
      3. # Can be specified in kb, mb, gb. Just a number indicates
      4. # it's in bytes.
      5. request-body-limit: 4096
      6. response-body-limit: 4096
      7. double-decode-path: no
      8. double-decode-query: no
    39. iis7:
      1. address:
      1. personality: IIS_7_0
      2. # Can be specified in kb, mb, gb. Just a number indicates
      3. # it's in bytes.
      4. request-body-limit: 4096
      5. response-body-limit: 4096
      6. double-decode-path: no
      7. double-decode-query: no
    1. Note: Modbus probe parser is minimalist due to the poor significant field
    2. Only Modbus message length (greater than Modbus header length)
    3. And Protocol ID (equal to 0) are checked in probing parser
    4. It is important to enable detection port and define Modbus port
    5. to avoid false positive
      modbus: # How many unreplied Modbus requests are considered a flood. # If the limit is reached, app-layer-event:modbus.flooded; will match.
      #request-flood: 500 enabled: no
      detection-ports:
      dp: 502
      1. According to MODBUS Messaging on TCP/IP Implementation Guide V1.0b, it
      2. is recommended to keep the TCP connection opened with a remote device
      3. and not to open and close it for each MODBUS/TCP transaction. In that
      4. case, it is important to set the depth of the stream reassembling as
      5. unlimited (stream.reassembly.depth: 0)
      1. Stream reassembly size for modbus. By default track it completely.
        stream-depth: 0
    1. DNP3
      dnp3:
      enabled: no
      detection-ports:
      dp: 20000
    1. SCADA EtherNet/IP and CIP protocol support
      enip:
      enabled: no
      detection-ports:
      dp: 44818
      sp: 44818
  1. Limit for the maximum number of asn1 frames to decode (default 256)
    asn1-max-frames: 256
############################################################################## ##
  1. Advanced settings below ## ##############################################################################
##
  1. Run Options ##
  1. Run suricata as user and group.
    run-as:
    user: suricata
    group: suricata
  1. Some logging module will use that name in event as identifier. The default
  2. value is the hostname
    #sensor-name: suricata
  1. Default pid file.
  2. Will use this file if no --pidfile in command options.
    #pid-file: /var/run/suricata.pid
  1. Daemon working directory
  2. Suricata will change directory to this one if provided
  3. Default: "/"
    #daemon-directory: "/"
  1. Suricata core dump configuration. Limits the size of the core dump file to
  2. approximately max-dump. The actual core dump size will be a multiple of the
  3. page size. Core dumps that would be larger than max-dump are truncated. On
  4. Linux, the actual core dump size may be a few pages larger than max-dump.
  5. Setting max-dump to 0 disables core dumping.
  6. Setting max-dump to 'unlimited' will give the full core dump file.
  7. On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size
  8. to be 'unlimited'.

coredump:
max-dump: unlimited

  1. If suricata box is a router for the sniffed networks, set it to 'router'. If
  2. it is a pure sniffing setup, set it to 'sniffer-only'.
  3. If set to auto, the variable is internally switch to 'router' in IPS mode
  4. and 'sniffer-only' in IDS mode.
  5. This feature is currently only used by the reject* keywords.
    host-mode: auto
  1. Number of packets preallocated per thread. The default is 1024. A higher number
  2. will make sure each CPU will be more easily kept busy, but may negatively
  3. impact caching. #
  4. If you are using the CUDA pattern matcher (mpm-algo: ac-cuda), different rules
  5. apply. In that case try something like 60000 or more. This is because the CUDA
  6. pattern matcher buffers and scans as many packets as possible in parallel.
    #max-pending-packets: 1024
  1. Runmode the engine should use. Please check --list-runmodes to get the available
  2. runmodes for each packet acquisition method. Defaults to "autofp" (auto flow pinned
  3. load balancing).
    #runmode: autofp
    runmode: workers
  1. Specifies the kind of flow load balancer used by the flow pinned autofp mode. #
  2. Supported schedulers are: #
  3. round-robin - Flows assigned to threads in a round robin fashion.
  4. active-packets - Flows assigned to threads that have the lowest number of
  5. unprocessed packets (default).
  6. hash - Flow alloted usihng the address hash. More of a random
  7. technique. Was the default in Suricata 1.2.1 and older. #
    #autofp-scheduler: active-packets
  1. Preallocated size for packet. Default is 1514 which is the classical
  2. size for pcap on ethernet. You should adjust this value to the highest
  3. packet size (MTU + hardware header) on your system.
    #default-packet-size: 1514
  1. Unix command socket can be used to pass commands to suricata.
  2. An external tool can then connect to get information from suricata
  3. or trigger some modifications of the engine. Set enabled to yes
  4. to activate the feature. In auto mode, the feature will only be
  5. activated in live capture mode. You can use the filename variable to set
  6. the file name of the socket.
    unix-command:
    enabled: yes
    #filename: custom.socket
  1. Magic file. The extension .mgc is added to the value here.
    #magic-file: /usr/share/file/magic
    #magic-file:

legacy:
uricontent: enabled

##
  1. Detection settings ##
  1. Set the order of alerts bassed on actions
  2. The default order is pass, drop, reject, alert
  3. action-order:
  4. - pass
  5. - drop
  6. - reject
  7. - alert
  1. IP Reputation
    #reputation-categories-file: /etc/suricata/iprep/categories.txt
    #default-reputation-path: /etc/suricata/iprep
    #reputation-files:
  2. - reputation.list
  1. When run with the option --engine-analysis, the engine will read each of
  2. the parameters below, and print reports for each of the enabled sections
  3. and exit. The reports are printed to a file in the default log dir
  4. given by the parameter "default-log-dir", with engine reporting
  5. 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

##
  1. Advanced Traffic Tracking and Reconstruction Settings ##
  1. Host specific policies for defragmentation and TCP stream
  2. reassembly. The host OS lookup is done using a radix tree, just
  3. 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: []
  1. Defrag settings:

defrag:
memcap: 32mb
hash-size: 65536
trackers: 65535 # number of defragmented flows to follow
max-frags: 65535 # number of fragments to keep (higher than trackers)
prealloc: yes
timeout: 60

  1. Enable defrag per host settings
  2. host-config: #
  3. - dmz:
  4. timeout: 30
  5. address: ... #
  6. - lan:
  7. timeout: 45
  8. address:
  1. Flow settings:
  2. By default, the reserved memory (memcap) for flows is 32MB. This is the limit
  3. for flow allocation inside the engine. You can change this value to allow
  4. more memory usage for flows.
  5. The hash-size determine the size of the hash used to identify flows inside
  6. the engine, and by default the value is 65536.
  7. At the startup, the engine can preallocate a number of flows, to get a better
  8. performance. The number of flows preallocated is 10000 by default.
  9. emergency-recovery is the percentage of flows that the engine need to
  10. prune before unsetting the emergency state. The emergency state is activated
  11. when the memcap limit is reached, allowing to create new flows, but
  12. prunning them with the emergency timeouts (they are defined below).
  13. If the memcap is reached, the engine will try to prune flows
  14. with the default timeouts. If it doens't find a flow to prune, it will set
  15. the emergency bit and it will try again with more agressive timeouts.
  16. If that doesn't work, then it will try to kill the last time seen flows
  17. not in use.
  18. The memcap can be specified in kb, mb, gb. Just a number indicates it's
  19. in bytes.

flow:
memcap: 128mb
hash-size: 65536
prealloc: 10000
emergency-recovery: 30
#managers: 1 # default to one flow manager
#recyclers: 1 # default to one flow recycler thread

  1. This option controls the use of vlan ids in the flow (and defrag)
  2. hashing. Normally this should be enabled, but in some (broken)
  3. setups where both sides of a flow are not tagged with the same vlan
  4. tag, we can ignore the vlan id's in the flow hashing.
    vlan:
    use-for-tracking: true
  1. Specific timeouts for flows. Here you can specify the timeouts that the
  2. active flows will wait to transit from the current state to another, on each
  3. protocol. The value of "new" determine the seconds to wait after a hanshake or
  4. stream startup before the engine free the data of that flow it doesn't
  5. change the state to established (usually if we don't receive more packets
  6. of that flow). The value of "established" is the amount of
  7. seconds that the engine will wait to free the flow if it spend that amount
  8. without receiving new packets or closing the connection. "closed" is the
  9. amount of time to wait after a flow is closed (usually zero). "bypassed"
  10. timeout controls locally bypassed flows. For these flows we don't do any other
  11. tracking. If no packets have been seen after this timeout, the flow is discarded. #
  12. There's an emergency mode that will become active under attack circumstances,
  13. making the engine to check flow status faster. This configuration variables
  14. use the prefix "emergency-" and work similar as the normal ones.
  15. Some timeouts doesn't apply to all the protocols, like "closed", for udp and
  16. icmp.

flow-timeouts:

default:
new: 30
established: 300
closed: 0
bypassed: 100
emergency-new: 10
emergency-established: 100
emergency-closed: 0
emergency-bypassed: 50
tcp:
new: 60
established: 600
closed: 60
bypassed: 100
emergency-new: 5
emergency-established: 100
emergency-closed: 10
emergency-bypassed: 50
udp:
new: 30
established: 300
bypassed: 100
emergency-new: 10
emergency-established: 100
emergency-bypassed: 50
icmp:
new: 30
established: 300
bypassed: 100
emergency-new: 10
emergency-established: 100
emergency-bypassed: 50
  1. Stream engine settings. Here the TCP stream tracking and reassembly
  2. engine is configured. #
  3. stream:
  4. memcap: 32mb # Can be specified in kb, mb, gb. Just a
  5. # number indicates it's in bytes.
  6. checksum-validation: yes # To validate the checksum of received
  7. # packet. If csum validation is specified as
  8. # "yes", then packet with invalid csum will not
  9. # be processed by the engine stream/app layer.
  10. # Warning: locally generated trafic can be
  11. # generated without checksum due to hardware offload
  12. # of checksum. You can control the handling of checksum
  13. # on a per-interface basis via the 'checksum-checks'
  14. # option
  15. prealloc-sessions: 2k # 2k sessions prealloc'd per stream thread
  16. midstream: false # don't allow midstream session pickups
  17. async-oneside: false # don't enable async stream handling
  18. inline: no # stream inline mode
  19. max-synack-queued: 5 # Max different SYN/ACKs to queue
  20. bypass: no # Bypass packets when stream.depth is reached #
  21. reassembly:
  22. memcap: 64mb # Can be specified in kb, mb, gb. Just a number
  23. # indicates it's in bytes.
  24. depth: 1mb # Can be specified in kb, mb, gb. Just a number
  25. # indicates it's in bytes.
  26. toserver-chunk-size: 2560 # inspect raw stream in chunks of at least
  27. # this size. Can be specified in kb, mb,
  28. # gb. Just a number indicates it's in bytes.
  29. # The max acceptable size is 4024 bytes.
  30. toclient-chunk-size: 2560 # inspect raw stream in chunks of at least
  31. # this size. Can be specified in kb, mb,
  32. # gb. Just a number indicates it's in bytes.
  33. # The max acceptable size is 4024 bytes.
  34. randomize-chunk-size: yes # Take a random value for chunk size around the specified value.
  35. # This lower the risk of some evasion technics but could lead
  36. # detection change between runs. It is set to 'yes' by default.
  37. randomize-chunk-range: 10 # If randomize-chunk-size is active, the value of chunk-size is
  38. # a random value between (1 - randomize-chunk-range/100)*toserver-chunk-size
  39. # and (1 + randomize-chunk-range/100)*toserver-chunk-size and the same
  40. # calculation for toclient-chunk-size.
  41. # Default value of randomize-chunk-range is 10. #
  42. raw: yes # 'Raw' reassembly enabled or disabled.
  43. # raw is for content inspection by detection
  44. # engine. #
  45. chunk-prealloc: 250 # Number of preallocated stream chunks. These
  46. # are used during stream inspection (raw).
  47. segments: # Settings for reassembly segment pool.
  48. - size: 4 # Size of the (data)segment for a pool
  49. prealloc: 256 # Number of segments to prealloc and keep
  50. # in the pool.
  51. zero-copy-size: 128 # This option sets in bytes the value at
  52. # which segment data is passed to the app
  53. # layer API directly. Data sizes equal to
  54. # and higher than the value set are passed
  55. # on directly. #
    stream:
    memcap: 512mb #64mb
    checksum-validation: yes # reject wrong csums
    inline: auto # auto will use inline mode in IPS mode, yes or no set it statically
    reassembly:
    memcap: 2gb #256mb
    depth: 8mb # 1mb # reassemble 1mb into a stream
    toserver-chunk-size: 2560
    toclient-chunk-size: 2560
    randomize-chunk-size: yes
    #randomize-chunk-range: 10
    #raw: yes
    #chunk-prealloc: 250
    #segments: # - size: 4 # prealloc: 256 # - size: 16 # prealloc: 512 # - size: 112 # prealloc: 512 # - size: 248 # prealloc: 512 # - size: 512 # prealloc: 512 # - size: 768 # prealloc: 1024 # 'from_mtu' means that the size is mtu - 40, # or 1460 if mtu couldn't be determined. # - size: from_mtu # prealloc: 1024 # - size: 65535 # prealloc: 128
    #zero-copy-size: 128
  1. Host table: #
  2. Host table is used by tagging and per host thresholding subsystems. #
    host:
    hash-size: 4096
    prealloc: 1000
    memcap: 32mb
  1. IP Pair table: #
  2. Used by xbits 'ippair' tracking. #
    #ippair:
  3. hash-size: 4096
  4. prealloc: 1000
  5. memcap: 32mb
##
  1. Performance tuning and profiling ##
  1. The detection engine builds internal groups of signatures. The engine
  2. allow us to specify the profile to use for them, to manage memory on an
  3. efficient way keeping a good performance. For the profile keyword you
  4. can use the words "low", "medium", "high" or "custom". If you use custom
  5. make sure to define the values at "- custom-values" as your convenience.
  6. Usually you would prefer medium/high/low. #
  7. "sgh mpm-context", indicates how the staging should allot mpm contexts for
  8. the signature groups. "single" indicates the use of a single context for
  9. all the signature group heads. "full" indicates a mpm-context for each
  10. group head. "auto" lets the engine decide the distribution of contexts
  11. based on the information the engine gathers on the patterns from each
  12. group head. #
  13. The option inspection-recursion-limit is used to limit the recursive calls
  14. in the content inspection code. For certain payload-sig combinations, we
  15. might end up taking too much time in the content inspection code.
  16. If the argument specified is 0, the engine uses an internally defined
  17. default limit. On not specifying a value, we use no limits on the recursion.
    detect:
    profile: medium
    custom-values:
    toclient-groups: 3
    toserver-groups: 25
    sgh-mpm-context: auto
    inspection-recursion-limit: 3000 # 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

    1. the grouping values above control how many groups are created per
    2. direction. Port whitelisting forces that port to get it's own group.
    3. Very common ports will benefit, as well as ports with many expensive
    4. rules.
      grouping:
      #tcp-whitelist: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080
      #udp-whitelist: 53, 135, 5060

    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: false
    include-rules: false # very verbose
    include-mpm-stats: false

  1. Select the multi pattern algorithm you want to run for scan/search the
  2. in the engine. #
  3. The supported algorithms are:
  4. "ac" - Aho-Corasick, default implementation
  5. "ac-bs" - Aho-Corasick, reduced memory implementation
  6. "ac-cuda" - Aho-Corasick, CUDA implementation
  7. "ac-ks" - Aho-Corasick, "Ken Steele" variant
  8. "hs" - Hyperscan, available when built with Hyperscan support #
  9. The default mpm-algo value of "auto" will use "hs" if Hyperscan is
  10. available, "ac" otherwise. #
  11. The mpm you choose also decides the distribution of mpm contexts for
  12. signature groups, specified by the conf - "detect.sgh-mpm-context".
  13. Selecting "ac" as the mpm would require "detect.sgh-mpm-context"
  14. to be set to "single", because of ac's memory requirements, unless the
  15. ruleset is small enough to fit in one's memory, in which case one can
  16. use "full" with "ac". Rest of the mpms can be run in "full" mode. #
  17. There is also a CUDA pattern matcher (only available if Suricata was
  18. compiled with --enable-cuda: b2g_cuda. Make sure to update your
  19. max-pending-packets setting above as well if you use b2g_cuda.

mpm-algo: auto

  1. Select the matching algorithm you want to use for single-pattern searches. #
  2. Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only
  3. available if Suricata has been built with Hyperscan support). #
  4. The default of "auto" will use "hs" if available, otherwise "bm".

spm-algo: auto

  1. Suricata is multi-threaded. Here the threading can be influenced.
    threading:
    set-cpu-affinity: yes #no # Tune cpu affinity of threads. Each family of threads can be bound # on 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 ] # include only these cpus in affinity settings
    - receive-cpu-set:
    cpu: [ 0 ] # include only these cpus in affinity settings
    - worker-cpu-set:
    cpu: [ 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54 ] # [ "all" ]
    mode: "exclusive" # Use explicitely 3 threads and don't compute number by using # detect-thread-ratio variable: # threads: 3
    prio: # low: [ 0 ] # medium: [ "1-2" ] # high: [ 3 ]
    default: "high" # "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: 0.5 #1.0
  1. Luajit has a strange memory requirement, it's 'states' need to be in the
  2. first 2G of the process' memory. #
  3. 'luajit.states' is used to control how many states are preallocated.
  4. State use: per detect script: 1 per detect thread. Per output script: 1 per
  5. script.
    luajit:
    states: 128
  1. Profiling settings. Only effective if Suricata has been built with the
  2. the --enable-profiling configure flag. #
    profiling: # Run profiling for every xth packet. The default is 1, which means we # profile every packet. If set to 1000, one packet is profiled for every # 1000 received.
    sample-rate: 100
    1. rule profiling
      rules:
      1. Profiling can be disabled here, but it will still have a
      2. performance impact if compiled in.
        enabled: yes
        filename: rule_perf.log
        append: yes
      1. Sort options: ticks, avgticks, checks, matches, maxticks
        sort: avgticks
      1. Limit the number of items printed at exit (ignored for json).
        limit: 100
      1. output to json
        json: yes
    1. per keyword profiling
      keywords:
      enabled: yes
      filename: keyword_perf.log
      append: yes
    1. per rulegroup profiling
      rulegroups:
      enabled: yes
      filename: rule_group_perf.log
      append: yes
    1. packet profiling
      packets:
      1. Profiling can be disabled here, but it will still have a
      2. performance impact if compiled in.
        enabled: yes
        filename: packet_stats.log
        append: yes
      1. per packet csv output
        csv:
        1. Output can be disabled here, but it will still have a
        2. performance impact if compiled in.
          enabled: no
          filename: packet_stats.csv
    1. profiling of locking. Only available when Suricata was built with
    2. --enable-profiling-locks.
      locks:
      enabled: no
      filename: lock_stats.log
      append: yes

    pcap-log:
    enabled: no
    filename: pcaplog_stats.log
    append: yes

##
  1. Netfilter integration ##
  1. When running in NFQ inline mode, it is possible to use a simulated
  2. non-terminal NFQUEUE verdict.
  3. This permit to do send all needed packet to suricata via this a rule:
  4. iptables -I FORWARD -m mark ! --mark $MARK/$MASK -j NFQUEUE
  5. And below, you can have your standard filtering ruleset. To activate
  6. this mode, you need to set mode to 'repeat'
  7. If you want packet to be sent to another queue after an ACCEPT decision
  8. set mode to 'route' and set next-queue value.
  9. On linux >= 3.1, you can set batchcount to a value > 1 to improve performance
  10. by processing several packets before sending a verdict (worker runmode only).
  11. On linux >= 3.6, you can set the fail-open option to yes to have the kernel
  12. accept the packet if suricata is not able to keep pace.
  13. bypass mark and mask can be used to implement NFQ bypass. If bypass mark is
  14. set then the NFQ bypass is activated. Suricata will set the bypass mark/mask
  15. on packet of a flow that need to be bypassed. The Nefilter ruleset has to
  16. directly accept all packets of a flow once a packet has been marked.
    nfq:
  17. mode: accept
  18. repeat-mark: 1
  19. repeat-mask: 1
  20. bypass-mark: 1
  21. bypass-mask: 1
  22. route-queue: 2
  23. batchcount: 20
  24. fail-open: 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 packet to queue inside kernel
qthreshold: 1 # set the delay before flushing packet in the queue inside kernel
qtimeout: 100 # netlink max buffer size
max-size: 20000

##
  1. Advanced Capture Options ##
  1. general settings affecting packet capture
    capture: # disable NIC offloading. It's restored when Suricata exists. # Enabled by default
    #disable-offloading: false # # disable checksum validation. Same as setting '-k none' on the # commandline
    #checksum-validation: none
  1. Netmap support #
  2. Netmap operates with NIC directly in driver, so you need FreeBSD wich have
  3. built-in netmap support or compile and install netmap module and appropriate
  4. NIC driver on your Linux system.
  5. To reach maximum throughput disable all receive-, segmentation-,
  6. checksum- offloadings on NIC.
  7. Disabling Tx checksum offloading is required for connecting OS endpoint
  8. with NIC endpoint.
  9. You can find more information at https://github.com/luigirizzo/netmap #
    netmap: # To specify OS endpoint add plus sign at the end (e.g. "eth0+")
    - interface: eth2 # Number of receive threads. "auto" uses number of RSS queues on interface.
    #threads: auto # You can use the following variables to activate netmap tap or IPS mode. # If copy-mode is set to ips or tap, the traffic coming to the current # interface will be copied to the copy-iface interface. If 'tap' is set, the # copy is complete. If 'ips' is set, the packet matching a 'drop' action # will not be copied. # To specify the OS as the copy-iface (so the OS can route packets, or forward # to a service running on the same machine) add a plus sign at the end # (e.g. "copy-iface: eth0+"). Don't forget to set up a symmetrical eth0+ -> eth0 # for return packets. Hardware checksumming must be off on the interface if # using an OS endpoint (e.g. 'ifconfig eth0 -rxcsum -txcsum -rxcsum6 -txcsum6' for FreeBSD # or 'ethtool -K eth0 tx off rx off' for Linux).
    #copy-mode: tap
    #copy-iface: eth3 # Set to yes to disable promiscuous mode # disable-promisc: no # Choose checksum verification mode for the interface. At the moment # of the capture, some packets may be with an invalid checksum due to # offloading to the network card of the checksum computation. # Possible values are: # - yes: checksum validation is forced # - no: checksum validation is disabled # - auto: suricata uses a statistical approach to detect when # checksum off-loading is used. # Warning: 'checksum-validation' must be set to yes to have any validation
    #checksum-checks: auto # BPF filter to apply to this interface. The pcap filter syntax apply here.
    #bpf-filter: port 80 or udp
    #- interface: eth3
    #threads: auto
    #copy-mode: tap
    #copy-iface: eth2 # Put default values here
    - interface: default
  1. PF_RING configuration. for use with native PF_RING support
  2. for more info see http://www.ntop.org/products/pf_ring/
    pfring:
    - interface: ... # Number of receive threads (>1 will enable experimental flow pinned # runmode)
    threads: 10
    1. Default clusterid. PF_RING will load balance packets based on flow. # All threads/processes that will participate need to have the same # clusterid.
      cluster-id: 99
    2. Second interface
      - interface: ...
      threads: 10
      cluster-id: 93
      cluster-type: cluster_flow
    3. Put default values here
      - interface: default
      #threads: 2
    1. Default PF_RING cluster type. PF_RING can load balance per flow.
    2. Possible values are cluster_flow or cluster_round_robin.
      cluster-type: cluster_flow
    3. bpf filter for this interface
      #bpf-filter: tcp
    4. Choose checksum verification mode for the interface. At the moment
    5. of the capture, some packets may be with an invalid checksum due to
    6. offloading to the network card of the checksum computation.
    7. Possible values are:
    8. - rxonly: only compute checksum for packets received by network card.
    9. - yes: checksum validation is forced
    10. - no: checksum validation is disabled
    11. - auto: suricata uses a statistical approach to detect when
    12. checksum off-loading is used. (default)
    13. Warning: 'checksum-validation' must be set to yes to have any validation
      #checksum-checks: auto
  1. For FreeBSD ipfw(8) divert(4) support.
  2. Please make sure you have ipfw_load="YES" and ipdivert_load="YES"
  3. in /etc/loader.conf or kldload'ing the appropriate kernel modules.
  4. Additionally, you need to have an ipfw rule for the engine to see
  5. the packets from ipfw. For Example: #
  6. ipfw add 100 divert 8000 ip from any to any #
  7. The 8000 above should be the same number you passed on the command
  8. line, i.e. -d 8000 #
    ipfw:
    1. Reinject packets at the specified ipfw rule number. This config
    2. option is the ipfw rule number AT WHICH rule processing continues
    3. in the ipfw processing system after the engine has finished
    4. inspecting the packet for acceptance. If no rule number is specified,
    5. accepted packets are reinjected at the divert rule which they entered
    6. and IPFW rule processing continues. No check is done to verify
    7. this will rule makes sense so care must be taken to avoid loops in ipfw. #
      1. The following example tells the engine to reinject packets
    8. back into the ipfw firewall AT rule number 5500: #
    9. ipfw-reinjection-rule-number: 5500

napatech: # The Host Buffer Allowance for all streams # (-1 = OFF, 1 - 100 = percentage of the host buffer that can be held back)
hba: -1

  1. use_all_streams set to "yes" will query the Napatech service for all configured
  2. streams and listen on all of them. When set to "no" the streams config array
  3. will be used.
    use-all-streams: yes
  1. The streams to listen on
    streams: [1, 2, 3]
  1. Tilera mpipe configuration. for use on Tilera TILE-Gx.
    mpipe:
    1. Load balancing modes: "static", "dynamic", "sticky", or "round-robin".
      load-balance: dynamic
    1. Number of Packets in each ingress packet queue. Must be 128, 512, 2028 or 65536
      iqueue-packets: 2048
    1. List of interfaces we will listen on.
      inputs:
      - interface: xgbe2
      - interface: xgbe3
      - interface: xgbe4
    1. Relative weight of memory for packets of each mPipe buffer size.
      stack:
      size128: 0
      size256: 9
      size512: 0
      size1024: 0
      size1664: 7
      size4096: 0
      size10386: 0
      size16384: 0
##
  1. Hardware accelaration ##
  1. Cuda configuration.
    cuda: # The "mpm" profile. On not specifying any of these parameters, the engine's # internal default values are used, which are same as the ones specified in # in the default conf file.
    mpm: # The minimum length required to buffer data to the gpu. # Anything below this is MPM'ed on the CPU. # Can be specified in kb, mb, gb. Just a number indicates it's in bytes. # A value of 0 indicates there's no limit.
    data-buffer-size-min-limit: 0 # The maximum length for data that we would buffer to the gpu. # Anything over this is MPM'ed on the CPU. # Can be specified in kb, mb, gb. Just a number indicates it's in bytes.
    data-buffer-size-max-limit: 1500 # The ring buffer size used by the CudaBuffer API to buffer data.
    cudabuffer-buffer-size: 500mb # The max chunk size that can be sent to the gpu in a single go.
    gpu-transfer-size: 50mb # The timeout limit for batching of packets in microseconds.
    batching-timeout: 2000 # The device to use for the mpm. Currently we don't support load balancing # on multiple gpus. In case you have multiple devices on your system, you # can specify the device to use, using this conf. By default we hold 0, to # specify the first device cuda sees. To find out device-id associated with # the card(s) on the system run "suricata --list-cuda-cards".
    device-id: 0 # No of Cuda streams used for asynchronous processing. All values > 0 are valid. # For this option you need a device with Compute Capability > 1.0.
    cuda-streams: 2
##
  1. Include other configs ##
  1. Includes. Files included here will be handled as if they were
  2. inlined in this configuration file.
    #include: include1.yaml
    #include: include2.yaml

Also available in: Atom PDF