Selaa lähdekoodia

warn users about the environment on multi-user systems

Antoine Beaupré 9 vuotta sitten
vanhempi
sitoutus
5cd5fa72f6
2 muutettua tiedostoa jossa 11 lisäystä ja 1 poistoa
  1. 5 0
      docs/faq.rst
  2. 6 1
      docs/quickstart.rst

+ 5 - 0
docs/faq.rst

@@ -81,6 +81,11 @@ automated encrypted backups. Another option is to use
 key file based encryption with a blank passphrase. See
 key file based encryption with a blank passphrase. See
 :ref:`encrypted_repos` for more details.
 :ref:`encrypted_repos` for more details.
 
 
+.. caution:: When passing the passphrase through the environment, the
+             passphrase can be read by any user on the same system, so
+             the use of this technique is strongly discouraged on
+             multi-user systems.
+
 When backing up to remote encrypted repos, is encryption done locally?
 When backing up to remote encrypted repos, is encryption done locally?
 ----------------------------------------------------------------------
 ----------------------------------------------------------------------
      
      

+ 6 - 1
docs/quickstart.rst

@@ -150,7 +150,12 @@ by providing the correct passphrase.
 For automated backups the passphrase can be specified using the
 For automated backups the passphrase can be specified using the
 `BORG_PASSPHRASE` environment variable.
 `BORG_PASSPHRASE` environment variable.
 
 
-**The repository data is totally inaccessible without the key:**
+.. caution:: When passing the passphrase through the environment, the
+             passphrase can be read by any user on the same system, so
+             the use of this technique is strongly discouraged on
+             multi-user systems.
+
+.. important:: The repository data is totally inaccessible without the key:**
     Make a backup copy of the key file (``keyfile`` mode) or repo config
     Make a backup copy of the key file (``keyfile`` mode) or repo config
     file (``repokey`` mode) and keep it at a safe place, so you still have
     file (``repokey`` mode) and keep it at a safe place, so you still have
     the key in case it gets corrupted or lost.
     the key in case it gets corrupted or lost.