4 include::attributes.txt[]
9 pve-firewall - The PVE Firewall Daemon
15 include::pve-firewall.8-synopsis.adoc[]
25 include::attributes.txt[]
28 // Copied from pve wiki: Revision as of 08:45, 9 November 2015
30 Proxmox VE Firewall provides an easy way to protect your IT
31 infrastructure. You can easily setup firewall rules for all hosts
32 inside a cluster, or define rules for virtual machines and
33 containers. Features like firewall macros, security groups, IP sets
34 and aliases help making that task easier.
36 While all configuration is stored on the cluster file system, the
37 iptables based firewall runs on each cluster node, and thus provides
38 full isolation between virtual machines. The distributed nature of
39 this system also provides much higher bandwidth than a central
42 NOTE: If you enable the firewall, all traffic is blocked by default,
43 except WebGUI(8006) and ssh(22) from your local network.
49 The Proxmox VE firewall groups the network into the following logical zones:
53 Traffic from/to a cluster node
57 Traffic from/to a specific VM
59 For each zone, you can define firewall rules for incoming and/or
63 Ports used by Proxmox VE
64 ------------------------
67 * VNC Web console: 5900-5999
69 * sshd (used for cluster actions): 22
71 * corosync multicast (if you run a cluster): 5404, 5405 UDP
77 All firewall related configuration is stored on the proxmox cluster
78 file system. So those files are automatically distributed to all
79 cluster nodes, and the 'pve-firewall' service updates the underlying
80 iptables rules automatically on any change. Any configuration can be
81 done using the GUI (i.e. Datacenter -> Firewall -> Options tab (tabs
82 at the bottom of the page), or on a Node -> Firewall), so the
83 following configuration file snippets are just for completeness.
85 Cluster wide configuration is stored at:
87 /etc/pve/firewall/cluster.fw
89 The firewall is completely disabled by default, so you need to set the
94 # enable firewall (cluster wide setting, default is disabled)
98 The cluster wide configuration can contain the following data:
102 * Security group definitions
103 * Cluster wide firewall rules for all nodes
105 VM firewall configuration is read from:
107 /etc/pve/firewall/<VMID>.fw
109 and contains the following data:
113 * Firewall rules for this VM
114 * VM specific options
116 And finally, any host related configuration is read from:
118 /etc/pve/nodes/<nodename>/host.fw
120 This is useful if you want to overwrite rules from 'cluster.fw'
121 config. You can also increase log verbosity, and set netfilter related
124 Enabling the Firewall for VMs and Containers
125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127 You need to enable the firewall on the virtual network interface configuration
128 in addition to the general 'Enable Firewall' option in the 'Options' tab.
133 Any firewall rule consists of a direction (`IN` or `OUT`) and an
134 action (`ACCEPT`, `DENY`, `REJECT`). Additional options can be used to
135 refine rule matches. Here are some examples:
140 #TYPE ACTION [OPTIONS]
141 #TYPE MACRO(ACTION) [OPTIONS]
147 # -dport <DESTINATION_PORT>
148 # -sport <SOURCE_PORT>
150 IN SSH(ACCEPT) -i net0
151 IN SSH(ACCEPT) -i net0 # a comment
152 IN SSH(ACCEPT) -i net0 -source 192.168.2.192 # only allow SSH from 192.168.2.192
153 IN SSH(ACCEPT) -i net0 -source 10.0.0.1-10.0.0.10 # accept SSH for ip range
154 IN SSH(ACCEPT) -i net0 -source 10.0.0.1,10.0.0.2,10.0.0.3 #accept ssh for ip list
155 IN SSH(ACCEPT) -i net0 -source +mynetgroup # accept ssh for ipset mynetgroup
156 IN SSH(ACCEPT) -i net0 -source myserveralias #accept ssh for alias myserveralias
158 |IN SSH(ACCEPT) -i net0 # disabled rule
164 A security group is a collection of rules, defined at cluster level, which
165 can be used in all VMs' rules. For example you can define a group named
166 `webserver` with rules to open the http and https ports.
169 # /etc/pve/firewall/cluster.fw
172 IN ACCEPT -p tcp -dport 80
173 IN ACCEPT -p tcp -dport 443
176 Then, you can add this group to a VM's firewall
179 # /etc/pve/firewall/<VMID>.fw
189 IP Aliases allow you to associate IP addresses of networks with a
190 name. You can then refer to those names:
192 * inside IP set definitions
193 * in `source` and `dest` properties of firewall rules
195 Standard IP alias `local_network`
196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
198 This alias is automatically defined. Please use the following command
199 to see assigned values:
202 # pve-firewall localnet
203 local hostname: example
204 local IP address: 192.168.2.100
205 network auto detect: 192.168.0.0/20
206 using detected local_network: 192.168.0.0/20
209 The firewall automatically sets up rules to allow everything needed
210 for cluster communication (corosync, API, SSH) using this alias.
212 The user can overwrite these values in the cluster.fw alias
213 section. If you use a single host on a public network, it is better to
214 explicitly assign the local IP address
217 # /etc/pve/firewall/cluster.fw
219 local_network 1.2.3.4 # use the single ip address
225 IP sets can be used to define groups of networks and hosts. You can
226 refer to them with `+name` in the firewall rules' `source` and `dest`
229 The following example allows HTTP traffic from the `management` IP
232 IN HTTP(ACCEPT) -source +management
234 Standard IP set `management`
235 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
237 This IP set applies only to host firewalls (not VM firewalls). Those
238 ips are allowed to do normal management tasks (PVE GUI, VNC, SPICE,
241 The local cluster network is automatically added to this IP set (alias
242 `cluster_network`), to enable inter-host cluster
243 communication. (multicast,ssh,...)
246 # /etc/pve/firewall/cluster.fw
253 Standard IP set 'blacklist'
254 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
256 Traffic from these ips is dropped by every host's and VM's firewall.
259 # /etc/pve/firewall/cluster.fw
266 Standard IP set 'ipfilter-net*'
267 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
269 These filters belong to a VM's network interface and are mainly used to prevent
270 IP spoofing. If such a set exists for an interface then any outgoing traffic
271 with a source IP not matching its interface's corresponding ipfilter set will
274 For containers with configured IP addresses these sets, if they exist (or are
275 activated via the general `IP Filter` option in the VM's firewall's 'options'
276 tab), implicitly contain the associated IP addresses.
278 For both virtual machines and containers they also implicitly contain the
279 standard MAC-derived IPv6 link-local address in order to allow the neighbor
280 discovery protocol to work.
283 /etc/pve/firewall/<VMID>.fw
285 [IPSET ipfilter-net0] # only allow specified IPs on net0
289 Services and Commands
290 ~~~~~~~~~~~~~~~~~~~~~
292 The firewall runs two service daemons on each node:
294 * pvefw-logger: NFLOG daemon (ulogd replacement).
295 * pve-firewall: updates iptables rules
297 There is also a CLI command named 'pve-firewall', which can be used to
298 start and stop the firewall service:
303 To get the status use:
305 # pve-firewall status
307 The above command reads and compiles all firewall rules, so you will
308 see warnings if your firewall configuration contains any errors.
310 If you want to see the generated iptables rules you can use:
320 FTP is an old style protocol which uses port 21 and several other dynamic ports. So you
321 need a rule to accept port 21. In addition, you need to load the 'ip_conntrack_ftp' module.
324 modprobe ip_conntrack_ftp
326 and add `ip_conntrack_ftp` to '/etc/modules' (so that it works after a reboot) .
328 Suricata IPS integration
329 ^^^^^^^^^^^^^^^^^^^^^^^^
331 If you want to use the http://suricata-ids.org/[Suricata IPS]
332 (Intrusion Prevention System), it's possible.
334 Packets will be forwarded to the IPS only after the firewall ACCEPTed
337 Rejected/Dropped firewall packets don't go to the IPS.
339 Install suricata on proxmox host:
342 # apt-get install suricata
343 # modprobe nfnetlink_queue
346 Don't forget to add `nfnetlink_queue` to '/etc/modules' for next reboot.
348 Then, enable IPS for a specific VM with:
351 # /etc/pve/firewall/<VMID>.fw
358 `ips_queues` will bind a specific cpu queue for this VM.
360 Available queues are defined in
363 # /etc/default/suricata
369 include::copyright.adoc[]