From 2d5fbd15fe4f7fbadf6dc681a34caf61e7574135 Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sat, 27 Jan 2018 13:31:36 +0000 Subject: [PATCH 1/8] Update for 4.0 Split out 4.0 and 3.2 into multiple sections due to multiple minor differences between procedures. Emergency 4.0 Recovery procedure needs to be developed. --- common-tasks/backup-restore.md | 68 ++++++++++++++++++++++++++++++---- 1 file changed, 61 insertions(+), 7 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index 0b2ecaa7..14f02a2f 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -11,7 +11,7 @@ redirect_from: Qubes Backup, Restoration, and Migration ======================================== -**Caution:** The Qubes backup system currently relies on a [weak key derivation scheme](https://github.com/QubesOS/qubes-issues/issues/971). It is *strongly recommended* that users select a *high-entropy* passphrase for use with Qubes backups. +**Caution:** The Qubes R3.2 backup system currently relies on a [weak key derivation scheme](https://github.com/QubesOS/qubes-issues/issues/971). Although resolved in R4.0 and higher with the switch to scrypt, it is *strongly recommended* that users select a *high-entropy* passphrase for use with Qubes backups. With Qubes, it's easy to back up and restore your whole system, as well as to migrate between two physical machines. @@ -19,7 +19,36 @@ With Qubes, it's easy to back up and restore your whole system, as well as to mi As of Qubes R2B3, these functions are integrated into the Qubes VM Manager GUI. There are also two command-line tools available which perform the same functions: [qvm-backup](/doc/dom0-tools/qvm-backup/) and [qvm-backup-restore](/doc/dom0-tools/qvm-backup-restore/). -Creating a Backup +Creating a Backup (R4.0 and later) +----------------- + +1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Backup Qubes** in the drop-down list. This brings up the **Qubes Backup VMs** window. + +2. Move the VMs that you want to back up to the right-hand **Selected** column. VMs in the left-hand **Available** column will not be backed up. + + **Note:** A VM must be shut down in order to be backed up. Currently running VMs appear in red. + + You may choose whether to compress backups by checking or unchecking the **Compress the backup** box. Normally this should be left on unless you have a specific reason otherwise. + + Once you have selected all desired VMs, click **Next**. + +3. Select the destination for the backup: + + If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. + If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), first mount the device in a VM, then select the mount point inside that VM as the backup destination. + + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply type or browse to `backups` in this field. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. + + By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. + + **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. + + At this point, you may also choose whether to save your settings by checking or unchecking the **Save settings as default backup profile** box. + **Warning: Saving the settings will result in your backup passphrase being saved in plaintext in dom0, so consider your threat model before checking this box.** + +4. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. + +Creating a Backup (R3.2 and earlier) ----------------- 1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Backup VMs** in the drop-down list. This brings up the **Qubes Backup VMs** window. @@ -35,7 +64,7 @@ Creating a Backup If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), first mount the device in a VM, then select the mount point inside that VM as the backup destination. - You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply type `backups` in this field. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply type or browse to `backups` in this field. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. @@ -48,7 +77,32 @@ Creating a Backup 4. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. -Restoring from a Backup +Restoring from a Backup (R4.0 and later) +----------------------- + +1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Restore Qubes from backup** in the drop-down list. This brings up the **Qubes Restore VMs** window. + +2. Select the source location of the backup to be restored: + + - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), select the device in the drop-down box next to **Device**. + - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. + + You must also specify the directory in which the backup resides (or a command to be executed in a VM). If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again type `backups` into the **Backup directory** field. + + **Note:** After you have typed the directory location of the backup in the **Backup directory** field, click the ellipsis button `...` to the right of the field. + +3. There are three options you may select when restoring from a backup: + 1. **ignore missing templates and net VMs**: If any of the VMs in your backup depended upon a NetVM or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. + 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. + 3. **Verify backup integrity, do not restore the data**: Like it says- check this if you only want to verify. + +4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. + + **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. + +5. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. + +Restoring from a Backup (R3.2 and earlier) ----------------------- 1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Restore VMs from backup** in the drop-down list. This brings up the **Qubes Restore VMs** window. @@ -65,7 +119,7 @@ Restoring from a Backup 3. There are three options you may select when restoring from a backup: 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **skip dom0**: If this box is checked, dom0's home directory will not be restored from your backup. + 3. **Verify backup integrity, do not restore the data**: Like it says- check this if you only want to verify. 4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. @@ -81,7 +135,7 @@ Emergency Backup Recovery without Qubes The Qubes backup system has been designed with emergency disaster recovery in mind. No special Qubes-specific tools are required to access data backed up by Qubes. In the event a Qubes system is unavailable, you can access your data on any GNU/Linux system with the following procedure. -For emergency restore of backup created on Qubes R2 or newer take a look [here](/doc/backup-emergency-restore-v3/). For backups created on earlier Qubes version, take a look [here](/doc/backup-emergency-restore-v2/). +For emergency restore of a backup created on Qubes R4 or newer, take a look here (TBD). For R3 take a look [here](/doc/backup-emergency-restore-v3/). For backups created on even earlier Qubes versions, take a look [here](/doc/backup-emergency-restore-v2/). Migrating Between Two Physical Machines @@ -101,6 +155,6 @@ Here are some things to consider when selecting a passphrase for your backups: Notes ----- - * The Qubes backup system relies on `openssl enc`, which is known to use a very weak key derivation scheme. The Qubes backup system also uses the same passphrase for authentication and for encryption, which is problematic from a security perspective. Users are advised to use a very high entropy passphrase for Qubes backups. For a full discussion, see [this ticket](https://github.com/QubesOS/qubes-issues/issues/971) and [this thread](https://groups.google.com/d/msg/qubes-devel/CZ7WRwLXcnk/u_rZPoVxL5IJ). + * The Qubes R3.2 and earlier backup system relies on `openssl enc`, which is known to use a very weak key derivation scheme. The Qubes backup system also uses the same passphrase for authentication and for encryption, which is problematic from a security perspective. Users are advised to use a very high entropy passphrase for Qubes backups. For a full discussion, see [this ticket](https://github.com/QubesOS/qubes-issues/issues/971) and [this thread](https://groups.google.com/d/msg/qubes-devel/CZ7WRwLXcnk/u_rZPoVxL5IJ). * For the technical details of the backup system, please refer to [this thread](https://groups.google.com/d/topic/qubes-devel/TQr_QcXIVww/discussion). * If working with symlinks, note the issues described in [this thread](https://groups.google.com/d/topic/qubes-users/EITd1kBHD30/discussion). From 1d9c917d7988a58b8b0237b636e6caef22a1249b Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sat, 27 Jan 2018 17:29:16 +0000 Subject: [PATCH 2/8] Add link to v4 emergency restore Didn't need to develop, just had to have it pointed out to me --- common-tasks/backup-restore.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index 14f02a2f..dfaaa433 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -135,7 +135,11 @@ Emergency Backup Recovery without Qubes The Qubes backup system has been designed with emergency disaster recovery in mind. No special Qubes-specific tools are required to access data backed up by Qubes. In the event a Qubes system is unavailable, you can access your data on any GNU/Linux system with the following procedure. -For emergency restore of a backup created on Qubes R4 or newer, take a look here (TBD). For R3 take a look [here](/doc/backup-emergency-restore-v3/). For backups created on even earlier Qubes versions, take a look [here](/doc/backup-emergency-restore-v2/). +Refer to the follow for emergency restore of a backup created on: + + * [Qubes R4 or newer](/doc/backup-emergency-restore-v4/) + * [Qubes R3](/doc/backup-emergency-restore-v3/) + * [Earlier Qubes versions](/doc/backup-emergency-restore-v2/) Migrating Between Two Physical Machines From b975d77280dd87a5f48c219e55c5b255a1f8bca8 Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sat, 27 Jan 2018 17:34:30 +0000 Subject: [PATCH 3/8] Grammar and word choice --- common-tasks/backup-restore.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index dfaaa433..c7de18b4 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -135,11 +135,11 @@ Emergency Backup Recovery without Qubes The Qubes backup system has been designed with emergency disaster recovery in mind. No special Qubes-specific tools are required to access data backed up by Qubes. In the event a Qubes system is unavailable, you can access your data on any GNU/Linux system with the following procedure. -Refer to the follow for emergency restore of a backup created on: +Refer to the following for emergency restore of a backup created on: * [Qubes R4 or newer](/doc/backup-emergency-restore-v4/) * [Qubes R3](/doc/backup-emergency-restore-v3/) - * [Earlier Qubes versions](/doc/backup-emergency-restore-v2/) + * [Qubes R2 or older](/doc/backup-emergency-restore-v2/) Migrating Between Two Physical Machines From 80c0a3c47004e6b5067bd09a5f6214a3f2ae842b Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sat, 27 Jan 2018 17:57:08 +0000 Subject: [PATCH 4/8] Better description of Verify only restore option --- common-tasks/backup-restore.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index c7de18b4..42e7c6fd 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -94,7 +94,7 @@ Restoring from a Backup (R4.0 and later) 3. There are three options you may select when restoring from a backup: 1. **ignore missing templates and net VMs**: If any of the VMs in your backup depended upon a NetVM or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **Verify backup integrity, do not restore the data**: Like it says- check this if you only want to verify. + 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. 4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. @@ -119,7 +119,7 @@ Restoring from a Backup (R3.2 and earlier) 3. There are three options you may select when restoring from a backup: 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **Verify backup integrity, do not restore the data**: Like it says- check this if you only want to verify. + 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details.. 4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. From 2c02e7a13a36be1d2e1963c5ecceac1427f01b22 Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sat, 27 Jan 2018 18:12:29 +0000 Subject: [PATCH 5/8] Added whitespace, removed superfluous "." --- common-tasks/backup-restore.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index 42e7c6fd..9940f6ca 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -44,6 +44,7 @@ Creating a Backup (R4.0 and later) **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. At this point, you may also choose whether to save your settings by checking or unchecking the **Save settings as default backup profile** box. + **Warning: Saving the settings will result in your backup passphrase being saved in plaintext in dom0, so consider your threat model before checking this box.** 4. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. @@ -119,7 +120,7 @@ Restoring from a Backup (R3.2 and earlier) 3. There are three options you may select when restoring from a backup: 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details.. + 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. 4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. From 047353056aa1e2fc33f4ce7eb2dedc06d030f4f0 Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sun, 28 Jan 2018 17:50:45 +0000 Subject: [PATCH 6/8] Update backup-restore.md --- common-tasks/backup-restore.md | 48 ++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index 9940f6ca..9593fa4d 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -22,12 +22,10 @@ As of Qubes R2B3, these functions are integrated into the Qubes VM Manager GUI. Creating a Backup (R4.0 and later) ----------------- -1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Backup Qubes** in the drop-down list. This brings up the **Qubes Backup VMs** window. +1. Go to **Applications menu -> System Tools -> Backup Qubes**. This brings up the **Qubes Backup VMs** window. 2. Move the VMs that you want to back up to the right-hand **Selected** column. VMs in the left-hand **Available** column will not be backed up. - **Note:** A VM must be shut down in order to be backed up. Currently running VMs appear in red. - You may choose whether to compress backups by checking or unchecking the **Compress the backup** box. Normally this should be left on unless you have a specific reason otherwise. Once you have selected all desired VMs, click **Next**. @@ -35,9 +33,9 @@ Creating a Backup (R4.0 and later) 3. Select the destination for the backup: If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. - If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), first mount the device in a VM, then select the mount point inside that VM as the backup destination. + If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. - You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply type or browse to `backups` in this field. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. @@ -47,7 +45,9 @@ Creating a Backup (R4.0 and later) **Warning: Saving the settings will result in your backup passphrase being saved in plaintext in dom0, so consider your threat model before checking this box.** -4. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. +4. You will now the the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. + +5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. Creating a Backup (R3.2 and earlier) ----------------- @@ -63,9 +63,9 @@ Creating a Backup (R3.2 and earlier) 3. Select the destination for the backup: If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. - If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), first mount the device in a VM, then select the mount point inside that VM as the backup destination. + If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. - You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply type or browse to `backups` in this field. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. If it does not exist, you must create it manually prior to backing up. By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. @@ -75,33 +75,35 @@ Creating a Backup (R3.2 and earlier) **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. If you decide not to encrypt your backup (by unchecking the **Encrypt backup** box), the passphrase you supply will be used **only** for integrity verification. If you supply a passphrase but do not check the **Encrypt backup** box, your backup will **not** be encrypted! -4. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. +4. You will now the the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. + +5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. Restoring from a Backup (R4.0 and later) ----------------------- -1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Restore Qubes from backup** in the drop-down list. This brings up the **Qubes Restore VMs** window. +1. Go to **Applications menu -> System Tools -> Restore Backup**. This brings up the **Qubes Restore VMs** window. 2. Select the source location of the backup to be restored: - - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), select the device in the drop-down box next to **Device**. + - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. - You must also specify the directory in which the backup resides (or a command to be executed in a VM). If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again type `backups` into the **Backup directory** field. - - **Note:** After you have typed the directory location of the backup in the **Backup directory** field, click the ellipsis button `...` to the right of the field. + You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click it or select it and hit **OK**. 3. There are three options you may select when restoring from a backup: - 1. **ignore missing templates and net VMs**: If any of the VMs in your backup depended upon a NetVM or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. + 1. **ignore missing templates and net VMs**: If any of the VMs in your backup depended upon a NetVM or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway and set them to use the default NetVM and system default template. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. 4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. - **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. + **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. All backups made from a Qubes R4.0 system will be encrypted. -5. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. +5. You will now the the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. + +6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. Restoring from a Backup (R3.2 and earlier) ----------------------- @@ -110,15 +112,13 @@ Restoring from a Backup (R3.2 and earlier) 2. Select the source location of the backup to be restored: - - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), select the device in the drop-down box next to **Device**. + - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. - You must also specify the directory in which the backup resides (or a command to be executed in a VM). If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again type `backups` into the **Backup directory** field. - - **Note:** After you have typed the directory location of the backup in the **Backup directory** field, click the ellipsis button `...` to the right of the field. + You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click or select it and hit **OK**. 3. There are three options you may select when restoring from a backup: - 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway. + 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway and set them to use the default NetVM and system default template. 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. @@ -128,7 +128,9 @@ Restoring from a Backup (R3.2 and earlier) **Note:** A VM cannot be restored from a backup if a VM with the same name already exists on the current system. You must first remove or change the name of any VM with the same name in order to restore such a VM. -5. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. +5. You will now the the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. + +6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. Emergency Backup Recovery without Qubes From ee5361c3e3602fcc6fe5293e5a7e79d5150fd01d Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Sun, 28 Jan 2018 19:31:21 +0000 Subject: [PATCH 7/8] Update backup-restore.md --- common-tasks/backup-restore.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index 9593fa4d..d07e1e1a 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -33,7 +33,7 @@ Creating a Backup (R4.0 and later) 3. Select the destination for the backup: If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. - If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. + If you wish to send your backup to a [USB mass storage device](/doc/usb/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. @@ -45,7 +45,7 @@ Creating a Backup (R4.0 and later) **Warning: Saving the settings will result in your backup passphrase being saved in plaintext in dom0, so consider your threat model before checking this box.** -4. You will now the the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. +4. You will now see the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. 5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. @@ -63,7 +63,7 @@ Creating a Backup (R3.2 and earlier) 3. Select the destination for the backup: If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. - If you wish to send your backup to a [USB mass storage device](/doc/stick-mounting/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. + If you wish to send your backup to a [USB mass storage device](/doc/usb/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. If it does not exist, you must create it manually prior to backing up. @@ -75,7 +75,7 @@ Creating a Backup (R3.2 and earlier) **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. If you decide not to encrypt your backup (by unchecking the **Encrypt backup** box), the passphrase you supply will be used **only** for integrity verification. If you supply a passphrase but do not check the **Encrypt backup** box, your backup will **not** be encrypted! -4. You will now the the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. +4. You will now see the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. 5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. @@ -87,7 +87,7 @@ Restoring from a Backup (R4.0 and later) 2. Select the source location of the backup to be restored: - - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), attach it first to another VM or select `sys-usb` in the next item. + - If your backup is located on a [USB mass storage device](/doc/usb/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click it or select it and hit **OK**. @@ -101,7 +101,7 @@ Restoring from a Backup (R4.0 and later) **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. All backups made from a Qubes R4.0 system will be encrypted. -5. You will now the the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. +5. You will now see the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. 6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. @@ -112,7 +112,7 @@ Restoring from a Backup (R3.2 and earlier) 2. Select the source location of the backup to be restored: - - If your backup is located on a [USB mass storage device](/doc/stick-mounting/), attach it first to another VM or select `sys-usb` in the next item. + - If your backup is located on a [USB mass storage device](/doc/usb/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click or select it and hit **OK**. @@ -128,7 +128,7 @@ Restoring from a Backup (R3.2 and earlier) **Note:** A VM cannot be restored from a backup if a VM with the same name already exists on the current system. You must first remove or change the name of any VM with the same name in order to restore such a VM. -5. You will now the the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. +5. You will now see the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. 6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. From 6dda05712e217e37a3975aa7af2c2b8f1469ce4c Mon Sep 17 00:00:00 2001 From: awokd <34515595+awokd@users.noreply.github.com> Date: Mon, 5 Feb 2018 15:15:13 +0000 Subject: [PATCH 8/8] add linebreaks, use US spelling of grey --- common-tasks/backup-restore.md | 141 +++++++++++++++++++++++---------- 1 file changed, 101 insertions(+), 40 deletions(-) diff --git a/common-tasks/backup-restore.md b/common-tasks/backup-restore.md index d07e1e1a..24be5e44 100644 --- a/common-tasks/backup-restore.md +++ b/common-tasks/backup-restore.md @@ -11,22 +11,27 @@ redirect_from: Qubes Backup, Restoration, and Migration ======================================== -**Caution:** The Qubes R3.2 backup system currently relies on a [weak key derivation scheme](https://github.com/QubesOS/qubes-issues/issues/971). Although resolved in R4.0 and higher with the switch to scrypt, it is *strongly recommended* that users select a *high-entropy* passphrase for use with Qubes backups. +**Caution:** The Qubes R3.2 backup system currently relies on a [weak key derivation scheme](https://github.com/QubesOS/qubes-issues/issues/971). +Although resolved in R4.0 and higher with the switch to scrypt, it is *strongly recommended* that users select a *high-entropy* passphrase for use with Qubes backups. With Qubes, it's easy to back up and restore your whole system, as well as to migrate between two physical machines. -As of Qubes R2B3, these functions are integrated into the Qubes VM Manager GUI. There are also two command-line tools available which perform the same functions: [qvm-backup](/doc/dom0-tools/qvm-backup/) and [qvm-backup-restore](/doc/dom0-tools/qvm-backup-restore/). +As of Qubes R2B3, these functions are integrated into the Qubes VM Manager GUI. +There are also two command-line tools available which perform the same functions: [qvm-backup](/doc/dom0-tools/qvm-backup/) and [qvm-backup-restore](/doc/dom0-tools/qvm-backup-restore/). Creating a Backup (R4.0 and later) ----------------- -1. Go to **Applications menu -> System Tools -> Backup Qubes**. This brings up the **Qubes Backup VMs** window. +1. Go to **Applications menu -> System Tools -> Backup Qubes**. +This brings up the **Qubes Backup VMs** window. -2. Move the VMs that you want to back up to the right-hand **Selected** column. VMs in the left-hand **Available** column will not be backed up. +2. Move the VMs that you want to back up to the right-hand **Selected** column. +VMs in the left-hand **Available** column will not be backed up. - You may choose whether to compress backups by checking or unchecking the **Compress the backup** box. Normally this should be left on unless you have a specific reason otherwise. + You may choose whether to compress backups by checking or unchecking the **Compress the backup** box. + Normally this should be left on unless you have a specific reason otherwise. Once you have selected all desired VMs, click **Next**. @@ -35,9 +40,14 @@ Creating a Backup (R4.0 and later) If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. If you wish to send your backup to a [USB mass storage device](/doc/usb/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. - You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. This destination directory must already exist. If it does not exist, you must create it manually prior to backing up. + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. + For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. + This destination directory must already exist. + If it does not exist, you must create it manually prior to backing up. - By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. + By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. + Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. + This can be used to send your backup directly to, e.g., a remote server using SSH. **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. @@ -45,18 +55,24 @@ Creating a Backup (R4.0 and later) **Warning: Saving the settings will result in your backup passphrase being saved in plaintext in dom0, so consider your threat model before checking this box.** -4. You will now see the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. +4. You will now see the summary of VMs to be backed up. +If there are any issues preventing the backup, they will be listed here and the **Next** button grayed out. -5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. +5. When you are ready, click **Next**. +Qubes will proceed to create your backup. +Once the progress bar has completed, you may click **Finish**. Creating a Backup (R3.2 and earlier) ----------------- -1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Backup VMs** in the drop-down list. This brings up the **Qubes Backup VMs** window. +1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Backup VMs** in the drop-down list. +This brings up the **Qubes Backup VMs** window. -2. Move the VMs that you want to back up to the right-hand **Selected** column. VMs in the left-hand **Available** column will not be backed up. +2. Move the VMs that you want to back up to the right-hand **Selected** column. +VMs in the left-hand **Available** column will not be backed up. - **Note:** A VM must be shut down in order to be backed up. Currently running VMs appear in red. + **Note:** A VM must be shut down in order to be backed up. + Currently running VMs appear in red. Once you have selected all desired VMs, click **Next**. @@ -65,78 +81,114 @@ Creating a Backup (R3.2 and earlier) If you wish to send your backup to a (currently running) VM, select the VM in the drop-down box next to **Target AppVM**. If you wish to send your backup to a [USB mass storage device](/doc/usb/), you can use the directory selection widget to mount a connected device (under "Other locations" item on the left); or first mount the device in a VM, then select the mount point inside that VM as the backup destination. - You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. If it does not exist, you must create it manually prior to backing up. + You must also specify a directory on the device or in the VM, or a command to be executed in the VM as a destination for your backup. + For example, if you wish to send your backup to the `~/backups` folder in the target VM, you would simply browse to it using the convenient directory selection dialog (`...`) at the right. + If it does not exist, you must create it manually prior to backing up. - By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. This can be used to send your backup directly to, e.g., a remote server using SSH. + By specifying the appropriate directory as the destination in a VM, it is possible to send the backup directly to, e.g., a USB mass storage device attached to the VM. + Likewise, it is possible to enter any command as a backup target by specifying the command as the destination in the VM. + This can be used to send your backup directly to, e.g., a remote server using SSH. At this point, you must also choose whether to encrypt your backup by checking or unchecking the **Encrypt backup** box. **Note:** It is strongly recommended that you opt to encrypt all backups which will be sent to untrusted destinations! - **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. If you decide not to encrypt your backup (by unchecking the **Encrypt backup** box), the passphrase you supply will be used **only** for integrity verification. If you supply a passphrase but do not check the **Encrypt backup** box, your backup will **not** be encrypted! + **Note:** The supplied passphrase is used for **both** encryption/decryption and integrity verification. + If you decide not to encrypt your backup (by unchecking the **Encrypt backup** box), the passphrase you supply will be used **only** for integrity verification. + If you supply a passphrase but do not check the **Encrypt backup** box, your backup will **not** be encrypted! -4. You will now see the summary of VMs to be backed up. If there are any issues preventing the backup, they will be listed here and the **Next** button greyed out. +4. You will now see the summary of VMs to be backed up. +If there are any issues preventing the backup, they will be listed here and the **Next** button grayed out. -5. When you are ready, click **Next**. Qubes will proceed to create your backup. Once the progress bar has completed, you may click **Finish**. +5. When you are ready, click **Next**. +Qubes will proceed to create your backup. +Once the progress bar has completed, you may click **Finish**. Restoring from a Backup (R4.0 and later) ----------------------- -1. Go to **Applications menu -> System Tools -> Restore Backup**. This brings up the **Qubes Restore VMs** window. +1. Go to **Applications menu -> System Tools -> Restore Backup**. +This brings up the **Qubes Restore VMs** window. 2. Select the source location of the backup to be restored: - If your backup is located on a [USB mass storage device](/doc/usb/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. - You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click it or select it and hit **OK**. + You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. + If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. + For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. + Once you've located the backup file, double-click it or select it and hit **OK**. 3. There are three options you may select when restoring from a backup: 1. **ignore missing templates and net VMs**: If any of the VMs in your backup depended upon a NetVM or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway and set them to use the default NetVM and system default template. - 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. + 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. + If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. + 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. + However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. + See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. -4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. +4. If your backup is encrypted, you must check the **Encrypted backup** box. +If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. - **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. All backups made from a Qubes R4.0 system will be encrypted. + **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. + If the backup was not encrypted, the supplied passphrase is used only for integrity verification. + All backups made from a Qubes R4.0 system will be encrypted. -5. You will now see the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. +5. You will now see the summary of VMs to be restored. +If there are any issues preventing the restore, they will be listed here and the **Next** button grayed out. -6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. +6. When you are ready, click **Next**. +Qubes will proceed to restore from your backup. +Once the progress bar has completed, you may click **Finish**. Restoring from a Backup (R3.2 and earlier) ----------------------- -1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Restore VMs from backup** in the drop-down list. This brings up the **Qubes Restore VMs** window. +1. In **Qubes VM Manager**, click **System** on the menu bar, then click **Restore VMs from backup** in the drop-down list. +This brings up the **Qubes Restore VMs** window. 2. Select the source location of the backup to be restored: - If your backup is located on a [USB mass storage device](/doc/usb/), attach it first to another VM or select `sys-usb` in the next item. - If your backup is located in a (currently running) VM, select the VM in the drop-down box next to **AppVM**. - You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. Once you've located the backup file, double-click or select it and hit **OK**. + You must also specify the directory and filename of the backup (or a command to be executed in a VM) in the **Backup file** field. + If you followed the instructions in the previous section, "Creating a Backup," then your backup is most likely in the location you chose as the destination in step 3. + For example, if you had chosen the `~/backups` directory of a VM as your destination in step 3, you would now select the same VM and again browse to (using `...`) the `backups` folder. + Once you've located the backup file, double-click or select it and hit **OK**. 3. There are three options you may select when restoring from a backup: 1. **ignore missing**: If any of the VMs in your backup depended upon a NetVM, ProxyVM, or TemplateVM that is not present in (i.e., "missing from") the current system, checking this box will ignore the fact that they are missing and restore the VMs anyway and set them to use the default NetVM and system default template. - 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. - 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. + 2. **ignore username mismatch**: This option applies only to the restoration of dom0's home directory. + If your backup was created on a Qubes system which had a different dom0 username than the dom0 username of the current system, then checking this box will ignore the mismatch between the two usernames and proceed to restore the home directory anyway. + 3. **Verify backup integrity, do not restore the data**: This will scan the backup file for corrupted data. + However, it does not currently detect if it is missing data as long as it is a correctly structured, non-corrupted backup file. See [issue #3498](https://github.com/QubesOS/qubes-issues/issues/3498) for more details. -4. If your backup is encrypted, you must check the **Encrypted backup** box. If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. +4. If your backup is encrypted, you must check the **Encrypted backup** box. +If a passphrase was supplied during the creation of your backup (regardless of whether it is encrypted), then you must supply it here. - **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. If the backup was not encrypted, the supplied passphrase is used only for integrity verification. + **Note:** The passphrase which was supplied when the backup was created was used for **both** encryption/decryption and integrity verification. + If the backup was not encrypted, the supplied passphrase is used only for integrity verification. - **Note:** A VM cannot be restored from a backup if a VM with the same name already exists on the current system. You must first remove or change the name of any VM with the same name in order to restore such a VM. + **Note:** A VM cannot be restored from a backup if a VM with the same name already exists on the current system. + You must first remove or change the name of any VM with the same name in order to restore such a VM. -5. You will now see the summary of VMs to be restored. If there are any issues preventing the restore, they will be listed here and the **Next** button greyed out. +5. You will now see the summary of VMs to be restored. +If there are any issues preventing the restore, they will be listed here and the **Next** button grayed out. -6. When you are ready, click **Next**. Qubes will proceed to restore from your backup. Once the progress bar has completed, you may click **Finish**. +6. When you are ready, click **Next**. +Qubes will proceed to restore from your backup. +Once the progress bar has completed, you may click **Finish**. Emergency Backup Recovery without Qubes --------------------------------------- -The Qubes backup system has been designed with emergency disaster recovery in mind. No special Qubes-specific tools are required to access data backed up by Qubes. In the event a Qubes system is unavailable, you can access your data on any GNU/Linux system with the following procedure. +The Qubes backup system has been designed with emergency disaster recovery in mind. +No special Qubes-specific tools are required to access data backed up by Qubes. +In the event a Qubes system is unavailable, you can access your data on any GNU/Linux system with the following procedure. Refer to the following for emergency restore of a backup created on: @@ -148,20 +200,29 @@ Refer to the following for emergency restore of a backup created on: Migrating Between Two Physical Machines --------------------------------------- -In order to migrate your Qubes system from one physical machine to another, simply follow the backup procedure on the old machine, [install Qubes](/downloads/) on the new machine, and follow the restoration procedure on the new machine. All of your settings and data will be preserved! +In order to migrate your Qubes system from one physical machine to another, simply follow the backup procedure on the old machine, [install Qubes](/downloads/) on the new machine, and follow the restoration procedure on the new machine. +All of your settings and data will be preserved! Choosing a Backup Passphrase ---------------------------- Here are some things to consider when selecting a passphrase for your backups: - * If you plan to store the backup for a long time or on third-party servers, you should make sure to use a very long, high-entropy passphrase. (Depending on the decryption passphrase you use for your system drive, this may necessitate selecting a stronger passphrase. If your system drive decryption passphrase is already sufficiently strong, it may not.) - * An adversary who has access to your backups may try to substitute one backup for another. For example, when you attempt to retrieve a recent backup, the adversary may instead give you a very old backup containing a compromised VM. If you're concerned about this type of attack, you may wish to use a different passphrase for each backup, e.g., by appending a number or date to the passphrase. - * If you're forced to enter your system drive decryption passphrase in plain view of others (where it can be shoulder-surfed), then you may want to use a different passphrase for your backups (even if your system drive decryption passphrase is already maximally strong). On the othe hand, if you're careful to avoid shoulder-surfing and/or have a passphrase that's difficult to detect via shoulder-surfing, then this may not be a problem for you. + * If you plan to store the backup for a long time or on third-party servers, you should make sure to use a very long, high-entropy passphrase. + (Depending on the decryption passphrase you use for your system drive, this may necessitate selecting a stronger passphrase. + If your system drive decryption passphrase is already sufficiently strong, it may not.) + * An adversary who has access to your backups may try to substitute one backup for another. + For example, when you attempt to retrieve a recent backup, the adversary may instead give you a very old backup containing a compromised VM. + If you're concerned about this type of attack, you may wish to use a different passphrase for each backup, e.g., by appending a number or date to the passphrase. + * If you're forced to enter your system drive decryption passphrase in plain view of others (where it can be shoulder-surfed), then you may want to use a different passphrase for your backups (even if your system drive decryption passphrase is already maximally strong). + On the othe hand, if you're careful to avoid shoulder-surfing and/or have a passphrase that's difficult to detect via shoulder-surfing, then this may not be a problem for you. Notes ----- - * The Qubes R3.2 and earlier backup system relies on `openssl enc`, which is known to use a very weak key derivation scheme. The Qubes backup system also uses the same passphrase for authentication and for encryption, which is problematic from a security perspective. Users are advised to use a very high entropy passphrase for Qubes backups. For a full discussion, see [this ticket](https://github.com/QubesOS/qubes-issues/issues/971) and [this thread](https://groups.google.com/d/msg/qubes-devel/CZ7WRwLXcnk/u_rZPoVxL5IJ). + * The Qubes R3.2 and earlier backup system relies on `openssl enc`, which is known to use a very weak key derivation scheme. + The Qubes backup system also uses the same passphrase for authentication and for encryption, which is problematic from a security perspective. + Users are advised to use a very high entropy passphrase for Qubes backups. + For a full discussion, see [this ticket](https://github.com/QubesOS/qubes-issues/issues/971) and [this thread](https://groups.google.com/d/msg/qubes-devel/CZ7WRwLXcnk/u_rZPoVxL5IJ). * For the technical details of the backup system, please refer to [this thread](https://groups.google.com/d/topic/qubes-devel/TQr_QcXIVww/discussion). * If working with symlinks, note the issues described in [this thread](https://groups.google.com/d/topic/qubes-users/EITd1kBHD30/discussion).