changes.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707
  1. .. _important_notes:
  2. Important notes 2.x
  3. ===================
  4. This section provides information about security and corruption issues.
  5. (nothing to see here yet)
  6. .. _upgradenotes2:
  7. Upgrade Notes
  8. =============
  9. borg 1.2.x to borg 2.0
  10. ----------------------
  11. Compatibility notes:
  12. - this is a major "breaking" release that is not compatible with existing repos.
  13. We tried to put all the necessary "breaking" changes into this release, so we
  14. hopefully do not need another breaking release in the near future. The changes
  15. were necessary for improved security, improved speed, unblocking future
  16. improvements, getting rid of legacy crap / design limitations, having less and
  17. simpler code to maintain.
  18. You can use "borg transfer" to transfer archives from borg 1.1/1.2 repos to
  19. a new borg 2.0 repo, but it will need some time and space.
  20. Before using "borg transfer", you must have upgraded to borg >= 1.2.6 (or
  21. another borg version that was patched to fix CVE-2023-CVE-2023-36811) and
  22. you must have followed the upgrade instructions at top of the change log
  23. relating to manifest and archive TAMs (borg2 just requires these TAMs now).
  24. - command line syntax was changed, scripts and wrappers will need changes:
  25. - you will usually either export BORG_REPO=<MYREPO> into your environment or
  26. call borg like: "borg -r <MYREPO> <COMMAND>".
  27. in the docs, we usually omit "-r ..." for brevity.
  28. - the scp-style REPO syntax was removed, please use ssh://..., #6697
  29. - ssh:// URLs: removed support for /~otheruser/, #6855.
  30. If you used this, just replace it by: ssh://user@host:port/home/otheruser/
  31. - -P / --prefix option was removed, please use the similar -a / --match-archives.
  32. - the archive name is always given separately from the repository
  33. (differently than with borg 1.x you must not give repo::archive).
  34. - the archive name is either given as a positional parameter, like:
  35. - borg create myarchive2 /some/path
  36. - borg diff myarchive1 myarchive2
  37. - or, if the command makes sense for an arbitrary amount of archives, archives
  38. can be selected using a glob pattern, like:
  39. - borg delete -a 'sh:myarchive*'
  40. - borg recreate -a 'sh:myarchive*'
  41. - some borg 1.x commands that supported working on a repo AND on an archive
  42. were split into 2 commands, some others were renamed:
  43. - borg 2 repo commands:
  44. - borg rcreate # "repo create", was: borg init
  45. - borg rlist # "repo list"
  46. - borg rinfo # "repo info"
  47. - borg rdelete # "repo delete"
  48. - borg 2 archive commands:
  49. - borg create ARCHIVE ...
  50. - borg list ARCHIVE
  51. - borg extract ARCHIVE ...
  52. - borg diff ARCH1 ARCH2
  53. - borg rename OLDNAME NEWNAME
  54. - borg info -a ARCH_GLOB
  55. - borg delete -a ARCH_GLOB
  56. - borg recreate -a ARCH_GLOB ...
  57. - borg mount -a ARCH_GLOB mountpoint ...
  58. For more details, please consult the docs or --help option output.
  59. - create/recreate/import-tar --timestamp: defaults to local timezone
  60. now (was: UTC)
  61. - some deprecated options were removed:
  62. - removed --remote-ratelimit (use --upload-ratelimit)
  63. - removed --numeric-owner (use --numeric-ids)
  64. - removed --nobsdflags (use --noflags)
  65. - removed --noatime (default now, see also --atime)
  66. - removed --save-space option (does not change behaviour)
  67. - using --list together with --progress is now disallowed (except with --log-json), #7219
  68. - the --glob-archives option was renamed to --match-archives (the short option
  69. name -a is unchanged) and extended to support different pattern styles:
  70. - id: for identical string match (this is the new default!)
  71. - sh: for shell pattern / globbing match (this was used by --glob-archives)
  72. - re: for regular expression match
  73. So you might need to edit your scripts like e.g.::
  74. borg 1.x: --glob-archives 'myserver-*'
  75. borg 2.0: --match-archives 'sh:myserver-*'
  76. - use platformdirs 3.x.x instead of home-grown code. Due to that:
  77. - XDG_*_HOME is not honoured on macOS and on Windows.
  78. - BORG_BASE_DIR can still be used to enforce some base dir + .config/ or .cache/.
  79. - the default macOS config and cache dir will now be in ~/Library/Application Support/borg/.
  80. - create: different included/excluded status chars, #7321
  81. - dry-run: now uses "+" (was: "-") and "-" (was: "x") for included/excluded status
  82. - non-dry-run: now uses "-" (was: "x") for excluded files
  83. Option --filter=... might need an update, if you filter for the status chars
  84. that were changed.
  85. - borg is now more strict and disallows giving some options multiple times -
  86. if that makes no sense. Highlander options, see #6269. That might make scripts
  87. fail now that somehow "worked" before (but maybe didn't work as intended due to
  88. the contradicting options).
  89. .. _changelog:
  90. Change Log 2.x
  91. ==============
  92. Version 2.0.0b8 (2024-02-20)
  93. ----------------------------
  94. Please note:
  95. This is a beta release, only for testing - do not use for production repos.
  96. For upgrade and compatibility hints, please also read the section "Upgrade Notes"
  97. above.
  98. New features:
  99. - create: add the slashdot hack, update docs, #4685
  100. - BORG_EXIT_CODES=modern: optional more specific return codes (for errors and warnings).
  101. The default value of this new environment variable is "legacy", which should result in
  102. a behaviour similar to borg 1.2 and older (only using rc 0, 1 and 2).
  103. "modern" exit codes are much more specific (see the internals/frontends docs).
  104. - implement "borg version" (shows client and server version), #7829
  105. Fixes:
  106. - docs: CVE-2023-36811 upgrade steps: consider checkpoint archives, #7802
  107. - check/compact: fix spurious reappearance of orphan chunks since borg 1.2, #6687 -
  108. this consists of 2 fixes:
  109. - for existing chunks: check --repair: recreate shadow index, #7897 #6687
  110. - for newly created chunks: update shadow index when doing a double-put, #7896 #5661
  111. If you have experienced issue #6687, you may want to run borg check --repair
  112. after upgrading to borg 1.2.7 to recreate the shadow index and get rid of the
  113. issue for existing chunks.
  114. - check: fix return code for index entry value discrepancies
  115. - LockRoster.modify: no KeyError if element was already gone, #7937
  116. - create --X-from-command: run subcommands with a clean environment, #7916
  117. - list --sort-by: support "archive" as alias of "name", #7873
  118. - fix rc and msg if arg parsing throws an exception, #7885
  119. - PATH: do not accept empty strings, #4221
  120. - fix invalid pattern argument error msg
  121. - zlib legacy decompress fixes, #7883
  122. Other changes:
  123. - replace archive/manifest TAMs by typed repo objects (ro_type), docs, #7670
  124. - crypto: use a one-step kdf for session keys, #7953
  125. - remove recreate --recompress option, use the more efficient repo-wide "rcompress".
  126. - include unistd.h in _chunker.c (fix for Python 3.13)
  127. - allow msgpack 1.0.7
  128. - allow platformdirs 4, #7950
  129. - use and require cython3
  130. - move conftest.py to src/borg/testsuite, #6386
  131. - use less setup.py, use pip and build
  132. - linux: use pkgconfig to find libacl
  133. - borg.logger: use same method params as python logging
  134. - create and use Brewfile, document "brew bundle" install (macOS)
  135. - blacken master branch
  136. - prevent CLI argument issues in scripts/glibc_check.py
  137. - pyproject.toml: exclude source files which have been compiled, #7828
  138. - sdist: dynamically compute readme (long_description)
  139. - init: better borg key export instructions
  140. - scripts/make.py: move clean, build_man, build_usage to there,
  141. so we do not need to invoke setup.py directly, update docs
  142. - vagrant:
  143. - use openssl 3.0 on macOS
  144. - add script for fetching borg binaries from VMs, #7989
  145. - use generic/openbsd7 box
  146. - netbsd: test on py311 only
  147. - remove debian 9 "stretch" box
  148. - use freebsd 14, #6871
  149. - use python 3.9.4 for tests, latest python 3.11.7 for binary builds
  150. - use pyinstaller 6.3.0
  151. - docs:
  152. - add typical PR workflow to development docs, #7495
  153. - improve docs for borg with-lock, add example #8024
  154. - create disk/partition sector backup by disk serial number
  155. - Add "check.rebuild_refcounts" message
  156. - not only attack/unsafe, can also be a fs issue, #7853
  157. - use virtualenv on Cygwin
  158. - readthedocs: also build offline docs, #7835
  159. - do not refer to setup.py installation method
  160. - how to run the testsuite using the dist package
  161. - requirements are defined in pyproject.toml
  162. Version 2.0.0b7 (2023-09-14)
  163. ----------------------------
  164. New features:
  165. - BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos
  166. without having the borg key, #7700
  167. Fixes:
  168. - archive tam verify security fix, fixes CVE-2023-36811
  169. - remote logging/progress: use callback to send queued records, #7662
  170. - make_path_safe: remove test for backslashes, #7651
  171. - benchmark cpu: use sanitized path, #7654
  172. - create: do not try to read parent dir of recursion root, #7746
  173. Other changes:
  174. - always implicitly require archive TAMs (all archives have TAMs since borg 1.2.6)
  175. - always implicitly require manifest TAMs (manifests have TAMs since borg 1.0.9)
  176. - rlist: remove support for {tam} placeholder, archives are now always TAM-authenticated.
  177. - support / test on Python 3.12
  178. - allow msgpack 1.0.6 (which has py312 wheels), #7810
  179. - manifest: move item_keys into config dict (manifest.version == 2 now), #7710
  180. - replace "datetime.utcfromtimestamp" to avoid deprecation warnings with Python 3.12
  181. - properly normalise paths on Windows (forward slashes, integrate drive letter into path)
  182. - Docs:
  183. - move upgrade / compat. notes to own section, see #7546
  184. - fix borg delete examples, #7759
  185. - improve rcreate / related repos docs
  186. - automated-local.rst: use UUID for consistent udev rule
  187. - rewrite `borg check` docs, #7578
  188. - misc. other docs updates
  189. - Tests / CI / Vagrant:
  190. - major testsuite refactoring: a lot more tests now use pytest, #7626
  191. - freebsd: add some ACL tests, #7745
  192. - fix test_disk_full, #7617
  193. - fix failing test_get_runtime_dir test on OpenBSD, #7719
  194. - CI: run on ubuntu 22.04
  195. - CI: test building the docs
  196. - simplify flake8 config, fix some complaints
  197. - use pyinstaller 5.13.1 to build the borg binaries
  198. Version 2.0.0b6 (2023-06-11)
  199. ----------------------------
  200. New features:
  201. - diff: include changes in ctime and mtime, #7248
  202. - diff: sort JSON output alphabetically
  203. - diff --content-only: option added to ignore metadata changes
  204. - diff: add --format option, #4634
  205. - import-tar --ignore-zeros: new option to support importing concatenated tars, #7432
  206. - debug id-hash / parse-obj / format-obj: new debug commands, #7406
  207. - transfer --compression=C --recompress=M: recompress while transferring, #7529
  208. - extract --continue: continue a previously interrupted extraction, #1356
  209. - prune --list-kept/--list-pruned: only list the kept (or pruned) archives, #7511
  210. - prune --short/--format: enable users to format the list output, #3238
  211. - implement BORG_<CMD>_FORMAT env vars for prune, list, rlist, #5166
  212. - rlist: size and nfiles format keys
  213. - implement unix domain (ipc) socket support, #6183::
  214. borg serve --socket # server side (not started automatically!)
  215. borg -r socket:///path/to/repo ... # client side
  216. - add get_runtime_dir / BORG_RUNTIME_DIR (contains e.g. .sock and .pid file)
  217. - support shell-style alternatives, like: sh:image.{png,jpg}, #7602
  218. Fixes:
  219. - do not retry on permission errors (pointless)
  220. - transfer: verify chunks we get using assert_id, #7383
  221. - fix config/cache dir compatibility issues, #7445
  222. - xattrs: fix namespace processing on FreeBSD, #6997
  223. - ProgressIndicatorPercent: fix space computation for wide chars, #3027
  224. - delete: remove --cache-only option, #7440.
  225. for deleting the cache only, use: borg rdelete --cache-only
  226. - borg debug get-obj/put-obj: fixed chunk id
  227. - create: ignore empty paths, print warning, #5637
  228. - extract: support extraction of atime/mtime on win32
  229. - benchmark crud: use TemporaryDirectory below given path, #4706
  230. - Ensure that cli options specified with action=Highlander can only be set once, even
  231. if the set value is a default value. Add tests for action=Highlander, #7500, #6269.
  232. - Fix argparse error messages from misc. validators (being more specific).
  233. - put security infos into data dir, add BORG_DATA_DIR env var, #5760
  234. - setup.cfg: remove setup_requires (we have a pyproject.toml for that), #7574
  235. - do not crash for empty archives list in borg rlist date based matching, #7522
  236. - sanitize paths during archive creation and extraction, #7108 #7099
  237. - make sure we do not get backslashes into item paths
  238. Other changes:
  239. - allow msgpack 1.0.5 also
  240. - development.lock.txt: upgrade cython to 0.29.35, misc. other upgrades
  241. - clarify platformdirs requirements, #7393.
  242. 3.0.0 is only required for macOS due to breaking changes.
  243. 2.6.0 was the last breaking change for Linux/UNIX.
  244. - mount: improve mountpoint error msgs, see #7496
  245. - more Highlander options, #6269
  246. - Windows: simplify building (just use pip)
  247. - refactor toplevel exception handling, #6018
  248. - remove nonce management, related repo methods (not needed for borg2)
  249. - borg.remote: remove support for borg < 1.1.0
  250. ($LOG, logging setup, exceptions, rpc tuple data format, version)
  251. - new remote and progress logging, #7604
  252. - borg.logger: add logging debugging functionality
  253. - add function to clear empty directories at end of compact process
  254. - unify scanning and listing of segment dirs / segment files, #7597
  255. - replace `LRUCache` internals with `OrderedDict`
  256. - docs:
  257. - add installation instructions for Windows
  258. - improve --one-file-system help and docs (macOS APFS), #5618 #4876
  259. - BORG_KEY_FILE: clarify docs, #7444
  260. - installation: add link to OS dependencies, #7356
  261. - update FAQ about locale/unicode issues, #6999
  262. - improve mount options rendering, #7359
  263. - make timestamps in manual pages reproducible.
  264. - describe performing pull-backups via ssh remote forwarding
  265. - suggest to use forced command when using remote-forwarding via ssh
  266. - fix some -a / --match-archives docs issues
  267. - incl./excl. options header, clarify --path-from-stdin exclusive control
  268. - add note about MAX_DATA_SIZE
  269. - update security support docs
  270. - improve patterns help
  271. - CI / tests / vagrant:
  272. - added pre-commit for linting purposes, #7476
  273. - resolved mode bug and added sleep clause for darwin systems, #7470
  274. - "auto" compressor tests: do not assume zlib is better than lz4, #7363
  275. - add stretch64 VM with deps built from source
  276. - misc. other CI / test fixes and updates
  277. - vagrant: add lunar64 VM, fix packages_netbsd
  278. - avoid long ids in pytest output
  279. - tox: package = editable-legacy, #7580
  280. - tox under fakeroot: fix finding setup_docs, #7391
  281. - check buzhash chunksize distribution, #7586
  282. - use debian/bookworm64 box
  283. Version 2.0.0b5 (2023-02-27)
  284. ----------------------------
  285. New features:
  286. - create: implement retries for individual fs files
  287. (e.g. if a file changed while we read it, if a file had an OSError)
  288. - info: add used storage quota, #7121
  289. - transfer: support --progress
  290. - create/recreate/import-tar: add --checkpoint-volume option
  291. - support date-based matching for archive selection,
  292. add --newer/--older/--newest/--oldest options, #7062 #7296
  293. Fixes:
  294. - disallow --list with --progress, #7219
  295. - create: fix --list --dry-run output for directories, #7209
  296. - do no assume hardlink_master=True if not present, #7175
  297. - fix item_ptrs orphaned chunks of checkpoint archives
  298. - avoid orphan content chunks on BackupOSError, #6709
  299. - transfer: fix bug in obfuscated data upgrade code
  300. - fs.py: fix bug in f-string (thanks mypy!)
  301. - recreate: when --target is given, do not detect "nothing to do", #7254
  302. - locking (win32): deal with os.rmdir/listdir PermissionErrors
  303. - locking: thread id must be parsed as hex from lock file name
  304. - extract: fix mtime when ResourceFork xattr is set (macOS specific), #7234
  305. - recreate: without --chunker-params borg shall not rechunk, #7336
  306. - allow mixing --progress and --list in log-json mode
  307. - add "files changed while reading" to Statistics class, #7354
  308. - fixed keys determination in Statistics.__add__(), #7355
  309. Other changes:
  310. - use local time / local timezone to output timestamps, #7283
  311. - update development.lock.txt, including a setuptools security fix, #7227
  312. - remove --save-space option (does not change behaviour)
  313. - remove part files from final archive
  314. - remove --consider-part-files, related stats code, update docs
  315. - transfer: drop part files
  316. - check: show id of orphaned chunks
  317. - ArchiveItem.cmdline list-of-str -> .command_line str, #7246
  318. - Item: symlinks: rename .source to .target, #7245
  319. - Item: make user/group/uid/gid optional
  320. - create: do not store user/group for stdin data by default, #7249
  321. - extract: chown only if we have u/g info in archived item, #7249
  322. - export-tar: for items w/o uid/gid, default to 0/0, #7249
  323. - fix some uid/gid lookup code / tests for win32
  324. - cache.py: be less verbose during cache sync
  325. - update bash completion script commands and options, #7273
  326. - require and use platformdirs 3.x.x package, tests
  327. - better included/excluded status chars, docs, #7321
  328. - undef NDEBUG for chunker and hashindex (make assert() work)
  329. - assert_id: better be paranoid (add back same crypto code as in old borg), #7362
  330. - check --verify_data: always decompress and call assert_id(), #7362
  331. - make hashindex_compact simpler and probably faster, minor fixes, cleanups, more tests
  332. - hashindex minor fixes, refactor, tweaks, tests
  333. - pyinstaller: remove icon
  334. - validation / placeholders / JSON:
  335. - implement (text|binary)_to_json: key (text), key_b64 (base64(binary))
  336. - remove bpath, barchive, bcomment placeholders / JSON keys
  337. - archive metadata: make sure hostname and username have no surrogate escapes
  338. - text attributes (like archive name, comment): validate more strictly, #2290
  339. - transfer: validate archive names and comment before transfer
  340. - json output: use text_to_json (path, target), #6151
  341. - docs:
  342. - docs and comments consistency, readability and spelling fixes
  343. - fix --progress display description, #7180
  344. - document how borg deals with non-unicode bytes in JSON output
  345. - document another way to get UTF-8 encoding on stdin/stdout/stderr, #2273
  346. - pruning interprets timestamps in the local timezone where borg prune runs
  347. - shellpattern: add license, use copyright/license markup
  348. - key change-passphrase: fix --encryption value in examples
  349. - remove BORG_LIBB2_PREFIX (not used any more)
  350. - Installation: Update Fedora in distribution list, #7357
  351. - add .readthedocs.yaml (use py311, use non-shallow clone)
  352. - tests:
  353. - fix archiver tests on Windows, add running the tests to Windows CI
  354. - fix tox4 passenv issue, #7199
  355. - github actions updates (fix deprecation warnings)
  356. - add tests for borg transfer/upgrade
  357. - fix test hanging reading FIFO when `borg create` failed
  358. - mypy inspired fixes / updates
  359. - fix prune tests, prune in localtime
  360. - do not look up uid 0 / gid 0, but current process uid/gid
  361. - safe_unlink tests: use os.link to support win32 also
  362. - fix test_size_on_disk_accurate for large st_blksize, #7250
  363. - relaxed timestamp comparisons, use same_ts_ns
  364. - add test for extracted directory mtime
  365. - use "fail" chunker to test erroneous input file skipping
  366. Version 2.0.0b4 (2022-11-27)
  367. ----------------------------
  368. Fixes:
  369. - transfer/upgrade: fix borg < 1.2 chunker_params, #7079
  370. - transfer/upgrade: do not access Item._dict, #7077
  371. - transfer/upgrade: fix crash in borg transfer, #7156
  372. - archive.save(): always use metadata from stats, #7072
  373. - benchmark: fixed TypeError in compression benchmarks, #7075
  374. - fix repository.scan api minimum requirement
  375. - fix args.paths related argparsing, #6994
  376. Other changes:
  377. - tar_filter: recognize .tar.zst as zstd, #7093
  378. - adding performance statistics to borg create, #6991
  379. - docs: add rcompress to usage index
  380. - tests:
  381. - use github and MSYS2 for Windows CI, #7097
  382. - win32 and cygwin: test fixes / skip hanging test
  383. - vagrant / github CI: use python 3.11.0 / 3.10.8
  384. - vagrant:
  385. - upgrade pyinstaller to 5.6.2 (supports python 3.11)
  386. - use python 3.11 to build the borg binary
  387. Version 2.0.0b3 (2022-10-02)
  388. ----------------------------
  389. Fixes:
  390. - transfer: fix user/group == None crash with borg1 archives
  391. - compressors: avoid memoryview related TypeError
  392. - check: fix uninitialised variable if repo is completely empty, #7034
  393. - do not use version_tuple placeholder in setuptools_scm template, #7024
  394. - get_chunker: fix missing sparse=False argument, #7056
  395. New features:
  396. - rcompress: do a repo-wide (re)compression, #7037
  397. - implement pattern support for --match-archives, #6504
  398. - BORG_LOCK_WAIT=n env var to set default for --lock-wait option, #5279
  399. Other:
  400. - repository.scan: misc. fixes / improvements
  401. - metadata: differentiate between empty/zero and unknown, #6908
  402. - CI: test pyfuse3 with python 3.11
  403. - use more relative imports
  404. - make borg.testsuite.archiver a package, split archiver tests into many modules
  405. - support reading new, improved hashindex header format, #6960.
  406. added version number and num_empty to the HashHeader, fixed alignment.
  407. - vagrant: upgrade pyinstaller 4.10 -> 5.4.1, use python 3.9.14 for binary build
  408. - item.pyx: use more Cython (faster, uses less memory), #5763
  409. Version 2.0.0b2 (2022-09-10)
  410. ----------------------------
  411. Bug fixes:
  412. - xattrs / extended stat: improve exception handling, #6988
  413. - fix and refactor replace_placeholders, #6966
  414. New features:
  415. - support archive timestamps with utc offsets, adapt them when using
  416. borg transfer to transfer from borg 1.x repos (append +00:00 for UTC).
  417. - create/recreate/import-tar --timestamp: accept giving timezone via
  418. its utc offset. defaults to local timezone, if no utc offset is given.
  419. Other changes:
  420. - chunks: have separate encrypted metadata (ctype, clevel, csize, size)
  421. chunk = enc_meta_len16 + encrypted(msgpacked(meta)) + encrypted(compressed(data)).
  422. this breaks repo format compatibility, you need to create fresh repos!
  423. - repository api: flags support, #6982
  424. - OpenBSD only - statically link OpenSSL, #6474.
  425. Avoid conflicting with shared libcrypto from the base OS pulled in via dependencies.
  426. - restructured source code
  427. - update diagrams to odg format, #6928
  428. Version 2.0.0b1 (2022-08-08)
  429. ----------------------------
  430. New features:
  431. - massively increase archive metadata stream size limit, #1473.
  432. currently rather testing the code, scalability will improve later, see #6945.
  433. - rcreate --copy-crypt-key: copy crypt_key from key of other repo, #6710.
  434. default: create new, random authenticated encryption key.
  435. - prune/delete --checkpoint-interval=1800 and ctrl-c/SIGINT support, #6284
  436. Fixes:
  437. - ctrl-c must not kill important subprocesses, #6912
  438. - transfer: check whether ID hash method and chunker secret are same.
  439. add PlaintextKey and AuthenticatedKey support to uses_same_id_hash function.
  440. - check: try harder to create the key, #5719
  441. - SaveFile: use a custom mkstemp with mode support, #6933, #6400
  442. - make setuptools happy, #6874
  443. - fix misc. compiler warnings
  444. - list: fix {flags:<WIDTH>} formatting, #6081
  445. Other changes:
  446. - new crypto does not need to call ._assert_id(), update code and docs.
  447. https://github.com/borgbackup/borg/pull/6463#discussion_r925436156
  448. - check: --verify-data does not need to decompress with new crypto modes
  449. - Key: crypt_key instead of enc_key + enc_hmac_key, #6611
  450. - misc. docs updates and improvements
  451. - CI: test on macOS 12 without fuse / fuse tests
  452. - repository: add debug logging for issue #6687
  453. - _version.py: remove trailing blank, add LF at EOF (make pep8 checker happy)
  454. Version 2.0.0a4 (2022-07-17)
  455. ----------------------------
  456. New features:
  457. - recreate: consider level for recompression, #6698, #3622
  458. Other changes:
  459. - stop using libdeflate
  460. - CI: add mypy (if we add type hints, it can do type checking)
  461. - big changes to the source code:
  462. - split up archiver module, transform it into a package
  463. - use Black for automated code formatting
  464. - remove some legacy code
  465. - adapt/fix code for mypy
  466. - use language_level = 3str for cython (this will be the default in cython 3)
  467. - docs: document HardLinkManager and hlid, #2388
  468. Version 2.0.0a3 (2022-07-04)
  469. ----------------------------
  470. Fixes:
  471. - check repo version, accept old repos only for --other-repo (e.g. rcreate/transfer).
  472. v2 is the default repo version for borg 2.0. v1 repos must only be used in a
  473. read-only way, e.g. for --other-repo=V1_REPO with borg init and borg transfer!
  474. New features:
  475. - transfer: --upgrader=NoOp is the default.
  476. This is to support general-purpose transfer of archives between related borg2
  477. repos.
  478. - transfer: --upgrader=From12To20 must be used to transfer (and convert) archives
  479. from borg 1.2 repos to borg 2.0 repos.
  480. Other changes:
  481. - removed some deprecated options
  482. - removed -P (aka --prefix) option, #6806. The option -a (aka --glob-archives)
  483. can be used for same purpose and is more powerful, e.g.: -a 'PREFIX*'
  484. - rcreate: always use argon2 kdf for new repos, #6820
  485. - rcreate: remove legacy encryption modes for new repos, #6490
  486. Version 2.0.0a2 (2022-06-26)
  487. ----------------------------
  488. Changes:
  489. - split repo and archive name into separate args, #948
  490. - use -r or --repo or BORG_REPO env var to give the repository
  491. - use --other-repo or BORG_OTHER_REPO to give another repo (e.g. borg transfer)
  492. - use positional argument for archive name or `-a ARCH_GLOB`
  493. - remove support for scp-style repo specification, use ssh://...
  494. - simplify stats output: repo ops -> repo stats, archive ops -> archive stats
  495. - repository index: add payload size (==csize) and flags to NSIndex entries
  496. - repository index: set/query flags, iteration over flagged items (NSIndex)
  497. - repository: sync write file in get_fd
  498. - stats: deduplicated size now, was deduplicated compressed size in borg 1.x
  499. - remove csize support at most places in the code (chunks index, stats, get_size,
  500. Item.chunks)
  501. - replace problematic/ugly hardlink_master approach of borg 1.x by:
  502. - symmetric hlid (all hardlinks pointing to same inode have same hlid)
  503. - all archived hardlinked regular files have a chunks list
  504. - borg rcreate --other-repo=OTHER_REPO: reuse key material from OTHER_REPO, #6554.
  505. This is useful if you want to use borg transfer to transfer archives from an
  506. existing borg 1.1/1.2 repo. If the chunker secret and the id key and algorithm
  507. stay the same, the deduplication will also work between past and future backups.
  508. - borg transfer:
  509. - efficiently copy archives from a borg 1.1/1.2 repo to a new repo.
  510. uses deduplication and does not decompress/recompress file content data.
  511. - does some cleanups / fixes / conversions:
  512. - disallow None value for .user/group/chunks/chunks_healthy
  513. - cleanup msgpack related str/bytes mess, use new msgpack spec, #968
  514. - obfuscation: fix byte order for size, #6701
  515. - compression: use the 2 bytes for type and level, #6698
  516. - use version 2 for new archives
  517. - convert timestamps int/bigint -> msgpack.Timestamp, see #2323
  518. - all hardlinks have chunks, maybe chunks_healthy, hlid
  519. - remove the zlib type bytes hack
  520. - make sure items with chunks have precomputed size
  521. - removes the csize element from the tuples in the Item.chunks list
  522. - clean item of attic 0.13 'acl' bug remnants
  523. - crypto: see 1.3.0a1 log entry
  524. - removed "borg upgrade" command (not needed any more)
  525. - compact: removed --cleanup-commits option
  526. - docs: fixed quickstart and usage docs with new cli command syntax
  527. - docs: removed the parts talking about potential AES-CTR mode issues
  528. (we will not use that any more).
  529. Version 1.3.0a1 (2022-04-15)
  530. ----------------------------
  531. Although this was released as 1.3.0a1, it can be also seen as 2.0.0a1 as it was
  532. later decided to do breaking changes and thus the major release number had to
  533. be increased (thus, there will not be a 1.3.0 release, but 2.0.0).
  534. New features:
  535. - init: new --encryption=(repokey|keyfile)-[blake2-](aes-ocb|chacha20-poly1305)
  536. - New, better, faster crypto (see encryption-aead diagram in the docs), #6463.
  537. - New AEAD cipher suites: AES-OCB and CHACHA20-POLY1305.
  538. - Session keys are derived via HKDF from random session id and master key.
  539. - Nonces/MessageIVs are counters starting from 0 for each session.
  540. - AAD: chunk id, key type, messageIV, sessionID are now authenticated also.
  541. - Solves the potential AES-CTR mode counter management issues of the legacy crypto.
  542. - init: --key-algorithm=argon2 (new default KDF, older pbkdf2 also still available)
  543. borg key change-passphrase / change-location keeps the key algorithm unchanged.
  544. - key change-algorithm: to upgrade existing keys to argon2 or downgrade to pbkdf2.
  545. We recommend you to upgrade unless you have to keep the key compatible with older versions of borg.
  546. - key change-location: usable for repokey <-> keyfile location change
  547. - benchmark cpu: display benchmarks of cpu bound stuff
  548. - export-tar: new --tar-format=PAX (default: GNU)
  549. - import-tar/export-tar: can use PAX format for ctime and atime support
  550. - import-tar/export-tar: --tar-format=BORG: roundtrip ALL item metadata, #5830
  551. - repository: create and use version 2 repos only for now
  552. - repository: implement PUT2: header crc32, overall xxh64, #1704
  553. Other changes:
  554. - require python >= 3.9, #6315
  555. - simplify libs setup, #6482
  556. - unbundle most bundled 3rd party code, use libs, #6316
  557. - use libdeflate.crc32 (Linux and all others) or zlib.crc32 (macOS)
  558. - repository: code cleanups / simplifications
  559. - internal crypto api: speedups / cleanups / refactorings / modernisation
  560. - remove "borg upgrade" support for "attic backup" repos
  561. - remove PassphraseKey code and borg key migrate-to-repokey command
  562. - OpenBSD: build borg with OpenSSL (not: LibreSSL), #6474
  563. - remove support for LibreSSL, #6474
  564. - remove support for OpenSSL < 1.1.1