root / README.md @ 26cdcbbd
Historique | Voir | Annoter | Télécharger (3,66 ko)
1 | 0ba57c66 | mh | # nftables puppet module |
---|---|---|---|
2 | |||
3 | 82b6fd57 | Steve Traylen | [](https://forge.puppetlabs.com/puppet/nftables) |
4 | [](https://forge.puppetlabs.com/puppet/nftables) |
||
5 | [](http://www.puppetmodule.info/m/puppet-nftables) |
||
6 | [](LICENSE) |
||
7 | |||
8 | 1ffab17b | Nacho Barrientos | This module manages an opinionated nftables configuration. |
9 | 0ba57c66 | mh | |
10 | By default it sets up a firewall that drops every incoming |
||
11 | and outgoing connection. |
||
12 | |||
13 | 7940fb07 | tr | It only allows outgoing dns, ntp and web and ingoing ssh |
14 | 1330c27e | Nacho Barrientos | traffic, although this can be overridden using parameters. |
15 | 0ba57c66 | mh | |
16 | The config file has a inet filter and a ip nat table setup. |
||
17 | |||
18 | 0f31ffbe | Nacho Barrientos | Additionally, the module comes with a basic infrastructure |
19 | 0ba57c66 | mh | to hook into different places. |
20 | |||
21 | ## nftables config |
||
22 | |||
23 | The main configuration file loaded by the nftables service |
||
24 | will be `files/config/puppet.nft`, all other files created |
||
25 | by that module go into `files/config/puppet` and will also |
||
26 | be purged if not managed anymore. |
||
27 | |||
28 | The main configuration file includes dedicated files for |
||
29 | the filter and nat tables, as well as processes any |
||
30 | `custom-*.nft` files before hand. |
||
31 | |||
32 | The filter and NAT tables both have all the master chains |
||
33 | 7940fb07 | tr | (INPUT, OUTPUT, FORWARD in case of filter and PREROUTING |
34 | and POSTROUTING in case of NAT) configured, to which you |
||
35 | can hook in your own chains that can contain specific |
||
36 | rules. |
||
37 | 0ba57c66 | mh | |
38 | All filter masterchains drop by default. |
||
39 | By default we have a set of default_MASTERCHAIN chains |
||
40 | configured to which you can easily add your custom rules. |
||
41 | |||
42 | For specific needs you can add your own chain. |
||
43 | |||
44 | There is a global chain, that defines the default behavior |
||
45 | 620da9a6 | Nacho Barrientos | for all masterchains. This chain is empty by default. |
46 | 0ba57c66 | mh | |
47 | 7940fb07 | tr | INPUT and OUTPUT to the loopback device is allowed by |
48 | default, though you could restrict it later. |
||
49 | 0ba57c66 | mh | |
50 | 30462da1 | Steve Traylen | ### Rules Validation |
51 | 4ed97e58 | Nacho Barrientos | |
52 | 30462da1 | Steve Traylen | Initially puppet deploys all configuration to |
53 | `/etc/nftables/puppet-preflight/` and |
||
54 | `/etc/nftables/puppet-preflight.nft`. This is validated with |
||
55 | `nfc -c -L /etc/nftables/puppet-preflight/ -f /etc/nftables/puppet-preflight.nft`. |
||
56 | If and only if successful the configuration will be copied to |
||
57 | the real locations before the service is reloaded. |
||
58 | |||
59 | 0ba57c66 | mh | ### nftables::config |
60 | |||
61 | Manages a raw file in `/etc/nftables/puppet/${name}.nft` |
||
62 | |||
63 | Use this for any custom table files. |
||
64 | |||
65 | 7940fb07 | tr | ## nftables::chain |
66 | 0ba57c66 | mh | |
67 | 7940fb07 | tr | Prepares a chain file as a `concat` file to which you will |
68 | be able to add dedicated rules through `nftables::rule`. |
||
69 | 0ba57c66 | mh | |
70 | 7940fb07 | tr | The name must be unique for all chains. The inject |
71 | parameter can be used to directly add a jump to a |
||
72 | masterchain. inject must follow the pattern |
||
73 | `ORDER-MASTERCHAIN`, where order references a 2-digit |
||
74 | number which defines the rule order (by default use e.g. 20) |
||
75 | and masterchain references the chain to hook in the new |
||
76 | af544fea | tr | chain. It's possible to specify the in-interface name and |
77 | out-interface name for the inject rule. |
||
78 | 0ba57c66 | mh | |
79 | 7940fb07 | tr | ## nftables::rule |
80 | 0ba57c66 | mh | |
81 | 7940fb07 | tr | A simple way to add rules to any chain. The name must be: |
82 | `CHAIN_NAME-rulename`, where CHAIN_NAME refers to your |
||
83 | chain and an arbitrary name for your rule. |
||
84 | The rule will be a `concat::fragment` to the chain |
||
85 | `CHAIN_NAME`. |
||
86 | 0ba57c66 | mh | |
87 | You can define the order by using the `order` param. |
||
88 | 20b96360 | Nacho Barrientos | |
89 | 8ded326d | Nacho Barrientos | ## nftables::set |
90 | 20b96360 | Nacho Barrientos | |
91 | Adds a named set to a given table. It allows composing the |
||
92 | set using individual parameters but also takes raw input |
||
93 | via the content and source parameters. |
||
94 | abb04c95 | Nacho Barrientos | |
95 | ## nftables::simplerule |
||
96 | |||
97 | Allows expressing firewall rules without having to use nftables's language by |
||
98 | adding an abstraction layer a-la-Firewall. It's rather limited how far you can |
||
99 | go so if you need rather complex rules or you can speak nftables it's |
||
100 | recommended to use `nftables::rule` directly. |