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