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