]>
Commit | Line | Data |
---|---|---|
80c0adcb | 1 | [[chapter_pve_firewall]] |
c7eda5e6 | 2 | ifdef::manvolnum[] |
b2f242ab DM |
3 | pve-firewall(8) |
4 | =============== | |
5f09af76 DM |
5 | :pve-toplevel: |
6 | ||
c7eda5e6 DM |
7 | NAME |
8 | ---- | |
9 | ||
f5eb0727 | 10 | pve-firewall - PVE Firewall Daemon |
c7eda5e6 DM |
11 | |
12 | ||
49a5e11c | 13 | SYNOPSIS |
c7eda5e6 DM |
14 | -------- |
15 | ||
5f34196d | 16 | include::pve-firewall.8-synopsis.adoc[] |
c7eda5e6 DM |
17 | |
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
c7eda5e6 DM |
22 | ifndef::manvolnum[] |
23 | {pve} Firewall | |
24 | ============== | |
194d2f29 | 25 | :pve-toplevel: |
c7eda5e6 | 26 | endif::manvolnum[] |
5f09af76 | 27 | ifdef::wiki[] |
cb84ed18 | 28 | :title: Firewall |
5f09af76 DM |
29 | endif::wiki[] |
30 | ||
26ca7ff5 | 31 | {pve} Firewall provides an easy way to protect your IT |
89a8b6c6 | 32 | infrastructure. You can setup firewall rules for all hosts |
c7eda5e6 DM |
33 | inside a cluster, or define rules for virtual machines and |
34 | containers. Features like firewall macros, security groups, IP sets | |
5eba0743 | 35 | and aliases help to make that task easier. |
c7eda5e6 DM |
36 | |
37 | While all configuration is stored on the cluster file system, the | |
8c1189b6 | 38 | `iptables`-based firewall runs on each cluster node, and thus provides |
c7eda5e6 DM |
39 | full isolation between virtual machines. The distributed nature of |
40 | this system also provides much higher bandwidth than a central | |
41 | firewall solution. | |
42 | ||
bd73a43e DM |
43 | The firewall has full support for IPv4 and IPv6. IPv6 support is fully |
44 | transparent, and we filter traffic for both protocols by default. So | |
45 | there is no need to maintain a different set of rules for IPv6. | |
46 | ||
c7eda5e6 DM |
47 | |
48 | Zones | |
49 | ----- | |
50 | ||
51 | The Proxmox VE firewall groups the network into the following logical zones: | |
52 | ||
53 | Host:: | |
54 | ||
55 | Traffic from/to a cluster node | |
56 | ||
57 | VM:: | |
58 | ||
59 | Traffic from/to a specific VM | |
60 | ||
61 | For each zone, you can define firewall rules for incoming and/or | |
62 | outgoing traffic. | |
63 | ||
64 | ||
79672214 DM |
65 | Configuration Files |
66 | ------------------- | |
c7eda5e6 DM |
67 | |
68 | All firewall related configuration is stored on the proxmox cluster | |
69 | file system. So those files are automatically distributed to all | |
8c1189b6 FG |
70 | cluster nodes, and the `pve-firewall` service updates the underlying |
71 | `iptables` rules automatically on changes. | |
c7eda5e6 | 72 | |
e300cf7d FG |
73 | You can configure anything using the GUI (i.e. *Datacenter* -> *Firewall*, |
74 | or on a *Node* -> *Firewall*), or you can edit the configuration files | |
89a8b6c6 DM |
75 | directly using your preferred editor. |
76 | ||
77 | Firewall configuration files contains sections of key-value | |
8c1189b6 | 78 | pairs. Lines beginning with a `#` and blank lines are considered |
79672214 | 79 | comments. Sections starts with a header line containing the section |
8c1189b6 | 80 | name enclosed in `[` and `]`. |
79672214 | 81 | |
89a8b6c6 | 82 | |
80c0adcb | 83 | [[pve_firewall_cluster_wide_setup]] |
79672214 DM |
84 | Cluster Wide Setup |
85 | ~~~~~~~~~~~~~~~~~~ | |
86 | ||
87 | The cluster wide firewall configuration is stored at: | |
c7eda5e6 DM |
88 | |
89 | /etc/pve/firewall/cluster.fw | |
90 | ||
79672214 | 91 | The configuration can contain the following sections: |
c7eda5e6 | 92 | |
8c1189b6 | 93 | `[OPTIONS]`:: |
79672214 DM |
94 | |
95 | This is used to set cluster wide firewall options. | |
96 | ||
c48819d1 DM |
97 | include::pve-firewall-cluster-opts.adoc[] |
98 | ||
8c1189b6 | 99 | `[RULES]`:: |
c7eda5e6 | 100 | |
79672214 DM |
101 | This sections contains cluster wide firewall rules for all nodes. |
102 | ||
8c1189b6 | 103 | `[IPSET <name>]`:: |
79672214 DM |
104 | |
105 | Cluster wide IP set definitions. | |
106 | ||
8c1189b6 | 107 | `[GROUP <name>]`:: |
79672214 DM |
108 | |
109 | Cluster wide security group definitions. | |
110 | ||
8c1189b6 | 111 | `[ALIASES]`:: |
79672214 DM |
112 | |
113 | Cluster wide Alias definitions. | |
114 | ||
89a8b6c6 DM |
115 | |
116 | Enabling the Firewall | |
117 | ^^^^^^^^^^^^^^^^^^^^^ | |
118 | ||
119 | The firewall is completely disabled by default, so you need to | |
120 | set the enable option here: | |
121 | ||
122 | ---- | |
123 | [OPTIONS] | |
124 | # enable firewall (cluster wide setting, default is disabled) | |
125 | enable: 1 | |
126 | ---- | |
127 | ||
128 | IMPORTANT: If you enable the firewall, traffic to all hosts is blocked by | |
129 | default. Only exceptions is WebGUI(8006) and ssh(22) from your local | |
130 | network. | |
131 | ||
132 | If you want to administrate your {pve} hosts from remote, you | |
133 | need to create rules to allow traffic from those remote IPs to the web | |
134 | GUI (port 8006). You may also want to allow ssh (port 22), and maybe | |
135 | SPICE (port 3128). | |
136 | ||
137 | TIP: Please open a SSH connection to one of your {PVE} hosts before | |
138 | enabling the firewall. That way you still have access to the host if | |
139 | something goes wrong . | |
140 | ||
141 | To simplify that task, you can instead create an IPSet called | |
8c1189b6 | 142 | ``management'', and add all remote IPs there. This creates all required |
89a8b6c6 DM |
143 | firewall rules to access the GUI from remote. |
144 | ||
145 | ||
80c0adcb | 146 | [[pve_firewall_host_specific_configuration]] |
5eba0743 | 147 | Host Specific Configuration |
79672214 DM |
148 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
149 | ||
150 | Host related configuration is read from: | |
151 | ||
152 | /etc/pve/nodes/<nodename>/host.fw | |
153 | ||
8c1189b6 | 154 | This is useful if you want to overwrite rules from `cluster.fw` |
79672214 | 155 | config. You can also increase log verbosity, and set netfilter related |
888c4116 DM |
156 | options. The configuration can contain the following sections: |
157 | ||
8c1189b6 | 158 | `[OPTIONS]`:: |
888c4116 DM |
159 | |
160 | This is used to set host related firewall options. | |
161 | ||
162 | include::pve-firewall-host-opts.adoc[] | |
163 | ||
8c1189b6 | 164 | `[RULES]`:: |
888c4116 DM |
165 | |
166 | This sections contains host specific firewall rules. | |
79672214 | 167 | |
641cc419 | 168 | [[pve_firewall_vm_container_configuration]] |
5eba0743 | 169 | VM/Container Configuration |
79672214 | 170 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 | 171 | |
a4922e12 | 172 | VM firewall configuration is read from: |
c7eda5e6 DM |
173 | |
174 | /etc/pve/firewall/<VMID>.fw | |
175 | ||
176 | and contains the following data: | |
177 | ||
8c1189b6 | 178 | `[OPTIONS]`:: |
78ef35dc DM |
179 | |
180 | This is used to set VM/Container related firewall options. | |
181 | ||
182 | include::pve-firewall-vm-opts.adoc[] | |
183 | ||
8c1189b6 | 184 | `[RULES]`:: |
78ef35dc DM |
185 | |
186 | This sections contains VM/Container firewall rules. | |
187 | ||
8c1189b6 | 188 | `[IPSET <name>]`:: |
78ef35dc DM |
189 | |
190 | IP set definitions. | |
191 | ||
8c1189b6 | 192 | `[ALIASES]`:: |
78ef35dc DM |
193 | |
194 | IP Alias definitions. | |
c7eda5e6 | 195 | |
c7eda5e6 | 196 | |
58b16f71 | 197 | Enabling the Firewall for VMs and Containers |
79672214 | 198 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
c7eda5e6 | 199 | |
89a8b6c6 DM |
200 | Each virtual network device has its own firewall enable flag. So you |
201 | can selectively enable the firewall for each interface. This is | |
8c1189b6 | 202 | required in addition to the general firewall `enable` option. |
89a8b6c6 | 203 | |
79672214 | 204 | |
c7eda5e6 | 205 | Firewall Rules |
79672214 | 206 | -------------- |
c7eda5e6 | 207 | |
696fb448 DM |
208 | Firewall rules consists of a direction (`IN` or `OUT`) and an |
209 | action (`ACCEPT`, `DENY`, `REJECT`). You can also specify a macro | |
8c1189b6 FG |
210 | name. Macros contain predefined sets of rules and options. Rules can be |
211 | disabled by prefixing them with `|`. | |
c7eda5e6 | 212 | |
696fb448 | 213 | .Firewall rules syntax |
c7eda5e6 DM |
214 | ---- |
215 | [RULES] | |
216 | ||
696fb448 DM |
217 | DIRECTION ACTION [OPTIONS] |
218 | |DIRECTION ACTION [OPTIONS] # disabled rule | |
c7eda5e6 | 219 | |
696fb448 DM |
220 | DIRECTION MACRO(ACTION) [OPTIONS] # use predefined macro |
221 | ---- | |
222 | ||
223 | The following options can be used to refine rule matches. | |
224 | ||
225 | include::pve-firewall-rules-opts.adoc[] | |
226 | ||
227 | Here are some examples: | |
c7eda5e6 | 228 | |
696fb448 DM |
229 | ---- |
230 | [RULES] | |
c7eda5e6 DM |
231 | IN SSH(ACCEPT) -i net0 |
232 | IN SSH(ACCEPT) -i net0 # a comment | |
696fb448 | 233 | IN SSH(ACCEPT) -i net0 -source 192.168.2.192 # only allow SSH from 192.168.2.192 |
b3234584 OB |
234 | IN SSH(ACCEPT) -i net0 -source 10.0.0.1-10.0.0.10 # accept SSH for IP range |
235 | IN SSH(ACCEPT) -i net0 -source 10.0.0.1,10.0.0.2,10.0.0.3 #accept ssh for IP list | |
696fb448 DM |
236 | IN SSH(ACCEPT) -i net0 -source +mynetgroup # accept ssh for ipset mynetgroup |
237 | IN SSH(ACCEPT) -i net0 -source myserveralias #accept ssh for alias myserveralias | |
c7eda5e6 DM |
238 | |
239 | |IN SSH(ACCEPT) -i net0 # disabled rule | |
696fb448 DM |
240 | |
241 | IN DROP # drop all incoming packages | |
242 | OUT ACCEPT # accept all outgoing packages | |
c7eda5e6 DM |
243 | ---- |
244 | ||
8c1189b6 | 245 | |
80c0adcb | 246 | [[pve_firewall_security_groups]] |
c7eda5e6 | 247 | Security Groups |
79672214 | 248 | --------------- |
c7eda5e6 | 249 | |
58b16f71 WB |
250 | A security group is a collection of rules, defined at cluster level, which |
251 | can be used in all VMs' rules. For example you can define a group named | |
8c1189b6 | 252 | ``webserver'' with rules to open the 'http' and 'https' ports. |
c7eda5e6 DM |
253 | |
254 | ---- | |
255 | # /etc/pve/firewall/cluster.fw | |
256 | ||
257 | [group webserver] | |
258 | IN ACCEPT -p tcp -dport 80 | |
259 | IN ACCEPT -p tcp -dport 443 | |
260 | ---- | |
261 | ||
58b16f71 | 262 | Then, you can add this group to a VM's firewall |
c7eda5e6 DM |
263 | |
264 | ---- | |
265 | # /etc/pve/firewall/<VMID>.fw | |
266 | ||
267 | [RULES] | |
268 | GROUP webserver | |
269 | ---- | |
270 | ||
641cc419 | 271 | [[pve_firewall_ip_aliases]] |
c7eda5e6 | 272 | IP Aliases |
79672214 | 273 | ---------- |
c7eda5e6 | 274 | |
58b16f71 | 275 | IP Aliases allow you to associate IP addresses of networks with a |
c7eda5e6 DM |
276 | name. You can then refer to those names: |
277 | ||
278 | * inside IP set definitions | |
279 | * in `source` and `dest` properties of firewall rules | |
280 | ||
5eba0743 FG |
281 | |
282 | Standard IP Alias `local_network` | |
79672214 | 283 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 DM |
284 | |
285 | This alias is automatically defined. Please use the following command | |
286 | to see assigned values: | |
287 | ||
288 | ---- | |
289 | # pve-firewall localnet | |
290 | local hostname: example | |
291 | local IP address: 192.168.2.100 | |
292 | network auto detect: 192.168.0.0/20 | |
293 | using detected local_network: 192.168.0.0/20 | |
294 | ---- | |
295 | ||
296 | The firewall automatically sets up rules to allow everything needed | |
58b16f71 | 297 | for cluster communication (corosync, API, SSH) using this alias. |
c7eda5e6 | 298 | |
8c1189b6 | 299 | The user can overwrite these values in the `cluster.fw` alias |
c7eda5e6 DM |
300 | section. If you use a single host on a public network, it is better to |
301 | explicitly assign the local IP address | |
302 | ||
303 | ---- | |
304 | # /etc/pve/firewall/cluster.fw | |
305 | [ALIASES] | |
b3234584 | 306 | local_network 1.2.3.4 # use the single IP address |
c7eda5e6 DM |
307 | ---- |
308 | ||
641cc419 | 309 | [[pve_firewall_ip_sets]] |
c7eda5e6 | 310 | IP Sets |
79672214 | 311 | ------- |
c7eda5e6 DM |
312 | |
313 | IP sets can be used to define groups of networks and hosts. You can | |
58b16f71 | 314 | refer to them with `+name` in the firewall rules' `source` and `dest` |
c7eda5e6 DM |
315 | properties. |
316 | ||
317 | The following example allows HTTP traffic from the `management` IP | |
318 | set. | |
319 | ||
320 | IN HTTP(ACCEPT) -source +management | |
321 | ||
5eba0743 | 322 | |
c7eda5e6 | 323 | Standard IP set `management` |
79672214 | 324 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 DM |
325 | |
326 | This IP set applies only to host firewalls (not VM firewalls). Those | |
5eba0743 | 327 | IPs are allowed to do normal management tasks (PVE GUI, VNC, SPICE, |
c7eda5e6 DM |
328 | SSH). |
329 | ||
330 | The local cluster network is automatically added to this IP set (alias | |
331 | `cluster_network`), to enable inter-host cluster | |
332 | communication. (multicast,ssh,...) | |
333 | ||
334 | ---- | |
335 | # /etc/pve/firewall/cluster.fw | |
336 | ||
337 | [IPSET management] | |
338 | 192.168.2.10 | |
339 | 192.168.2.10/24 | |
340 | ---- | |
341 | ||
8c1189b6 FG |
342 | |
343 | Standard IP set `blacklist` | |
79672214 | 344 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 | 345 | |
5eba0743 | 346 | Traffic from these IPs is dropped by every host's and VM's firewall. |
c7eda5e6 DM |
347 | |
348 | ---- | |
349 | # /etc/pve/firewall/cluster.fw | |
350 | ||
351 | [IPSET blacklist] | |
352 | 77.240.159.182 | |
353 | 213.87.123.0/24 | |
354 | ---- | |
355 | ||
8c1189b6 | 356 | |
80c0adcb | 357 | [[pve_firewall_ipfilter_section]] |
8c1189b6 | 358 | Standard IP set `ipfilter-net*` |
79672214 | 359 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 | 360 | |
a34d23e8 WB |
361 | These filters belong to a VM's network interface and are mainly used to prevent |
362 | IP spoofing. If such a set exists for an interface then any outgoing traffic | |
363 | with a source IP not matching its interface's corresponding ipfilter set will | |
364 | be dropped. | |
365 | ||
366 | For containers with configured IP addresses these sets, if they exist (or are | |
e300cf7d | 367 | activated via the general `IP Filter` option in the VM's firewall's *options* |
a34d23e8 WB |
368 | tab), implicitly contain the associated IP addresses. |
369 | ||
370 | For both virtual machines and containers they also implicitly contain the | |
371 | standard MAC-derived IPv6 link-local address in order to allow the neighbor | |
372 | discovery protocol to work. | |
c7eda5e6 DM |
373 | |
374 | ---- | |
375 | /etc/pve/firewall/<VMID>.fw | |
376 | ||
377 | [IPSET ipfilter-net0] # only allow specified IPs on net0 | |
378 | 192.168.2.10 | |
379 | ---- | |
380 | ||
79672214 | 381 | |
c7eda5e6 | 382 | Services and Commands |
79672214 | 383 | --------------------- |
c7eda5e6 DM |
384 | |
385 | The firewall runs two service daemons on each node: | |
386 | ||
387 | * pvefw-logger: NFLOG daemon (ulogd replacement). | |
388 | * pve-firewall: updates iptables rules | |
389 | ||
8c1189b6 | 390 | There is also a CLI command named `pve-firewall`, which can be used to |
c7eda5e6 DM |
391 | start and stop the firewall service: |
392 | ||
393 | # pve-firewall start | |
394 | # pve-firewall stop | |
395 | ||
396 | To get the status use: | |
397 | ||
398 | # pve-firewall status | |
399 | ||
400 | The above command reads and compiles all firewall rules, so you will | |
401 | see warnings if your firewall configuration contains any errors. | |
402 | ||
403 | If you want to see the generated iptables rules you can use: | |
404 | ||
405 | # iptables-save | |
406 | ||
79672214 | 407 | |
c7eda5e6 | 408 | Tips and Tricks |
79672214 | 409 | --------------- |
c7eda5e6 DM |
410 | |
411 | How to allow FTP | |
79672214 | 412 | ~~~~~~~~~~~~~~~~ |
c7eda5e6 DM |
413 | |
414 | FTP is an old style protocol which uses port 21 and several other dynamic ports. So you | |
8c1189b6 | 415 | need a rule to accept port 21. In addition, you need to load the `ip_conntrack_ftp` module. |
c7eda5e6 DM |
416 | So please run: |
417 | ||
418 | modprobe ip_conntrack_ftp | |
419 | ||
8c1189b6 | 420 | and add `ip_conntrack_ftp` to `/etc/modules` (so that it works after a reboot). |
c7eda5e6 | 421 | |
79672214 | 422 | |
c7eda5e6 | 423 | Suricata IPS integration |
79672214 | 424 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
c7eda5e6 DM |
425 | |
426 | If you want to use the http://suricata-ids.org/[Suricata IPS] | |
427 | (Intrusion Prevention System), it's possible. | |
428 | ||
429 | Packets will be forwarded to the IPS only after the firewall ACCEPTed | |
430 | them. | |
431 | ||
432 | Rejected/Dropped firewall packets don't go to the IPS. | |
433 | ||
434 | Install suricata on proxmox host: | |
435 | ||
436 | ---- | |
437 | # apt-get install suricata | |
438 | # modprobe nfnetlink_queue | |
439 | ---- | |
440 | ||
8c1189b6 | 441 | Don't forget to add `nfnetlink_queue` to `/etc/modules` for next reboot. |
c7eda5e6 DM |
442 | |
443 | Then, enable IPS for a specific VM with: | |
444 | ||
445 | ---- | |
446 | # /etc/pve/firewall/<VMID>.fw | |
447 | ||
448 | [OPTIONS] | |
449 | ips: 1 | |
450 | ips_queues: 0 | |
451 | ---- | |
452 | ||
453 | `ips_queues` will bind a specific cpu queue for this VM. | |
454 | ||
455 | Available queues are defined in | |
456 | ||
457 | ---- | |
458 | # /etc/default/suricata | |
459 | NFQUEUE=0 | |
460 | ---- | |
461 | ||
8c1189b6 | 462 | |
79672214 DM |
463 | Notes on IPv6 |
464 | ------------- | |
465 | ||
466 | The firewall contains a few IPv6 specific options. One thing to note is that | |
467 | IPv6 does not use the ARP protocol anymore, and instead uses NDP (Neighbor | |
468 | Discovery Protocol) which works on IP level and thus needs IP addresses to | |
469 | succeed. For this purpose link-local addresses derived from the interface's MAC | |
8c1189b6 | 470 | address are used. By default the `NDP` option is enabled on both host and VM |
79672214 DM |
471 | level to allow neighbor discovery (NDP) packets to be sent and received. |
472 | ||
473 | Beside neighbor discovery NDP is also used for a couple of other things, like | |
b3234584 | 474 | auto-configuration and advertising routers. |
79672214 DM |
475 | |
476 | By default VMs are allowed to send out router solicitation messages (to query | |
5eba0743 | 477 | for a router), and to receive router advertisement packets. This allows them to |
79672214 | 478 | use stateless auto configuration. On the other hand VMs cannot advertise |
8c1189b6 | 479 | themselves as routers unless the ``Allow Router Advertisement'' (`radv: 1`) option |
79672214 DM |
480 | is set. |
481 | ||
8c1189b6 | 482 | As for the link local addresses required for NDP, there's also an ``IP Filter'' |
79672214 DM |
483 | (`ipfilter: 1`) option which can be enabled which has the same effect as adding |
484 | an `ipfilter-net*` ipset for each of the VM's network interfaces containing the | |
485 | corresponding link local addresses. (See the | |
80c0adcb | 486 | <<pve_firewall_ipfilter_section,Standard IP set `ipfilter-net*`>> section for details.) |
79672214 DM |
487 | |
488 | ||
26ca7ff5 FG |
489 | Ports used by {pve} |
490 | ------------------- | |
224128ce DM |
491 | |
492 | * Web interface: 8006 | |
493 | * VNC Web console: 5900-5999 | |
494 | * SPICE proxy: 3128 | |
495 | * sshd (used for cluster actions): 22 | |
496 | * rpcbind: 111 | |
5eba0743 | 497 | * corosync multicast (if you run a cluster): 5404, 5405 UDP |
224128ce | 498 | |
14c06023 DM |
499 | |
500 | ifdef::manvolnum[] | |
501 | ||
502 | Macro Definitions | |
503 | ----------------- | |
504 | ||
505 | include::pve-firewall-macros.adoc[] | |
506 | ||
507 | ||
508 | include::pve-copyright.adoc[] | |
509 | ||
510 | endif::manvolnum[] |