4 # Suricata configuration file. In addition to the comments describing all
5 # options in this file, full documentation can be found at:
6 # https://suricata.readthedocs.io/en/latest/configuration/suricata-yaml.html
9 ## Step 1: Inform Suricata about your network
13 # more specific is better for alert accuracy and performance
15 HOME_NET: "[192.168.0.0/16,10.0.0.0/8,172.16.0.0/12]"
16 #HOME_NET: "[192.168.0.0/16]"
17 #HOME_NET: "[10.0.0.0/8]"
18 #HOME_NET: "[172.16.0.0/12]"
21 EXTERNAL_NET: "!$HOME_NET"
24 HTTP_SERVERS: "$HOME_NET"
25 SMTP_SERVERS: "$HOME_NET"
26 SQL_SERVERS: "$HOME_NET"
27 DNS_SERVERS: "$HOME_NET"
28 TELNET_SERVERS: "$HOME_NET"
29 AIM_SERVERS: "$EXTERNAL_NET"
30 DC_SERVERS: "$HOME_NET"
31 DNP3_SERVER: "$HOME_NET"
32 DNP3_CLIENT: "$HOME_NET"
33 MODBUS_CLIENT: "$HOME_NET"
34 MODBUS_SERVER: "$HOME_NET"
35 ENIP_CLIENT: "$HOME_NET"
36 ENIP_SERVER: "$HOME_NET"
40 SHELLCODE_PORTS: "!80"
45 FILE_DATA_PORTS: "[$HTTP_PORTS,110,143]"
51 ## Step 2: Select outputs to enable
54 # The default logging directory. Any log or output file will be
55 # placed here if it's not specified with a full path name. This can be
56 # overridden with the -l command line parameter.
57 default-log-dir: @e_logdir@
59 # Global stats configuration
62 # The interval field (in seconds) controls the interval at
63 # which stats are updated in the log.
65 # Add decode events to stats.
67 # Decoder event prefix in stats. Has been 'decoder' before, but that leads
68 # to missing events in the eve.stats records. See issue #2225.
69 #decoder-events-prefix: "decoder.event"
70 # Add stream events as stats.
73 # Configure the type of alert (and other) logging you would like.
75 # a line based alerts log similar to Snort's fast.log
80 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
82 # Extensible Event Format (nicknamed EVE) event log in JSON format
84 enabled: @e_enable_evelog@
85 filetype: regular #regular|syslog|unix_dgram|unix_stream|redis
87 #prefix: "@cee: " # prefix to prepend to each log entry
88 # the following are valid when type: syslog above
91 #level: Info ## possible levels: Emergency, Alert, Critical,
92 ## Error, Warning, Notice, Info, Debug
96 # async: true ## if redis replies are read asynchronously
97 # mode: list ## possible values: list|lpush (default), rpush, channel|publish
98 # ## lpush and rpush are using a Redis list. "list" is an alias for lpush
99 # ## publish is using a Redis channel. "channel" is an alias for publish
100 # key: suricata ## key or channel to use (default to suricata)
101 # Redis pipelining set up. This will enable to only do a query every
102 # 'batch-size' events. This should lower the latency induced by network
103 # connection at the cost of some memory. There is no flushing implemented
104 # so this setting should be reserved to high traffic Suricata deployments.
106 # enabled: yes ## set enable to yes to enable query pipelining
107 # batch-size: 10 ## number of entries to keep in buffer
109 # Include top level metadata. Default yes.
112 # include the name of the input pcap file in pcap file processing mode
116 # Adds a 'community_id' field to EVE records. These are meant to give
117 # records a predictable flow ID that can be used to match records to
118 # output of other tools such as Zeek (Bro).
120 # Takes a 'seed' that needs to be same across sensors and tools
121 # to make the id less predictable.
123 # enable/disable the community id feature.
125 # Seed value for the ID output. Valid values are 0-65535.
128 # HTTP X-Forwarded-For support by adding an extra field or overwriting
129 # the source or destination IP address (depending on flow direction)
130 # with the one reported in the X-Forwarded-For HTTP header. This is
131 # helpful when reviewing alerts for traffic that is being reverse
132 # or forward proxied.
135 # Two operation modes are available: "extra-data" and "overwrite".
137 # Two proxy deployments are supported: "reverse" and "forward". In
138 # a "reverse" deployment the IP address used is the last one, in a
139 # "forward" deployment the first IP address is used.
141 # Header name where the actual IP address will be reported. If more
142 # than one IP address is present, the last IP address will be the
143 # one taken into consideration.
144 header: X-Forwarded-For
148 # payload: yes # enable dumping payload in Base64
149 # payload-buffer-size: 4kb # max size of payload buffer to output in eve-log
150 # payload-printable: yes # enable dumping payload in printable (lossy) format
151 # packet: yes # enable dumping of packet (without stream segments)
152 # metadata: no # enable inclusion of app layer metadata with alert. Default yes
153 # http-body: yes # Requires metadata; enable dumping of HTTP body in Base64
154 # http-body-printable: yes # Requires metadata; enable dumping of HTTP body in printable format
156 # Enable the logging of tagged packets for rules using the
160 # Anomaly log records describe unexpected conditions such
161 # as truncated packets, packets with invalid IP/UDP/TCP
162 # length values, and other events that render the packet
163 # invalid for further processing or describe unexpected
164 # behavior on an established stream. Networks which
165 # experience high occurrences of anomalies may experience
166 # packet processing degradation.
168 # Anomalies are reported for the following:
169 # 1. Decode: Values and conditions that are detected while
170 # decoding individual packets. This includes invalid or
171 # unexpected values for low-level protocol lengths as well
172 # as stream related events (TCP 3-way handshake issues,
173 # unexpected sequence number, etc).
174 # 2. Stream: This includes stream related events (TCP
175 # 3-way handshake issues, unexpected sequence number,
177 # 3. Application layer: These denote application layer
178 # specific conditions that are unexpected, invalid or are
179 # unexpected given the application monitoring state.
181 # By default, anomaly logging is enabled. When anomaly
182 # logging is enabled, applayer anomaly reporting is
186 # Choose one or more types of anomaly logging and whether to enable
187 # logging of the packet header for packet anomalies.
194 extended: yes # enable this for extended logging information
195 # custom allows additional HTTP fields to be included in eve-log.
196 # the example below adds three additional fields when uncommented
197 #custom: [Accept-Encoding, Accept-Language, Authorization]
198 # set this value to one and only one from {both, request, response}
199 # to dump all HTTP headers for every HTTP request and/or response
200 # dump-all-headers: none
202 # This configuration uses the new DNS logging format,
203 # the old configuration is still available:
204 # https://suricata.readthedocs.io/en/latest/output/eve/eve-json-output.html#dns-v1-format
206 # As of Suricata 5.0, version 2 of the eve dns output
207 # format is the default.
210 # Enable/disable this logger. Default: enabled.
213 # Control logging of requests and responses:
214 # - requests: enable logging of DNS queries
215 # - responses: enable logging of DNS answers
216 # By default both requests and responses are logged.
220 # Format of answer logging:
221 # - detailed: array item per answer
222 # - grouped: answers aggregated by type
224 #formats: [detailed, grouped]
226 # DNS record types to log, based on the query type.
228 #types: [a, aaaa, cname, mx, ns, ptr, txt]
230 extended: yes # enable this for extended logging information
231 # output TLS transaction where the session is resumed using a
233 #session-resumption: no
234 # custom controls which TLS fields that are included in eve-log
235 #custom: [subject, issuer, session_resumed, serial, fingerprint, sni, version, not_before, not_after, certificate, chain, ja3, ja3s]
237 force-magic: no # force logging magic on all logged files
238 # force logging of checksums, available hash functions are md5,
242 # alerts: yes # log alerts that caused drops
243 # flows: all # start or all: 'start' logs only a single drop
244 # # per flow direction. All logs each dropped pkt.
246 #extended: yes # enable this for extended logging information
247 # this includes: bcc, message-id, subject, x_mailer, user-agent
248 # custom fields logging from the list:
249 # reply-to, bcc, message-id, subject, x-mailer, user-agent, received,
250 # x-originating-ip, in-reply-to, references, importance, priority,
251 # sensitivity, organization, content-md5, date
252 #custom: [received, x-mailer, x-originating-ip, relays, reply-to, bcc]
253 # output md5 of fields: body, subject
254 # for the body you need to set app-layer.protocols.smtp.mime.body-md5
256 #md5: [body, subject]
271 # When extended mode is on, all DHCP messages are logged
272 # with full detail. When extended mode is off (the
273 # default), just enough information to map a MAC address
274 # to an IP address is logged.
278 totals: yes # stats for all threads merged together
279 threads: no # per thread stats
280 deltas: no # include delta values
281 # bi-directional flows
283 # uni-directional flows
286 # Metadata event type. Triggered whenever a pktvar is saved
287 # and will include the pktvars, flowvars, flowbits and
291 # a line based log of HTTP requests (no alerts)
296 #extended: yes # enable this for extended logging information
297 #custom: yes # enable the custom logging format (defined by customformat)
298 #customformat: "%{%D-%H:%M:%S}t.%z %{X-Forwarded-For}i %H %m %h %u %s %B %a:%p -> %A:%P"
299 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
301 # a line based log of TLS handshake parameters (no alerts)
303 enabled: no # Log TLS connections.
304 filename: tls.log # File to store TLS logs.
306 #extended: yes # Log extended information like fingerprint
307 #custom: yes # enabled the custom logging format (defined by customformat)
308 #customformat: "%{%D-%H:%M:%S}t.%z %a:%p -> %A:%P %v %n %d %D"
309 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
310 # output TLS transaction where the session is resumed using a
312 #session-resumption: no
314 # output module to store certificates chain to disk
317 #certs-log-dir: certs # directory to store the certificates files
319 # Packet log... log packets in pcap format. 3 modes of operation: "normal"
320 # "multi" and "sguil".
322 # In normal mode a pcap file "filename" is created in the default-log-dir,
323 # or as specified by "dir".
324 # In multi mode, a file is created per thread. This will perform much
325 # better, but will create multiple files where 'normal' would create one.
326 # In multi mode the filename takes a few special variables:
327 # - %n -- thread number
329 # - %t -- timestamp (secs or secs.usecs based on 'ts-format'
330 # E.g. filename: pcap.%n.%t
332 # Note that it's possible to use directories, but the directories are not
333 # created by Suricata. E.g. filename: pcaps/%n/log.%s will log into the
334 # per thread directory.
336 # Also note that the limit and max-files settings are enforced per thread.
337 # So the size limit when using 8 threads with 1000mb files and 2000 files
338 # is: 8*1000*2000 ~ 16TiB.
340 # In Sguil mode "dir" indicates the base directory. In this base dir the
341 # pcaps are created in the directory structure Sguil expects:
343 # $sguil-base-dir/YYYY-MM-DD/$filename.<timestamp>
345 # By default all packets are logged except:
346 # - TCP streams beyond stream.reassembly.depth
347 # - encrypted streams after the key exchange
353 # File size limit. Can be specified in kb, mb, gb. Just a number
354 # is parsed as bytes.
357 # If set to a value, ring buffer mode is enabled. Will keep maximum of
358 # "max-files" of size "limit"
361 # Compression algorithm for pcap files. Possible values: none, lz4.
362 # Enabling compression is incompatible with the sguil mode. Note also
363 # that on Windows, enabling compression will *increase* disk I/O.
366 # Further options for lz4 compression. The compression level can be set
367 # to a value between 0 and 16, where higher values result in higher
372 mode: normal # normal, multi or sguil.
374 # Directory to place pcap files. If not provided the default log
375 # directory will be used. Required for "sguil" mode.
378 #ts-format: usec # sec or usec second format (default) is filename.sec usec is filename.sec.usec
379 use-stream-depth: no #If set to "yes" packets seen after reaching stream inspection depth are ignored. "no" logs all packets
380 honor-pass-rules: no # If set to "yes", flows in which a pass rule matched will stop being logged.
382 # a full alert log containing much information for signature writers
383 # or for investigating suspected false positives.
386 filename: alert-debug.log
388 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
390 # alert output to prelude (https://www.prelude-siem.org/) only
391 # available if Suricata has been compiled with --enable-prelude
395 log-packet-content: no
396 log-packet-header: yes
398 # Stats.log contains data from various counters of the Suricata engine.
402 append: yes # append to file (yes) or overwrite it (no)
403 totals: yes # stats for all threads merged together
404 threads: no # per thread stats
405 #null-values: yes # print counters that have value 0. Default: no
407 # a line based alerts log similar to fast.log into syslog
410 # reported identity to syslog. If omitted the program name (usually
411 # suricata) will be used.
412 #identity: "suricata"
414 #level: Info ## possible levels: Emergency, Alert, Critical,
415 ## Error, Warning, Notice, Info, Debug
417 # (deprecated) A line based information for dropped packets in IPS mode
420 # further options documented at:
421 # https://suricata.readthedocs.io/en/suricata-5.0.0/configuration/suricata-yaml.html#drop-log-a-line-based-information-for-dropped-packets
423 # Output module for storing files on disk. Files are stored in
424 # directory names consisting of the first 2 characters of the
425 # SHA256 of the file. Each file is given its SHA256 as a filename.
427 # When a duplicate file is found, the timestamps on the existing file
430 # Unlike the older filestore, metadata is not written by default
431 # as each file should already have a "fileinfo" record in the
432 # eve-log. If write-fileinfo is set to yes, then each file will have
433 # one more associated .json files that consist of the fileinfo
434 # record. A fileinfo file will be written for each occurrence of the
435 # file seen using a filename suffix to ensure uniqueness.
437 # To prune the filestore directory see the "suricatactl filestore
438 # prune" command which can delete files over a certain age.
443 # Set the directory for the filestore. Relative pathnames
444 # are contained within the "default-log-dir".
447 # Write out a fileinfo record for each occurrence of a file.
448 # Disabled by default as each occurrence is already logged
449 # as a fileinfo record to the main eve-log.
452 # Force storing of all files. Default: no.
453 #force-filestore: yes
455 # Override the global stream-depth for sessions in which we want
456 # to perform file extraction. Set to 0 for unlimited.
459 # Uncomment the following variable to define how many files can
460 # remain open for filestore by Suricata. Default value is 0 which
461 # means files get closed after each write to the file.
462 #max-open-files: 1000
464 # Force logging of checksums: available hash functions are md5,
465 # sha1 and sha256. Note that SHA256 is automatically forced by
466 # the use of this output module as it uses the SHA256 as the
467 # file naming scheme.
468 #force-hash: [sha1, md5]
469 # NOTE: X-Forwarded configuration is ignored if write-fileinfo is disabled
470 # HTTP X-Forwarded-For support by adding an extra field or overwriting
471 # the source or destination IP address (depending on flow direction)
472 # with the one reported in the X-Forwarded-For HTTP header. This is
473 # helpful when reviewing alerts for traffic that is being reverse
474 # or forward proxied.
477 # Two operation modes are available, "extra-data" and "overwrite".
479 # Two proxy deployments are supported, "reverse" and "forward". In
480 # a "reverse" deployment the IP address used is the last one, in a
481 # "forward" deployment the first IP address is used.
483 # Header name where the actual IP address will be reported. If more
484 # than one IP address is present, the last IP address will be the
485 # one taken into consideration.
486 header: X-Forwarded-For
488 # Log TCP data after stream normalization
489 # Two types: file or dir:
490 # - file logs into a single logfile.
491 # - dir creates 2 files per TCP session and stores the raw TCP
493 # Use 'both' to enable both file and dir modes.
495 # Note: limited by "stream.reassembly.depth"
499 filename: tcp-data.log
501 # Log HTTP body data after normalization, de-chunking and unzipping.
502 # Two types: file or dir.
503 # - file logs into a single logfile.
504 # - dir creates 2 files per HTTP session and stores the
505 # normalized data into them.
506 # Use 'both' to enable both file and dir modes.
508 # Note: limited by the body limit settings
512 filename: http-data.log
514 # Lua Output Support - execute lua script to generate alert and event
517 # https://suricata.readthedocs.io/en/latest/output/lua-output.html
520 #scripts-dir: /etc/suricata/lua-output/
524 # Logging configuration. This is not about logging IDS alerts/events, but
525 # output about what Suricata is doing, like startup messages, errors, etc.
527 # The default log level: can be overridden in an output section.
528 # Note that debug level logging will only be emitted if Suricata was
529 # compiled with the --enable-debug configure option.
531 # This value is overridden by the SC_LOG_LEVEL env var.
532 default-log-level: notice
534 # The default output format. Optional parameter, should default to
535 # something reasonable if not provided. Can be overridden in an
536 # output section. You can leave this out to get the default.
538 # This value is overridden by the SC_LOG_FORMAT env var.
539 #default-log-format: "[%i] %t - (%f:%l) <%d> (%n) -- "
541 # A regex to filter output. Can be overridden in an output section.
542 # Defaults to empty (no filter).
544 # This value is overridden by the SC_LOG_OP_FILTER env var.
545 default-output-filter:
547 # Define your logging outputs. If none are defined, or they are all
548 # disabled you will get the default: console output.
556 filename: suricata.log
561 format: "[%i] <%d> -- "
566 ## Step 3: Configure common capture settings
568 ## See "Advanced Capture Options" below for more options, including Netmap
572 # Linux high speed capture support
575 # Number of receive threads. "auto" uses the number of cores
577 # Default clusterid. AF_PACKET will load balance packets based on flow.
579 # Default AF_PACKET cluster type. AF_PACKET can load balance per flow or per hash.
580 # This is only supported for Linux kernel > 3.1
581 # possible value are:
582 # * cluster_flow: all packets of a given flow are sent to the same socket
583 # * cluster_cpu: all packets treated in kernel by a CPU are sent to the same socket
584 # * cluster_qm: all packets linked by network card to a RSS queue are sent to the same
585 # socket. Requires at least Linux 3.14.
586 # * cluster_ebpf: eBPF file load balancing. See doc/userguide/capture-hardware/ebpf-xdp.rst for
588 # Recommended modes are cluster_flow on most boxes and cluster_cpu or cluster_qm on system
589 # with capture card using RSS (requires cpu affinity tuning and system IRQ tuning)
590 cluster-type: cluster_flow
591 # In some fragmentation cases, the hash can not be computed. If "defrag" is set
592 # to yes, the kernel will do the needed defragmentation before sending the packets.
594 # To use the ring feature of AF_PACKET, set 'use-mmap' to yes
596 # Lock memory map to avoid it being swapped. Be careful that over
597 # subscribing could lock your system
599 # Use tpacket_v3 capture mode, only active if use-mmap is true
600 # Don't use it in IPS or TAP mode as it causes severe latency
602 # Ring size will be computed with respect to "max-pending-packets" and number
603 # of threads. You can set manually the ring size in number of packets by setting
604 # the following value. If you are using flow "cluster-type" and have really network
605 # intensive single-flow you may want to set the "ring-size" independently of the number
608 # Block size is used by tpacket_v3 only. It should set to a value high enough to contain
609 # a decent number of packets. Size is in bytes so please consider your MTU. It should be
610 # a power of 2 and it must be multiple of page size (usually 4096).
612 # tpacket_v3 block timeout: an open block is passed to userspace if it is not
613 # filled after block-timeout milliseconds.
615 # On busy systems, set it to yes to help recover from a packet drop
616 # phase. This will result in some packets (at max a ring flush) not being inspected.
617 #use-emergency-flush: yes
618 # recv buffer size, increased value could improve performance
620 # Set to yes to disable promiscuous mode
621 # disable-promisc: no
622 # Choose checksum verification mode for the interface. At the moment
623 # of the capture, some packets may have an invalid checksum due to
624 # the checksum computation being offloaded to the network card.
625 # Possible values are:
626 # - kernel: use indication sent by kernel for each packet (default)
627 # - yes: checksum validation is forced
628 # - no: checksum validation is disabled
629 # - auto: Suricata uses a statistical approach to detect when
630 # checksum off-loading is used.
631 # Warning: 'capture.checksum-validation' must be set to yes to have any validation
632 #checksum-checks: kernel
633 # BPF filter to apply to this interface. The pcap filter syntax applies here.
634 #bpf-filter: port 80 or udp
635 # You can use the following variables to activate AF_PACKET tap or IPS mode.
636 # If copy-mode is set to ips or tap, the traffic coming to the current
637 # interface will be copied to the copy-iface interface. If 'tap' is set, the
638 # copy is complete. If 'ips' is set, the packet matching a 'drop' action
639 # will not be copied.
642 # For eBPF and XDP setup including bypass, filter and load balancing, please
643 # see doc/userguide/capture-hardware/ebpf-xdp.rst for more info.
645 # Put default values here. These will be used for an interface that is not
652 # Cross platform libpcap capture support
655 # On Linux, pcap will try to use mmap'ed capture and will use "buffer-size"
656 # as total memory used by the ring. So set this to something bigger
657 # than 1% of your bandwidth.
658 #buffer-size: 16777216
659 #bpf-filter: "tcp and port 25"
660 # Choose checksum verification mode for the interface. At the moment
661 # of the capture, some packets may have an invalid checksum due to
662 # the checksum computation being offloaded to the network card.
663 # Possible values are:
664 # - yes: checksum validation is forced
665 # - no: checksum validation is disabled
666 # - auto: Suricata uses a statistical approach to detect when
667 # checksum off-loading is used. (default)
668 # Warning: 'capture.checksum-validation' must be set to yes to have any validation
669 #checksum-checks: auto
670 # With some accelerator cards using a modified libpcap (like Myricom), you
671 # may want to have the same number of capture threads as the number of capture
672 # rings. In this case, set up the threads variable to N to start N threads
673 # listening on the same interface.
675 # set to no to disable promiscuous mode:
677 # set snaplen, if not set it defaults to MTU if MTU can be known
678 # via ioctl call and to full capture if not.
680 # Put default values here
682 #checksum-checks: auto
684 # Settings for reading pcap files
686 # Possible values are:
687 # - yes: checksum validation is forced
688 # - no: checksum validation is disabled
689 # - auto: Suricata uses a statistical approach to detect when
690 # checksum off-loading is used. (default)
691 # Warning: 'checksum-validation' must be set to yes to have checksum tested
692 checksum-checks: auto
694 # See "Advanced Capture Options" below for more options, including Netmap
699 ## Step 4: App Layer Protocol configuration
702 # Configure the app-layer parsers. The protocol's section details each
705 # The option "enabled" takes 3 values - "yes", "no", "detection-only".
706 # "yes" enables both detection and the parser, "no" disables both, and
707 # "detection-only" enables protocol detection only (parser disabled).
713 dp: 5900, 5901, 5902, 5903, 5904, 5905, 5906, 5907, 5908, 5909
725 # Generate JA3 fingerprint from client hello. If not specified it
726 # will be disabled by default, but enabled if rules require it.
727 #ja3-fingerprints: auto
729 # What to do when the encrypted communications start:
730 # - default: keep tracking TLS session, check for protocol anomalies,
731 # inspect tls_* keywords. Disables inspection of unmodified
732 # 'content' signatures.
733 # - bypass: stop processing this flow as much as possible. No further
734 # TLS parsing and inspection. Offload flow bypass to kernel
735 # or hardware if possible.
736 # - full: keep tracking and inspection as normal. Unmodified content
737 # keyword signatures are inspected as well.
739 # For best performance, select 'bypass'.
741 #encryption-handling: default
748 # RDP, disabled by default.
756 # Configure SMTP-MIME Decoder
758 # Decode MIME messages from SMTP transactions
759 # (may be resource intensive)
760 # This field supersedes all others because it turns the entire
764 # Decode MIME entity bodies (ie. Base64, quoted-printable, etc.)
766 decode-quoted-printable: yes
768 # Maximum bytes per header data value stored in the data structure
770 header-value-depth: 2000
772 # Extract URLs and save in state data structure
774 # Set to yes to compute the md5 of the mail body. You will then
775 # be able to journalize it.
777 # Configure inspected-tracker for file_data keyword
779 content-limit: 100000
780 content-inspect-min-size: 32768
781 content-inspect-window: 4096
783 enabled: detection-only
789 # Stream reassembly size for SMB streams. By default track it completely.
807 # memcap: Maximum memory capacity for HTTP
808 # Default is unlimited, values can be 64mb, e.g.
810 # default-config: Used when no server-config matches
811 # personality: List of personalities used by default
812 # request-body-limit: Limit reassembly of request body for inspection
813 # by http_client_body & pcre /P option.
814 # response-body-limit: Limit reassembly of response body for inspection
815 # by file_data, http_server_body & pcre /Q option.
817 # For advanced options, see the user guide
820 # server-config: List of server configurations to use if address matches
821 # address: List of IP addresses or networks for this block
822 # personality: List of personalities used by this block
824 # Then, all the fields from default-config can be overloaded
826 # Currently Available Personalities:
827 # Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0,
828 # IIS_7_0, IIS_7_5, Apache_2
833 # Can be specified in kb, mb, gb. Just a number indicates
835 request-body-limit: 100kb
836 response-body-limit: 100kb
839 request-body-minimal-inspect-size: 32kb
840 request-body-inspect-window: 4kb
841 response-body-minimal-inspect-size: 40kb
842 response-body-inspect-window: 16kb
844 # response body decompression (0 disables)
845 response-body-decompress-layer-limit: 2
847 # auto will use http-body-inline mode in IPS mode, yes or no set it statically
848 http-body-inline: auto
850 # Decompress SWF files.
851 # Two types: 'deflate', 'lzma', 'both' will decompress deflate and lzma
853 # Specifies the maximum amount of data to decompress,
854 # set 0 for unlimited.
856 # Specifies the maximum amount of decompressed data to obtain,
857 # set 0 for unlimited.
864 # Use a random value for inspection sizes around the specified value.
865 # This lowers the risk of some evasion techniques but could lead
866 # to detection change between runs. It is set to 'yes' by default.
867 #randomize-inspection-sizes: yes
868 # If "randomize-inspection-sizes" is active, the value of various
869 # inspection size will be chosen from the [1 - range%, 1 + range%]
871 # Default value of "randomize-inspection-range" is 10.
872 #randomize-inspection-range: 10
875 double-decode-path: no
876 double-decode-query: no
878 # Can disable LZMA decompression
880 # Memory limit usage for LZMA decompression dictionary
881 # Data is decompressed until dictionary reaches this size
883 # Maximum decompressed size with a compression ratio
884 # above 2048 (only LZMA can reach this ratio, deflate cannot)
885 #compression-bomb-limit: 1mb
890 # address: [192.168.1.0/24, 127.0.0.0/8, "::1"]
891 # personality: Apache_2
892 # # Can be specified in kb, mb, gb. Just a number indicates
894 # request-body-limit: 4096
895 # response-body-limit: 4096
896 # double-decode-path: no
897 # double-decode-query: no
903 # personality: IIS_7_0
904 # # Can be specified in kb, mb, gb. Just a number indicates
906 # request-body-limit: 4096
907 # response-body-limit: 4096
908 # double-decode-path: no
909 # double-decode-query: no
911 # Note: Modbus probe parser is minimalist due to the limited usage in the field.
912 # Only Modbus message length (greater than Modbus header length)
913 # and protocol ID (equal to 0) are checked in probing parser
914 # It is important to enable detection port and define Modbus port
915 # to avoid false positives
917 # How many unanswered Modbus requests are considered a flood.
918 # If the limit is reached, the app-layer-event:modbus.flooded; will match.
924 # According to MODBUS Messaging on TCP/IP Implementation Guide V1.0b, it
925 # is recommended to keep the TCP connection opened with a remote device
926 # and not to open and close it for each MODBUS/TCP transaction. In that
927 # case, it is important to set the depth of the stream reassembling as
928 # unlimited (stream.reassembly.depth: 0)
930 # Stream reassembly size for modbus. By default track it completely.
939 # SCADA EtherNet/IP and CIP protocol support
952 # SIP, disabled by default.
956 # Limit for the maximum number of asn1 frames to decode (default 256)
960 ##############################################################################
962 ## Advanced settings below
964 ##############################################################################
970 # Run Suricata with a specific user-id and group-id:
975 # Some logging modules will use that name in event as identifier. The default
976 # value is the hostname
977 #sensor-name: suricata
979 # Default location of the pid file. The pid file is only used in
980 # daemon mode (start Suricata with -D). If not running in daemon mode
981 # the --pidfile command line option must be used to create a pid file.
982 #pid-file: @e_rundir@suricata.pid
984 # Daemon working directory
985 # Suricata will change directory to this one if provided
987 #daemon-directory: "/"
990 # Suricata will use this umask if it is provided. By default it will use the
991 # umask passed on by the shell.
994 # Suricata core dump configuration. Limits the size of the core dump file to
995 # approximately max-dump. The actual core dump size will be a multiple of the
996 # page size. Core dumps that would be larger than max-dump are truncated. On
997 # Linux, the actual core dump size may be a few pages larger than max-dump.
998 # Setting max-dump to 0 disables core dumping.
999 # Setting max-dump to 'unlimited' will give the full core dump file.
1000 # On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size
1001 # to be 'unlimited'.
1006 # If the Suricata box is a router for the sniffed networks, set it to 'router'. If
1007 # it is a pure sniffing setup, set it to 'sniffer-only'.
1008 # If set to auto, the variable is internally switched to 'router' in IPS mode
1009 # and 'sniffer-only' in IDS mode.
1010 # This feature is currently only used by the reject* keywords.
1013 # Number of packets preallocated per thread. The default is 1024. A higher number
1014 # will make sure each CPU will be more easily kept busy, but may negatively
1016 #max-pending-packets: 1024
1018 # Runmode the engine should use. Please check --list-runmodes to get the available
1019 # runmodes for each packet acquisition method. Default depends on selected capture
1020 # method. 'workers' generally gives best performance.
1023 # Specifies the kind of flow load balancer used by the flow pinned autofp mode.
1025 # Supported schedulers are:
1027 # hash - Flow assigned to threads using the 5-7 tuple hash.
1028 # ippair - Flow assigned to threads using addresses only.
1030 #autofp-scheduler: hash
1032 # Preallocated size for each packet. Default is 1514 which is the classical
1033 # size for pcap on Ethernet. You should adjust this value to the highest
1034 # packet size (MTU + hardware header) on your system.
1035 #default-packet-size: 1514
1037 # Unix command socket that can be used to pass commands to Suricata.
1038 # An external tool can then connect to get information from Suricata
1039 # or trigger some modifications of the engine. Set enabled to yes
1040 # to activate the feature. In auto mode, the feature will only be
1041 # activated in live capture mode. You can use the filename variable to set
1042 # the file name of the socket.
1045 #filename: custom.socket
1047 # Magic file. The extension .mgc is added to the value here.
1048 #magic-file: /usr/share/file/magic
1049 @e_magic_file_comment@magic-file: @e_magic_file@
1051 # GeoIP2 database file. Specify path and filename of GeoIP2 database
1052 # if using rules with "geoip" rule option.
1053 #geoip-database: /usr/local/share/GeoLite2/GeoLite2-Country.mmdb
1059 ## Detection settings
1062 # Set the order of alerts based on actions
1063 # The default order is pass, drop, reject, alert
1071 #reputation-categories-file: @e_sysconfdir@iprep/categories.txt
1072 #default-reputation-path: @e_sysconfdir@iprep
1076 # When run with the option --engine-analysis, the engine will read each of
1077 # the parameters below, and print reports for each of the enabled sections
1078 # and exit. The reports are printed to a file in the default log dir
1079 # given by the parameter "default-log-dir", with engine reporting
1080 # subsection below printing reports in its own report file.
1082 # enables printing reports for fast-pattern for every rule.
1083 rules-fast-pattern: yes
1084 # enables printing reports for each rule
1087 #recursion and match limits for PCRE where supported
1090 match-limit-recursion: 1500
1093 ## Advanced Traffic Tracking and Reconstruction Settings
1096 # Host specific policies for defragmentation and TCP stream
1097 # reassembly. The host OS lookup is done using a radix tree, just
1098 # like a routing table so the most specific entry matches.
1100 # Make the default policy windows.
1101 windows: [0.0.0.0/0]
1120 trackers: 65535 # number of defragmented flows to follow
1121 max-frags: 65535 # number of fragments to keep (higher than trackers)
1125 # Enable defrag per host settings
1130 # 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"]
1140 # By default, the reserved memory (memcap) for flows is 32MB. This is the limit
1141 # for flow allocation inside the engine. You can change this value to allow
1142 # more memory usage for flows.
1143 # The hash-size determines the size of the hash used to identify flows inside
1144 # the engine, and by default the value is 65536.
1145 # At startup, the engine can preallocate a number of flows, to get better
1146 # performance. The number of flows preallocated is 10000 by default.
1147 # emergency-recovery is the percentage of flows that the engine needs to
1148 # prune before clearing the emergency state. The emergency state is activated
1149 # when the memcap limit is reached, allowing new flows to be created, but
1150 # pruning them with the emergency timeouts (they are defined below).
1151 # If the memcap is reached, the engine will try to prune flows
1152 # with the default timeouts. If it doesn't find a flow to prune, it will set
1153 # the emergency bit and it will try again with more aggressive timeouts.
1154 # If that doesn't work, then it will try to kill the oldest flows using
1155 # last time seen flows.
1156 # The memcap can be specified in kb, mb, gb. Just a number indicates it's
1163 emergency-recovery: 30
1164 #managers: 1 # default to one flow manager
1165 #recyclers: 1 # default to one flow recycler thread
1167 # This option controls the use of VLAN ids in the flow (and defrag)
1168 # hashing. Normally this should be enabled, but in some (broken)
1169 # setups where both sides of a flow are not tagged with the same VLAN
1170 # tag, we can ignore the VLAN id's in the flow hashing.
1172 use-for-tracking: true
1174 # Specific timeouts for flows. Here you can specify the timeouts that the
1175 # active flows will wait to transit from the current state to another, on each
1176 # protocol. The value of "new" determines the seconds to wait after a handshake or
1177 # stream startup before the engine frees the data of that flow it doesn't
1178 # change the state to established (usually if we don't receive more packets
1179 # of that flow). The value of "established" is the amount of
1180 # seconds that the engine will wait to free the flow if that time elapses
1181 # without receiving new packets or closing the connection. "closed" is the
1182 # amount of time to wait after a flow is closed (usually zero). "bypassed"
1183 # timeout controls locally bypassed flows. For these flows we don't do any other
1184 # tracking. If no packets have been seen after this timeout, the flow is discarded.
1186 # There's an emergency mode that will become active under attack circumstances,
1187 # making the engine to check flow status faster. This configuration variables
1188 # use the prefix "emergency-" and work similar as the normal ones.
1189 # Some timeouts doesn't apply to all the protocols, like "closed", for udp and
1200 emergency-established: 100
1202 emergency-bypassed: 50
1209 emergency-established: 100
1210 emergency-closed: 10
1211 emergency-bypassed: 50
1217 emergency-established: 100
1218 emergency-bypassed: 50
1224 emergency-established: 100
1225 emergency-bypassed: 50
1227 # Stream engine settings. Here the TCP stream tracking and reassembly
1228 # engine is configured.
1231 # memcap: 32mb # Can be specified in kb, mb, gb. Just a
1232 # # number indicates it's in bytes.
1233 # checksum-validation: yes # To validate the checksum of received
1234 # # packet. If csum validation is specified as
1235 # # "yes", then packets with invalid csum values will not
1236 # # be processed by the engine stream/app layer.
1237 # # Warning: locally generated traffic can be
1238 # # generated without checksum due to hardware offload
1239 # # of checksum. You can control the handling of checksum
1240 # # on a per-interface basis via the 'checksum-checks'
1242 # prealloc-sessions: 2k # 2k sessions prealloc'd per stream thread
1243 # midstream: false # don't allow midstream session pickups
1244 # async-oneside: false # don't enable async stream handling
1245 # inline: no # stream inline mode
1246 # drop-invalid: yes # in inline mode, drop packets that are invalid with regards to streaming engine
1247 # max-synack-queued: 5 # Max different SYN/ACKs to queue
1248 # bypass: no # Bypass packets when stream.reassembly.depth is reached.
1249 # # Warning: first side to reach this triggers
1253 # memcap: 64mb # Can be specified in kb, mb, gb. Just a number
1254 # # indicates it's in bytes.
1255 # depth: 1mb # Can be specified in kb, mb, gb. Just a number
1256 # # indicates it's in bytes.
1257 # toserver-chunk-size: 2560 # inspect raw stream in chunks of at least
1258 # # this size. Can be specified in kb, mb,
1259 # # gb. Just a number indicates it's in bytes.
1260 # toclient-chunk-size: 2560 # inspect raw stream in chunks of at least
1261 # # this size. Can be specified in kb, mb,
1262 # # gb. Just a number indicates it's in bytes.
1263 # randomize-chunk-size: yes # Take a random value for chunk size around the specified value.
1264 # # This lowers the risk of some evasion techniques but could lead
1265 # # to detection change between runs. It is set to 'yes' by default.
1266 # randomize-chunk-range: 10 # If randomize-chunk-size is active, the value of chunk-size is
1267 # # a random value between (1 - randomize-chunk-range/100)*toserver-chunk-size
1268 # # and (1 + randomize-chunk-range/100)*toserver-chunk-size and the same
1269 # # calculation for toclient-chunk-size.
1270 # # Default value of randomize-chunk-range is 10.
1272 # raw: yes # 'Raw' reassembly enabled or disabled.
1273 # # raw is for content inspection by detection
1276 # segment-prealloc: 2048 # number of segments preallocated per thread
1278 # check-overlap-different-data: true|false
1279 # # check if a segment contains different data
1280 # # than what we've already seen for that
1281 # # position in the stream.
1282 # # This is enabled automatically if inline mode
1283 # # is used or when stream-event:reassembly_overlap_different_data;
1284 # # is used in a rule.
1288 checksum-validation: yes # reject incorrect csums
1289 inline: auto # auto will use inline mode in IPS mode, yes or no set it statically
1292 depth: 1mb # reassemble 1mb into a stream
1293 toserver-chunk-size: 2560
1294 toclient-chunk-size: 2560
1295 randomize-chunk-size: yes
1296 #randomize-chunk-range: 10
1298 #segment-prealloc: 2048
1299 #check-overlap-different-data: true
1303 # Host table is used by the tagging and per host thresholding subsystems.
1312 # Used by xbits 'ippair' tracking.
1322 # Teredo decoder is known to not be completely accurate
1323 # as it will sometimes detect non-teredo as teredo.
1326 # ports to look for Teredo. Max 4 ports. If no ports are given, or
1327 # the value is set to 'any', Teredo detection runs on _all_ UDP packets.
1328 ports: $TEREDO_PORTS # syntax: '[3544, 1234]' or '3533' or 'any'.
1330 # VXLAN decoder is assigned to up to 4 UDP ports. By default only the
1331 # IANA assigned port 4789 is enabled.
1334 ports: $VXLAN_PORTS # syntax: '[8472, 4789]' or '4789'.
1338 ## Performance tuning and profiling
1341 # The detection engine builds internal groups of signatures. The engine
1342 # allows us to specify the profile to use for them, to manage memory in an
1343 # efficient way keeping good performance. For the profile keyword you
1344 # can use the words "low", "medium", "high" or "custom". If you use custom,
1345 # make sure to define the values in the "custom-values" section.
1346 # Usually you would prefer medium/high/low.
1348 # "sgh mpm-context", indicates how the staging should allot mpm contexts for
1349 # the signature groups. "single" indicates the use of a single context for
1350 # all the signature group heads. "full" indicates a mpm-context for each
1351 # group head. "auto" lets the engine decide the distribution of contexts
1352 # based on the information the engine gathers on the patterns from each
1355 # The option inspection-recursion-limit is used to limit the recursive calls
1356 # in the content inspection code. For certain payload-sig combinations, we
1357 # might end up taking too much time in the content inspection code.
1358 # If the argument specified is 0, the engine uses an internally defined
1359 # default limit. When a value is not specified, there are no limits on the recursion.
1365 sgh-mpm-context: auto
1366 inspection-recursion-limit: 3000
1367 # If set to yes, the loading of signatures will be made after the capture
1368 # is started. This will limit the downtime in IPS mode.
1369 #delayed-detect: yes
1372 # default prefiltering setting. "mpm" only creates MPM/fast_pattern
1373 # engines. "auto" also sets up prefilter engines for other keywords.
1374 # Use --list-keywords=all to see which keywords support prefiltering.
1377 # the grouping values above control how many groups are created per
1378 # direction. Port whitelisting forces that port to get its own group.
1379 # Very common ports will benefit, as well as ports with many expensive
1382 #tcp-whitelist: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080
1383 #udp-whitelist: 53, 135, 5060
1386 # Log the rules that made it past the prefilter stage, per packet
1387 # default is off. The threshold setting determines how many rules
1388 # must have made it past pre-filter for that rule to trigger the
1390 #inspect-logging-threshold: 200
1393 include-rules: false # very verbose
1394 include-mpm-stats: false
1396 # Select the multi pattern algorithm you want to run for scan/search the
1399 # The supported algorithms are:
1400 # "ac" - Aho-Corasick, default implementation
1401 # "ac-bs" - Aho-Corasick, reduced memory implementation
1402 # "ac-ks" - Aho-Corasick, "Ken Steele" variant
1403 # "hs" - Hyperscan, available when built with Hyperscan support
1405 # The default mpm-algo value of "auto" will use "hs" if Hyperscan is
1406 # available, "ac" otherwise.
1408 # The mpm you choose also decides the distribution of mpm contexts for
1409 # signature groups, specified by the conf - "detect.sgh-mpm-context".
1410 # Selecting "ac" as the mpm would require "detect.sgh-mpm-context"
1411 # to be set to "single", because of ac's memory requirements, unless the
1412 # ruleset is small enough to fit in memory, in which case one can
1413 # use "full" with "ac". The rest of the mpms can be run in "full" mode.
1417 # Select the matching algorithm you want to use for single-pattern searches.
1419 # Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only
1420 # available if Suricata has been built with Hyperscan support).
1422 # The default of "auto" will use "hs" if available, otherwise "bm".
1426 # Suricata is multi-threaded. Here the threading can be influenced.
1428 set-cpu-affinity: no
1429 # Tune cpu affinity of threads. Each family of threads can be bound
1432 # These 2 apply to the all runmodes:
1433 # management-cpu-set is used for flow timeout handling, counters
1434 # worker-cpu-set is used for 'worker' threads
1436 # Additionally, for autofp these apply:
1437 # receive-cpu-set is used for capture threads
1438 # verdict-cpu-set is used for IPS verdict threads
1441 - management-cpu-set:
1442 cpu: [ 0 ] # include only these CPUs in affinity settings
1444 cpu: [ 0 ] # include only these CPUs in affinity settings
1448 # Use explicitly 3 threads and don't compute number by using
1449 # detect-thread-ratio variable:
1461 # By default Suricata creates one "detect" thread per available CPU/CPU core.
1462 # This setting allows controlling this behaviour. A ratio setting of 2 will
1463 # create 2 detect threads for each CPU/CPU core. So for a dual core CPU this
1464 # will result in 4 detect threads. If values below 1 are used, less threads
1465 # are created. So on a dual core CPU a setting of 0.5 results in 1 detect
1466 # thread being created. Regardless of the setting at a minimum 1 detect
1467 # thread will always be created.
1469 detect-thread-ratio: 1.0
1471 # Luajit has a strange memory requirement, its 'states' need to be in the
1472 # first 2G of the process' memory.
1474 # 'luajit.states' is used to control how many states are preallocated.
1475 # State use: per detect script: 1 per detect thread. Per output script: 1 per
1480 # Profiling settings. Only effective if Suricata has been built with
1481 # the --enable-profiling configure flag.
1484 # Run profiling for every X-th packet. The default is 1, which means we
1485 # profile every packet. If set to 1000, one packet is profiled for every
1492 # Profiling can be disabled here, but it will still have a
1493 # performance impact if compiled in.
1495 filename: rule_perf.log
1498 # Sort options: ticks, avgticks, checks, matches, maxticks
1499 # If commented out all the sort options will be used.
1502 # Limit the number of sids for which stats are shown at exit (per sort).
1506 json: @e_enable_evelog@
1508 # per keyword profiling
1511 filename: keyword_perf.log
1516 filename: prefilter_perf.log
1519 # per rulegroup profiling
1522 filename: rule_group_perf.log
1528 # Profiling can be disabled here, but it will still have a
1529 # performance impact if compiled in.
1531 filename: packet_stats.log
1534 # per packet csv output
1537 # Output can be disabled here, but it will still have a
1538 # performance impact if compiled in.
1540 filename: packet_stats.csv
1542 # profiling of locking. Only available when Suricata was built with
1543 # --enable-profiling-locks.
1546 filename: lock_stats.log
1551 filename: pcaplog_stats.log
1555 ## Netfilter integration
1558 # When running in NFQ inline mode, it is possible to use a simulated
1559 # non-terminal NFQUEUE verdict.
1560 # This permits sending all needed packet to Suricata via this rule:
1561 # iptables -I FORWARD -m mark ! --mark $MARK/$MASK -j NFQUEUE
1562 # And below, you can have your standard filtering ruleset. To activate
1563 # this mode, you need to set mode to 'repeat'
1564 # If you want a packet to be sent to another queue after an ACCEPT decision
1565 # set the mode to 'route' and set next-queue value.
1566 # On Linux >= 3.1, you can set batchcount to a value > 1 to improve performance
1567 # by processing several packets before sending a verdict (worker runmode only).
1568 # On Linux >= 3.6, you can set the fail-open option to yes to have the kernel
1569 # accept the packet if Suricata is not able to keep pace.
1570 # bypass mark and mask can be used to implement NFQ bypass. If bypass mark is
1571 # set then the NFQ bypass is activated. Suricata will set the bypass mark/mask
1572 # on packet of a flow that need to be bypassed. The Nefilter ruleset has to
1573 # directly accept all packets of a flow once a packet has been marked.
1586 # netlink multicast group
1587 # (the same as the iptables --nflog-group param)
1588 # Group 0 is used by the kernel, so you can't use it
1590 # netlink buffer size
1592 # put default value here
1594 # set number of packets to queue inside kernel
1596 # set the delay before flushing packet in the kernel's queue
1598 # netlink max buffer size
1602 ## Advanced Capture Options
1605 # General settings affecting packet capture
1607 # disable NIC offloading. It's restored when Suricata exits.
1608 # Enabled by default.
1609 #disable-offloading: false
1611 # disable checksum validation. Same as setting '-k none' on the
1613 #checksum-validation: none
1617 # Netmap operates with NIC directly in driver, so you need FreeBSD 11+ which has
1618 # built-in Netmap support or compile and install the Netmap module and appropriate
1619 # NIC driver for your Linux system.
1620 # To reach maximum throughput disable all receive-, segmentation-,
1621 # checksum- offloading on your NIC (using ethtool or similar).
1622 # Disabling TX checksum offloading is *required* for connecting OS endpoint
1623 # with NIC endpoint.
1624 # You can find more information at https://github.com/luigirizzo/netmap
1627 # To specify OS endpoint add plus sign at the end (e.g. "eth0+")
1629 # Number of capture threads. "auto" uses number of RSS queues on interface.
1630 # Warning: unless the RSS hashing is symmetrical, this will lead to
1633 # You can use the following variables to activate netmap tap or IPS mode.
1634 # If copy-mode is set to ips or tap, the traffic coming to the current
1635 # interface will be copied to the copy-iface interface. If 'tap' is set, the
1636 # copy is complete. If 'ips' is set, the packet matching a 'drop' action
1637 # will not be copied.
1638 # To specify the OS as the copy-iface (so the OS can route packets, or forward
1639 # to a service running on the same machine) add a plus sign at the end
1640 # (e.g. "copy-iface: eth0+"). Don't forget to set up a symmetrical eth0+ -> eth0
1641 # for return packets. Hardware checksumming must be *off* on the interface if
1642 # using an OS endpoint (e.g. 'ifconfig eth0 -rxcsum -txcsum -rxcsum6 -txcsum6' for FreeBSD
1643 # or 'ethtool -K eth0 tx off rx off' for Linux).
1646 # Set to yes to disable promiscuous mode
1647 # disable-promisc: no
1648 # Choose checksum verification mode for the interface. At the moment
1649 # of the capture, some packets may have an invalid checksum due to
1650 # the checksum computation being offloaded to the network card.
1651 # Possible values are:
1652 # - yes: checksum validation is forced
1653 # - no: checksum validation is disabled
1654 # - auto: Suricata uses a statistical approach to detect when
1655 # checksum off-loading is used.
1656 # Warning: 'checksum-validation' must be set to yes to have any validation
1657 #checksum-checks: auto
1658 # BPF filter to apply to this interface. The pcap filter syntax apply here.
1659 #bpf-filter: port 80 or udp
1664 # Put default values here
1665 - interface: default
1667 # PF_RING configuration: for use with native PF_RING support
1668 # for more info see http://www.ntop.org/products/pf_ring/
1671 # Number of receive threads. If set to 'auto' Suricata will first try
1672 # to use CPU (core) count and otherwise RSS queue count.
1675 # Default clusterid. PF_RING will load balance packets based on flow.
1676 # All threads/processes that will participate need to have the same
1680 # Default PF_RING cluster type. PF_RING can load balance per flow.
1681 # Possible values are cluster_flow or cluster_round_robin.
1682 cluster-type: cluster_flow
1684 # bpf filter for this interface
1687 # If bypass is set then the PF_RING hw bypass is activated, when supported
1688 # by the network interface. Suricata will instruct the interface to bypass
1689 # all future packets for a flow that need to be bypassed.
1692 # Choose checksum verification mode for the interface. At the moment
1693 # of the capture, some packets may have an invalid checksum due to
1694 # the checksum computation being offloaded to the network card.
1695 # Possible values are:
1696 # - rxonly: only compute checksum for packets received by network card.
1697 # - yes: checksum validation is forced
1698 # - no: checksum validation is disabled
1699 # - auto: Suricata uses a statistical approach to detect when
1700 # checksum off-loading is used. (default)
1701 # Warning: 'checksum-validation' must be set to yes to have any validation
1702 #checksum-checks: auto
1707 # cluster-type: cluster_flow
1708 # Put default values here
1709 - interface: default
1712 # For FreeBSD ipfw(8) divert(4) support.
1713 # Please make sure you have ipfw_load="YES" and ipdivert_load="YES"
1714 # in /etc/loader.conf or kldload'ing the appropriate kernel modules.
1715 # Additionally, you need to have an ipfw rule for the engine to see
1716 # the packets from ipfw. For Example:
1718 # ipfw add 100 divert 8000 ip from any to any
1720 # N.B. This example uses "8000" -- this number must mach the values
1721 # you passed on the command line, i.e., -d 8000
1725 # Reinject packets at the specified ipfw rule number. This config
1726 # option is the ipfw rule number AT WHICH rule processing continues
1727 # in the ipfw processing system after the engine has finished
1728 # inspecting the packet for acceptance. If no rule number is specified,
1729 # accepted packets are reinjected at the divert rule which they entered
1730 # and IPFW rule processing continues. No check is done to verify
1731 # this will rule makes sense so care must be taken to avoid loops in ipfw.
1733 ## The following example tells the engine to reinject packets
1734 # back into the ipfw firewall AT rule number 5500:
1736 # ipfw-reinjection-rule-number: 5500
1740 # The Host Buffer Allowance for all streams
1741 # (-1 = OFF, 1 - 100 = percentage of the host buffer that can be held back)
1742 # This may be enabled when sharing streams with another application.
1743 # Otherwise, it should be turned off.
1746 # When use_all_streams is set to "yes" the initialization code will query
1747 # the Napatech service for all configured streams and listen on all of them.
1748 # When set to "no" the streams config array will be used.
1750 # This option necessitates running the appropriate NTPL commands to create
1751 # the desired streams prior to running Suricata.
1752 #use-all-streams: no
1754 # The streams to listen on when auto-config is disabled or when and threading
1755 # cpu-affinity is disabled. This can be either:
1756 # an individual stream (e.g. streams: [0])
1758 # a range of streams (e.g. streams: ["0-3"])
1762 # Stream stats can be enabled to provide fine grain packet and byte counters
1763 # for each thread/stream that is configured.
1765 enable-stream-stats: no
1767 # When auto-config is enabled the streams will be created and assigned
1768 # automatically to the NUMA node where the thread resides. If cpu-affinity
1769 # is enabled in the threading section. Then the streams will be created
1770 # according to the number of worker threads specified in the worker-cpu-set.
1771 # Otherwise, the streams array is used to define the streams.
1773 # This option is intended primarily to support legacy configurations.
1775 # This option cannot be used simultaneously with either "use-all-streams"
1776 # or "hardware-bypass".
1780 # Enable hardware level flow bypass.
1782 hardware-bypass: yes
1784 # Enable inline operation. When enabled traffic arriving on a given port is
1785 # automatically forwarded out its peer port after analysis by Suricata.
1789 # Ports indicates which Napatech ports are to be used in auto-config mode.
1790 # these are the port IDs of the ports that will be merged prior to the
1791 # traffic being distributed to the streams.
1793 # When hardware-bypass is enabled the ports must be configured as a segment.
1794 # specify the port(s) on which upstream and downstream traffic will arrive.
1795 # This information is necessary for the hardware to properly process flows.
1797 # When using a tap configuration one of the ports will receive inbound traffic
1798 # for the network and the other will receive outbound traffic. The two ports on a
1799 # given segment must reside on the same network adapter.
1801 # When using a SPAN-port configuration the upstream and downstream traffic
1802 # arrives on a single port. This is configured by setting the two sides of the
1803 # segment to reference the same port. (e.g. 0-0 to configure a SPAN port on
1806 # port segments are specified in the form:
1807 # ports: [0-1,2-3,4-5,6-6,7-7]
1809 # For legacy systems when hardware-bypass is disabled this can be specified in any
1810 # of the following ways:
1812 # a list of individual ports (e.g. ports: [0,1,2,3])
1814 # a range of ports (e.g. ports: [0-3])
1816 # "all" to indicate that all ports are to be merged together
1817 # (e.g. ports: [all])
1819 # This parameter has no effect if auto-config is disabled.
1823 # When auto-config is enabled the hashmode specifies the algorithm for
1824 # determining to which stream a given packet is to be delivered.
1825 # This can be any valid Napatech NTPL hashmode command.
1827 # The most common hashmode commands are: hash2tuple, hash2tuplesorted,
1828 # hash5tuple, hash5tuplesorted and roundrobin.
1830 # See Napatech NTPL documentation other hashmodes and details on their use.
1832 # This parameter has no effect if auto-config is disabled.
1834 hashmode: hash5tuplesorted
1837 ## Configure Suricata to load Suricata-Update managed rules.
1840 default-rule-path: @e_defaultruledir@
1846 ## Auxiliary configuration files.
1849 classification-file: @e_sysconfdir@classification.config
1850 reference-config-file: @e_sysconfdir@reference.config
1851 # threshold-file: @e_sysconfdir@threshold.config
1854 ## Include other configs
1857 # Includes: Files included here will be handled as if they were in-lined
1858 # in this configuration file. Files with relative pathnames will be
1859 # searched for in the same directory as this configuration file. You may
1860 # use absolute pathnames too.
1861 # You can specify more than 2 configuration files, if needed.
1862 #include: include1.yaml
1863 #include: include2.yaml