|
1 | | -# Description |
| 1 | +# ufw Cookbook |
2 | 2 |
|
3 | | -Configures Uncomplicated Firewall (ufw) on Ubuntu and Debian. Including the `ufw` recipe in a run list means the firewall will be enabled and will deny everything except SSH and ICMP ping by default. |
4 | | - |
5 | | -Rules may be added to the node by adding them to the `['firewall']['rules']` attributes in roles or on the node directly. The `firewall` cookbook has an LWRP that may be used to apply rules directly from other recipes as well. There is no need to explicitly remove rules, they are reevaluated on changes and reset. Rules are applied in the order of the run list, unless ordering is explicitly added. |
| 3 | +The `ufw` cookbook provides a single custom resource, `ufw_firewall`, for managing |
| 4 | +Uncomplicated Firewall on Debian and Ubuntu with the `firewall` cookbook's UFW provider. |
6 | 5 |
|
7 | 6 | ## Requirements |
8 | 7 |
|
9 | 8 | ### Platforms |
10 | 9 |
|
11 | | -- Ubuntu |
12 | | -- Debian |
| 10 | +- Debian 12+ |
| 11 | +- Ubuntu 22.04+ |
13 | 12 |
|
14 | 13 | ### Chef |
15 | 14 |
|
16 | | -- Chef 15.3 |
| 15 | +- Chef 15.3+ |
17 | 16 |
|
18 | 17 | ### Cookbooks |
19 | 18 |
|
20 | | -- firewall 2.0+ |
21 | | - |
22 | | -## Recipes |
23 | | - |
24 | | -### default |
25 | | - |
26 | | -The `default` recipe looks for the list of firewall rules to apply from the `['firewall']['rules']` attribute added to roles and on the node itself. The list of rules is then applied to the node in the order specified. |
27 | | - |
28 | | -### disable |
29 | | - |
30 | | -The `disable` recipe is used if there is a need to disable the existing firewall, perhaps for testing. It disables the ufw firewall even if other ufw recipes attempt to enable it. |
31 | | - |
32 | | -If you remove this recipe, the firewall does not get automatically re-enabled. You will need clear the value of the `['firewall']['state']` to force a recalculation of the firewall rules. This can be done with `knife node edit`. |
33 | | - |
34 | | -### databag |
| 19 | +- `firewall` 2.0+ |
35 | 20 |
|
36 | | -The `databag` recipe looks in the `firewall` data bag for to apply firewall rules based on inspecting the runlist for roles and recipe names for keys that map to the data bag items and are applied in the the order specified. |
| 21 | +## Resource |
37 | 22 |
|
38 | | -The `databag` recipe calls the `default` recipe after the `['firewall']['rules']` attribute is set to apply the rules, so you may mix roles with databag items if you want (roles apply first, then data bag contents). |
| 23 | +### ufw_firewall |
39 | 24 |
|
40 | | -### recipes |
41 | | - |
42 | | -The `recipes` recipe applies firewall rules based on inspecting the runlist for recipes that have node[\<recipe\>]['firewall']['rules'] attributes. These are appended to node['firewall']['rules'] and applied to the node. Cookbooks may define attributes for recipes like so:</recipe> |
43 | | - |
44 | | -#### attributes/default.rb for test cookbook |
| 25 | +`ufw_firewall` installs and enables UFW, optionally opens SSH, and applies the provided rule set. |
| 26 | +It can also merge in rules discovered from a data bag or from legacy recipe-level firewall |
| 27 | +attributes during migration. |
45 | 28 |
|
46 | 29 | ```ruby |
47 | | -default['test']['firewall']['rules'] = [ |
48 | | - {"test"=> { |
49 | | - "port"=> "27901", |
50 | | - "protocol"=> "udp" |
51 | | - } |
52 | | - } |
53 | | -] |
54 | | -default['test::awesome']['firewall']['rules'] = [ |
55 | | - {"awesome"=> { |
56 | | - "port"=> "99427", |
57 | | - "protocol"=> "udp" |
58 | | - } |
59 | | - }, |
60 | | - {"awesome2"=> { |
61 | | - "port"=> "99428" |
62 | | - } |
63 | | - } |
64 | | -] |
65 | | -``` |
66 | | - |
67 | | -Note that the 'test::awesome' rules are only applied if that specific recipe is in the runlist. Recipe-applied firewall rules are applied after any rules defined in role attributes. |
68 | | - |
69 | | -### securitylevel |
70 | | - |
71 | | -The `securitylevel` recipe is used if there are any node['firewall']['securitylevel'] settings that need to be enforced. It is a reference implementation with nothing configured. |
72 | | - |
73 | | -## Attributes |
74 | | - |
75 | | -Roles and the node may have the `['firewall']['rules']` attribute set. This attribute is a list of hashes, the key will be rule name, the value will be the hash of parameters. Application order is based on run list. |
76 | | - |
77 | | -### Example Role |
78 | | - |
79 | | -```ruby |
80 | | -name "fw_example" |
81 | | -description "Firewall rules for Examples" |
82 | | -override_attributes( |
83 | | - "firewall" => { |
84 | | - "rules" => [ |
85 | | - {"tftp" => {}}, |
86 | | - {"http" => { |
87 | | - "port" => "80" |
88 | | - } |
| 30 | +ufw_firewall 'default' do |
| 31 | + allow_ssh true |
| 32 | + rules( |
| 33 | + [ |
| 34 | + { 'http' => { 'port' => '80' } }, |
| 35 | + { 'https' => { 'port' => '443' } }, |
| 36 | + { |
| 37 | + 'block-admin' => { |
| 38 | + 'port' => '8443', |
| 39 | + 'source' => '192.0.2.10', |
| 40 | + 'action' => 'deny', |
| 41 | + }, |
89 | 42 | }, |
90 | | - {"block tomcat from 192.168.1.0/24" => { |
91 | | - "port" => "8080", |
92 | | - "source" => "192.168.1.0/24", |
93 | | - "action" => "deny" |
94 | | - } |
95 | | - }, |
96 | | - {"Allow access to udp 1.2.3.4 port 5469 from 1.2.3.5 port 5469" => { |
97 | | - "protocol" => "udp", |
98 | | - "port" => "5469", |
99 | | - "source" => "1.2.3.4", |
100 | | - "destination" => "1.2.3.5", |
101 | | - "dest_port" => "5469" |
102 | | - } |
103 | | - }, |
104 | | - {"allow to tcp ports 8000-8010 from 192.168.1.0/24" => { |
105 | | - "port_range" => "8000..8010", |
106 | | - "source" => "192.168.1.0/24", |
107 | | - "protocol" => "tcp" //protocol is mandatory when using port ranges |
108 | | - } |
109 | | - } |
110 | 43 | ] |
111 | | - } |
112 | 44 | ) |
| 45 | + action :create |
| 46 | +end |
113 | 47 | ``` |
114 | 48 |
|
115 | | -- default['firewall']['allow_ssh'] Opens port 22 for SSH when set to true. Default set to true. |
116 | | - |
117 | | -## Data Bags |
| 49 | +### Data bag-backed rules |
118 | 50 |
|
119 | | -The `firewall` data bag may be used with the `databag` recipe. It will contain items that map to role names (eg. the 'apache' role will map to the 'apache' item in the 'firewall' data bag). Either roles or recipes may be keys (role[webserver] is 'webserver', recipe[apache2] is 'apache2'). If you have recipe-specific firewall rules, you will need to replace the '::' with '**' (double underscores) (eg. recipe[apache2::mod_ssl] is 'apache2**mod_ssl' in the data bag item). |
| 51 | +```ruby |
| 52 | +ufw_firewall 'default' do |
| 53 | + data_bag_name 'firewall' |
| 54 | + action :create |
| 55 | +end |
| 56 | +``` |
120 | 57 |
|
121 | | -The items in the data bag will contain a 'rules' array of hashes to apply to the `['firewall']['rules']` attribute. |
| 58 | +### Collect rules from other cookbooks' recipe attributes |
122 | 59 |
|
123 | | -```shell |
124 | | -% knife data bag create firewall |
125 | | -% knife data bag from file firewall examples/data_bags/firewall/apache2.json |
126 | | -% knife data bag from file firewall examples/data_bags/firewall/apache2__mod_ssl.json |
| 60 | +```ruby |
| 61 | +ufw_firewall 'default' do |
| 62 | + collect_recipe_rules true |
| 63 | + action :create |
| 64 | +end |
127 | 65 | ``` |
128 | 66 |
|
129 | | -### Example 'firewall' data bag item |
130 | | - |
131 | | -```javascript |
132 | | -{ |
133 | | - "id": "apache2", |
134 | | - "rules": [ |
135 | | - {"http": { |
136 | | - "port": "80" |
137 | | - }}, |
138 | | - {"block http from 192.168.1.0/24": { |
139 | | - "port": "80", |
140 | | - "source": "192.168.1.0/24", |
141 | | - "action": "deny" |
142 | | - }} |
143 | | - ] |
144 | | -} |
145 | | -``` |
| 67 | +### Remove UFW and reset the firewall |
146 | 68 |
|
147 | | -## Resources/Providers |
| 69 | +```ruby |
| 70 | +ufw_firewall 'default' do |
| 71 | + action :delete |
| 72 | +end |
| 73 | +``` |
148 | 74 |
|
149 | | -The `firewall` cookbook provides the `firewall` and `firewall_rule` LWRPs, for which there is a ufw provider. |
| 75 | +See [`documentation/ufw_ufw_firewall.md`](documentation/ufw_ufw_firewall.md) for the full |
| 76 | +resource API. |
150 | 77 |
|
151 | 78 | ## License & Authors |
152 | 79 |
|
|
0 commit comments