X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveproxy.adoc;h=4b5dac0877db062e84eba79da548c015d55075e0;hb=4368fce0a32560b58fac36969054da7e7913dbb0;hp=5b831066f00a5ae282da85760c61ccf79677e827;hpb=a69bfc83f6d2b79e94eeb39781d89b720b4482dc;p=pve-docs.git diff --git a/pveproxy.adoc b/pveproxy.adoc index 5b83106..4b5dac0 100644 --- a/pveproxy.adoc +++ b/pveproxy.adoc @@ -23,20 +23,20 @@ pveproxy - Proxmox VE API Proxy Daemon ====================================== endif::manvolnum[] -This daemon exposes the whole {pve} API on TCP port 8006 using -HTTPS. It runs as user `www-data` and has very limited permissions. -Operation requiring more permissions are forwarded to the local -`pvedaemon`. +This daemon exposes the whole {pve} API on TCP port 8006 using HTTPS. It runs +as user `www-data` and has very limited permissions. Operation requiring more +permissions are forwarded to the local `pvedaemon`. -Requests targeted for other nodes are automatically forwarded to those -nodes. This means that you can manage your whole cluster by connecting -to a single {pve} node. +Requests targeted for other nodes are automatically forwarded to those nodes. +This means that you can manage your whole cluster by connecting to a single +{pve} node. +[[pveproxy_host_acls]] Host based Access Control ------------------------- -It is possible to configure ``apache2''-like access control -lists. Values are read from file `/etc/default/pveproxy`. For example: +It is possible to configure ``apache2''-like access control lists. Values are +read from file `/etc/default/pveproxy`. For example: ---- ALLOW_FROM="10.0.0.1-10.0.0.5,192.168.0.0/22" @@ -45,7 +45,8 @@ POLICY="allow" ---- IP addresses can be specified using any syntax understood by `Net::IP`. The -name `all` is an alias for `0/0`. +name `all` is an alias for `0/0` and `::/0` (meaning all IPv4 and IPv6 +addresses). The default policy is `allow`. @@ -58,17 +59,98 @@ The default policy is `allow`. | Match Both Allow & Deny | deny | allow |=========================================================== +[[pveproxy_listening_address]] +Listening IP Address +-------------------- + +By default the `pveproxy` and `spiceproxy` daemons listen on the wildcard +address and accept connections from both IPv4 and IPv6 clients. + + +By setting `LISTEN_IP` in `/etc/default/pveproxy` you can control to which IP +address the `pveproxy` and `spiceproxy` daemons bind. The IP-address needs to +be configured on the system. + +Setting the `sysctl` `net.ipv6.bindv6only` to the non-default `1` will cause +the daemons to only accept connection from IPv6 clients, while usually also +causing lots of other issues. If you set this configuration we recommend to +either remove the `sysctl` setting, or set the `LISTEN_IP` to `0.0.0.0` (which +will only allow IPv4 clients). + +`LISTEN_IP` can be used to only to restricting the socket to an internal +interface and thus have less exposure to the public internet, for example: + +---- +LISTEN_IP="192.0.2.1" +---- + +Similarly, you can also set an IPv6 address: + +---- +LISTEN_IP="2001:db8:85a3::1" +---- + +Note that if you want to specify a link-local IPv6 address, you need to provide +the interface name itself. For example: + +---- +LISTEN_IP="fe80::c463:8cff:feb9:6a4e%vmbr0" +---- + +WARNING: The nodes in a cluster need access to `pveproxy` for communication, +possibly on different sub-nets. It is **not recommended** to set `LISTEN_IP` on +clustered systems. + +To apply the change you need to either reboot your node or fully restart the +`pveproxy` and `spiceproxy` service: + +---- +systemctl restart pveproxy.service spiceproxy.service +---- + +NOTE: Unlike `reload`, a `restart` of the pveproxy service can interrupt some +long-running worker processes, for example a running console or shell from a +virtual guest. So, please use a maintenance window to bring this change in +effect. + SSL Cipher Suite ---------------- -You can define the cipher list in `/etc/default/pveproxy`, for example +You can define the cipher list in `/etc/default/pveproxy` via the `CIPHERS` +(TLS <= 1.2) and `CIPHERSUITES` (TLS >= 1.3) keys. For example - CIPHERS="HIGH:MEDIUM:!aNULL:!MD5" + CIPHERS="ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256" + CIPHERSUITES="TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256" Above is the default. See the ciphers(1) man page from the openssl package for a list of all available options. +Additionally, you can set the client to choose the cipher used in +`/etc/default/pveproxy` (default is the first cipher in the list available to +both client and `pveproxy`): + + HONOR_CIPHER_ORDER=0 + + +Supported TLS versions +---------------------- + +The insecure SSL versions 2 and 3 are unconditionally disabled for pveproxy. +TLS versions below 1.1 are disabled by default on recent OpenSSL versions, +which is honored by `pveproxy` (see `/etc/ssl/openssl.cnf`). + +To disable TLS version 1.2 or 1.3, set the following in `/etc/default/pveproxy`: + + DISABLE_TLS_1_2=1 + +or, respectively: + + DISABLE_TLS_1_3=1 + +NOTE: Unless there is a specific reason to do so, it is not recommended to +manually adjust the supported TLS versions. + Diffie-Hellman Parameters ------------------------- @@ -85,29 +167,36 @@ used. NOTE: DH parameters are only used if a cipher suite utilizing the DH key exchange algorithm is negotiated. +[[pveproxy_custom_tls_cert]] Alternative HTTPS certificate ----------------------------- -By default, pveproxy uses the certificate `/etc/pve/local/pve-ssl.pem` -(and private key `/etc/pve/local/pve-ssl.key`) for HTTPS connections. -This certificate is signed by the cluster CA certificate, and therefor -not trusted by browsers and operating systems by default. - -In order to use a different certificate and private key for HTTPS, -store the server certificate and any needed intermediate / CA -certificates in PEM format in the file `/etc/pve/local/pveproxy-ssl.pem` -and the associated private key in PEM format without a password in the -file `/etc/pve/local/pveproxy-ssl.key`. - -WARNING: Do not replace the automatically generated node certificate -files in `/etc/pve/local/pve-ssl.pem` and `etc/pve/local/pve-ssl.key` or -the cluster CA files in `/etc/pve/pve-root-ca.pem` and -`/etc/pve/priv/pve-root-ca.key`. - -NOTE: There is a detailed HOWTO for configuring commercial HTTPS certificates -on the {webwiki-url}HTTPS_Certificate_Configuration_(Version_4.x_and_newer)[wiki], -including setup instructions for obtaining certificates from the popular free -Let's Encrypt certificate authority. +You can change the certificate used to an external one or to one obtained via +ACME. + +pveproxy uses `/etc/pve/local/pveproxy-ssl.pem` and +`/etc/pve/local/pveproxy-ssl.key`, if present, and falls back to +`/etc/pve/local/pve-ssl.pem` and `/etc/pve/local/pve-ssl.key`. +The private key may not use a passphrase. + +It is possible to override the location of the certificate private key +`/etc/pve/local/pveproxy-ssl.key` by setting `TLS_KEY_FILE` in +`/etc/default/pveproxy`, for example: + + TLS_KEY_FILE="/secrets/pveproxy.key" + +NOTE: The included ACME integration does not honor this setting. + +See the Host System Administration chapter of the documentation for details. + +[[pveproxy_response_compression]] +Response Compression +-------------------- + +By default `pveproxy` uses gzip HTTP-level compression for compressible +content, if the client supports it. This can disabled in `/etc/default/pveproxy` + + COMPRESSION=0 ifdef::manvolnum[] include::pve-copyright.adoc[]