Precise certificate generation

[pve-docs.git] / pve-firewall.adoc

diff --git a/pve-firewall.adoc b/pve-firewall.adoc
index 2f18e8ec938a21c59f47d837b86d5956cf5765f3..bc9df0e6ca736eec01d9992648c99fb8ff9b069f 100644 (file)
--- a/pve-firewall.adoc
+++ b/pve-firewall.adoc
@@ -1,15 +1,16 @@
-include::attributes.txt[]
+[[chapter_pve_firewall]]

 ifdef::manvolnum[]
 ifdef::manvolnum[]

-PVE({manvolnum})
-================
+pve-firewall(8)
+===============
+:pve-toplevel:

 
 NAME
 ----
 
 
 NAME
 ----
 

-pve-firewall - The PVE Firewall Daemon
+pve-firewall - PVE Firewall Daemon

 
 
 
 

-SYNOPSYS
+SYNOPSIS

 --------
 
 include::pve-firewall.8-synopsis.adoc[]
 --------
 
 include::pve-firewall.8-synopsis.adoc[]


@@ -18,28 +19,30 @@ include::pve-firewall.8-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
 DESCRIPTION
 -----------
 endif::manvolnum[]

-

 ifndef::manvolnum[]
 {pve} Firewall
 ==============
 ifndef::manvolnum[]
 {pve} Firewall
 ==============

+:pve-toplevel:

 endif::manvolnum[]
 endif::manvolnum[]

+ifdef::wiki[]
+:title: Firewall
+endif::wiki[]

 
 

-// Copied from pve wiki: Revision as of 08:45, 9 November 2015
-
-Proxmox VE Firewall provides an easy way to protect your IT
-infrastructure. You can easily setup firewall rules for all hosts
+{pve} Firewall provides an easy way to protect your IT
+infrastructure. You can setup firewall rules for all hosts

 inside a cluster, or define rules for virtual machines and
 containers. Features like firewall macros, security groups, IP sets
 inside a cluster, or define rules for virtual machines and
 containers. Features like firewall macros, security groups, IP sets

-and aliases help making that task easier.
+and aliases help to make that task easier.

 
 While all configuration is stored on the cluster file system, the
 
 While all configuration is stored on the cluster file system, the

-iptables based firewall runs on each cluster node, and thus provides
+`iptables`-based firewall runs on each cluster node, and thus provides

 full isolation between virtual machines. The distributed nature of
 this system also provides much higher bandwidth than a central
 firewall solution.
 
 full isolation between virtual machines. The distributed nature of
 this system also provides much higher bandwidth than a central
 firewall solution.
 

-NOTE: If you enable the firewall, all traffic is blocked by default,
-except WebGUI(8006) and ssh(22) from your local network.
+The firewall has full support for IPv4 and IPv6. IPv6 support is fully
+transparent, and we filter traffic for both protocols by default. So
+there is no need to maintain a different set of rules for IPv6.

 
 
 Zones
 
 
 Zones


@@ -59,34 +62,62 @@ For each zone, you can define firewall rules for incoming and/or
 outgoing traffic.
 
 
 outgoing traffic.
 
 

-Ports used by Proxmox VE
-------------------------
+Configuration Files
+-------------------

 
 

-* Web interface: 8006
-* VNC Web console: 5900-5999
-* SPICE proxy: 3128
-* sshd (used for cluster actions): 22
-* rpcbind: 111
-*  corosync multicast (if you run a cluster): 5404, 5405 UDP
+All firewall related configuration is stored on the proxmox cluster
+file system. So those files are automatically distributed to all
+cluster nodes, and the `pve-firewall` service updates the underlying
+`iptables` rules automatically on changes.

 
 

+You can configure anything using the GUI (i.e. *Datacenter* -> *Firewall*,
+or on a *Node* -> *Firewall*), or you can edit the configuration files
+directly using your preferred editor.

 
 

-Configuration
--------------
+Firewall configuration files contains sections of key-value
+pairs. Lines beginning with a `#` and blank lines are considered
+comments. Sections starts with a header line containing the section
+name enclosed in `[` and `]`.

 
 

-All firewall related configuration is stored on the proxmox cluster
-file system. So those files are automatically distributed to all
-cluster nodes, and the 'pve-firewall' service updates the underlying
-iptables rules automatically on any change. Any configuration can be
-done using the GUI (i.e. Datacenter -> Firewall -> Options tab (tabs
-at the bottom of the page), or on a Node -> Firewall), so the
-following configuration file snippets are just for completeness.

 
 

-Cluster wide configuration is stored at:
+[[pve_firewall_cluster_wide_setup]]
+Cluster Wide Setup
+~~~~~~~~~~~~~~~~~~
+
+The cluster wide firewall configuration is stored at:

  
  /etc/pve/firewall/cluster.fw
 
  
  /etc/pve/firewall/cluster.fw
 

-The firewall is completely disabled by default, so you need to set the
-enable option here:
+The configuration can contain the following sections:
+
+`[OPTIONS]`::
+
+This is used to set cluster wide firewall options.
+
+include::pve-firewall-cluster-opts.adoc[]
+
+`[RULES]`::
+
+This sections contains cluster wide firewall rules for all nodes.
+
+`[IPSET <name>]`::
+
+Cluster wide IP set definitions.
+
+`[GROUP <name>]`::
+
+Cluster wide security group definitions.
+
+`[ALIASES]`::
+
+Cluster wide Alias definitions.
+
+
+Enabling the Firewall
+^^^^^^^^^^^^^^^^^^^^^
+
+The firewall is completely disabled by default, so you need to
+set the enable option here:

 
 ----
 [OPTIONS]
 
 ----
 [OPTIONS]


@@ -94,12 +125,49 @@ enable option here:
 enable: 1
 ----
 
 enable: 1
 ----
 

-The cluster wide configuration can contain the following data:
+IMPORTANT: If you enable the firewall, traffic to all hosts is blocked by
+default. Only exceptions is WebGUI(8006) and ssh(22) from your local
+network.
+
+If you want to administrate your {pve} hosts from remote, you
+need to create rules to allow traffic from those remote IPs to the web
+GUI (port 8006). You may also want to allow ssh (port 22), and maybe
+SPICE (port 3128).
+
+TIP: Please open a SSH connection to one of your {PVE} hosts before
+enabling the firewall. That way you still have access to the host if
+something goes wrong .
+
+To simplify that task, you can instead create an IPSet called
+``management'', and add all remote IPs there. This creates all required
+firewall rules to access the GUI from remote.
+
+
+[[pve_firewall_host_specific_configuration]]
+Host Specific Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Host related configuration is read from:
+
+ /etc/pve/nodes/<nodename>/host.fw
+
+This is useful if you want to overwrite rules from `cluster.fw`
+config. You can also increase log verbosity, and set netfilter related
+options. The configuration can contain the following sections:
+
+`[OPTIONS]`::
+
+This is used to set host related firewall options.
+
+include::pve-firewall-host-opts.adoc[]

 
 

-* IP set definitions
-* Alias definitions
-* Security group definitions
-* Cluster wide firewall rules for all nodes
+`[RULES]`::
+
+This sections contains host specific firewall rules.
+
+[[pve_firewall_vm_container_configuration]]
+VM/Container Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 VM firewall configuration is read from:
 
 
 VM firewall configuration is read from:
 


@@ -107,61 +175,81 @@ VM firewall configuration is read from:
 
 and contains the following data:
 
 
 and contains the following data:
 

-* IP set definitions
-* Alias definitions
-* Firewall rules for this VM
-* VM specific options
+`[OPTIONS]`::

 
 

-And finally, any host related configuration is read from:
+This is used to set VM/Container related firewall options.

 
 

- /etc/pve/nodes/<nodename>/host.fw
+include::pve-firewall-vm-opts.adoc[]

 
 

-This is useful if you want to overwrite rules from 'cluster.fw'
-config. You can also increase log verbosity, and set netfilter related
-options.
+`[RULES]`::
+
+This sections contains VM/Container firewall rules.

 
 

-Enabling Firewall for VMs and Containers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`[IPSET <name>]`::
+
+IP set definitions.
+
+`[ALIASES]`::
+
+IP Alias definitions.
+
+
+Enabling the Firewall for VMs and Containers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Each virtual network device has its own firewall enable flag. So you
+can selectively enable the firewall for each interface. This is
+required in addition to the general firewall `enable` option.

 
 

-You need to enable the firewall on the virtual network interface configuration.

 
 Firewall Rules
 
 Firewall Rules

-~~~~~~~~~~~~~~
+--------------

 
 

-Any firewall rule consists of a direction (`IN` or `OUT`) and an
-action (`ACCEPT`, `DENY`, `REJECT`). Additional options can be used to
-refine rule matches. Here are some examples:
+Firewall rules consists of a direction (`IN` or `OUT`) and an
+action (`ACCEPT`, `DENY`, `REJECT`). You can also specify a macro
+name. Macros contain predefined sets of rules and options. Rules can be
+disabled by prefixing them with `|`.

 
 

+.Firewall rules syntax

 ----
 [RULES]
 
 ----
 [RULES]
 

-#TYPE ACTION [OPTIONS]
-#TYPE MACRO(ACTION) [OPTIONS]
+DIRECTION ACTION [OPTIONS]
+|DIRECTION ACTION [OPTIONS] # disabled rule

 
 

-# -i      <INTERFACE>
-# -source <SOURCE>
-# -dest   <DEST>
-# -p      <PROTOCOL>
-# -dport  <DESTINATION_PORT>
-# -sport  <SOURCE_PORT>
+DIRECTION MACRO(ACTION) [OPTIONS] # use predefined macro
+----
+
+The following options can be used to refine rule matches. 
+
+include::pve-firewall-rules-opts.adoc[]

 
 

+Here are some examples:
+
+----
+[RULES]

 IN SSH(ACCEPT) -i net0
 IN SSH(ACCEPT) -i net0 # a comment
 IN SSH(ACCEPT) -i net0
 IN SSH(ACCEPT) -i net0 # a comment

-IN SSH(ACCEPT) -i net0 -source 192.168.2.192  # only allow SSH from 192.168.2.192
+IN SSH(ACCEPT) -i net0 -source 192.168.2.192 # only allow SSH from 192.168.2.192

 IN SSH(ACCEPT) -i net0 -source 10.0.0.1-10.0.0.10 # accept SSH for ip range
 IN SSH(ACCEPT) -i net0 -source 10.0.0.1,10.0.0.2,10.0.0.3 #accept ssh for ip list
 IN SSH(ACCEPT) -i net0 -source 10.0.0.1-10.0.0.10 # accept SSH for ip range
 IN SSH(ACCEPT) -i net0 -source 10.0.0.1,10.0.0.2,10.0.0.3 #accept ssh for ip list

-IN SSH(ACCEPT) -i net0 -source +mynetgroup   # accept ssh for ipset mynetgroup
-IN SSH(ACCEPT) -i net0 -source myserveralias   #accept ssh for alias myserveralias
+IN SSH(ACCEPT) -i net0 -source +mynetgroup # accept ssh for ipset mynetgroup
+IN SSH(ACCEPT) -i net0 -source myserveralias #accept ssh for alias myserveralias

 
 |IN SSH(ACCEPT) -i net0 # disabled rule
 
 |IN SSH(ACCEPT) -i net0 # disabled rule

+
+IN  DROP # drop all incoming packages
+OUT ACCEPT # accept all outgoing packages

 ----
 
 ----
 

+
+[[pve_firewall_security_groups]]

 Security Groups
 Security Groups

-~~~~~~~~~~~~~~~
+---------------

 
 

-A security group is a group a rules, defined at cluster level, which
-can be used in all VMs rules. For example you can define a group named
-`webserver` with rules to open http and https ports.
+A security group is a collection of rules, defined at cluster level, which
+can be used in all VMs' rules. For example you can define a group named
+``webserver'' with rules to open the 'http' and 'https' ports.

 
 ----
 # /etc/pve/firewall/cluster.fw
 
 ----
 # /etc/pve/firewall/cluster.fw


@@ -171,7 +259,7 @@ IN  ACCEPT -p tcp -dport 80
 IN  ACCEPT -p tcp -dport 443
 ----
 
 IN  ACCEPT -p tcp -dport 443
 ----
 

-Then, you can add this group in a vm firewall
+Then, you can add this group to a VM's firewall

 
 ----
 # /etc/pve/firewall/<VMID>.fw
 
 ----
 # /etc/pve/firewall/<VMID>.fw


@@ -180,18 +268,19 @@ Then, you can add this group in a vm firewall
 GROUP webserver
 ----
 
 GROUP webserver
 ----
 

-
+[[pve_firewall_ip_aliases]]

 IP Aliases
 IP Aliases

-~~~~~~~~~~
+----------

 
 

-IP Aliases allows you to associate IP addresses of Networks with a
+IP Aliases allow you to associate IP addresses of networks with a

 name. You can then refer to those names:
 
 * inside IP set definitions
 * in `source` and `dest` properties of firewall rules
 
 name. You can then refer to those names:
 
 * inside IP set definitions
 * in `source` and `dest` properties of firewall rules
 

-Standard IP alias `local_network`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Standard IP Alias `local_network`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 This alias is automatically defined. Please use the following command
 to see assigned values:
 
 This alias is automatically defined. Please use the following command
 to see assigned values:


@@ -205,9 +294,9 @@ using detected local_network: 192.168.0.0/20
 ----
 
 The firewall automatically sets up rules to allow everything needed
 ----
 
 The firewall automatically sets up rules to allow everything needed

-for cluster communication (corosync, API, SSH).
+for cluster communication (corosync, API, SSH) using this alias.

 
 

-The user can overwrite these values in the cluster.fw alias
+The user can overwrite these values in the `cluster.fw` alias

 section. If you use a single host on a public network, it is better to
 explicitly assign the local IP address
 
 section. If you use a single host on a public network, it is better to
 explicitly assign the local IP address
 


@@ -217,11 +306,12 @@ explicitly assign the local IP address
 local_network 1.2.3.4 # use the single ip address
 ----
 
 local_network 1.2.3.4 # use the single ip address
 ----
 

+[[pve_firewall_ip_sets]]

 IP Sets
 IP Sets

-~~~~~~~
+-------

 
 IP sets can be used to define groups of networks and hosts. You can
 
 IP sets can be used to define groups of networks and hosts. You can

-refer to them with `+name` in firewall rules `source` and `dest`
+refer to them with `+name` in the firewall rules' `source` and `dest`

 properties.
 
 The following example allows HTTP traffic from the `management` IP
 properties.
 
 The following example allows HTTP traffic from the `management` IP


@@ -229,11 +319,12 @@ set.
 
  IN HTTP(ACCEPT) -source +management
 
 
  IN HTTP(ACCEPT) -source +management
 

+

 Standard IP set `management`
 Standard IP set `management`

-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 This IP set applies only to host firewalls (not VM firewalls).  Those
 
 This IP set applies only to host firewalls (not VM firewalls).  Those

-ips are allowed to do normal management tasks (PVE GUI, VNC, SPICE,
+IPs are allowed to do normal management tasks (PVE GUI, VNC, SPICE,

 SSH).
 
 The local cluster network is automatically added to this IP set (alias
 SSH).
 
 The local cluster network is automatically added to this IP set (alias


@@ -248,10 +339,11 @@ communication. (multicast,ssh,...)
 192.168.2.10/24
 ----
 
 192.168.2.10/24
 ----
 

-Standard IP set 'blacklist'
-^^^^^^^^^^^^^^^^^^^^^^^^^^^

 
 

-Traffic from those ips is dropped in all hosts and VMs firewalls.
+Standard IP set `blacklist`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Traffic from these IPs is dropped by every host's and VM's firewall.

 
 ----
 # /etc/pve/firewall/cluster.fw
 
 ----
 # /etc/pve/firewall/cluster.fw


@@ -261,10 +353,23 @@ Traffic from those ips is dropped in all hosts and VMs firewalls.
 213.87.123.0/24
 ----
 
 213.87.123.0/24
 ----
 

-Standard IP set 'ipfilter'
-^^^^^^^^^^^^^^^^^^^^^^^^^^

 
 

-This ipset is used to prevent ip spoofing
+[[pve_firewall_ipfilter_section]]
+Standard IP set `ipfilter-net*`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These filters belong to a VM's network interface and are mainly used to prevent
+IP spoofing. If such a set exists for an interface then any outgoing traffic
+with a source IP not matching its interface's corresponding ipfilter set will
+be dropped.
+
+For containers with configured IP addresses these sets, if they exist (or are
+activated via the general `IP Filter` option in the VM's firewall's *options*
+tab), implicitly contain the associated IP addresses.
+
+For both virtual machines and containers they also implicitly contain the
+standard MAC-derived IPv6 link-local address in order to allow the neighbor
+discovery protocol to work.

 
 ----
 /etc/pve/firewall/<VMID>.fw
 
 ----
 /etc/pve/firewall/<VMID>.fw


@@ -273,15 +378,16 @@ This ipset is used to prevent ip spoofing
 192.168.2.10
 ----
 
 192.168.2.10
 ----
 

+

 Services and Commands
 Services and Commands

-~~~~~~~~~~~~~~~~~~~~~
+---------------------

 
 The firewall runs two service daemons on each node:
 
 * pvefw-logger: NFLOG daemon (ulogd replacement).
 * pve-firewall: updates iptables rules
 
 
 The firewall runs two service daemons on each node:
 
 * pvefw-logger: NFLOG daemon (ulogd replacement).
 * pve-firewall: updates iptables rules
 

-There is also a CLI command named 'pve-firewall', which can be used to
+There is also a CLI command named `pve-firewall`, which can be used to

 start and stop the firewall service:
 
  # pve-firewall start
 start and stop the firewall service:
 
  # pve-firewall start


@@ -298,22 +404,24 @@ If you want to see the generated iptables rules you can use:
 
  # iptables-save
 
 
  # iptables-save
 

+

 Tips and Tricks
 Tips and Tricks

-~~~~~~~~~~~~~~~
+---------------

 
 How to allow FTP
 
 How to allow FTP

-^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~

 
 FTP is an old style protocol which uses port 21 and several other dynamic ports. So you
 
 FTP is an old style protocol which uses port 21 and several other dynamic ports. So you

-need a rule to accept port 21. In addition, you need to load the 'ip_conntrack_ftp' module.
+need a rule to accept port 21. In addition, you need to load the `ip_conntrack_ftp` module.

 So please run: 
 
  modprobe ip_conntrack_ftp
 
 So please run: 
 
  modprobe ip_conntrack_ftp
 

-and add `ip_conntrack_ftp` to '/etc/modules' (so that it works after a reboot) .
+and add `ip_conntrack_ftp` to `/etc/modules` (so that it works after a reboot).
+

 
 Suricata IPS integration
 
 Suricata IPS integration

-^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~

 
 If you want to use the http://suricata-ids.org/[Suricata IPS]
 (Intrusion Prevention System), it's possible.
 
 If you want to use the http://suricata-ids.org/[Suricata IPS]
 (Intrusion Prevention System), it's possible.


@@ -330,7 +438,7 @@ Install suricata on proxmox host:
 # modprobe nfnetlink_queue  
 ----
 
 # modprobe nfnetlink_queue  
 ----
 

-Don't forget to add `nfnetlink_queue` to '/etc/modules' for next reboot.
+Don't forget to add `nfnetlink_queue` to `/etc/modules` for next reboot.

 
 Then, enable IPS for a specific VM with:
 
 
 Then, enable IPS for a specific VM with:
 


@@ -352,7 +460,51 @@ NFQUEUE=0
 ----
 
 
 ----
 
 

+Notes on IPv6
+-------------
+
+The firewall contains a few IPv6 specific options. One thing to note is that
+IPv6 does not use the ARP protocol anymore, and instead uses NDP (Neighbor
+Discovery Protocol) which works on IP level and thus needs IP addresses to
+succeed. For this purpose link-local addresses derived from the interface's MAC
+address are used. By default the `NDP` option is enabled on both host and VM
+level to allow neighbor discovery (NDP) packets to be sent and received.
+
+Beside neighbor discovery NDP is also used for a couple of other things, like
+autoconfiguration and advertising routers.
+
+By default VMs are allowed to send out router solicitation messages (to query
+for a router), and to receive router advertisement packets. This allows them to
+use stateless auto configuration. On the other hand VMs cannot advertise
+themselves as routers unless the ``Allow Router Advertisement'' (`radv: 1`) option
+is set.
+
+As for the link local addresses required for NDP, there's also an ``IP Filter''
+(`ipfilter: 1`) option which can be enabled which has the same effect as adding
+an `ipfilter-net*` ipset for each of the VM's network interfaces containing the
+corresponding link local addresses.  (See the
+<<pve_firewall_ipfilter_section,Standard IP set `ipfilter-net*`>> section for details.)
+
+
+Ports used by {pve}
+-------------------
+
+* Web interface: 8006
+* VNC Web console: 5900-5999
+* SPICE proxy: 3128
+* sshd (used for cluster actions): 22
+* rpcbind: 111
+* corosync multicast (if you run a cluster): 5404, 5405 UDP
+
+

 ifdef::manvolnum[]
 ifdef::manvolnum[]

-include::copyright.adoc[]
-endif::manvolnum[]

 
 

+Macro Definitions
+-----------------
+
+include::pve-firewall-macros.adoc[]
+
+
+include::pve-copyright.adoc[]
+
+endif::manvolnum[]