Debian Codegraph @

docs/config/section/foomuuri.md

raw
1 # foomuuri
2
3 This section can be usually omitted as default values should be fine.
4
5 This section defines common options for Foomuuri. If really needed, it is
6 usually better to override single value, not full section. Example:
7
8 ```
9 foomuuri {
10 # Change rpfilter's value, keep everything else as default
11 rpfilter no
12 }
13 ```
14
15 Full list of default values are:
16
17 ```
18 foomuuri {
19 log_rate "1/second burst 3"
20 log_input yes
21 log_output yes
22 log_forward yes
23 log_rpfilter yes
24 log_invalid no
25 log_smurfs no
26 log_prefix "$(szone)-$(dzone) $(statement)"
27 log_level "level info flags skuid"
28 localhost_zone localhost
29 dbus_zone public
30 rpfilter yes
31 flowtable no
32 counter no
33 set_size 65535
34 recursion_limit 10000
35 priority_offset 5
36 dbus_firewalld no
37 nft_bin nft
38 try_reload_timeout 15
39 }
40 ```
41
42 `log_rate` is the default logging rate per source IP. Default value is to
43 log first three entries per source IP and then one additional entry per second.
44 Rate [specification](../rule/ratelimit.md#global_rate) is the same as in rate
45 limit rule.
46
47 `log_input` ... `log_smurfs` defines default value for specific logging.
48 Value can be:
49
50 * `yes` to log it with `log_rate`
51 * `no` to not log
52 * `"3/second burst 10"` to log it with specific rate
53
54 `log_prefix` defines the default log prefix for
55 [logging](../rule/logging.md#log).
56
57 `log_level` is the syslog level of logging. For possible values see
58 rule specific [version](../rule/logging.md#log_level).
59
60 `localhost_zone` is the name of zone used for the computer running Foomuuri,
61 similar to "localhost" in hostnames. See [zone](zone.md) and
62 [zone-zone](zonezone.md) sections for more information.
63
64 `dbus_zone` is the name of your outgoing internet zone. This is used in
65 D-Bus support.
66
67 `rpfilter` is to enable or disable reverse path filtering. Value can be:
68
69 * `yes` to enable it to all interfaces
70 * `no` to disable it
71 * `eth0 eth1 eth2` to enable it to specified interfaces `eth0 eth1 eth2`
72 * `-eth1 -eth2` to enable it to all other interfaces than `eth1 eth2`
73
74 `flowtable` is to enable Netfilter flowtable infrastructure for specified
75 interfaces, for example `flowtable eth0 eth1`. It improves network forward
76 performance for high speed interfaces. Optional `hw_offload=yes` keyword
77 enables hardware offloading (make sure your interface supports
78 `hw-tc-offload`). Value `yes` or negative notation does not work here.
79
80 `counter` is to add anonymous byte and packet
81 [counter](../rule/logging.md#counter) to all rules. Value can be:
82
83 * `yes` to add it to all rules
84 * `no` to not add it
85 * `localhost-public public-localhost` to add it to all rules in
86 `localhost-public` and `public-localhost` sections
87
88 `set_size` is the size of [rate limit](../rule/ratelimit.md) set,
89 [log rate limit](../rule/logging.md) set and
90 [dynamic iplist](../rule/matcher.md#iplist_update) set. This is the maximum
91 amount of entries in the set in kernel. Default value 65535 is fine for normal
92 host. For company firewall larger value is required, for example 262143
93 (equals to 2^18 - 1). Setting this value too high doesn't harm. If set is
94 full, new entry can't be added. This doesn't matter for log rate limits, but
95 for rate limits and dynamic iplists this means that the statement (usually
96 accept for rate limit, drop for iplist) is skipped. See `foomuuri ruleset list`
97 for content of your currently active sets.
98
99 `recursion_limit` is the internal limit to avoid macro and template expansion
100 loop. Increase this value if you get false "Possible macro or template loop"
101 error.
102
103 `priority_offset` is the chain priority offset for rules generated by Foomuuri.
104 Tune this value if you have multiple software adding chains and want to
105 process them in some particular order. For example, iptables uses offset 0
106 and firewalld uses 10. Lowest priority is processed first. So to process
107 Foomuuri rules first, use value `-5`. To process them last, use `20`.
108
109 `dbus_firewalld` is to enable or disable firewalld D-Bus emulation inside
110 Foomuuri. NetworkManager can tell firewalld to attach and detach interfaces
111 to zones via D-Bus call. This option enables Foomuuri to listen to firewalld
112 D-Bus and do the same thing.
113
114 `nft_bin` is the name for `nft` binary. Full path can be specified if required.
115
116 `try_reload_timeout` is the timeout in seconds for `foomuuri try-reload`
117 command.