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 # Include DNS_SERVERS declaration from external file.
15 include: /var/ipfire/suricata/suricata-dns-servers.yaml
19 HTTP_SERVERS: "$HOME_NET"
20 SMTP_SERVERS: "$HOME_NET"
21 SQL_SERVERS: "$HOME_NET"
22 TELNET_SERVERS: "$HOME_NET"
23 AIM_SERVERS: "$EXTERNAL_NET"
24 DC_SERVERS: "$HOME_NET"
25 DNP3_SERVER: "$HOME_NET"
26 DNP3_CLIENT: "$HOME_NET"
27 MODBUS_CLIENT: "$HOME_NET"
28 MODBUS_SERVER: "$HOME_NET"
29 ENIP_CLIENT: "$HOME_NET"
30 ENIP_SERVER: "$HOME_NET"
34 SHELLCODE_PORTS: "!80"
39 FILE_DATA_PORTS: "[$HTTP_PORTS,110,143]"
43 ## Ruleset specific options.
45 default-rule-path: /var/lib/suricata
47 # Include enabled ruleset files from external file.
48 include: /var/ipfire/suricata/suricata-used-rulefiles.yaml
50 classification-file: /var/lib/suricata/classification.config
51 reference-config-file: /var/lib/suricata/reference.config
52 threshold-file: /var/lib/suricata/threshold.config
58 default-log-dir: /var/log/suricata/
60 # global stats configuration
63 # The interval field (in seconds) controls at what interval
64 # the loggers are invoked.
67 # Add decode events as stats.
69 # Decoder event prefix in stats. Has been 'decoder' before, but that leads
70 # to missing events in the eve.stats records. See issue #2225.
71 decoder-events-prefix: "decoder.event"
72 # Add stream events as stats.
75 # Configure the type of alert (and other) logging you would like.
77 # a line based alerts log similar to Snort's fast.log
82 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
84 # Stats.log contains data from various counters of the suricata engine.
88 append: no # append to file (yes) or overwrite it (no)
89 totals: yes # stats for all threads merged together
90 threads: no # per thread stats
91 #null-values: yes # print counters that have value 0
94 # The default log level, can be overridden in an output section.
95 # Note that debug level logging will only be emitted if Suricata was
96 # compiled with the --enable-debug configure option.
98 # This value is overriden by the SC_LOG_LEVEL env var.
99 default-log-level: notice
101 # A regex to filter output. Can be overridden in an output section.
102 # Defaults to empty (no filter).
104 # This value is overriden by the SC_LOG_OP_FILTER env var.
105 default-output-filter:
107 # Define your logging outputs. If none are defined, or they are all
108 # disabled you will get the default - console output.
116 filename: /var/log/suricata/suricata.log
125 ## Netfilter configuration
130 repeat-mark: 1879048192
131 repeat-mask: 1879048192
139 ## Step 5: App Layer Protocol Configuration
142 # Configure the app-layer parsers. The protocols section details each
145 # The option "enabled" takes 3 values - "yes", "no", "detection-only".
146 # "yes" enables both detection and the parser, "no" disables both, and
147 # "detection-only" enables protocol detection only (parser disabled).
151 enabled: no # Requires rust
157 dp: "[443,444,465,853,993,995]"
159 # Completely stop processing TLS/SSL session after the handshake
160 # completed. If bypass is enabled this will also trigger flow
161 # bypass. If disabled (the default), TLS/SSL session is still
162 # tracked for Heartbleed and other anomalies.
172 # Configure SMTP-MIME Decoder
174 # Decode MIME messages from SMTP transactions
175 # (may be resource intensive)
176 # This field supercedes all others because it turns the entire
180 # Decode MIME entity bodies (ie. base64, quoted-printable, etc.)
182 decode-quoted-printable: yes
184 # Maximum bytes per header data value stored in the data structure
186 header-value-depth: 2000
188 # Extract URLs and save in state data structure
190 # Set to yes to compute the md5 of the mail body. You will then
191 # be able to journalize it.
193 # Configure inspected-tracker for file_data keyword
195 content-limit: 100000
196 content-inspect-min-size: 32768
197 content-inspect-window: 4096
206 # smb2 detection is disabled internally inside the engine.
210 # memcaps. Globally and per flow/state.
214 # How many unreplied DNS requests are considered a flood.
215 # If the limit is reached, app-layer-event:dns.flooded; will match.
230 # default-config: Used when no server-config matches
231 # personality: List of personalities used by default
232 # request-body-limit: Limit reassembly of request body for inspection
233 # by http_client_body & pcre /P option.
234 # response-body-limit: Limit reassembly of response body for inspection
235 # by file_data, http_server_body & pcre /Q option.
236 # double-decode-path: Double decode path section of the URI
237 # double-decode-query: Double decode query section of the URI
238 # response-body-decompress-layer-limit:
239 # Limit to how many layers of compression will be
240 # decompressed. Defaults to 2.
242 # Currently Available Personalities:
243 # Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0,
244 # IIS_7_0, IIS_7_5, Apache_2
249 # Can be specified in kb, mb, gb. Just a number indicates
251 request-body-limit: 0
252 response-body-limit: 0
254 # response body decompression (0 disables)
255 response-body-decompress-layer-limit: 2
257 # auto will use http-body-inline mode in IPS mode, yes or no set it statically
258 http-body-inline: auto
260 # Take a random value for inspection sizes around the specified value.
261 # This lower the risk of some evasion technics but could lead
262 # detection change between runs. It is set to 'yes' by default.
263 randomize-inspection-sizes: yes
264 # If randomize-inspection-sizes is active, the value of various
265 # inspection size will be choosen in the [1 - range%, 1 + range%]
267 # Default value of randomize-inspection-range is 10.
268 randomize-inspection-range: 10
271 double-decode-path: no
272 double-decode-query: no
275 # Limit for the maximum number of asn1 frames to decode (default 256)
279 ##############################################################################
281 ## Advanced settings below
283 ##############################################################################
289 # Run suricata as user and group.
294 # Suricata core dump configuration. Limits the size of the core dump file to
295 # approximately max-dump. The actual core dump size will be a multiple of the
296 # page size. Core dumps that would be larger than max-dump are truncated. On
297 # Linux, the actual core dump size may be a few pages larger than max-dump.
298 # Setting max-dump to 0 disables core dumping.
299 # Setting max-dump to 'unlimited' will give the full core dump file.
300 # On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size
306 # If suricata box is a router for the sniffed networks, set it to 'router'. If
307 # it is a pure sniffing setup, set it to 'sniffer-only'.
308 # If set to auto, the variable is internally switch to 'router' in IPS mode
309 # and 'sniffer-only' in IDS mode.
310 # This feature is currently only used by the reject* keywords.
313 # Number of packets preallocated per thread. The default is 1024. A higher number
314 # will make sure each CPU will be more easily kept busy, but may negatively
316 max-pending-packets: 1024
318 # Runmode the engine should use. Please check --list-runmodes to get the available
319 # runmodes for each packet acquisition method. Defaults to "autofp" (auto flow pinned
323 # Specifies the kind of flow load balancer used by the flow pinned autofp mode.
325 # Supported schedulers are:
327 # round-robin - Flows assigned to threads in a round robin fashion.
328 # active-packets - Flows assigned to threads that have the lowest number of
329 # unprocessed packets (default).
330 # hash - Flow alloted usihng the address hash. More of a random
331 # technique. Was the default in Suricata 1.2.1 and older.
333 #autofp-scheduler: active-packets
335 # Preallocated size for packet. Default is 1514 which is the classical
336 # size for pcap on ethernet. You should adjust this value to the highest
337 # packet size (MTU + hardware header) on your system.
338 default-packet-size: 1514
340 # Unix command socket can be used to pass commands to suricata.
341 # An external tool can then connect to get information from suricata
342 # or trigger some modifications of the engine. Set enabled to yes
343 # to activate the feature. In auto mode, the feature will only be
344 # activated in live capture mode. You can use the filename variable to set
345 # the file name of the socket.
348 #filename: custom.socket
351 magic-file: /usr/share/misc/magic.mgc
357 ## Detection settings
360 # Set the order of alerts bassed on actions
361 # The default order is pass, drop, reject, alert
368 # When run with the option --engine-analysis, the engine will read each of
369 # the parameters below, and print reports for each of the enabled sections
370 # and exit. The reports are printed to a file in the default log dir
371 # given by the parameter "default-log-dir", with engine reporting
372 # subsection below printing reports in its own report file.
374 # enables printing reports for fast-pattern for every rule.
375 rules-fast-pattern: yes
376 # enables printing reports for each rule
379 #recursion and match limits for PCRE where supported
382 match-limit-recursion: 1500
385 ## Advanced Traffic Tracking and Reconstruction Settings
388 # Host specific policies for defragmentation and TCP stream
389 # reassembly. The host OS lookup is done using a radix tree, just
390 # like a routing table so the most specific entry matches.
392 # Make the default policy windows.
412 trackers: 65535 # number of defragmented flows to follow
413 max-frags: 65535 # number of fragments to keep (higher than trackers)
418 # By default, the reserved memory (memcap) for flows is 32MB. This is the limit
419 # for flow allocation inside the engine. You can change this value to allow
420 # more memory usage for flows.
421 # The hash-size determine the size of the hash used to identify flows inside
422 # the engine, and by default the value is 65536.
423 # At the startup, the engine can preallocate a number of flows, to get a better
424 # performance. The number of flows preallocated is 10000 by default.
425 # emergency-recovery is the percentage of flows that the engine need to
426 # prune before unsetting the emergency state. The emergency state is activated
427 # when the memcap limit is reached, allowing to create new flows, but
428 # prunning them with the emergency timeouts (they are defined below).
429 # If the memcap is reached, the engine will try to prune flows
430 # with the default timeouts. If it doens't find a flow to prune, it will set
431 # the emergency bit and it will try again with more agressive timeouts.
432 # If that doesn't work, then it will try to kill the last time seen flows
434 # The memcap can be specified in kb, mb, gb. Just a number indicates it's
441 emergency-recovery: 30
445 # This option controls the use of vlan ids in the flow (and defrag)
446 # hashing. Normally this should be enabled, but in some (broken)
447 # setups where both sides of a flow are not tagged with the same vlan
448 # tag, we can ignore the vlan id's in the flow hashing.
450 use-for-tracking: true
452 # Specific timeouts for flows. Here you can specify the timeouts that the
453 # active flows will wait to transit from the current state to another, on each
454 # protocol. The value of "new" determine the seconds to wait after a hanshake or
455 # stream startup before the engine free the data of that flow it doesn't
456 # change the state to established (usually if we don't receive more packets
457 # of that flow). The value of "established" is the amount of
458 # seconds that the engine will wait to free the flow if it spend that amount
459 # without receiving new packets or closing the connection. "closed" is the
460 # amount of time to wait after a flow is closed (usually zero). "bypassed"
461 # timeout controls locally bypassed flows. For these flows we don't do any other
462 # tracking. If no packets have been seen after this timeout, the flow is discarded.
464 # There's an emergency mode that will become active under attack circumstances,
465 # making the engine to check flow status faster. This configuration variables
466 # use the prefix "emergency-" and work similar as the normal ones.
467 # Some timeouts doesn't apply to all the protocols, like "closed", for udp and
478 emergency-established: 100
480 emergency-bypassed: 50
487 emergency-established: 100
489 emergency-bypassed: 50
495 emergency-established: 100
496 emergency-bypassed: 50
502 emergency-established: 100
503 emergency-bypassed: 50
505 # Stream engine settings. Here the TCP stream tracking and reassembly
506 # engine is configured.
509 # memcap: 32mb # Can be specified in kb, mb, gb. Just a
510 # # number indicates it's in bytes.
511 # checksum-validation: yes # To validate the checksum of received
512 # # packet. If csum validation is specified as
513 # # "yes", then packet with invalid csum will not
514 # # be processed by the engine stream/app layer.
515 # # Warning: locally generated trafic can be
516 # # generated without checksum due to hardware offload
517 # # of checksum. You can control the handling of checksum
518 # # on a per-interface basis via the 'checksum-checks'
520 # prealloc-sessions: 2k # 2k sessions prealloc'd per stream thread
521 # midstream: false # don't allow midstream session pickups
522 # async-oneside: false # don't enable async stream handling
523 # inline: no # stream inline mode
524 # drop-invalid: yes # in inline mode, drop packets that are invalid with regards to streaming engine
525 # max-synack-queued: 5 # Max different SYN/ACKs to queue
526 # bypass: no # Bypass packets when stream.depth is reached
529 # memcap: 64mb # Can be specified in kb, mb, gb. Just a number
530 # # indicates it's in bytes.
531 # depth: 1mb # Can be specified in kb, mb, gb. Just a number
532 # # indicates it's in bytes.
533 # toserver-chunk-size: 2560 # inspect raw stream in chunks of at least
534 # # this size. Can be specified in kb, mb,
535 # # gb. Just a number indicates it's in bytes.
536 # toclient-chunk-size: 2560 # inspect raw stream in chunks of at least
537 # # this size. Can be specified in kb, mb,
538 # # gb. Just a number indicates it's in bytes.
539 # randomize-chunk-size: yes # Take a random value for chunk size around the specified value.
540 # # This lower the risk of some evasion technics but could lead
541 # # detection change between runs. It is set to 'yes' by default.
542 # randomize-chunk-range: 10 # If randomize-chunk-size is active, the value of chunk-size is
543 # # a random value between (1 - randomize-chunk-range/100)*toserver-chunk-size
544 # # and (1 + randomize-chunk-range/100)*toserver-chunk-size and the same
545 # # calculation for toclient-chunk-size.
546 # # Default value of randomize-chunk-range is 10.
548 # raw: yes # 'Raw' reassembly enabled or disabled.
549 # # raw is for content inspection by detection
552 # segment-prealloc: 2048 # number of segments preallocated per thread
554 # check-overlap-different-data: true|false
555 # # check if a segment contains different data
556 # # than what we've already seen for that
557 # # position in the stream.
558 # # This is enabled automatically if inline mode
559 # # is used or when stream-event:reassembly_overlap_different_data;
560 # # is used in a rule.
564 prealloc-sessions: 4096
565 checksum-validation: yes # reject wrong csums
566 inline: auto # auto will use inline mode in IPS mode, yes or no set it statically
569 depth: 1mb # reassemble 1mb into a stream
570 toserver-chunk-size: 2560
571 toclient-chunk-size: 2560
572 randomize-chunk-size: yes
574 segment-prealloc: 2048
575 check-overlap-different-data: true
579 # Host table is used by tagging and per host thresholding subsystems.
588 # Used by xbits 'ippair' tracking.
598 # Teredo decoder is known to not be completely accurate
599 # it will sometimes detect non-teredo as teredo.
605 ## Performance tuning and profiling
608 # The detection engine builds internal groups of signatures. The engine
609 # allow us to specify the profile to use for them, to manage memory on an
610 # efficient way keeping a good performance. For the profile keyword you
611 # can use the words "low", "medium", "high" or "custom". If you use custom
612 # make sure to define the values at "- custom-values" as your convenience.
613 # Usually you would prefer medium/high/low.
615 # "sgh mpm-context", indicates how the staging should allot mpm contexts for
616 # the signature groups. "single" indicates the use of a single context for
617 # all the signature group heads. "full" indicates a mpm-context for each
618 # group head. "auto" lets the engine decide the distribution of contexts
619 # based on the information the engine gathers on the patterns from each
622 # The option inspection-recursion-limit is used to limit the recursive calls
623 # in the content inspection code. For certain payload-sig combinations, we
624 # might end up taking too much time in the content inspection code.
625 # If the argument specified is 0, the engine uses an internally defined
626 # default limit. On not specifying a value, we use no limits on the recursion.
632 sgh-mpm-context: auto
633 inspection-recursion-limit: 3000
635 # If set to yes, the loading of signatures will be made after the capture
636 # is started. This will limit the downtime in IPS mode.
640 # default prefiltering setting. "mpm" only creates MPM/fast_pattern
641 # engines. "auto" also sets up prefilter engines for other keywords.
642 # Use --list-keywords=all to see which keywords support prefiltering.
645 # the grouping values above control how many groups are created per
646 # direction. Port whitelisting forces that port to get it's own group.
647 # Very common ports will benefit, as well as ports with many expensive
650 #tcp-whitelist: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080
651 #udp-whitelist: 53, 135, 5060
654 # Log the rules that made it past the prefilter stage, per packet
655 # default is off. The threshold setting determines how many rules
656 # must have made it past pre-filter for that rule to trigger the
658 #inspect-logging-threshold: 200
661 include-rules: false # very verbose
662 include-mpm-stats: false
664 # Select the multi pattern algorithm you want to run for scan/search the
667 # The supported algorithms are:
668 # "ac" - Aho-Corasick, default implementation
669 # "ac-bs" - Aho-Corasick, reduced memory implementation
670 # "ac-cuda" - Aho-Corasick, CUDA implementation
671 # "ac-ks" - Aho-Corasick, "Ken Steele" variant
672 # "hs" - Hyperscan, available when built with Hyperscan support
674 # The default mpm-algo value of "auto" will use "hs" if Hyperscan is
675 # available, "ac" otherwise.
677 # The mpm you choose also decides the distribution of mpm contexts for
678 # signature groups, specified by the conf - "detect.sgh-mpm-context".
679 # Selecting "ac" as the mpm would require "detect.sgh-mpm-context"
680 # to be set to "single", because of ac's memory requirements, unless the
681 # ruleset is small enough to fit in one's memory, in which case one can
682 # use "full" with "ac". Rest of the mpms can be run in "full" mode.
684 # There is also a CUDA pattern matcher (only available if Suricata was
685 # compiled with --enable-cuda: b2g_cuda. Make sure to update your
686 # max-pending-packets setting above as well if you use b2g_cuda.
690 # Select the matching algorithm you want to use for single-pattern searches.
692 # Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only
693 # available if Suricata has been built with Hyperscan support).
695 # The default of "auto" will use "hs" if available, otherwise "bm".
699 # Suricata is multi-threaded. Here the threading can be influenced.
702 # Tune cpu affinity of threads. Each family of threads can be bound
705 # These 2 apply to the all runmodes:
706 # management-cpu-set is used for flow timeout handling, counters
707 # worker-cpu-set is used for 'worker' threads
709 # Additionally, for autofp these apply:
710 # receive-cpu-set is used for capture threads
711 # verdict-cpu-set is used for IPS verdict threads
714 - management-cpu-set:
715 cpu: [ 0 ] # include only these cpus in affinity settings
717 cpu: [ 0 ] # include only these cpus in affinity settings
731 # By default Suricata creates one "detect" thread per available CPU/CPU core.
732 # This setting allows controlling this behaviour. A ratio setting of 2 will
733 # create 2 detect threads for each CPU/CPU core. So for a dual core CPU this
734 # will result in 4 detect threads. If values below 1 are used, less threads
735 # are created. So on a dual core CPU a setting of 0.5 results in 1 detect
736 # thread being created. Regardless of the setting at a minimum 1 detect
737 # thread will always be created.
739 detect-thread-ratio: 1.0