]> git.ipfire.org Git - ipfire-2.x.git/blob - config/suricata/suricata.yaml
suricata: Drop profiling section from configuration
[ipfire-2.x.git] / config / suricata / suricata.yaml
1 %YAML 1.1
2 ---
3
4 ##
5 ## IPFire specific configuration file - an untouched example configuration
6 ## can be found in suricata-example.yaml.
7 ##
8
9 vars:
10 address-groups:
11 # Include HOME_NET declaration from external file.
12 include: /var/ipfire/suricata/suricata-homenet.yaml
13
14 EXTERNAL_NET: "!$HOME_NET"
15 #EXTERNAL_NET: "any"
16
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"
29
30 port-groups:
31 HTTP_PORTS: "80"
32 SHELLCODE_PORTS: "!80"
33 ORACLE_PORTS: 1521
34 SSH_PORTS: "[22,222]"
35 DNP3_PORTS: 20000
36 MODBUS_PORTS: 502
37 FILE_DATA_PORTS: "[$HTTP_PORTS,110,143]"
38 FTP_PORTS: 21
39
40 ##
41 ## Ruleset specific options.
42 ##
43 default-rule-path: /var/lib/suricata
44 rule-files:
45 # Include enabled ruleset files from external file.
46 include: /var/ipfire/suricata/suricata-used-rulefiles.yaml
47
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
51
52
53 ##
54 ## Logging options.
55 ##
56 default-log-dir: /var/log/suricata/
57
58 # global stats configuration
59 stats:
60 enabled: yes
61 # The interval field (in seconds) controls at what interval
62 # the loggers are invoked.
63 interval: 8
64
65 # Configure the type of alert (and other) logging you would like.
66 outputs:
67 # a line based alerts log similar to Snort's fast.log
68 - fast:
69 enabled: yes
70 filename: fast.log
71 append: yes
72 #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
73
74 # Stats.log contains data from various counters of the suricata engine.
75 - stats:
76 enabled: yes
77 filename: stats.log
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
82
83 logging:
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.
87 #
88 # This value is overriden by the SC_LOG_LEVEL env var.
89 default-log-level: notice
90
91 # A regex to filter output. Can be overridden in an output section.
92 # Defaults to empty (no filter).
93 #
94 # This value is overriden by the SC_LOG_OP_FILTER env var.
95 default-output-filter:
96
97 # Define your logging outputs. If none are defined, or they are all
98 # disabled you will get the default - console output.
99 outputs:
100 - console:
101 enabled: no
102 # type: json
103 - file:
104 enabled: no
105 level: info
106 filename: /var/log/suricata/suricata.log
107 # type: json
108 - syslog:
109 enabled: yes
110 facility: local5
111 format: "[%i] <%d> -- "
112 # type: json
113
114 ##
115 ## Netfilter configuration
116 ##
117
118 nfq:
119 mode: repeat
120 repeat-mark: 16
121 repeat-mask: 16
122 # bypass-mark: 1
123 # bypass-mask: 1
124 # route-queue: 2
125 # batchcount: 20
126 fail-open: yes
127
128 ##
129 ## Step 5: App Layer Protocol Configuration
130 ##
131
132 # Configure the app-layer parsers. The protocols section details each
133 # protocol.
134 #
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).
138 app-layer:
139 protocols:
140 tls:
141 enabled: yes
142 detection-ports:
143 dp: "[443,444,465,993,995]"
144
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.
149 #no-reassemble: yes
150 dcerpc:
151 enabled: yes
152 ftp:
153 enabled: yes
154 ssh:
155 enabled: yes
156 smtp:
157 enabled: yes
158 # Configure SMTP-MIME Decoder
159 mime:
160 # Decode MIME messages from SMTP transactions
161 # (may be resource intensive)
162 # This field supercedes all others because it turns the entire
163 # process on or off
164 decode-mime: yes
165
166 # Decode MIME entity bodies (ie. base64, quoted-printable, etc.)
167 decode-base64: yes
168 decode-quoted-printable: yes
169
170 # Maximum bytes per header data value stored in the data structure
171 # (default is 2000)
172 header-value-depth: 2000
173
174 # Extract URLs and save in state data structure
175 extract-urls: yes
176 # Set to yes to compute the md5 of the mail body. You will then
177 # be able to journalize it.
178 body-md5: no
179 # Configure inspected-tracker for file_data keyword
180 inspected-tracker:
181 content-limit: 100000
182 content-inspect-min-size: 32768
183 content-inspect-window: 4096
184 imap:
185 enabled: yes
186 msn:
187 enabled: yes
188 smb:
189 enabled: yes
190 detection-ports:
191 dp: 139, 445
192 # smb2 detection is disabled internally inside the engine.
193 #smb2:
194 # enabled: yes
195 # Note: NFS parser depends on Rust support: pass --enable-rust
196 # to configure.
197 nfs:
198 enabled: no
199 dns:
200 # memcaps. Globally and per flow/state.
201 #global-memcap: 16mb
202 #state-memcap: 512kb
203
204 # How many unreplied DNS requests are considered a flood.
205 # If the limit is reached, app-layer-event:dns.flooded; will match.
206 #request-flood: 500
207
208 tcp:
209 enabled: yes
210 detection-ports:
211 dp: "[53,853]"
212 udp:
213 enabled: yes
214 detection-ports:
215 dp: "[53,853]"
216 http:
217 enabled: yes
218 # memcap: 64mb
219
220 # default-config: Used when no server-config matches
221 # personality: List of personalities used by default
222 # request-body-limit: Limit reassembly of request body for inspection
223 # by http_client_body & pcre /P option.
224 # response-body-limit: Limit reassembly of response body for inspection
225 # by file_data, http_server_body & pcre /Q option.
226 # double-decode-path: Double decode path section of the URI
227 # double-decode-query: Double decode query section of the URI
228 # response-body-decompress-layer-limit:
229 # Limit to how many layers of compression will be
230 # decompressed. Defaults to 2.
231 #
232 # server-config: List of server configurations to use if address matches
233 # address: List of ip addresses or networks for this block
234 # personalitiy: List of personalities used by this block
235 # request-body-limit: Limit reassembly of request body for inspection
236 # by http_client_body & pcre /P option.
237 # response-body-limit: Limit reassembly of response body for inspection
238 # by file_data, http_server_body & pcre /Q option.
239 # double-decode-path: Double decode path section of the URI
240 # double-decode-query: Double decode query section of the URI
241 #
242 # uri-include-all: Include all parts of the URI. By default the
243 # 'scheme', username/password, hostname and port
244 # are excluded. Setting this option to true adds
245 # all of them to the normalized uri as inspected
246 # by http_uri, urilen, pcre with /U and the other
247 # keywords that inspect the normalized uri.
248 # Note that this does not affect http_raw_uri.
249 # Also, note that including all was the default in
250 # 1.4 and 2.0beta1.
251 #
252 # meta-field-limit: Hard size limit for request and response size
253 # limits. Applies to request line and headers,
254 # response line and headers. Does not apply to
255 # request or response bodies. Default is 18k.
256 # If this limit is reached an event is raised.
257 #
258 # Currently Available Personalities:
259 # Minimal, Generic, IDS (default), IIS_4_0, IIS_5_0, IIS_5_1, IIS_6_0,
260 # IIS_7_0, IIS_7_5, Apache_2
261 libhtp:
262 default-config:
263 personality: IDS
264
265 # Can be specified in kb, mb, gb. Just a number indicates
266 # it's in bytes.
267 request-body-limit: 100kb
268 response-body-limit: 100kb
269
270 # inspection limits
271 request-body-minimal-inspect-size: 32kb
272 request-body-inspect-window: 4kb
273 response-body-minimal-inspect-size: 40kb
274 response-body-inspect-window: 16kb
275
276 # response body decompression (0 disables)
277 response-body-decompress-layer-limit: 2
278
279 # auto will use http-body-inline mode in IPS mode, yes or no set it statically
280 http-body-inline: auto
281
282 # Take a random value for inspection sizes around the specified value.
283 # This lower the risk of some evasion technics but could lead
284 # detection change between runs. It is set to 'yes' by default.
285 #randomize-inspection-sizes: yes
286 # If randomize-inspection-sizes is active, the value of various
287 # inspection size will be choosen in the [1 - range%, 1 + range%]
288 # range
289 # Default value of randomize-inspection-range is 10.
290 #randomize-inspection-range: 10
291
292 # decoding
293 double-decode-path: no
294 double-decode-query: no
295
296 server-config:
297
298 #- apache:
299 # address: [192.168.1.0/24, 127.0.0.0/8, "::1"]
300 # personality: Apache_2
301 # # Can be specified in kb, mb, gb. Just a number indicates
302 # # it's in bytes.
303 # request-body-limit: 4096
304 # response-body-limit: 4096
305 # double-decode-path: no
306 # double-decode-query: no
307
308 #- iis7:
309 # address:
310 # - 192.168.0.0/24
311 # - 192.168.10.0/24
312 # personality: IIS_7_0
313 # # Can be specified in kb, mb, gb. Just a number indicates
314 # # it's in bytes.
315 # request-body-limit: 4096
316 # response-body-limit: 4096
317 # double-decode-path: no
318 # double-decode-query: no
319
320 # Note: Modbus probe parser is minimalist due to the poor significant field
321 # Only Modbus message length (greater than Modbus header length)
322 # And Protocol ID (equal to 0) are checked in probing parser
323 # It is important to enable detection port and define Modbus port
324 # to avoid false positive
325 modbus:
326 # How many unreplied Modbus requests are considered a flood.
327 # If the limit is reached, app-layer-event:modbus.flooded; will match.
328 #request-flood: 500
329
330 enabled: no
331 detection-ports:
332 dp: 502
333 # According to MODBUS Messaging on TCP/IP Implementation Guide V1.0b, it
334 # is recommended to keep the TCP connection opened with a remote device
335 # and not to open and close it for each MODBUS/TCP transaction. In that
336 # case, it is important to set the depth of the stream reassembling as
337 # unlimited (stream.reassembly.depth: 0)
338
339 # Stream reassembly size for modbus. By default track it completely.
340 stream-depth: 0
341
342 # DNP3
343 dnp3:
344 enabled: no
345 detection-ports:
346 dp: 20000
347
348 # SCADA EtherNet/IP and CIP protocol support
349 enip:
350 enabled: no
351 detection-ports:
352 dp: 44818
353 sp: 44818
354
355 # Note: parser depends on experimental Rust support
356 # with --enable-rust-experimental passed to configure
357 ntp:
358 enabled: no
359
360 # Limit for the maximum number of asn1 frames to decode (default 256)
361 asn1-max-frames: 256
362
363
364 ##############################################################################
365 ##
366 ## Advanced settings below
367 ##
368 ##############################################################################
369
370 ##
371 ## Run Options
372 ##
373
374 # Run suricata as user and group.
375 #run-as:
376 # user: suri
377 # group: suri
378
379 # Some logging module will use that name in event as identifier. The default
380 # value is the hostname
381 #sensor-name: suricata
382
383 # Default location of the pid file. The pid file is only used in
384 # daemon mode (start Suricata with -D). If not running in daemon mode
385 # the --pidfile command line option must be used to create a pid file.
386 #pid-file: /var/run/suricata.pid
387
388 # Daemon working directory
389 # Suricata will change directory to this one if provided
390 # Default: "/"
391 #daemon-directory: "/"
392
393 # Suricata core dump configuration. Limits the size of the core dump file to
394 # approximately max-dump. The actual core dump size will be a multiple of the
395 # page size. Core dumps that would be larger than max-dump are truncated. On
396 # Linux, the actual core dump size may be a few pages larger than max-dump.
397 # Setting max-dump to 0 disables core dumping.
398 # Setting max-dump to 'unlimited' will give the full core dump file.
399 # On 32-bit Linux, a max-dump value >= ULONG_MAX may cause the core dump size
400 # to be 'unlimited'.
401
402 coredump:
403 max-dump: unlimited
404
405 # If suricata box is a router for the sniffed networks, set it to 'router'. If
406 # it is a pure sniffing setup, set it to 'sniffer-only'.
407 # If set to auto, the variable is internally switch to 'router' in IPS mode
408 # and 'sniffer-only' in IDS mode.
409 # This feature is currently only used by the reject* keywords.
410 host-mode: auto
411
412 # Number of packets preallocated per thread. The default is 1024. A higher number
413 # will make sure each CPU will be more easily kept busy, but may negatively
414 # impact caching.
415 max-pending-packets: 1024
416
417 # Runmode the engine should use. Please check --list-runmodes to get the available
418 # runmodes for each packet acquisition method. Defaults to "autofp" (auto flow pinned
419 # load balancing).
420 #runmode: autofp
421
422 # Specifies the kind of flow load balancer used by the flow pinned autofp mode.
423 #
424 # Supported schedulers are:
425 #
426 # round-robin - Flows assigned to threads in a round robin fashion.
427 # active-packets - Flows assigned to threads that have the lowest number of
428 # unprocessed packets (default).
429 # hash - Flow alloted usihng the address hash. More of a random
430 # technique. Was the default in Suricata 1.2.1 and older.
431 #
432 #autofp-scheduler: active-packets
433
434 # Preallocated size for packet. Default is 1514 which is the classical
435 # size for pcap on ethernet. You should adjust this value to the highest
436 # packet size (MTU + hardware header) on your system.
437 default-packet-size: 1514
438
439 # Unix command socket can be used to pass commands to suricata.
440 # An external tool can then connect to get information from suricata
441 # or trigger some modifications of the engine. Set enabled to yes
442 # to activate the feature. In auto mode, the feature will only be
443 # activated in live capture mode. You can use the filename variable to set
444 # the file name of the socket.
445 unix-command:
446 enabled: no
447 #filename: custom.socket
448
449 # Magic file. The extension .mgc is added to the value here.
450 #magic-file: /usr/share/file/magic
451 #magic-file:
452
453 legacy:
454 uricontent: enabled
455
456 ##
457 ## Detection settings
458 ##
459
460 # Set the order of alerts bassed on actions
461 # The default order is pass, drop, reject, alert
462 # action-order:
463 # - pass
464 # - drop
465 # - reject
466 # - alert
467
468 # IP Reputation
469 #reputation-categories-file: /etc/suricata/iprep/categories.txt
470 #default-reputation-path: /etc/suricata/iprep
471 #reputation-files:
472 # - reputation.list
473
474 # When run with the option --engine-analysis, the engine will read each of
475 # the parameters below, and print reports for each of the enabled sections
476 # and exit. The reports are printed to a file in the default log dir
477 # given by the parameter "default-log-dir", with engine reporting
478 # subsection below printing reports in its own report file.
479 engine-analysis:
480 # enables printing reports for fast-pattern for every rule.
481 rules-fast-pattern: yes
482 # enables printing reports for each rule
483 rules: yes
484
485 #recursion and match limits for PCRE where supported
486 pcre:
487 match-limit: 3500
488 match-limit-recursion: 1500
489
490 ##
491 ## Advanced Traffic Tracking and Reconstruction Settings
492 ##
493
494 # Host specific policies for defragmentation and TCP stream
495 # reassembly. The host OS lookup is done using a radix tree, just
496 # like a routing table so the most specific entry matches.
497 host-os-policy:
498 # Make the default policy windows.
499 windows: [0.0.0.0/0]
500 bsd: []
501 bsd-right: []
502 old-linux: []
503 linux: []
504 old-solaris: []
505 solaris: []
506 hpux10: []
507 hpux11: []
508 irix: []
509 macos: []
510 vista: []
511 windows2k3: []
512
513 # Defrag settings:
514
515 defrag:
516 memcap: 32mb
517 hash-size: 65536
518 trackers: 65535 # number of defragmented flows to follow
519 max-frags: 65535 # number of fragments to keep (higher than trackers)
520 prealloc: yes
521 timeout: 60
522
523 # Enable defrag per host settings
524 # host-config:
525 #
526 # - dmz:
527 # timeout: 30
528 # 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"]
529 #
530 # - lan:
531 # timeout: 45
532 # address:
533 # - 192.168.0.0/24
534 # - 192.168.10.0/24
535 # - 172.16.14.0/24
536
537 # Flow settings:
538 # By default, the reserved memory (memcap) for flows is 32MB. This is the limit
539 # for flow allocation inside the engine. You can change this value to allow
540 # more memory usage for flows.
541 # The hash-size determine the size of the hash used to identify flows inside
542 # the engine, and by default the value is 65536.
543 # At the startup, the engine can preallocate a number of flows, to get a better
544 # performance. The number of flows preallocated is 10000 by default.
545 # emergency-recovery is the percentage of flows that the engine need to
546 # prune before unsetting the emergency state. The emergency state is activated
547 # when the memcap limit is reached, allowing to create new flows, but
548 # prunning them with the emergency timeouts (they are defined below).
549 # If the memcap is reached, the engine will try to prune flows
550 # with the default timeouts. If it doens't find a flow to prune, it will set
551 # the emergency bit and it will try again with more agressive timeouts.
552 # If that doesn't work, then it will try to kill the last time seen flows
553 # not in use.
554 # The memcap can be specified in kb, mb, gb. Just a number indicates it's
555 # in bytes.
556
557 flow:
558 memcap: 128mb
559 hash-size: 65536
560 prealloc: 10000
561 emergency-recovery: 30
562 #managers: 1 # default to one flow manager
563 #recyclers: 1 # default to one flow recycler thread
564
565 # This option controls the use of vlan ids in the flow (and defrag)
566 # hashing. Normally this should be enabled, but in some (broken)
567 # setups where both sides of a flow are not tagged with the same vlan
568 # tag, we can ignore the vlan id's in the flow hashing.
569 vlan:
570 use-for-tracking: true
571
572 # Specific timeouts for flows. Here you can specify the timeouts that the
573 # active flows will wait to transit from the current state to another, on each
574 # protocol. The value of "new" determine the seconds to wait after a hanshake or
575 # stream startup before the engine free the data of that flow it doesn't
576 # change the state to established (usually if we don't receive more packets
577 # of that flow). The value of "established" is the amount of
578 # seconds that the engine will wait to free the flow if it spend that amount
579 # without receiving new packets or closing the connection. "closed" is the
580 # amount of time to wait after a flow is closed (usually zero). "bypassed"
581 # timeout controls locally bypassed flows. For these flows we don't do any other
582 # tracking. If no packets have been seen after this timeout, the flow is discarded.
583 #
584 # There's an emergency mode that will become active under attack circumstances,
585 # making the engine to check flow status faster. This configuration variables
586 # use the prefix "emergency-" and work similar as the normal ones.
587 # Some timeouts doesn't apply to all the protocols, like "closed", for udp and
588 # icmp.
589
590 flow-timeouts:
591
592 default:
593 new: 30
594 established: 300
595 closed: 0
596 bypassed: 100
597 emergency-new: 10
598 emergency-established: 100
599 emergency-closed: 0
600 emergency-bypassed: 50
601 tcp:
602 new: 60
603 established: 600
604 closed: 60
605 bypassed: 100
606 emergency-new: 5
607 emergency-established: 100
608 emergency-closed: 10
609 emergency-bypassed: 50
610 udp:
611 new: 30
612 established: 300
613 bypassed: 100
614 emergency-new: 10
615 emergency-established: 100
616 emergency-bypassed: 50
617 icmp:
618 new: 30
619 established: 300
620 bypassed: 100
621 emergency-new: 10
622 emergency-established: 100
623 emergency-bypassed: 50
624
625 # Stream engine settings. Here the TCP stream tracking and reassembly
626 # engine is configured.
627 #
628 # stream:
629 # memcap: 32mb # Can be specified in kb, mb, gb. Just a
630 # # number indicates it's in bytes.
631 # checksum-validation: yes # To validate the checksum of received
632 # # packet. If csum validation is specified as
633 # # "yes", then packet with invalid csum will not
634 # # be processed by the engine stream/app layer.
635 # # Warning: locally generated trafic can be
636 # # generated without checksum due to hardware offload
637 # # of checksum. You can control the handling of checksum
638 # # on a per-interface basis via the 'checksum-checks'
639 # # option
640 # prealloc-sessions: 2k # 2k sessions prealloc'd per stream thread
641 # midstream: false # don't allow midstream session pickups
642 # async-oneside: false # don't enable async stream handling
643 # inline: no # stream inline mode
644 # drop-invalid: yes # in inline mode, drop packets that are invalid with regards to streaming engine
645 # max-synack-queued: 5 # Max different SYN/ACKs to queue
646 # bypass: no # Bypass packets when stream.depth is reached
647 #
648 # reassembly:
649 # memcap: 64mb # Can be specified in kb, mb, gb. Just a number
650 # # indicates it's in bytes.
651 # depth: 1mb # Can be specified in kb, mb, gb. Just a number
652 # # indicates it's in bytes.
653 # toserver-chunk-size: 2560 # inspect raw stream in chunks of at least
654 # # this size. Can be specified in kb, mb,
655 # # gb. Just a number indicates it's in bytes.
656 # toclient-chunk-size: 2560 # inspect raw stream in chunks of at least
657 # # this size. Can be specified in kb, mb,
658 # # gb. Just a number indicates it's in bytes.
659 # randomize-chunk-size: yes # Take a random value for chunk size around the specified value.
660 # # This lower the risk of some evasion technics but could lead
661 # # detection change between runs. It is set to 'yes' by default.
662 # randomize-chunk-range: 10 # If randomize-chunk-size is active, the value of chunk-size is
663 # # a random value between (1 - randomize-chunk-range/100)*toserver-chunk-size
664 # # and (1 + randomize-chunk-range/100)*toserver-chunk-size and the same
665 # # calculation for toclient-chunk-size.
666 # # Default value of randomize-chunk-range is 10.
667 #
668 # raw: yes # 'Raw' reassembly enabled or disabled.
669 # # raw is for content inspection by detection
670 # # engine.
671 #
672 # segment-prealloc: 2048 # number of segments preallocated per thread
673 #
674 # check-overlap-different-data: true|false
675 # # check if a segment contains different data
676 # # than what we've already seen for that
677 # # position in the stream.
678 # # This is enabled automatically if inline mode
679 # # is used or when stream-event:reassembly_overlap_different_data;
680 # # is used in a rule.
681 #
682 stream:
683 memcap: 64mb
684 checksum-validation: yes # reject wrong csums
685 inline: auto # auto will use inline mode in IPS mode, yes or no set it statically
686 reassembly:
687 memcap: 256mb
688 depth: 1mb # reassemble 1mb into a stream
689 toserver-chunk-size: 2560
690 toclient-chunk-size: 2560
691 randomize-chunk-size: yes
692 #randomize-chunk-range: 10
693 #raw: yes
694 #segment-prealloc: 2048
695 #check-overlap-different-data: true
696
697 # Host table:
698 #
699 # Host table is used by tagging and per host thresholding subsystems.
700 #
701 host:
702 hash-size: 4096
703 prealloc: 1000
704 memcap: 32mb
705
706 # IP Pair table:
707 #
708 # Used by xbits 'ippair' tracking.
709 #
710 #ippair:
711 # hash-size: 4096
712 # prealloc: 1000
713 # memcap: 32mb
714
715 # Decoder settings
716
717 decoder:
718 # Teredo decoder is known to not be completely accurate
719 # it will sometimes detect non-teredo as teredo.
720 teredo:
721 enabled: true
722
723
724 ##
725 ## Performance tuning and profiling
726 ##
727
728 # The detection engine builds internal groups of signatures. The engine
729 # allow us to specify the profile to use for them, to manage memory on an
730 # efficient way keeping a good performance. For the profile keyword you
731 # can use the words "low", "medium", "high" or "custom". If you use custom
732 # make sure to define the values at "- custom-values" as your convenience.
733 # Usually you would prefer medium/high/low.
734 #
735 # "sgh mpm-context", indicates how the staging should allot mpm contexts for
736 # the signature groups. "single" indicates the use of a single context for
737 # all the signature group heads. "full" indicates a mpm-context for each
738 # group head. "auto" lets the engine decide the distribution of contexts
739 # based on the information the engine gathers on the patterns from each
740 # group head.
741 #
742 # The option inspection-recursion-limit is used to limit the recursive calls
743 # in the content inspection code. For certain payload-sig combinations, we
744 # might end up taking too much time in the content inspection code.
745 # If the argument specified is 0, the engine uses an internally defined
746 # default limit. On not specifying a value, we use no limits on the recursion.
747 detect:
748 profile: high
749 custom-values:
750 toclient-groups: 3
751 toserver-groups: 25
752 sgh-mpm-context: auto
753 inspection-recursion-limit: 3000
754 # If set to yes, the loading of signatures will be made after the capture
755 # is started. This will limit the downtime in IPS mode.
756 #delayed-detect: yes
757
758 prefilter:
759 # default prefiltering setting. "mpm" only creates MPM/fast_pattern
760 # engines. "auto" also sets up prefilter engines for other keywords.
761 # Use --list-keywords=all to see which keywords support prefiltering.
762 default: mpm
763
764 # the grouping values above control how many groups are created per
765 # direction. Port whitelisting forces that port to get it's own group.
766 # Very common ports will benefit, as well as ports with many expensive
767 # rules.
768 grouping:
769 #tcp-whitelist: 53, 80, 139, 443, 445, 1433, 3306, 3389, 6666, 6667, 8080
770 #udp-whitelist: 53, 135, 5060
771
772 profiling:
773 # Log the rules that made it past the prefilter stage, per packet
774 # default is off. The threshold setting determines how many rules
775 # must have made it past pre-filter for that rule to trigger the
776 # logging.
777 #inspect-logging-threshold: 200
778 grouping:
779 dump-to-disk: false
780 include-rules: false # very verbose
781 include-mpm-stats: false
782
783 # Select the multi pattern algorithm you want to run for scan/search the
784 # in the engine.
785 #
786 # The supported algorithms are:
787 # "ac" - Aho-Corasick, default implementation
788 # "ac-bs" - Aho-Corasick, reduced memory implementation
789 # "ac-cuda" - Aho-Corasick, CUDA implementation
790 # "ac-ks" - Aho-Corasick, "Ken Steele" variant
791 # "hs" - Hyperscan, available when built with Hyperscan support
792 #
793 # The default mpm-algo value of "auto" will use "hs" if Hyperscan is
794 # available, "ac" otherwise.
795 #
796 # The mpm you choose also decides the distribution of mpm contexts for
797 # signature groups, specified by the conf - "detect.sgh-mpm-context".
798 # Selecting "ac" as the mpm would require "detect.sgh-mpm-context"
799 # to be set to "single", because of ac's memory requirements, unless the
800 # ruleset is small enough to fit in one's memory, in which case one can
801 # use "full" with "ac". Rest of the mpms can be run in "full" mode.
802 #
803 # There is also a CUDA pattern matcher (only available if Suricata was
804 # compiled with --enable-cuda: b2g_cuda. Make sure to update your
805 # max-pending-packets setting above as well if you use b2g_cuda.
806
807 mpm-algo: auto
808
809 # Select the matching algorithm you want to use for single-pattern searches.
810 #
811 # Supported algorithms are "bm" (Boyer-Moore) and "hs" (Hyperscan, only
812 # available if Suricata has been built with Hyperscan support).
813 #
814 # The default of "auto" will use "hs" if available, otherwise "bm".
815
816 spm-algo: auto
817
818 # Suricata is multi-threaded. Here the threading can be influenced.
819 threading:
820 set-cpu-affinity: no
821 # Tune cpu affinity of threads. Each family of threads can be bound
822 # on specific CPUs.
823 #
824 # These 2 apply to the all runmodes:
825 # management-cpu-set is used for flow timeout handling, counters
826 # worker-cpu-set is used for 'worker' threads
827 #
828 # Additionally, for autofp these apply:
829 # receive-cpu-set is used for capture threads
830 # verdict-cpu-set is used for IPS verdict threads
831 #
832 cpu-affinity:
833 - management-cpu-set:
834 cpu: [ 0 ] # include only these cpus in affinity settings
835 - receive-cpu-set:
836 cpu: [ 0 ] # include only these cpus in affinity settings
837 - worker-cpu-set:
838 cpu: [ "all" ]
839 mode: "exclusive"
840 # Use explicitely 3 threads and don't compute number by using
841 # detect-thread-ratio variable:
842 # threads: 3
843 prio:
844 low: [ 0 ]
845 medium: [ "1-2" ]
846 high: [ 3 ]
847 default: "medium"
848 #- verdict-cpu-set:
849 # cpu: [ 0 ]
850 # prio:
851 # default: "high"
852 #
853 # By default Suricata creates one "detect" thread per available CPU/CPU core.
854 # This setting allows controlling this behaviour. A ratio setting of 2 will
855 # create 2 detect threads for each CPU/CPU core. So for a dual core CPU this
856 # will result in 4 detect threads. If values below 1 are used, less threads
857 # are created. So on a dual core CPU a setting of 0.5 results in 1 detect
858 # thread being created. Regardless of the setting at a minimum 1 detect
859 # thread will always be created.
860 #
861 detect-thread-ratio: 1.0
862
863 ##
864 ## Include other configs
865 ##
866
867 # Includes. Files included here will be handled as if they were
868 # inlined in this configuration file.
869 #include: include1.yaml
870 #include: include2.yaml