5 ## IPFire specific configuration file - an untouched example configuration
6 ## can be found in suricata-example.yaml.
11 # Include HOME_NET declaration from external file.
12 include: /var/ipfire/suricata/suricata-homenet.yaml
14 EXTERNAL_NET: "!$HOME_NET"
17 HTTP_SERVERS: "$HOME_NET"
18 SMTP_SERVERS: "$HOME_NET"
19 SQL_SERVERS: "$HOME_NET"
20 DNS_SERVERS: "$HOME_NET"
21 TELNET_SERVERS: "$HOME_NET"
22 AIM_SERVERS: "$EXTERNAL_NET"
23 DNP3_SERVER: "$HOME_NET"
24 DNP3_CLIENT: "$HOME_NET"
25 MODBUS_CLIENT: "$HOME_NET"
26 MODBUS_SERVER: "$HOME_NET"
27 ENIP_CLIENT: "$HOME_NET"
28 ENIP_SERVER: "$HOME_NET"
32 SHELLCODE_PORTS: "!80"
37 FILE_DATA_PORTS: "[$HTTP_PORTS,110,143]"
41 ## Ruleset specific options.
43 default-rule-path: /var/lib/suricata
45 # Include enabled ruleset files from external file.
46 include: /var/ipfire/suricata/suricata-used-rulefiles.yaml
48 classification-file: /var/lib/suricata/classification.config
49 reference-config-file: /var/lib/suricata/reference.config
50 threshold-file: /var/lib/suricata/threshold.config
56 default-log-dir: /var/log/suricata/
58 # global stats configuration
61 # The interval field (in seconds) controls at what interval
62 # the loggers are invoked.
65 # Configure the type of alert (and other) logging you would like.
67 # a line based alerts log similar to Snort's fast.log
72 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
74 # Stats.log contains data from various counters of the suricata engine.
78 append: no # append to file (yes) or overwrite it (no)
79 totals: yes # stats for all threads merged together
80 threads: no # per thread stats
81 #null-values: yes # print counters that have value 0
84 # The default log level, can be overridden in an output section.
85 # Note that debug level logging will only be emitted if Suricata was
86 # compiled with the --enable-debug configure option.
88 # This value is overriden by the SC_LOG_LEVEL env var.
89 default-log-level: notice
91 # A regex to filter output. Can be overridden in an output section.
92 # Defaults to empty (no filter).
94 # This value is overriden by the SC_LOG_OP_FILTER env var.
95 default-output-filter:
97 # Define your logging outputs. If none are defined, or they are all
98 # disabled you will get the default - console output.
106 filename: /var/log/suricata/suricata.log
115 ## Netfilter configuration
129 ## Step 5: App Layer Protocol Configuration
132 # Configure the app-layer parsers. The protocols section details each
135 # The option "enabled" takes 3 values - "yes", "no", "detection-only".
136 # "yes" enables both detection and the parser, "no" disables both, and
137 # "detection-only" enables protocol detection only (parser disabled).
143 dp: "[443,444,465,993,995]"
145 # Completely stop processing TLS/SSL session after the handshake
146 # completed. If bypass is enabled this will also trigger flow
147 # bypass. If disabled (the default), TLS/SSL session is still
148 # tracked for Heartbleed and other anomalies.
158 # Configure SMTP-MIME Decoder
160 # Decode MIME messages from SMTP transactions
161 # (may be resource intensive)
162 # This field supercedes all others because it turns the entire
166 # Decode MIME entity bodies (ie. base64, quoted-printable, etc.)
168 decode-quoted-printable: yes
170 # Maximum bytes per header data value stored in the data structure
172 header-value-depth: 2000
174 # Extract URLs and save in state data structure
176 # Set to yes to compute the md5 of the mail body. You will then
177 # be able to journalize it.
179 # Configure inspected-tracker for file_data keyword
181 content-limit: 100000
182 content-inspect-min-size: 32768
183 content-inspect-window: 4096
192 # smb2 detection is disabled internally inside the engine.
196 # memcaps. Globally and per flow/state.
200 # How many unreplied DNS requests are considered a flood.
201 # If the limit is reached, app-layer-event:dns.flooded; will match.
216 # default-config: Used when no server-config matches
217 # personality: List of personalities used by default
218 # request-body-limit: Limit reassembly of request body for inspection
219 # by http_client_body & pcre /P option.
220 # response-body-limit: Limit reassembly of response body for inspection
221 # by file_data, http_server_body & pcre /Q option.
222 # double-decode-path: Double decode path section of the URI
223 # double-decode-query: Double decode query section of the URI
224 # response-body-decompress-layer-limit:
225 # Limit to how many layers of compression will be
226 # decompressed. Defaults to 2.
228 # server-config: List of server configurations to use if address matches
229 # address: List of ip addresses or networks for this block
230 # personalitiy: List of personalities used by this block
231 # request-body-limit: Limit reassembly of request body for inspection
232 # by http_client_body & pcre /P option.
233 # response-body-limit: Limit reassembly of response body for inspection
234 # by file_data, http_server_body & pcre /Q option.
235 # double-decode-path: Double decode path section of the URI
236 # double-decode-query: Double decode query section of the URI
238 # uri-include-all: Include all parts of the URI. By default the
239 # 'scheme', username/password, hostname and port
240 # are excluded. Setting this option to true adds
241 # all of them to the normalized uri as inspected
242 # by http_uri, urilen, pcre with /U and the other
243 # keywords that inspect the normalized uri.
244 # Note that this does not affect http_raw_uri.
245 # Also, note that including all was the default in
248 # meta-field-limit: Hard size limit for request and response size
249 # limits. Applies to request line and headers,
250 # response line and headers. Does not apply to
251 # request or response bodies. Default is 18k.
252 # If this limit is reached an event is raised.
254 # Currently Available Personalities:
255 # Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0,
256 # IIS_7_0, IIS_7_5, Apache_2
261 # Can be specified in kb, mb, gb. Just a number indicates
263 request-body-limit: 100kb
264 response-body-limit: 100kb
267 request-body-minimal-inspect-size: 32kb
268 request-body-inspect-window: 4kb
269 response-body-minimal-inspect-size: 40kb
270 response-body-inspect-window: 16kb
272 # response body decompression (0 disables)
273 response-body-decompress-layer-limit: 2
275 # auto will use http-body-inline mode in IPS mode, yes or no set it statically
276 http-body-inline: auto
278 # Take a random value for inspection sizes around the specified value.
279 # This lower the risk of some evasion technics but could lead
280 # detection change between runs. It is set to 'yes' by default.
281 #randomize-inspection-sizes: yes
282 # If randomize-inspection-sizes is active, the value of various
283 # inspection size will be choosen in the [1 - range%, 1 + range%]
285 # Default value of randomize-inspection-range is 10.
286 #randomize-inspection-range: 10
289 double-decode-path: no
290 double-decode-query: no
295 # address: [192.168.1.0/24, 127.0.0.0/8, "::1"]
296 # personality: Apache_2
297 # # Can be specified in kb, mb, gb. Just a number indicates
299 # request-body-limit: 4096
300 # response-body-limit: 4096
301 # double-decode-path: no
302 # double-decode-query: no
308 # personality: IIS_7_0
309 # # Can be specified in kb, mb, gb. Just a number indicates
311 # request-body-limit: 4096
312 # response-body-limit: 4096
313 # double-decode-path: no
314 # double-decode-query: no
316 # Note: Modbus probe parser is minimalist due to the poor significant field
317 # Only Modbus message length (greater than Modbus header length)
318 # And Protocol ID (equal to 0) are checked in probing parser
319 # It is important to enable detection port and define Modbus port
320 # to avoid false positive
322 # How many unreplied Modbus requests are considered a flood.
323 # If the limit is reached, app-layer-event:modbus.flooded; will match.
329 # According to MODBUS Messaging on TCP/IP Implementation Guide V1.0b, it
330 # is recommended to keep the TCP connection opened with a remote device
331 # and not to open and close it for each MODBUS/TCP transaction. In that
332 # case, it is important to set the depth of the stream reassembling as
333 # unlimited (stream.reassembly.depth: 0)
335 # Stream reassembly size for modbus. By default track it completely.
344 # SCADA EtherNet/IP and CIP protocol support
351 # Limit for the maximum number of asn1 frames to decode (default 256)
355 ##############################################################################
357 ## Advanced settings below
359 ##############################################################################
361 # Suricata core dump configuration. Limits the size of the core dump file to
362 # approximately max-dump. The actual core dump size will be a multiple of the
363 # page size. Core dumps that would be larger than max-dump are truncated. On
364 # Linux, the actual core dump size may be a few pages larger than max-dump.
365 # Setting max-dump to 0 disables core dumping.
366 # Setting max-dump to 'unlimited' will give the full core dump file.
367 # On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size
373 # If suricata box is a router for the sniffed networks, set it to 'router'. If
374 # it is a pure sniffing setup, set it to 'sniffer-only'.
375 # If set to auto, the variable is internally switch to 'router' in IPS mode
376 # and 'sniffer-only' in IDS mode.
377 # This feature is currently only used by the reject* keywords.
380 # Number of packets preallocated per thread. The default is 1024. A higher number
381 # will make sure each CPU will be more easily kept busy, but may negatively
383 max-pending-packets: 1024
385 # Runmode the engine should use. Please check --list-runmodes to get the available
386 # runmodes for each packet acquisition method. Defaults to "autofp" (auto flow pinned
390 # Specifies the kind of flow load balancer used by the flow pinned autofp mode.
392 # Supported schedulers are:
394 # round-robin - Flows assigned to threads in a round robin fashion.
395 # active-packets - Flows assigned to threads that have the lowest number of
396 # unprocessed packets (default).
397 # hash - Flow alloted usihng the address hash. More of a random
398 # technique. Was the default in Suricata 1.2.1 and older.
400 #autofp-scheduler: active-packets
402 # Preallocated size for packet. Default is 1514 which is the classical
403 # size for pcap on ethernet. You should adjust this value to the highest
404 # packet size (MTU + hardware header) on your system.
405 default-packet-size: 1514
407 # Unix command socket can be used to pass commands to suricata.
408 # An external tool can then connect to get information from suricata
409 # or trigger some modifications of the engine. Set enabled to yes
410 # to activate the feature. In auto mode, the feature will only be
411 # activated in live capture mode. You can use the filename variable to set
412 # the file name of the socket.
415 #filename: custom.socket
418 magic-file: /usr/share/misc/magic.mgc
424 ## Detection settings
427 # Set the order of alerts bassed on actions
428 # The default order is pass, drop, reject, alert
435 # When run with the option --engine-analysis, the engine will read each of
436 # the parameters below, and print reports for each of the enabled sections
437 # and exit. The reports are printed to a file in the default log dir
438 # given by the parameter "default-log-dir", with engine reporting
439 # subsection below printing reports in its own report file.
441 # enables printing reports for fast-pattern for every rule.
442 rules-fast-pattern: yes
443 # enables printing reports for each rule
446 #recursion and match limits for PCRE where supported
449 match-limit-recursion: 1500
452 ## Advanced Traffic Tracking and Reconstruction Settings
455 # Host specific policies for defragmentation and TCP stream
456 # reassembly. The host OS lookup is done using a radix tree, just
457 # like a routing table so the most specific entry matches.
459 # Make the default policy windows.
479 trackers: 65535 # number of defragmented flows to follow
480 max-frags: 65535 # number of fragments to keep (higher than trackers)
485 # By default, the reserved memory (memcap) for flows is 32MB. This is the limit
486 # for flow allocation inside the engine. You can change this value to allow
487 # more memory usage for flows.
488 # The hash-size determine the size of the hash used to identify flows inside
489 # the engine, and by default the value is 65536.
490 # At the startup, the engine can preallocate a number of flows, to get a better
491 # performance. The number of flows preallocated is 10000 by default.
492 # emergency-recovery is the percentage of flows that the engine need to
493 # prune before unsetting the emergency state. The emergency state is activated
494 # when the memcap limit is reached, allowing to create new flows, but
495 # prunning them with the emergency timeouts (they are defined below).
496 # If the memcap is reached, the engine will try to prune flows
497 # with the default timeouts. If it doens't find a flow to prune, it will set
498 # the emergency bit and it will try again with more agressive timeouts.
499 # If that doesn't work, then it will try to kill the last time seen flows
501 # The memcap can be specified in kb, mb, gb. Just a number indicates it's
508 emergency-recovery: 30
512 # This option controls the use of vlan ids in the flow (and defrag)
513 # hashing. Normally this should be enabled, but in some (broken)
514 # setups where both sides of a flow are not tagged with the same vlan
515 # tag, we can ignore the vlan id's in the flow hashing.
517 use-for-tracking: true
519 # Specific timeouts for flows. Here you can specify the timeouts that the
520 # active flows will wait to transit from the current state to another, on each
521 # protocol. The value of "new" determine the seconds to wait after a hanshake or
522 # stream startup before the engine free the data of that flow it doesn't
523 # change the state to established (usually if we don't receive more packets
524 # of that flow). The value of "established" is the amount of
525 # seconds that the engine will wait to free the flow if it spend that amount
526 # without receiving new packets or closing the connection. "closed" is the
527 # amount of time to wait after a flow is closed (usually zero). "bypassed"
528 # timeout controls locally bypassed flows. For these flows we don't do any other
529 # tracking. If no packets have been seen after this timeout, the flow is discarded.
531 # There's an emergency mode that will become active under attack circumstances,
532 # making the engine to check flow status faster. This configuration variables
533 # use the prefix "emergency-" and work similar as the normal ones.
534 # Some timeouts doesn't apply to all the protocols, like "closed", for udp and
545 emergency-established: 100
547 emergency-bypassed: 50
554 emergency-established: 100
556 emergency-bypassed: 50
562 emergency-established: 100
563 emergency-bypassed: 50
569 emergency-established: 100
570 emergency-bypassed: 50
572 # Stream engine settings. Here the TCP stream tracking and reassembly
573 # engine is configured.
576 # memcap: 32mb # Can be specified in kb, mb, gb. Just a
577 # # number indicates it's in bytes.
578 # checksum-validation: yes # To validate the checksum of received
579 # # packet. If csum validation is specified as
580 # # "yes", then packet with invalid csum will not
581 # # be processed by the engine stream/app layer.
582 # # Warning: locally generated trafic can be
583 # # generated without checksum due to hardware offload
584 # # of checksum. You can control the handling of checksum
585 # # on a per-interface basis via the 'checksum-checks'
587 # prealloc-sessions: 2k # 2k sessions prealloc'd per stream thread
588 # midstream: false # don't allow midstream session pickups
589 # async-oneside: false # don't enable async stream handling
590 # inline: no # stream inline mode
591 # drop-invalid: yes # in inline mode, drop packets that are invalid with regards to streaming engine
592 # max-synack-queued: 5 # Max different SYN/ACKs to queue
593 # bypass: no # Bypass packets when stream.depth is reached
596 # memcap: 64mb # Can be specified in kb, mb, gb. Just a number
597 # # indicates it's in bytes.
598 # depth: 1mb # Can be specified in kb, mb, gb. Just a number
599 # # indicates it's in bytes.
600 # toserver-chunk-size: 2560 # inspect raw stream in chunks of at least
601 # # this size. Can be specified in kb, mb,
602 # # gb. Just a number indicates it's in bytes.
603 # toclient-chunk-size: 2560 # inspect raw stream in chunks of at least
604 # # this size. Can be specified in kb, mb,
605 # # gb. Just a number indicates it's in bytes.
606 # randomize-chunk-size: yes # Take a random value for chunk size around the specified value.
607 # # This lower the risk of some evasion technics but could lead
608 # # detection change between runs. It is set to 'yes' by default.
609 # randomize-chunk-range: 10 # If randomize-chunk-size is active, the value of chunk-size is
610 # # a random value between (1 - randomize-chunk-range/100)*toserver-chunk-size
611 # # and (1 + randomize-chunk-range/100)*toserver-chunk-size and the same
612 # # calculation for toclient-chunk-size.
613 # # Default value of randomize-chunk-range is 10.
615 # raw: yes # 'Raw' reassembly enabled or disabled.
616 # # raw is for content inspection by detection
619 # segment-prealloc: 2048 # number of segments preallocated per thread
621 # check-overlap-different-data: true|false
622 # # check if a segment contains different data
623 # # than what we've already seen for that
624 # # position in the stream.
625 # # This is enabled automatically if inline mode
626 # # is used or when stream-event:reassembly_overlap_different_data;
627 # # is used in a rule.
631 checksum-validation: yes # reject wrong csums
632 inline: auto # auto will use inline mode in IPS mode, yes or no set it statically
635 depth: 1mb # reassemble 1mb into a stream
636 toserver-chunk-size: 2560
637 toclient-chunk-size: 2560
638 randomize-chunk-size: yes
639 #randomize-chunk-range: 10
641 #segment-prealloc: 2048
642 #check-overlap-different-data: true
646 # Host table is used by tagging and per host thresholding subsystems.
655 # Used by xbits 'ippair' tracking.
665 # Teredo decoder is known to not be completely accurate
666 # it will sometimes detect non-teredo as teredo.
672 ## Performance tuning and profiling
675 # The detection engine builds internal groups of signatures. The engine
676 # allow us to specify the profile to use for them, to manage memory on an
677 # efficient way keeping a good performance. For the profile keyword you
678 # can use the words "low", "medium", "high" or "custom". If you use custom
679 # make sure to define the values at "- custom-values" as your convenience.
680 # Usually you would prefer medium/high/low.
682 # "sgh mpm-context", indicates how the staging should allot mpm contexts for
683 # the signature groups. "single" indicates the use of a single context for
684 # all the signature group heads. "full" indicates a mpm-context for each
685 # group head. "auto" lets the engine decide the distribution of contexts
686 # based on the information the engine gathers on the patterns from each
689 # The option inspection-recursion-limit is used to limit the recursive calls
690 # in the content inspection code. For certain payload-sig combinations, we
691 # might end up taking too much time in the content inspection code.
692 # If the argument specified is 0, the engine uses an internally defined
693 # default limit. On not specifying a value, we use no limits on the recursion.
699 sgh-mpm-context: auto
700 inspection-recursion-limit: 3000
701 # If set to yes, the loading of signatures will be made after the capture
702 # is started. This will limit the downtime in IPS mode.
706 # default prefiltering setting. "mpm" only creates MPM/fast_pattern
707 # engines. "auto" also sets up prefilter engines for other keywords.
708 # Use --list-keywords=all to see which keywords support prefiltering.
711 # the grouping values above control how many groups are created per
712 # direction. Port whitelisting forces that port to get it's own group.
713 # Very common ports will benefit, as well as ports with many expensive
716 #tcp-whitelist: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080
717 #udp-whitelist: 53, 135, 5060
720 # Log the rules that made it past the prefilter stage, per packet
721 # default is off. The threshold setting determines how many rules
722 # must have made it past pre-filter for that rule to trigger the
724 #inspect-logging-threshold: 200
727 include-rules: false # very verbose
728 include-mpm-stats: false
730 # Select the multi pattern algorithm you want to run for scan/search the
733 # The supported algorithms are:
734 # "ac" - Aho-Corasick, default implementation
735 # "ac-bs" - Aho-Corasick, reduced memory implementation
736 # "ac-cuda" - Aho-Corasick, CUDA implementation
737 # "ac-ks" - Aho-Corasick, "Ken Steele" variant
738 # "hs" - Hyperscan, available when built with Hyperscan support
740 # The default mpm-algo value of "auto" will use "hs" if Hyperscan is
741 # available, "ac" otherwise.
743 # The mpm you choose also decides the distribution of mpm contexts for
744 # signature groups, specified by the conf - "detect.sgh-mpm-context".
745 # Selecting "ac" as the mpm would require "detect.sgh-mpm-context"
746 # to be set to "single", because of ac's memory requirements, unless the
747 # ruleset is small enough to fit in one's memory, in which case one can
748 # use "full" with "ac". Rest of the mpms can be run in "full" mode.
750 # There is also a CUDA pattern matcher (only available if Suricata was
751 # compiled with --enable-cuda: b2g_cuda. Make sure to update your
752 # max-pending-packets setting above as well if you use b2g_cuda.
756 # Select the matching algorithm you want to use for single-pattern searches.
758 # Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only
759 # available if Suricata has been built with Hyperscan support).
761 # The default of "auto" will use "hs" if available, otherwise "bm".
765 # Suricata is multi-threaded. Here the threading can be influenced.
768 # Tune cpu affinity of threads. Each family of threads can be bound
771 # These 2 apply to the all runmodes:
772 # management-cpu-set is used for flow timeout handling, counters
773 # worker-cpu-set is used for 'worker' threads
775 # Additionally, for autofp these apply:
776 # receive-cpu-set is used for capture threads
777 # verdict-cpu-set is used for IPS verdict threads
780 - management-cpu-set:
781 cpu: [ 0 ] # include only these cpus in affinity settings
783 cpu: [ 0 ] # include only these cpus in affinity settings
787 # Use explicitely 3 threads and don't compute number by using
788 # detect-thread-ratio variable:
800 # By default Suricata creates one "detect" thread per available CPU/CPU core.
801 # This setting allows controlling this behaviour. A ratio setting of 2 will
802 # create 2 detect threads for each CPU/CPU core. So for a dual core CPU this
803 # will result in 4 detect threads. If values below 1 are used, less threads
804 # are created. So on a dual core CPU a setting of 0.5 results in 1 detect
805 # thread being created. Regardless of the setting at a minimum 1 detect
806 # thread will always be created.
808 detect-thread-ratio: 1.0