X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pve-storage-pbs.adoc;fp=pve-storage-pbs.adoc;h=1bb0721f74f62a76055474f12956cc9bce46e0d9;hp=9527237f7b35b314f069f6a39a1495c92904ab6f;hb=1658c673519fea697132d9a24c42a5a3a4667586;hpb=4e8fe2a9599c40ec04565091b1b1f5930d966e00 diff --git a/pve-storage-pbs.adoc b/pve-storage-pbs.adoc index 9527237..1bb0721 100644 --- a/pve-storage-pbs.adoc +++ b/pve-storage-pbs.adoc @@ -82,6 +82,48 @@ container. |backup |n/a |yes |n/a |n/a |=============================================================== +[[storage_pbs_encryption]] +Encryption +~~~~~~~~~~ + +Optionally, you can configure client-side encryption with AES-256 in GCM mode. +Encryption can be configured either via the web interface, or on the CLI with +the `encryption-key` option (see above). The key will be saved in the file +`/etc/pve/priv/storage/.enc`, which is only accessible by the root +user. + +WARNING: Without their key, backups will be inaccessible. Thus, you should +keep keys ordered and in a place that is separate from the contents being +backed up. It can happen, for example, that you back up an entire system, using +a key on that system. If the system then becomes inaccessible for any reason +and needs to be restored, this will not be possible as the encryption key will be +lost along with the broken system. + +It is recommended that you keep your keys safe, but easily accessible, in +order for quick disaster recovery. For this reason, the best place to store it +is in your password manager, where it is immediately recoverable. As a backup to +this, you should also save the key to a USB drive and store that in a secure +place. This way, it is detached from any system, but is still easy to recover +from, in case of emergency. Finally, in preparation for the worst case scenario, +you should also consider keeping a paper copy of your master key locked away in +a safe place. The `paperkey` subcommand can be used to create a QR encoded +version of your master key. The following command sends the output of the +`paperkey` command to a text file, for easy printing. + +---- +# proxmox-backup-client key paperkey --output-format text > qrkey.txt +---- + +Because the encryption is managed on the client side, you can use the same +datastore on the server for unencrypted backups and encrypted backups, even +if they are encrypted with different keys. However, deduplication between +backups with different keys is not possible, so it is often better to create +separate datastores. + +NOTE: Do not use encryption if there is no benefit from it, for example, when +you are running the server locally in a trusted network. It is always easier to +recover from unencrypted backups. + Examples ~~~~~~~~