Pre-1.0.9 manifest spoofing vulnerability (CVE-2016-10099)¶

A flaw in the cryptographic authentication scheme in Borg allowed an attacker to spoof the manifest. The attack requires an attacker to be able to

1. insert files (with no additional headers) into backups
2. gain write access to the repository

This vulnerability does not disclose plaintext to the attacker, nor does it affect the authenticity of existing archives.

The vulnerability allows an attacker to create a spoofed manifest (the list of archives). Creating plausible fake archives may be feasible for small archives, but is unlikely for large archives.

The fix adds a separate authentication tag to the manifest. For compatibility with prior versions this authentication tag is not required by default for existing repositories. Repositories created with 1.0.9 and later require it.

Steps you should take:

1. Upgrade all clients to 1.0.9 or later.
2. Run borg upgrade --tam <repository> on every client for each repository.
3. This will list all archives, including archive IDs, for easy comparison with your logs.
4. Done.

Prior versions can access and modify repositories with this measure enabled, however, to 1.0.9 or later their modifications are indiscernible from an attack and will raise an error until the below procedure is followed. We are aware that this can be be annoying in some circumstances, but don’t see a way to fix the vulnerability otherwise.

In case a version prior to 1.0.9 is used to modify a repository where above procedure was completed, and now you get an error message from other clients:

1. borg upgrade --tam --force <repository> once with any client suffices.

This attack is mitigated by:

• Noting/logging borg list, borg info, or borg create --stats, which contain the archive IDs.

We are not aware of others having discovered, disclosed or exploited this vulnerability.

Vulnerability time line:

• 2016-11-14: Vulnerability and fix discovered during review of cryptography by Marian Beermann (@enkore)
• 2016-11-20: First patch
• 2016-12-20: Released fixed version 1.0.9
• 2017-01-02: CVE was assigned
• 2017-01-15: Released fixed version 1.1.0b3 (fix was previously only available from source)

Pre-1.0.9 potential data loss¶

If you have archives in your repository that were made with attic <= 0.13 (and later migrated to borg), running borg check would report errors in these archives. See issue #1837.

The reason for this is a invalid (and useless) metadata key that was always added due to a bug in these old attic versions.

If you run borg check –repair, things escalate quickly: all archive items with invalid metadata will be killed. Due to that attic bug, that means all items in all archives made with these old attic versions.

Pre-1.0.4 potential repo corruption¶

Some external errors (like network or disk I/O errors) could lead to corruption of the backup repository due to issue #1138.

A sign that this happened is if “E” status was reported for a file that can not be explained by problems with the source file. If you still have logs from “borg create -v –list”, you can check for “E” status.

Here is what could cause corruption and what you can do now:

1. I/O errors (e.g. repo disk errors) while writing data to repo.

This could lead to corrupted segment files.

Fix:

# check for corrupt chunks / segments:
borg check -v --repository-only REPO

# repair the repo:
borg check -v --repository-only --repair REPO

# make sure everything is fixed:
borg check -v --repository-only REPO

2. Unreliable network / unreliable connection to the repo.

This could lead to archive metadata corruption.

Fix:

# check for corrupt archives:
borg check -v --archives-only REPO

# delete the corrupt archives:
borg delete --force REPO::CORRUPT_ARCHIVE

# make sure everything is fixed:
borg check -v --archives-only REPO

3. In case you want to do more intensive checking.

The best check that everything is ok is to run a dry-run extraction:

borg extract -v --dry-run REPO::ARCHIVE

Version 1.0.11 (2017-07-21)¶

Bug fixes:

• use limited unpacker for outer key (security precaution), #2174
• fix paperkey import bug

Other changes:

• change –checkpoint-interval default from 600s to 1800s, #2841. this improves efficiency for big repositories a lot.
• docs: fix OpenSUSE command and add OpenSUSE section
• tests: add tests for split_lstring and paperkey
• vagrant:
  • fix openbsd shell
  • backport cpu/ram setup from master
  • add stretch64 VM

Version 1.0.11rc1 (2017-06-27)¶

Bug fixes:

• performance: rebuild hashtable if we have too few empty buckets, #2246. this fixes some sporadic, but severe performance breakdowns.
• Archive: allocate zeros when needed, #2308 fixes huge memory usage of mount (8 MiB × number of archives)
• IPv6 address support also: Location: more informative exception when parsing fails
• borg single-file binary: use pyinstaller v3.2.1, #2396 this fixes that the prelink cronjob on some distros kills the borg binary by stripping away parts of it.
• extract:
  • warning for unextracted big extended attributes, #2258
  • also create parent dir for device files, if needed.
  • don’t write to disk with –stdout, #2645
• archive check: detect and fix missing all-zero replacement chunks, #2180
• fix (de)compression exceptions, #2224 #2221
• files cache: update inode number, #2226
• borg rpc: use limited msgpack.Unpacker (security precaution), #2139
• Manifest: use limited msgpack.Unpacker (security precaution), #2175
• Location: accept //servername/share/path
• fix ChunkIndex.__contains__ assertion for big-endian archs (harmless)
• create: handle BackupOSError on a per-path level in one spot
• fix error msg, there is no –keep-last in borg 1.0.x, #2282
• clamp (nano)second values to unproblematic range, #2304
• fuse / borg mount:
  • fix st_blocks to be an integer (not float) value
  • fix negative uid/gid crash (they could come into archives e.g. when backing up external drives under cygwin), #2674
  • fix crash if empty (None) xattr is read
  • do pre-mount checks before opening repository
  • check llfuse is installed before asking for passphrase
• borg rename: expand placeholders, #2386
• borg serve: fix forced command lines containing BORG_ env vars
• fix error msg, it is –keep-within, not –within
• fix borg key/debug/benchmark crashing without subcommand, #2240
• chunker: fix invalid use of types, don’t do uint32_t >> 32
• document follow_symlinks requirements, check libc, #2507

New features:

• added BORG_PASSCOMMAND environment variable, #2573

• add minimal version of in repository mandatory feature flags, #2134

  This should allow us to make sure older borg versions can be cleanly prevented from doing operations that are no longer safe because of repository format evolution. This allows more fine grained control than just incrementing the manifest version. So for example a change that still allows new archives to be created but would corrupt the repository when an old version tries to delete an archive or check the repository would add the new feature to the check and delete set but leave it out of the write set.

• borg delete –force –force to delete severely corrupted archives, #1975

Other changes:

• embrace y2038 issue to support 32bit platforms
• be more clear that this is a “beyond repair” case, #2427
• key file names: limit to 100 characters and remove colons from host name
• upgrade FUSE for macOS to 3.5.8, #2346
• split up parsing and filtering for –keep-within, better error message, #2610
• docs:
  • fix caskroom link, #2299
  • address SSH batch mode, #2202 #2270
  • improve remote-path description
  • document snapshot usage, #2178
  • document relative path usage, #1868
  • one link per distro in the installation page
  • development: new branching model in git repository
  • kill api page
  • added FAQ section about backing up root partition
  • add bountysource badge, #2558
  • create empty docs.txt reequirements, #2694
  • README: how to help the project
  • note -v/–verbose requirement on affected options, #2542
  • document borg init behaviour via append-only borg serve, #2440
  • be clear about what buzhash is used for (chunking) and want it is not used for (deduplication)- also say already in the readme that we use a cryptohash for dedupe, so people don’t worry, #2390
  • add hint about chunker params to borg upgrade docs, #2421
  • clarify borg upgrade docs, #2436
  • quickstart: delete problematic BORG_PASSPRHASE use, #2623
  • faq: specify “using inline shell scripts”
  • document pattern denial of service, #2624
• tests:
  • remove attic dependency of the tests, #2505
  • travis:
    • enhance travis setuptools_scm situation
    • install fakeroot for Linux
  • add test for borg delete –force
  • enable remote tests on cygwin (the cygwin issue that caused these tests to break was fixed in cygwin at least since cygwin 2.8, maybe even since 2.7.0).
  • remove skipping the noatime tests on GNU/Hurd, #2710
  • fix borg import issue, add comment, #2718
  • include attic.tar.gz when installing the package also: add include_package_data=True

Version 1.0.10 (2017-02-13)¶

Bug fixes:

• Manifest timestamps are now monotonically increasing, this fixes issues when the system clock jumps backwards or is set inconsistently across computers accessing the same repository, #2115
• Fixed testing regression in 1.0.10rc1 that lead to a hard dependency on py.test >= 3.0, #2112

New features:

• “key export” can now generate a printable HTML page with both a QR code and a human-readable “paperkey” representation (and custom text) through the --qr-html option.

  The same functionality is also available through paperkey.html, which is the same HTML page generated by --qr-html. It works with existing “key export” files and key files.

Other changes:

• docs:
  • language clarification - “borg create –one-file-system” option does not respect mount points, but considers different file systems instead, #2141
• setup.py: build_api: sort file list for determinism

Version 1.0.10rc1 (2017-01-29)¶

Bug fixes:

• borg serve: fix transmission data loss of pipe writes, #1268 This affects only the cygwin platform (not Linux, BSD, OS X).
• Avoid triggering an ObjectiveFS bug in xattr retrieval, #1992
• When running out of buffer memory when reading xattrs, only skip the current file, #1993
• Fixed “borg upgrade –tam” crashing with unencrypted repositories. Since the issue is not relevant for unencrypted repositories, it now does nothing and prints an error, #1981.
• Fixed change-passphrase crashing with unencrypted repositories, #1978
• Fixed “borg check repo::archive” indicating success if “archive” does not exist, #1997
• borg check: print non-exit-code warning if –last or –prefix aren’t fulfilled
• fix bad parsing of wrong repo location syntax
• create: don’t create hard link refs to failed files, mount: handle invalid hard link refs, #2092
• detect mingw byte order, #2073
• creating a new segment: use “xb” mode, #2099
• mount: umount on SIGINT/^C when in foreground, #2082

Other changes:

• binary: use fixed AND freshly compiled pyinstaller bootloader, #2002
• xattr: ignore empty names returned by llistxattr(2) et al
• Enable the fault handler: install handlers for the SIGSEGV, SIGFPE, SIGABRT, SIGBUS and SIGILL signals to dump the Python traceback.
• Also print a traceback on SIGUSR2.
• borg change-passphrase: print key location (simplify making a backup of it)
• officially support Python 3.6 (setup.py: add Python 3.6 qualifier)
• tests:
  • vagrant / travis / tox: add Python 3.6 based testing
  • vagrant: fix openbsd repo, #2042
  • vagrant: fix the freebsd64 machine, #2037 #2067
  • vagrant: use python 3.5.3 to build binaries, #2078
  • vagrant: use osxfuse 3.5.4 for tests / to build binaries vagrant: improve darwin64 VM settings
  • travis: fix osxfuse install (fixes OS X testing on Travis CI)
  • travis: require succeeding OS X tests, #2028
  • travis: use latest pythons for OS X based testing
  • use pytest-xdist to parallelize testing
  • fix xattr test race condition, #2047
  • setup.cfg: fix pytest deprecation warning, #2050
• docs:
  • language clarification - VM backup FAQ
  • borg create: document how to backup stdin, #2013
  • borg upgrade: fix incorrect title levels
  • add CVE numbers for issues fixed in 1.0.9, #2106
• fix typos (taken from Debian package patch)
• remote: include data hexdump in “unexpected RPC data” error message
• remote: log SSH command line at debug level
• API_VERSION: use numberspaces, #2023
• remove .github from pypi package, #2051
• add pip and setuptools to requirements file, #2030
• SyncFile: fix use of fd object after close (cosmetic)
• Manifest.in: simplify, exclude *.{so,dll,orig}, #2066
• ignore posix_fadvise errors in repository.py, #2095 (works around issues with docker on ARM)
• make LoggedIO.close_segment reentrant, avoid reentrance

Version 1.0.9 (2016-12-20)¶

Security fixes:

• A flaw in the cryptographic authentication scheme in Borg allowed an attacker to spoof the manifest. See Pre-1.0.9 manifest spoofing vulnerability (CVE-2016-10099) above for the steps you should take.

  CVE-2016-10099 was assigned to this vulnerability.

• borg check: When rebuilding the manifest (which should only be needed very rarely) duplicate archive names would be handled on a “first come first serve” basis, allowing an attacker to apparently replace archives.

  CVE-2016-10100 was assigned to this vulnerability.

Bug fixes:

• borg check:
  • rebuild manifest if it’s corrupted
  • skip corrupted chunks during manifest rebuild
• fix TypeError in integrity error handler, #1903, #1894
• fix location parser for archives with @ char (regression introduced in 1.0.8), #1930
• fix wrong duration/timestamps if system clock jumped during a create
• fix progress display not updating if system clock jumps backwards
• fix checkpoint interval being incorrect if system clock jumps

Other changes:

• docs:
  • add python3-devel as a dependency for cygwin-based installation
  • clarify extract is relative to current directory
  • FAQ: fix link to changelog
  • markup fixes
• tests:
  • test_get_(cache|keys)_dir: clean env state, #1897
  • get back pytest’s pretty assertion failures, #1938
• setup.py build_usage:
  • fixed build_usage not processing all commands
  • fixed build_usage not generating includes for debug commands

Version 1.0.9rc1 (2016-11-27)¶

Bug fixes:

• files cache: fix determination of newest mtime in backup set (which is used in cache cleanup and led to wrong “A” [added] status for unchanged files in next backup), #1860.
• borg check:
  • fix incorrectly reporting attic 0.13 and earlier archives as corrupt
  • handle repo w/o objects gracefully and also bail out early if repo is completely empty, #1815.
• fix tox/pybuild in 1.0-maint
• at xattr module import time, loggers are not initialized yet

New features:

• borg umount <mountpoint> exposed already existing umount code via the CLI api, so users can use it, which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount, #1855.
• implement borg create –noatime –noctime, fixes #1853

Other changes:

• docs:
  • display README correctly on PyPI
  • improve cache / index docs, esp. files cache docs, fixes #1825
  • different pattern matching for –exclude, #1779
  • datetime formatting examples for {now} placeholder, #1822
  • clarify passphrase mode attic repo upgrade, #1854
  • clarify –umask usage, #1859
  • clarify how to choose PR target branch
  • clarify prune behavior for different archive contents, #1824
  • fix PDF issues, add logo, fix authors, headings, TOC
  • move security verification to support section
  • fix links in standalone README (:ref: tags)
  • add link to security contact in README
  • add FAQ about security
  • move fork differences to FAQ
  • add more details about resource usage
• tests: skip remote tests on cygwin, #1268
• travis:
  • allow OS X failures until the brew cask osxfuse issue is fixed
  • caskroom osxfuse-beta gone, it’s osxfuse now (3.5.3)
• vagrant:
  • upgrade OSXfuse / FUSE for macOS to 3.5.3
  • remove llfuse from tox.ini at a central place
  • do not try to install llfuse on centos6
  • fix fuse test for darwin, #1546
  • add windows virtual machine with cygwin
  • Vagrantfile cleanup / code deduplication

Version 1.0.8 (2016-10-29)¶

Bug fixes:

• RemoteRepository: Fix busy wait in call_many, #940

New features:

• implement borgmajor/borgminor/borgpatch placeholders, #1694 {borgversion} was already there (full version string). With the new placeholders you can now also get e.g. 1 or 1.0 or 1.0.8.

Other changes:

• avoid previous_location mismatch, #1741

  due to the changed canonicalization for relative pathes in PR #1711 / #1655 (implement /./ relpath hack), there would be a changed repo location warning and the user would be asked if this is ok. this would break automation and require manual intervention, which is unwanted.

  thus, we automatically fix the previous_location config entry, if it only changed in the expected way, but still means the same location.

• docs:

  • deployment.rst: do not use bare variables in ansible snippet
  • add clarification about append-only mode, #1689
  • setup.py: add comment about requiring llfuse, #1726
  • update usage.rst / api.rst
  • repo url / archive location docs + typo fix
  • quickstart: add a comment about other (remote) filesystems

• vagrant / tests:

  • no chown when rsyncing (fixes boxes w/o vagrant group)
  • fix fuse permission issues on linux/freebsd, #1544
  • skip fuse test for borg binary + fakeroot
  • ignore security.selinux xattrs, fixes tests on centos, #1735

Version 1.0.8rc1 (2016-10-17)¶

Bug fixes:

• fix signal handling (SIGINT, SIGTERM, SIGHUP), #1620 #1593 Fixes e.g. leftover lock files for quickly repeated signals (e.g. Ctrl-C Ctrl-C) or lost connections or systemd sending SIGHUP.
• progress display: adapt formatting to narrow screens, do not crash, #1628
• borg create –read-special - fix crash on broken symlink, #1584. also correctly processes broken symlinks. before this regressed to a crash (5b45385) a broken symlink would’ve been skipped.
• process_symlink: fix missing backup_io() Fixes a chmod/chown/chgrp/unlink/rename/... crash race between getting dirents and dispatching to process_symlink.
• yes(): abort on wrong answers, saying so, #1622
• fixed exception borg serve raised when connection was closed before reposiory was openend. add an error message for this.
• fix read-from-closed-FD issue, #1551 (this seems not to get triggered in 1.0.x, but was discovered in master)
• hashindex: fix iterators (always raise StopIteration when exhausted) (this seems not to get triggered in 1.0.x, but was discovered in master)
• enable relative pathes in ssh:// repo URLs, via /./relpath hack, #1655
• allow repo pathes with colons, #1705
• update changed repo location immediately after acceptance, #1524
• fix debug get-obj / delete-obj crash if object not found and remote repo, #1684
• pyinstaller: use a spec file to build borg.exe binary, exclude osxfuse dylib on Mac OS X (avoids mismatch lib <-> driver), #1619

New features:

• add “borg key export” / “borg key import” commands, #1555, so users are able to backup / restore their encryption keys more easily.

  Supported formats are the keyfile format used by borg internally and a special “paper” format with by line checksums for printed backups. For the paper format, the import is an interactive process which checks each line as soon as it is input.

• add “borg debug-refcount-obj” to determine a repo objects’ referrer counts, #1352

Other changes:

• add “borg debug ...” subcommands (borg debug-* still works, but will be removed in borg 1.1)
• setup.py: Add subcommand support to build_usage.
• remote: change exception message for unexpected RPC data format to indicate dataflow direction.
• improved messages / error reporting:
  • IntegrityError: add placeholder for message, so that the message we give appears not only in the traceback, but also in the (short) error message, #1572
  • borg.key: include chunk id in exception msgs, #1571
  • better messages for cache newer than repo, #1700
• vagrant (testing/build VMs):
  • upgrade OSXfuse / FUSE for macOS to 3.5.2
  • update Debian Wheezy boxes, #1686
  • openbsd / netbsd: use own boxes, fixes misc rsync installation and fuse/llfuse related testing issues, #1695 #1696 #1670 #1671 #1728
• docs:
  • add docs for “key export” and “key import” commands, #1641
  • fix inconsistency in FAQ (pv-wrapper).
  • fix second block in “Easy to use” section not showing on GitHub, #1576
  • add bestpractices badge
  • link reference docs and faq about BORG_FILES_CACHE_TTL, #1561
  • improve borg info –help, explain size infos, #1532
  • add release signing key / security contact to README, #1560
  • add contribution guidelines for developers
  • development.rst: add sphinx_rtd_theme to the sphinx install command
  • adjust border color in borg.css
  • add debug-info usage help file
  • internals.rst: fix typos
  • setup.py: fix build_usage to always process all commands
  • added docs explaining multiple –restrict-to-path flags, #1602
  • add more specific warning about write-access debug commands, #1587
  • clarify FAQ regarding backup of virtual machines, #1672
• tests:
  • work around fuse xattr test issue with recent fakeroot
  • simplify repo/hashindex tests
  • travis: test fuse-enabled borg, use trusty to have a recent FUSE
  • re-enable fuse tests for RemoteArchiver (no deadlocks any more)
  • clean env for pytest based tests, #1714
  • fuse_mount contextmanager: accept any options

Version 1.0.7 (2016-08-19)¶

Security fixes:

• borg serve: fix security issue with remote repository access, #1428 If you used e.g. –restrict-to-path /path/client1/ (with or without trailing slash does not make a difference), it acted like a path prefix match using /path/client1 (note the missing trailing slash) - the code then also allowed working in e.g. /path/client13 or /path/client1000.

  As this could accidentally lead to major security/privacy issues depending on the pathes you use, the behaviour was changed to be a strict directory match. That means –restrict-to-path /path/client1 (with or without trailing slash does not make a difference) now uses /path/client1/ internally (note the trailing slash here!) for matching and allows precisely that path AND any path below it. So, /path/client1 is allowed, /path/client1/repo1 is allowed, but not /path/client13 or /path/client1000.

  If you willingly used the undocumented (dangerous) previous behaviour, you may need to rearrange your –restrict-to-path pathes now. We are sorry if that causes work for you, but we did not want a potentially dangerous behaviour in the software (not even using a for-backwards-compat option).

Bug fixes:

• fixed repeated LockTimeout exceptions when borg serve tried to write into a already write-locked repo (e.g. by a borg mount), #502 part b) This was solved by the fix for #1220 in 1.0.7rc1 already.
• fix cosmetics + file leftover for “not a valid borg repository”, #1490
• Cache: release lock if cache is invalid, #1501
• borg extract –strip-components: fix leak of preloaded chunk contents
• Repository, when a InvalidRepository exception happens:
  • fix spurious, empty lock.roster
  • fix repo not closed cleanly

New features:

• implement borg debug-info, fixes #1122 (just calls already existing code via cli, same output as below tracebacks)

Other changes:

• skip the O_NOATIME test on GNU Hurd, fixes #1315 (this is a very minor issue and the GNU Hurd project knows the bug)
• document using a clean repo to test / build the release

Version 1.0.7rc2 (2016-08-13)¶

Bug fixes:

• do not write objects to repository that are bigger than the allowed size, borg will reject reading them, #1451.

  Important: if you created archives with many millions of files or directories, please verify if you can open them successfully, e.g. try a “borg list REPO::ARCHIVE”.

• lz4 compression: dynamically enlarge the (de)compression buffer, the static buffer was not big enough for archives with extremely many items, #1453

• larger item metadata stream chunks, raise archive item limit by 8x, #1452

• fix untracked segments made by moved DELETEs, #1442

  Impact: Previously (metadata) segments could become untracked when deleting data, these would never be cleaned up.

• extended attributes (xattrs) related fixes:

  • fixed a race condition in xattrs querying that led to the entire file not being backed up (while logging the error, exit code = 1), #1469
  • fixed a race condition in xattrs querying that led to a crash, #1462
  • raise OSError including the error message derived from errno, deal with path being a integer FD

Other changes:

• print active env var override by default, #1467
• xattr module: refactor code, deduplicate, clean up
• repository: split object size check into too small and too big
• add a transaction_id assertion, so borg init on a broken (inconsistent) filesystem does not look like a coding error in borg, but points to the real problem.
• explain confusing TypeError caused by compat support for old servers, #1456
• add forgotten usage help file from build_usage
• refactor/unify buffer code into helpers.Buffer class, add tests
• docs:
  • document archive limitation, #1452
  • improve prune examples

Version 1.0.7rc1 (2016-08-05)¶

Bug fixes:

• fix repo lock deadlocks (related to lock upgrade), #1220
• catch unpacker exceptions, resync, #1351
• fix borg break-lock ignoring BORG_REPO env var, #1324
• files cache performance fixes (fixes unneccessary re-reading/chunking/ hashing of unmodified files for some use cases):
  • fix unintended file cache eviction, #1430
  • implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10 to 20, #1338
• FUSE:
  • cache partially read data chunks (performance), #965, #966
  • always create a root dir, #1125
• use an OrderedDict for helptext, making the build reproducible, #1346
• RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
• ignore stdout/stderr broken pipe errors (cosmetic), #1116

New features:

• better borg versions management support (useful esp. for borg servers wanting to offer multiple borg versions and for clients wanting to choose a specific server borg version), #1392:
  • add BORG_VERSION environment variable before executing “borg serve” via ssh
  • add new placeholder {borgversion}
  • substitute placeholders in –remote-path
• borg init –append-only option (makes using the more secure append-only mode more convenient. when used remotely, this requires 1.0.7+ also on the borg server), #1291.

Other changes:

• Vagrantfile:
  • darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
  • xenial64: use user “ubuntu”, not “vagrant” (as usual), #1331
• tests:
  • fix fuse tests on OS X, #1433
• docs:
  • FAQ: add backup using stable filesystem names recommendation
  • FAQ about glibc compatibility added, #491, glibc-check improved
  • FAQ: ‘A’ unchanged file; remove ambiguous entry age sentence.
  • OS X: install pkg-config to build with FUSE support, fixes #1400
  • add notes about shell/sudo pitfalls with env. vars, #1380
  • added platform feature matrix
• implement borg debug-dump-repo-objs

Version 1.0.6 (2016-07-12)¶

Bug fixes:

• Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
• Fix crash with unclear message if the libc is not found, #1314, #1111

Other changes:

• tests:
  • Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
  • Fixed sparse file tests for (file) systems not supporting it, #1310
• docs:
  • Fixed syntax highlighting, #1313
  • misc docs: added data processing overview picture

Version 1.0.6rc1 (2016-07-10)¶

New features:

• borg check –repair: heal damaged files if missing chunks re-appear (e.g. if the previously missing chunk was added again in a later backup archive), #148. (*) Also improved logging.

Bug fixes:

• sync_dir: silence fsync() failing with EINVAL, #1287 Some network filesystems (like smbfs) don’t support this and we use this in repository code.
• borg mount (FUSE):
  • fix directories being shadowed when contained paths were also specified, #1295
  • raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is used), #1302. (*)
• borg extract: warn if a damaged file is extracted, #1299. (*)
• Added some missing return code checks (ChunkIndex._add, hashindex_resize).
• borg check: fix/optimize initial hash table size, avoids resize of the table.

Other changes:

• tests:
  • add more FUSE tests, #1284
  • deduplicate fuse (u)mount code
  • fix borg binary test issues, #862
• docs:
  • changelog: added release dates to older borg releases
  • fix some sphinx (docs generator) warnings, #881

Notes:

(*) Some features depend on information (chunks_healthy list) added to item metadata when a file with missing chunks was “repaired” using all-zero replacement chunks. The chunks_healthy list is generated since borg 1.0.4, thus borg can’t recognize such “repaired” (but content-damaged) files if the repair was done with an older borg version.

Version 1.0.5 (2016-07-07)¶

Bug fixes:

• borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282

Other changes:

• backport some FAQ entries from master branch
• add release helper scripts
• Vagrantfile:
  • centos6: no FUSE, don’t build binary
  • add xz for redhat-like dists

Version 1.0.4 (2016-07-07)¶

New features:

• borg serve –append-only, #1168 This was included because it was a simple change (append-only functionality was already present via repository config file) and makes better security now practically usable.
• BORG_REMOTE_PATH environment variable, #1258 This was included because it was a simple change (–remote-path cli option was already present) and makes borg much easier to use if you need it.
• Repository: cleanup incomplete transaction on “no space left” condition. In many cases, this can avoid a 100% full repo filesystem (which is very problematic as borg always needs free space - even to delete archives).

Bug fixes:

• Fix wrong handling and reporting of OSErrors in borg create, #1138. This was a serious issue: in the context of “borg create”, errors like repository I/O errors (e.g. disk I/O errors, ssh repo connection errors) were handled badly and did not lead to a crash (which would be good for this case, because the repo transaction would be incomplete and trigger a transaction rollback to clean up). Now, error handling for source files is cleanly separated from every other error handling, so only problematic input files are logged and skipped.
• Implement fail-safe error handling for borg extract. Note that this isn’t nearly as critical as the borg create error handling bug, since nothing is written to the repo. So this was “merely” misleading error reporting.
• Add missing error handler in directory attr restore loop.
• repo: make sure write data hits disk before the commit tag (#1236) and also sync the containing directory.
• FUSE: getxattr fail must use errno.ENOATTR, #1126 (fixes Mac OS X Finder malfunction: “zero bytes” file length, access denied)
• borg check –repair: do not lose information about the good/original chunks. If we do not lose the original chunk IDs list when “repairing” a file (replacing missing chunks with all-zero chunks), we have a chance to “heal” the file back into its original state later, in case the chunks re-appear (e.g. in a fresh backup). Healing is not implemented yet, see #148.
• fixes for –read-special mode:
  • ignore known files cache, #1241
  • fake regular file mode, #1214
  • improve symlinks handling, #1215
• remove passphrase from subprocess environment, #1105
• Ignore empty index file (will trigger index rebuild), #1195
• add missing placeholder support for –prefix, #1027
• improve exception handling for placeholder replacement
• catch and format exceptions in arg parsing
• helpers: fix “undefined name ‘e’” in exception handler
• better error handling for missing repo manifest, #1043
• borg delete:
  • make it possible to delete a repo without manifest
  • borg delete –forced allows to delete corrupted archives, #1139
• borg check:
  • make borg check work for empty repo
  • fix resync and msgpacked item qualifier, #1135
  • rebuild_manifest: fix crash if ‘name’ or ‘time’ key were missing.
  • better validation of item metadata dicts, #1130
  • better validation of archive metadata dicts
• close the repo on exit - even if rollback did not work, #1197. This is rather cosmetic, it avoids repo closing in the destructor.
• tests:
  • fix sparse file test, #1170
  • flake8: ignore new F405, #1185
  • catch “invalid argument” on cygwin, #257
  • fix sparseness assertion in test prep, #1264

Other changes:

• make borg build/work on OpenSSL 1.0 and 1.1, #1187
• docs / help:
  • fix / clarify prune help, #1143
  • fix “patterns” help formatting
  • add missing docs / help about placeholders
  • resources: rename atticmatic to borgmatic
  • document sshd settings, #545
  • more details about checkpoints, add split trick, #1171
  • support docs: add freenode web chat link, #1175
  • add prune visualization / example, #723
  • add note that Fnmatch is default, #1247
  • make clear that lzma levels > 6 are a waste of cpu cycles
  • add a “do not edit” note to auto-generated files, #1250
  • update cygwin installation docs
• repository interoperability with borg master (1.1dev) branch:
  • borg check: read item metadata keys from manifest, #1147
  • read v2 hints files, #1235
  • fix hints file “unknown version” error handling bug
• tests: add tests for format_line
• llfuse: update version requirement for freebsd
• Vagrantfile:
  • use openbsd 5.9, #716
  • do not install llfuse on netbsd (broken)
  • update OSXfuse to version 3.3.3
  • use Python 3.5.2 to build the binaries
• glibc compatibility checker: scripts/glibc_check.py
• add .eggs to .gitignore

Version 1.0.3 (2016-05-20)¶

Bug fixes:

• prune: avoid that checkpoints are kept and completed archives are deleted in a prune run), #997
• prune: fix commandline argument validation - some valid command lines were considered invalid (annoying, but harmless), #942
• fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
• repository: fix commit tags being seen in data
• when probing key files, do binary reads. avoids crash when non-borg binary files are located in borg’s key files directory.
• handle SIGTERM and make a clean exit - avoids orphan lock files.
• repository cache: don’t cache large objects (avoid using lots of temp. disk space), #1063

Other changes:

• Vagrantfile: OS X: update osxfuse / install lzma package, #933
• setup.py: add check for platform_darwin.c
• setup.py: on freebsd, use a llfuse release that builds ok
• docs / help:
  • update readthedocs URLs, #991
  • add missing docs for “borg break-lock”, #992
  • borg create help: add some words to about the archive name
  • borg create help: document format tags, #894

Version 1.0.2 (2016-04-16)¶

Bug fixes:

• fix malfunction and potential corruption on (nowadays rather rare) big-endian architectures or bi-endian archs in (rare) BE mode. #886, #889

  cache resync / index merge was malfunctioning due to this, potentially leading to data loss. borg info had cosmetic issues (displayed wrong values).

  note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.

• add overflow and range checks for 1st (special) uint32 of the hashindex values, switch from int32 to uint32.

• fix so that refcount will never overflow, but just stick to max. value after a overflow would have occured.

• borg delete: fix –cache-only for broken caches, #874

  Makes –cache-only idempotent: it won’t fail if the cache is already deleted.

• fixed borg create –one-file-system erroneously traversing into other filesystems (if starting fs device number was 0), #873

• workround a bug in Linux fadvise FADV_DONTNEED, #907

Other changes:

• better test coverage for hashindex, incl. overflow testing, checking correct computations so endianness issues would be discovered.
• reproducible doc for ProgressIndicator*, make the build reproducible.
• use latest llfuse for vagrant machines
• docs:
  • use /path/to/repo in examples, fixes #901
  • fix confusing usage of “repo” as archive name (use “arch”)

Version 1.0.1 (2016-04-08)¶

New features:

Usually there are no new features in a bugfix release, but these were added due to their high impact on security/safety/speed or because they are fixes also:

• append-only mode for repositories, #809, #36 (see docs)
• borg create: add –ignore-inode option to make borg detect unmodified files even if your filesystem does not have stable inode numbers (like sshfs and possibly CIFS).
• add options –warning, –error, –critical for missing log levels, #826. it’s not recommended to suppress warnings or errors, but the user may decide this on his own. note: –warning is not given to borg serve so a <= 1.0.0 borg will still work as server (it is not needed as it is the default). do not use –error or –critical when using a <= 1.0.0 borg server.

Bug fixes:

• fix silently skipping EIO, #748
• add context manager for Repository (avoid orphan repository locks), #285
• do not sleep for >60s while waiting for lock, #773
• unpack file stats before passing to FUSE
• fix build on illumos
• don’t try to backup doors or event ports (Solaris and derivates)
• remove useless/misleading libc version display, #738
• test suite: reset exit code of persistent archiver, #844
• RemoteRepository: clean up pipe if remote open() fails
• Remote: don’t print tracebacks for Error exceptions handled downstream, #792
• if BORG_PASSPHRASE is present but wrong, don’t prompt for password, but fail instead, #791
• ArchiveChecker: move “orphaned objects check skipped” to INFO log level, #826
• fix capitalization, add ellipses, change log level to debug for 2 messages, #798

Other changes:

• update llfuse requirement, llfuse 1.0 works
• update OS / dist packages on build machines, #717
• prefer showing –info over -v in usage help, #859
• docs:
  • fix cygwin requirements (gcc-g++)
  • document how to debug / file filesystem issues, #664
  • fix reproducible build of api docs
  • RTD theme: CSS !important overwrite, #727
  • Document logo font. Recreate logo png. Remove GIMP logo file.

Version 1.0.0 (2016-03-05)¶

The major release number change (0.x -> 1.x) indicates bigger incompatible changes, please read the compatibility notes, adapt / test your scripts and check your backup logs.

Compatibility notes:

• drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490 note: we provide binaries that include python 3.5.1 and everything else needed. they are an option in case you are stuck with < 3.4 otherwise.

• change encryption to be on by default (using “repokey” mode)

• moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys, you can either move them manually or run “borg upgrade <REPO>”

• remove support for –encryption=passphrase, use borg migrate-to-repokey to switch to repokey mode, #97

• remove deprecated –compression <number>, use –compression zlib,<number> instead in case of 0, you could also use –compression none

• remove deprecated –hourly/daily/weekly/monthly/yearly use –keep-hourly/daily/weekly/monthly/yearly instead

• remove deprecated –do-not-cross-mountpoints, use –one-file-system instead

• disambiguate -p option, #563:

  • -p now is same as –progress
  • -P now is same as –prefix

• remove deprecated “borg verify”, use “borg extract –dry-run” instead

• cleanup environment variable semantics, #355 the environment variables used to be “yes sayers” when set, this was conceptually generalized to “automatic answerers” and they just give their value as answer (as if you typed in that value when being asked). See the “usage” / “Environment Variables” section of the docs for details.

• change the builtin default for –chunker-params, create 2MiB chunks, #343 –chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095

  one of the biggest issues with borg < 1.0 (and also attic) was that it had a default target chunk size of 64kiB, thus it created a lot of chunks and thus also a huge chunk management overhead (high RAM and disk usage).

  please note that the new default won’t change the chunks that you already have in your repository. the new big chunks do not deduplicate with the old small chunks, so expect your repo to grow at least by the size of every changed file and in the worst case (e.g. if your files cache was lost / is not used) by the size of every file (minus any compression you might use).

  in case you want to immediately see a much lower resource usage (RAM / disk) for chunks management, it might be better to start with a new repo than continuing in the existing repo (with an existing repo, you’ld have to wait until all archives with small chunks got pruned to see a lower resource usage).

  if you used the old –chunker-params default value (or if you did not use –chunker-params option at all) and you’ld like to continue using small chunks (and you accept the huge resource usage that comes with that), just explicitly use borg create –chunker-params=10,23,16,4095.

• archive timestamps: the ‘time’ timestamp now refers to archive creation start time (was: end time), the new ‘time_end’ timestamp refers to archive creation end time. This might affect prune if your backups take rather long. if you give a timestamp via cli this is stored into ‘time’, therefore it now needs to mean archive creation start time.

New features:

• implement password roundtrip, #695

Bug fixes:

• remote end does not need cache nor keys directories, do not create them, #701
• added retry counter for passwords, #703

Other changes:

• fix compiler warnings, #697
• docs:
  • update README.rst to new changelog location in docs/changes.rst
  • add Teemu to AUTHORS
  • changes.rst: fix old chunker params, #698
  • FAQ: how to limit bandwidth

Version 1.0.0rc2 (2016-02-28)¶

New features:

• format options for location: user, pid, fqdn, hostname, now, utcnow, user
• borg list –list-format
• borg prune -v –list enables the keep/prune list output, #658

Bug fixes:

• fix _open_rb noatime handling, #657
• add a simple archivename validator, #680
• borg create –stats: show timestamps in localtime, use same labels/formatting as borg info, #651
• llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)

Other changes:

• it is now possible to use “pip install borgbackup[fuse]” to automatically install the llfuse dependency using the correct version requirement for it. you still need to care about having installed the FUSE / build related OS package first, though, so that building llfuse can succeed.
• Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
• Vagrant: use pyinstaller v3.1.1 to build binaries
• docs:
  • borg upgrade: add to docs that only LOCAL repos are supported
  • borg upgrade also handles borg 0.xx -> 1.0
  • use pip extras or requirements file to install llfuse
  • fix order in release process
  • updated usage docs and other minor / cosmetic fixes
  • verified borg examples in docs, #644
  • freebsd dependency installation and fuse configuration, #649
  • add example how to restore a raw device, #671
  • add a hint about the dev headers needed when installing from source
  • add examples for delete (and handle delete after list, before prune), #656
  • update example for borg create -v –stats (use iso datetime format), #663
  • added example to BORG_RSH docs
  • “connection closed by remote”: add FAQ entry and point to issue #636

Version 1.0.0rc1 (2016-02-07)¶

New features:

• borg migrate-to-repokey (“passphrase” -> “repokey” encryption key mode)
• implement –short for borg list REPO, #611
• implement –list for borg extract (consistency with borg create)
• borg serve: overwrite client’s –restrict-to-path with ssh forced command’s option value (but keep everything else from the client commandline), #544
• use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
• “borg upgrade” moves the keyfile keys to the new location
• display both archive creation start and end time in “borg info”, #627

Bug fixes:

• normalize trailing slashes for the repository path, #606
• Cache: fix exception handling in __init__, release lock, #610

Other changes:

• suppress unneeded exception context (PEP 409), simpler tracebacks
• removed special code needed to deal with imperfections / incompatibilities / missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
• removed some version requirements that were kept on old versions because newer did not support py 3.2 any more
• use some py 3.4+ stdlib code instead of own/openssl/pypi code:
  • use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
  • use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
  • use hmac.compare_digest instead of == operator (constant time comparison)
  • use stat.filemode instead of homegrown code
  • use “mock” library from stdlib, #145
  • remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
• Vagrant: copy CHANGES.rst as symlink, #592
• cosmetic code cleanups, add flake8 to tox/travis, #4
• docs / help:
  • make “borg -h” output prettier, #591
  • slightly rephrase prune help
  • add missing example for –list option of borg create
  • quote exclude line that includes an asterisk to prevent shell expansion
  • fix dead link to license
  • delete Ubuntu Vivid, it is not supported anymore (EOL)
  • OS X binary does not work for older OS X releases, #629
  • borg serve’s special support for forced/original ssh commands, #544
  • misc. updates and fixes

Version 0.30.0 (2016-01-23)¶

Compatibility notes:

• you may need to use -v (or –info) more often to actually see output emitted at INFO log level (because it is suppressed at the default WARNING log level). See the “general” section in the usage docs.
• for borg create, you need –list (additionally to -v) to see the long file list (was needed so you can have e.g. –stats alone without the long list)
• see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was: BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)

Bug fixes:

• fix crash when using borg create –dry-run –keep-tag-files, #570
• make sure teardown with cleanup happens for Cache and RepositoryCache, avoiding leftover locks and TEMP dir contents, #285 (partially), #548
• fix locking KeyError, partial fix for #502
• log stats consistently, #526
• add abbreviated weekday to timestamp format, fixes #496
• strip whitespace when loading exclusions from file
• unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library version warning when using the borg binary, #514
• add some error handling/fallback for C library loading, #494
• added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in “borg delete”, #503
• remove unused “repair” rpc method name

New features:

• borg create: implement exclusions using regular expression patterns.
• borg create: implement inclusions using patterns.
• borg extract: support patterns, #361
• support different styles for patterns:
  • fnmatch (fm: prefix, default when omitted), like borg <= 0.29.
  • shell (sh: prefix) with * not matching directory separators and **/ matching 0..n directories
  • path prefix (pp: prefix, for unifying borg create pp1 pp2 into the patterns system), semantics like in borg <= 0.29
  • regular expression (re:), new!
• –progress option for borg upgrade (#291) and borg delete <archive>
• update progress indication more often (e.g. for borg create within big files or for borg check repo), #500
• finer chunker granularity for items metadata stream, #547, #487
• borg create –list now used (additionally to -v) to enable the verbose file list output
• display borg version below tracebacks, #532

Other changes:

• hashtable size (and thus: RAM and disk consumption) follows a growth policy: grows fast while small, grows slower when getting bigger, #527
• Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix, fixes #569
• no separate binaries for centos6 any more because the generic linux binaries also work on centos6 (or in general: on systems with a slightly older glibc than debian7
• dev environment: require virtualenv<14.0 so we get a py32 compatible pip
• docs:
  • add space-saving chunks.archive.d trick to FAQ
  • important: clarify -v and log levels in usage -> general, please read!
  • sphinx configuration: create a simple man page from usage docs
  • add a repo server setup example
  • disable unneeded SSH features in authorized_keys examples for security.
  • borg prune only knows “–keep-within” and not “–within”
  • add gource video to resources docs, #507
  • add netbsd install instructions
  • authors: make it more clear what refers to borg and what to attic
  • document standalone binary requirements, #499
  • rephrase the mailing list section
  • development docs: run build_api and build_usage before tagging release
  • internals docs: hash table max. load factor is 0.75 now
  • markup, typo, grammar, phrasing, clarifications and other fixes.
  • add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583

Version 0.29.0 (2015-12-13)¶

Compatibility notes:

• when upgrading to 0.29.0 you need to upgrade client as well as server installations due to the locking and commandline interface changes otherwise you’ll get an error msg about a RPC protocol mismatch or a wrong commandline option. if you run a server that needs to support both old and new clients, it is suggested that you have a “borg-0.28.2” and a “borg-0.29.0” command. clients then can choose via e.g. “borg –remote-path=borg-0.29.0 ...”.
• the default waiting time for a lock changed from infinity to 1 second for a better interactive user experience. if the repo you want to access is currently locked, borg will now terminate after 1s with an error message. if you have scripts that shall wait for the lock for a longer time, use –lock-wait N (with N being the maximum wait time in seconds).

Bug fixes:

• hash table tuning (better chosen hashtable load factor 0.75 and prime initial size of 1031 gave ~1000x speedup in some scenarios)
• avoid creation of an orphan lock for one case, #285
• –keep-tag-files: fix file mode and multiple tag files in one directory, #432
• fixes for “borg upgrade” (attic repo converter), #466
• remove –progress isatty magic (and also –no-progress option) again, #476
• borg init: display proper repo URL
• fix format of umask in help pages, #463

New features:

• implement –lock-wait, support timeout for UpgradableLock, #210
• implement borg break-lock command, #157
• include system info below traceback, #324
• sane remote logging, remote stderr, #461:
  • remote log output: intercept it and log it via local logging system, with “Remote: ” prefixed to message. log remote tracebacks.
  • remote stderr: output it to local stderr with “Remote: ” prefixed.
• add –debug and –info (same as –verbose) to set the log level of the builtin logging configuration (which otherwise defaults to warning), #426 note: there are few messages emitted at DEBUG level currently.
• optionally configure logging via env var BORG_LOGGING_CONF
• add –filter option for status characters: e.g. to show only the added or modified files (and also errors), use “borg create -v –filter=AME ...”.
• more progress indicators, #394
• use ISO-8601 date and time format, #375
• “borg check –prefix” to restrict archive checking to that name prefix, #206

Other changes:

• hashindex_add C implementation (speed up cache re-sync for new archives)
• increase FUSE read_size to 1024 (speed up metadata operations)
• check/delete/prune –save-space: free unused segments quickly, #239
• increase rpc protocol version to 2 (see also Compatibility notes), #458
• silence borg by default (via default log level WARNING)
• get rid of C compiler warnings, #391
• upgrade OS X FUSE to 3.0.9 on the OS X binary build system
• use python 3.5.1 to build binaries
• docs:
  • new mailing list borgbackup@python.org, #468
  • readthedocs: color and logo improvements
  • load coverage icons over SSL (avoids mixed content)
  • more precise binary installation steps
  • update release procedure docs about OS X FUSE
  • FAQ entry about unexpected ‘A’ status for unchanged file(s), #403
  • add docs about ‘E’ file status
  • add “borg upgrade” docs, #464
  • add developer docs about output and logging
  • clarify encryption, add note about client-side encryption
  • add resources section, with videos, talks, presentations, #149
  • Borg moved to Arch Linux [community]
  • fix wrong installation instructions for archlinux

Version 0.28.2 (2015-11-15)¶

New features:

• borg create –exclude-if-present TAGFILE - exclude directories that have the given file from the backup. You can additionally give –keep-tag-files to preserve just the directory roots and the tag-files (but not backup other directory contents), #395, attic #128, attic #142

Other changes:

• do not create docs sources at build time (just have them in the repo), completely remove have_cython() hack, do not use the “mock” library at build time, #384
• avoid hidden import, make it easier for PyInstaller, easier fix for #218
• docs:
  • add description of item flags / status output, fixes #402
  • explain how to regenerate usage and API files (build_api or build_usage) and when to commit usage files directly into git, #384
  • minor install docs improvements

Version 0.28.1 (2015-11-08)¶

Bug fixes:

• do not try to build api / usage docs for production install, fixes unexpected “mock” build dependency, #384

Other changes:

• avoid using msgpack.packb at import time
• fix formatting issue in changes.rst
• fix build on readthedocs

Version 0.28.0 (2015-11-08)¶

Compatibility notes:

• changed return codes (exit codes), see docs. in short: old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error

New features:

• refactor return codes (exit codes), fixes #61
• add –show-rc option enable “terminating with X status, rc N” output, fixes 58, #351
• borg create backups atime and ctime additionally to mtime, fixes #317 - extract: support atime additionally to mtime - FUSE: support ctime and atime additionally to mtime
• support borg –version
• emit a warning if we have a slow msgpack installed
• borg list –prefix=thishostname- REPO, fixes #205
• Debug commands (do not use except if you know what you do: debug-get-obj, debug-put-obj, debug-delete-obj, debug-dump-archive-items.

Bug fixes:

• setup.py: fix bug related to BORG_LZ4_PREFIX processing
• fix “check” for repos that have incomplete chunks, fixes #364
• borg mount: fix unlocking of repository at umount time, fixes #331
• fix reading files without touching their atime, #334
• non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
• fix acl_use_local_uid_gid() and add a test for it, attic #359
• borg upgrade: do not upgrade repositories in place by default, #299
• fix cascading failure with the index conversion code, #269
• borg check: implement ‘cmdline’ archive metadata value decoding, #311
• fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys were missing, but also bsdflags). add check for unknown metadata keys.
• create from stdin: also save atime, ctime (cosmetic)
• use default_notty=False for confirmations, fixes #345
• vagrant: fix msgpack installation on centos, fixes #342
• deal with unicode errors for symlinks in same way as for regular files and have a helpful warning message about how to fix wrong locale setup, fixes #382
• add ACL keys the RobustUnpacker must know about

Other changes:

• improve file size displays, more flexible size formatters
• explicitly commit to the units standard, #289
• archiver: add E status (means that an error occurred when processing this (single) item
• do binary releases via “github releases”, closes #214
• create: use -x and –one-file-system (was: –do-not-cross-mountpoints), #296
• a lot of changes related to using “logging” module and screen output, #233
• show progress display if on a tty, output more progress information, #303
• factor out status output so it is consistent, fix surrogates removal, maybe fixes #309
• move away from RawConfigParser to ConfigParser
• archive checker: better error logging, give chunk_id and sequence numbers (can be used together with borg debug-dump-archive-items).
• do not mention the deprecated passphrase mode
• emit a deprecation warning for –compression N (giving a just a number)
• misc .coverragerc fixes (and coverage measurement improvements), fixes #319
• refactor confirmation code, reduce code duplication, add tests
• prettier error messages, fixes #307, #57
• tests:
  • add a test to find disk-full issues, #327
  • travis: also run tests on Python 3.5
  • travis: use tox -r so it rebuilds the tox environments
  • test the generated pyinstaller-based binary by archiver unit tests, #215
  • vagrant: tests: announce whether fakeroot is used or not
  • vagrant: add vagrant user to fuse group for debianoid systems also
  • vagrant: llfuse install on darwin needs pkgconfig installed
  • vagrant: use pyinstaller from develop branch, fixes #336
  • benchmarks: test create, extract, list, delete, info, check, help, fixes #146
  • benchmarks: test with both the binary and the python code
  • archiver tests: test with both the binary and the python code, fixes #215
  • make basic test more robust
• docs:
  • moved docs to borgbackup.readthedocs.org, #155
  • a lot of fixes and improvements, use mobile-friendly RTD standard theme
  • use zlib,6 compression in some examples, fixes #275
  • add missing rename usage to docs, closes #279
  • include the help offered by borg help <topic> in the usage docs, fixes #293
  • include a list of major changes compared to attic into README, fixes #224
  • add OS X install instructions, #197
  • more details about the release process, #260
  • fix linux glibc requirement (binaries built on debian7 now)
  • build: move usage and API generation to setup.py
  • update docs about return codes, #61
  • remove api docs (too much breakage on rtd)
  • borgbackup install + basics presentation (asciinema)
  • describe the current style guide in documentation
  • add section about debug commands
  • warn about not running out of space
  • add example for rename
  • improve chunker params docs, fixes #362
  • minor development docs update

Version 0.27.0 (2015-10-07)¶

New features:

• “borg upgrade” command - attic -> borg one time converter / migration, #21
• temporary hack to avoid using lots of disk space for chunks.archive.d, #235: To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
• respect XDG_CACHE_HOME, attic #181
• add support for arbitrary SSH commands, attic #99
• borg delete –cache-only REPO (only delete cache, not REPO), attic #123

Bug fixes:

• use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow down observed when running the Centos6-built binary on Ubuntu, #222
• do not crash on empty lock.roster, fixes #232
• fix multiple issues with the cache config version check, #234
• fix segment entry header size check, attic #352 plus other error handling improvements / code deduplication there.
• always give segment and offset in repo IntegrityErrors

Other changes:

• stop producing binary wheels, remove docs about it, #147
• docs: - add warning about prune - generate usage include files only as needed - development docs: add Vagrant section - update / improve / reformat FAQ - hint to single-file pyinstaller binaries from README

Version 0.26.1 (2015-09-28)¶

This is a minor update, just docs and new pyinstaller binaries.

• docs update about python and binary requirements
• better docs for –read-special, fix #220
• re-built the binaries, fix #218 and #213 (glibc version issue)
• update web site about single-file pyinstaller binaries

Note: if you did a python-based installation, there is no need to upgrade.

Version 0.26.0 (2015-09-19)¶

New features:

• Faster cache sync (do all in one pass, remove tar/compression stuff), #163
• BORG_REPO env var to specify the default repo, #168
• read special files as if they were regular files, #79
• implement borg create –dry-run, attic issue #267
• Normalize paths before pattern matching on OS X, #143
• support OpenBSD and NetBSD (except xattrs/ACLs)
• support / run tests on Python 3.5

Bug fixes:

• borg mount repo: use absolute path, attic #200, attic #137
• chunker: use off_t to get 64bit on 32bit platform, #178
• initialize chunker fd to -1, so it’s not equal to STDIN_FILENO (0)
• fix reaction to “no” answer at delete repo prompt, #182
• setup.py: detect lz4.h header file location
• to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
• fix for obtaining char * from temporary Python value (old code causes a compile error on Mint 17.2)
• llfuse 0.41 install troubles on some platforms, require < 0.41 (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
• cython code: add some int types to get rid of unspecific python add / subtract operations (avoid undefined symbol FPE_... error on some platforms)
• fix verbose mode display of stdin backup
• extract: warn if a include pattern never matched, fixes #209, implement counters for Include/ExcludePatterns
• archive names with slashes are invalid, attic issue #180
• chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined - fixes building on OpenBSD.

Other changes:

• detect inconsistency / corruption / hash collision, #170
• replace versioneer with setuptools_scm, #106
• docs:
  • pkg-config is needed for llfuse installation
  • be more clear about pruning, attic issue #132
• unit tests:
  • xattr: ignore security.selinux attribute showing up
  • ext3 seems to need a bit more space for a sparse file
  • do not test lzma level 9 compression (avoid MemoryError)
  • work around strange mtime granularity issue on netbsd, fixes #204
  • ignore st_rdev if file is not a block/char device, fixes #203
  • stay away from the setgid and sticky mode bits
• use Vagrant to do easy cross-platform testing (#196), currently:
  • Debian 7 “wheezy” 32bit, Debian 8 “jessie” 64bit
  • Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
  • Centos 7 64bit
  • FreeBSD 10.2 64bit
  • OpenBSD 5.7 64bit
  • NetBSD 6.1.5 64bit
  • Darwin (OS X Yosemite)

Version 0.25.0 (2015-08-29)¶

Compatibility notes:

• lz4 compression library (liblz4) is a new requirement (#156)
• the new compression code is very compatible: as long as you stay with zlib compression, older borg releases will still be able to read data from a repo/archive made with the new code (note: this is not the case for the default “none” compression, use “zlib,0” if you want a “no compression” mode that can be read by older borg). Also the new code is able to read repos and archives made with older borg versions (for all zlib levels 0..9).

Deprecations:

• –compression N (with N being a number, as in 0.24) is deprecated. We keep the –compression 0..9 for now to not break scripts, but it is deprecated and will be removed later, so better fix your scripts now: –compression 0 (as in 0.24) is the same as –compression zlib,0 (now). BUT: if you do not want compression, you rather want –compression none (which is the default). –compression 1 (in 0.24) is the same as –compression zlib,1 (now) –compression 9 (in 0.24) is the same as –compression zlib,9 (now)

New features:

• create –compression none (default, means: do not compress, just pass through data “as is”. this is more efficient than zlib level 0 as used in borg 0.24)
• create –compression lz4 (super-fast, but not very high compression)
• create –compression zlib,N (slower, higher compression, default for N is 6)
• create –compression lzma,N (slowest, highest compression, default N is 6)
• honor the nodump flag (UF_NODUMP) and do not backup such items
• list –short just outputs a simple list of the files/directories in an archive

Bug fixes:

• fixed –chunker-params parameter order confusion / malfunction, fixes #154
• close fds of segments we delete (during compaction)
• close files which fell out the lrucache
• fadvise DONTNEED now is only called for the byte range actually read, not for the whole file, fixes #158.
• fix issue with negative “all archives” size, fixes #165
• restore_xattrs: ignore if setxattr fails with EACCES, fixes #162

Other changes:

• remove fakeroot requirement for tests, tests run faster without fakeroot (test setup does not fail any more without fakeroot, so you can run with or without fakeroot), fixes #151 and #91.
• more tests for archiver
• recover_segment(): don’t assume we have an fd for segment
• lrucache refactoring / cleanup, add dispose function, py.test tests
• generalize hashindex code for any key length (less hardcoding)
• lock roster: catch file not found in remove() method and ignore it
• travis CI: use requirements file
• improved docs:
  • replace hack for llfuse with proper solution (install libfuse-dev)
  • update docs about compression
  • update development docs about fakeroot
  • internals: add some words about lock files / locking system
  • support: mention BountySource and for what it can be used
  • theme: use a lighter green
  • add pypi, wheel, dist package based install docs
  • split install docs into system-specific preparations and generic instructions

Version 0.24.0 (2015-08-09)¶

Incompatible changes (compared to 0.23):

• borg now always issues –umask NNN option when invoking another borg via ssh on the repository server. By that, it’s making sure it uses the same umask for remote repos as for local ones. Because of this, you must upgrade both server and client(s) to 0.24.
• the default umask is 077 now (if you do not specify via –umask) which might be a different one as you used previously. The default umask avoids that you accidentally give access permissions for group and/or others to files created by borg (e.g. the repository).

Deprecations:

• “–encryption passphrase” mode is deprecated, see #85 and #97. See the new “–encryption repokey” mode for a replacement.

New features:

• borg create –chunker-params ... to configure the chunker, fixes #16 (attic #302, attic #300, and somehow also #41). This can be used to reduce memory usage caused by chunk management overhead, so borg does not create a huge chunks index/repo index and eats all your RAM if you back up lots of data in huge files (like VM disk images). See docs/misc/create_chunker-params.txt for more information.
• borg info now reports chunk counts in the chunk index.
• borg create –compression 0..9 to select zlib compression level, fixes #66 (attic #295).
• borg init –encryption repokey (to store the encryption key into the repo), fixes #85
• improve at-end error logging, always log exceptions and set exit_code=1
• LoggedIO: better error checks / exceptions / exception handling
• implement –remote-path to allow non-default-path borg locations, #125
• implement –umask M and use 077 as default umask for better security, #117
• borg check: give a named single archive to it, fixes #139
• cache sync: show progress indication
• cache sync: reimplement the chunk index merging in C

Bug fixes:

• fix segfault that happened for unreadable files (chunker: n needs to be a signed size_t), #116
• fix the repair mode, #144
• repo delete: add destroy to allowed rpc methods, fixes issue #114
• more compatible repository locking code (based on mkdir), maybe fixes #92 (attic #317, attic #201).
• better Exception msg if no Borg is installed on the remote repo server, #56
• create a RepositoryCache implementation that can cope with >2GiB, fixes attic #326.
• fix Traceback when running check –repair, attic #232
• clarify help text, fixes #73.
• add help string for –no-files-cache, fixes #140

Other changes:

• improved docs:
  • added docs/misc directory for misc. writeups that won’t be included “as is” into the html docs.
  • document environment variables and return codes (attic #324, attic #52)
  • web site: add related projects, fix web site url, IRC #borgbackup
  • Fedora/Fedora-based install instructions added to docs
  • Cygwin-based install instructions added to docs
  • updated AUTHORS
  • add FAQ entries about redundancy / integrity
  • clarify that borg extract uses the cwd as extraction target
  • update internals doc about chunker params, memory usage and compression
  • added docs about development
  • add some words about resource usage in general
  • document how to backup a raw disk
  • add note about how to run borg from virtual env
  • add solutions for (ll)fuse installation problems
  • document what borg check does, fixes #138
  • reorganize borgbackup.github.io sidebar, prev/next at top
  • deduplicate and refactor the docs / README.rst
• use borg-tmp as prefix for temporary files / directories
• short prune options without “keep-” are deprecated, do not suggest them
• improved tox configuration
• remove usage of unittest.mock, always use mock from pypi
• use entrypoints instead of scripts, for better use of the wheel format and modern installs
• add requirements.d/development.txt and modify tox.ini
• use travis-ci for testing based on Linux and (new) OS X
• use coverage.py, pytest-cov and codecov.io for test coverage support

I forgot to list some stuff already implemented in 0.23.0, here they are:

New features:

• efficient archive list from manifest, meaning a big speedup for slow repo connections and “list <repo>”, “delete <repo>”, “prune” (attic #242, attic #167)
• big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
• hashindex: improve error messages

Other changes:

• explicitly specify binary mode to open binary files
• some easy micro optimizations

Version 0.23.0 (2015-06-11)¶

Incompatible changes (compared to attic, fork related):

• changed sw name and cli command to “borg”, updated docs
• package name (and name in urls) uses “borgbackup” to have less collisions
• changed repo / cache internal magic strings from ATTIC* to BORG*, changed cache location to .cache/borg/ - this means that it currently won’t accept attic repos (see issue #21 about improving that)

Bug fixes:

• avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
• fix traceback when trying to do unsupported passphrase change, fixes attic #189
• datetime does not like the year 10.000, fixes attic #139
• fix “info” all archives stats, fixes attic #183
• fix parsing with missing microseconds, fixes attic #282
• fix misleading hint the fuse ImportError handler gave, fixes attic #237
• check unpacked data from RPC for tuple type and correct length, fixes attic #127
• fix Repository._active_txn state when lock upgrade fails
• give specific path to xattr.is_enabled(), disable symlink setattr call that always fails
• fix test setup for 32bit platforms, partial fix for attic #196
• upgraded versioneer, PEP440 compliance, fixes attic #257

New features:

• less memory usage: add global option –no-cache-files
• check –last N (only check the last N archives)
• check: sort archives in reverse time order
• rename repo::oldname newname (rename repository)
• create -v output more informative
• create –progress (backup progress indicator)
• create –timestamp (utc string or reference file/dir)
• create: if “-” is given as path, read binary from stdin
• extract: if –stdout is given, write all extracted binary data to stdout
• extract –sparse (simple sparse file support)
• extra debug information for ‘fread failed’
• delete <repo> (deletes whole repo + local cache)
• FUSE: reflect deduplication in allocated blocks
• only allow whitelisted RPC calls in server mode
• normalize source/exclude paths before matching
• use posix_fadvise to not spoil the OS cache, fixes attic #252
• toplevel error handler: show tracebacks for better error analysis
• sigusr1 / sigint handler to print current file infos - attic PR #286
• RPCError: include the exception args we get from remote

Other changes:

• source: misc. cleanups, pep8, style
• docs and faq improvements, fixes, updates
• cleanup crypto.pyx, make it easier to adapt to other AES modes
• do os.fsync like recommended in the python docs
• source: Let chunker optionally work with os-level file descriptor.
• source: Linux: remove duplicate os.fsencode calls
• source: refactor _open_rb code a bit, so it is more consistent / regular
• source: refactor indicator (status) and item processing
• source: use py.test for better testing, flake8 for code style checks
• source: fix tox >=2.0 compatibility (test runner)
• pypi package: add python version classifiers, add FreeBSD to platforms

Attic Changelog¶

Here you can see the full list of changes between each Attic release until Borg forked from Attic: