public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command
@ 2020-11-09 12:39 Dylan Whyte
  2020-11-09 14:20 ` [pbs-devel] applied: " Thomas Lamprecht
  2020-11-09 16:14 ` [pbs-devel] " Dietmar Maurer
  0 siblings, 2 replies; 3+ messages in thread
From: Dylan Whyte @ 2020-11-09 12:39 UTC (permalink / raw)
  To: pbs-devel

adds a paragraph to the encryption section about
encoding the master key into a qr code for printing

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 docs/backup-client.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index a23535fa..1ef42898 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -365,9 +365,17 @@ To set up a master key:
   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. In preparation for the worst case scenario,
-  you should consider keeping a paper copy of this key locked away in
-  a safe place.
+  lost along with the broken system.
+
+In preparation for the worst case scenario, you should 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.
+
+.. code-block:: console
+
+  proxmox-backup-client key paperkey --output-format text > qrkey.txt
 
 
 Restoring Data
-- 
2.20.1





^ permalink raw reply	[flat|nested] 3+ messages in thread

* [pbs-devel] applied: [PATCH docs] backup-client: encryption: discuss paperkey command
  2020-11-09 12:39 [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command Dylan Whyte
@ 2020-11-09 14:20 ` Thomas Lamprecht
  2020-11-09 16:14 ` [pbs-devel] " Dietmar Maurer
  1 sibling, 0 replies; 3+ messages in thread
From: Thomas Lamprecht @ 2020-11-09 14:20 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Dylan Whyte

On 09.11.20 13:39, Dylan Whyte wrote:
> adds a paragraph to the encryption section about
> encoding the master key into a qr code for printing
> 
> Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> ---
>  docs/backup-client.rst | 14 +++++++++++---
>  1 file changed, 11 insertions(+), 3 deletions(-)
> 
>

applied, thanks!




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command
  2020-11-09 12:39 [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command Dylan Whyte
  2020-11-09 14:20 ` [pbs-devel] applied: " Thomas Lamprecht
@ 2020-11-09 16:14 ` Dietmar Maurer
  1 sibling, 0 replies; 3+ messages in thread
From: Dietmar Maurer @ 2020-11-09 16:14 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Dylan Whyte

paperkey should be the last resort.

I store keys in:

1.) my passwork manager (very easy to access)
2.) USB stick, and put that in my vault (still easy to restore)
3.) paperkey (clumsy to restore, but useful if the USB stick is damaged)

> On 11/09/2020 1:39 PM Dylan Whyte <d.whyte@proxmox.com> wrote:
> 
>  
> adds a paragraph to the encryption section about
> encoding the master key into a qr code for printing
> 
> Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> ---
>  docs/backup-client.rst | 14 +++++++++++---
>  1 file changed, 11 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
> index a23535fa..1ef42898 100644
> --- a/docs/backup-client.rst
> +++ b/docs/backup-client.rst
> @@ -365,9 +365,17 @@ To set up a master key:
>    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. In preparation for the worst case scenario,
> -  you should consider keeping a paper copy of this key locked away in
> -  a safe place.
> +  lost along with the broken system.
> +
> +In preparation for the worst case scenario, you should 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.
> +
> +.. code-block:: console
> +
> +  proxmox-backup-client key paperkey --output-format text > qrkey.txt
>  
>  
>  Restoring Data
> -- 
> 2.20.1
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel




^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-11-09 16:15 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-09 12:39 [pbs-devel] [PATCH docs] backup-client: encryption: discuss paperkey command Dylan Whyte
2020-11-09 14:20 ` [pbs-devel] applied: " Thomas Lamprecht
2020-11-09 16:14 ` [pbs-devel] " Dietmar Maurer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal