1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
# puppet-ferm
[](https://travis-ci.org/voxpupuli/puppet-ferm)
[](https://forge.puppetlabs.com/puppet/ferm)
[](https://forge.puppetlabs.com/puppet/ferm)
[](https://forge.puppetlabs.com/puppet/ferm)
[](https://forge.puppetlabs.com/puppet/ferm)
[](https://voxpupuli.org/puppet-ferm)
[](LICENSE)
## Table of Contents
* [Overview](#overview)
* [What happened to older releases?](#what-happenend-to-older-releases)
* [Setup](#setup)
* [Support](#support)
* [Reference](#reference)
* [Development](#development)
* [Authors](#authors)
----
## Overview
This module manages the [ferm](http://ferm.foo-projects.org/) firewalling
software. It allows you to configure the actual software, but also all related
rules.
## What happened to older releases?
You maybe wonder what happend to release 1.1.0 and 1.0.0. We had to take them
down because they contained sensitive information.
## Setup
This is very easy:
```puppet
include ferm
```
This will install the package, but nothing more. It won't explicitly enable it
or write any rules. Be careful here: The default Debian package enabled
autostart for the service and only allows incoming SSH/IPSec connections.
You can easily define rules in Puppet (they don't need to be exported resources):
```puppet
@@ferm::rule{"allow_kafka_server2server-${trusted['certname']}":
chain => 'INPUT',
policy => 'ACCEPT',
proto => 'tcp',
dport => '(9092 9093)',
saddr => "(${facts['networking']['ip6']}/128 ${facts['networking']['ip']}/32)",
tag => 'allow_kafka_server2server',
}
```
You can collect them like this:
```puppet
# collect all exported resources with the tag allow_vault_server2server
Ferm::Rule <<| tag == 'allow_kafka_server2server' |>>
```
You can also define rules in Hiera. Make sure to use `alias()` as interpolation function, because `hiera()` will always return a string.
```yaml
---
subnet01: '123.123.123.0/24'
subnet02: '123.123.124.0/24'
subnet03:
- '123.123.125.0/24'
- '123.123.126.0/24'
subnets:
- "%{alias('subnet01')}"
- "%{alias('subnet02')}"
- "%{alias('subnet03')}"
- 123.123.127.0/24
ferm::rules:
'allow_http_https':
chain: 'INPUT'
policy: 'ACCEPT'
proto: 'tcp'
dport: '(80 443)'
saddr: "%{alias('subnets')}"
```
ferm::rules is a hash. configured for deep merge. Hiera will collect all
defined hashes and hand them over to the class. The main class will create
rules for all of them. It also collects all exported resources that are tagged
with the FQDN of a box.
## Reference
### Main class
The main class has the following parameters:
#### `manage_service`
[Boolean] disable/enable the management of the ferm daemon
#### `manage_configfile`
[Boolean] disable/enable the management of the ferm default config
#### `manage_initfile`
[Boolean] disable/enable the management of the ferm init script for RedHat-based OS
#### `configfile`
[Stdlib::Absolutepath] path to the config file
#### `forward_policy`
[Ferm::Policies] default policy for the FORWARD chain
#### `output_policy`
[Ferm::Policies] default policy for the OUTPUT chain
#### `input_policy`
[Ferm::Policies] default policy for the INPUT chain
#### `rules`
A hash that holds all data for ferm::rule
### rule defined resource
This creates an entry in the correct chain file for ferm.
#### `chain`
The chain where we place this rule
#### `policy`
The desired policy. Allowed values are Enum['ACCEPT','DROP', 'REJECT']
#### `protocol`
the protocol we would like to filter. Allowed values are Enum['icmp', 'tcp', 'udp']
### `proto_options`
The protocol options we would like to add.
The following example will suppress the hostname in programs like `traceroute`:
```yaml
---
ferm::rules:
'drop_output_traceroute':
chain: 'OUTPUT'
policy: 'DROP'
proto: 'icmp'
proto_options: 'icmp-type time-exceeded'
```
#### `comment`
A comment that will be written into the file and into ip(6)tables
#### `dport`
The destination port we want to filter for. Can be any string from
/etc/services or an integer
#### `sport`
Like the destination port above, just for the source port
#### `saddr`
Source IPv4/IPv6 address. Can be one or many of them. Multiple addresses are
always encapsulated in braces:
'(127.0.0.1 2003::)'
IPv4 and IPv6 addresses can be mixed. CIDR notation is possible if you want to
block networks, otherwise /32 or /128 is assumed by ferm/ip(6)tables
#### `daddr`
Same as above, just for the destination IP address
#### `ensure`
Add or remove it from the ruleset
#### `interface`
If set, this rule only applies to this specific interface
### chain defined resource
The module defines the three default chains for you, INPUT, FORWARD and OUTPUT.
You're able to define own chains if you want to
#### `policy`
The desired default policy for the chain
#### `chain`
The name of the chain
## Development
This project contains tests for [rspec-puppet](http://rspec-puppet.com/).
Quickstart to run all linter and unit tests:
```bash
bundle install --path .vendor/ --without system_tests --without development --without release
bundle exec rake test
```
## Authors
puppet-ferm is maintained by [Vox Pupuli](https://voxpupuli.org), it was written by [Tim 'bastelfreak' Meusel](https://github.com/bastelfreak).
|
