docs: add DoS warning for none encryption mode, fixes #6715

This commit is contained in:
TW 2026-05-13 09:55:36 +02:00 committed by GitHub
parent 0e94055d27
commit d84eeea84d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 5 deletions

View file

@ -805,6 +805,8 @@ b) with ``create --chunker-params buzhash,19,23,21,4095`` (default):
You'll save some memory, but it will need to read / chunk all the files as
it can not skip unmodified files then.
.. _internals_hashindex:
HashIndex
---------

View file

@ -3058,6 +3058,7 @@ class Archiver:
'borg_key_export': 'borg key export --help',
'borg_key_change-passphrase': 'borg key change-passphrase',
'environment-variables': 'Environment Variables',
'internals_hashindex': 'Internals -> Data structures and file formats -> HashIndex',
}
def process_epilog(epilog):
@ -4756,11 +4757,11 @@ class Archiver:
compatible with Borg 1.1 and later.
``none`` mode uses no encryption and no authentication. It uses SHA256
as chunk ID hash. This mode is not recommended. You should instead
consider using an authenticated or authenticated/encrypted mode. This
mode has possible denial-of-service issues when running ``borg create``
on contents controlled by an attacker. See above for alternatives.
This mode is compatible with all Borg versions.
as chunk ID hash. This mode is not recommended
as it is vulnerable to DoS attacks by an attacker (for example,
crafting content that causes hash index collisions). Do not use it if
untrusted clients use the repository. See :ref:`internals_hashindex` for
details. This mode is compatible with all Borg versions.
""")
subparser = subparsers.add_parser('init', parents=[common_parser], add_help=False,
description=self.do_init.__doc__, epilog=init_epilog,