mirror of https://github.com/borgbackup/borg.git
docs: clarify borg init's encryption modes
This commit is contained in:
parent
80e381c6ea
commit
b5d6e23d84
|
@ -11,7 +11,9 @@ Examples
|
||||||
$ borg init --encryption=none /path/to/repo
|
$ borg init --encryption=none /path/to/repo
|
||||||
|
|
||||||
# Remote repository (accesses a remote borg via ssh)
|
# Remote repository (accesses a remote borg via ssh)
|
||||||
|
# repokey: stores the (encrypted) key into <REPO_DIR>/config
|
||||||
$ borg init --encryption=repokey-blake2 user@hostname:backup
|
$ borg init --encryption=repokey-blake2 user@hostname:backup
|
||||||
|
|
||||||
# Remote repository (store the key your home dir)
|
# Remote repository (accesses a remote borg via ssh)
|
||||||
|
# keyfile: stores the (encrypted) key into ~/.config/borg/keys/
|
||||||
$ borg init --encryption=keyfile user@hostname:backup
|
$ borg init --encryption=keyfile user@hostname:backup
|
||||||
|
|
|
@ -3617,7 +3617,11 @@ class Archiver:
|
||||||
It is not recommended to work without encryption. Repository encryption protects
|
It is not recommended to work without encryption. Repository encryption protects
|
||||||
you e.g. against the case that an attacker has access to your backup repository.
|
you e.g. against the case that an attacker has access to your backup repository.
|
||||||
|
|
||||||
But be careful with the key / the passphrase:
|
Borg relies on randomly generated key material and uses that for chunking, id
|
||||||
|
generation, encryption and authentication. The key material is encrypted using
|
||||||
|
the passphrase you give before it is stored on-disk.
|
||||||
|
|
||||||
|
You need to be careful with the key / the passphrase:
|
||||||
|
|
||||||
If you want "passphrase-only" security, use one of the repokey modes. The
|
If you want "passphrase-only" security, use one of the repokey modes. The
|
||||||
key will be stored inside the repository (in its "config" file). In above
|
key will be stored inside the repository (in its "config" file). In above
|
||||||
|
@ -3655,6 +3659,12 @@ class Archiver:
|
||||||
Encryption modes
|
Encryption modes
|
||||||
++++++++++++++++
|
++++++++++++++++
|
||||||
|
|
||||||
|
You can choose from the encryption modes seen in the table below on a per-repo
|
||||||
|
basis. The mode determines encryption algorithm, hash/MAC algorithm and also the
|
||||||
|
key storage location.
|
||||||
|
|
||||||
|
Example: `borg init --encryption repokey ...`
|
||||||
|
|
||||||
.. nanorst: inline-fill
|
.. nanorst: inline-fill
|
||||||
|
|
||||||
+----------+---------------+------------------------+--------------------------+
|
+----------+---------------+------------------------+--------------------------+
|
||||||
|
@ -3670,7 +3680,8 @@ class Archiver:
|
||||||
|
|
||||||
.. nanorst: inline-replace
|
.. nanorst: inline-replace
|
||||||
|
|
||||||
`Marked modes` are new in Borg 1.1 and are not backwards-compatible with Borg 1.0.x.
|
Modes `marked like this` in the above table are new in Borg 1.1 and are not
|
||||||
|
backwards-compatible with Borg 1.0.x.
|
||||||
|
|
||||||
On modern Intel/AMD CPUs (except very cheap ones), AES is usually
|
On modern Intel/AMD CPUs (except very cheap ones), AES is usually
|
||||||
hardware-accelerated.
|
hardware-accelerated.
|
||||||
|
@ -3703,8 +3714,8 @@ class Archiver:
|
||||||
This mode is new and *not* compatible with Borg 1.0.x.
|
This mode is new and *not* compatible with Borg 1.0.x.
|
||||||
|
|
||||||
`none` mode uses no encryption and no authentication. It uses SHA256 as chunk
|
`none` mode uses no encryption and no authentication. It uses SHA256 as chunk
|
||||||
ID hash. Not recommended, rather consider using an authenticated or
|
ID hash. This mode is not recommended, you should rather consider using an authenticated
|
||||||
authenticated/encrypted mode. This mode has possible denial-of-service issues
|
or authenticated/encrypted mode. This mode has possible denial-of-service issues
|
||||||
when running ``borg create`` on contents controlled by an attacker.
|
when running ``borg create`` on contents controlled by an attacker.
|
||||||
Use it only for new repositories where no encryption is wanted **and** when compatibility
|
Use it only for new repositories where no encryption is wanted **and** when compatibility
|
||||||
with 1.0.x is important. If compatibility with 1.0.x is not important, use
|
with 1.0.x is important. If compatibility with 1.0.x is not important, use
|
||||||
|
|
Loading…
Reference in New Issue