Add VERSION for 0.8.0

restore: Fix restore to relative path

.envrc

@@ -1 +0,0 @@
-GOPATH=$PWD:$PWD/vendor

.github/ISSUE_TEMPLATE.md

@@ -1,12 +1,55 @@
+<!--
+NOTE: Not filling out the issue template needs a good reason, otherwise it may
+take a lot longer to find the problem! Please take the time to help us
+debugging the problem by collecting information, even if it seems irrelevant to
+you. Thanks!
+
+If you have a question, the forum at https://discourse.restic.net is a better place.
+Please do not create issues for usage or documentation questions! We're using
+the GitHub issue tracker mainly for tracking bugs and feature requests.
+-->
+
 ## Output of `restic version`
 
 
+## How did you run restic exactly?
+
+<!--
+This section should include at least:
+
+ * The complete command line and any environment variables you used to
+   configure restic's backend access. Make sure to replace sensitive values!
+
+ * The output of the commands, what restic prints gives may give us much
+   information to diagnose the problem!
+-->
+
+
+## What backend/server/service did you use to store the repository?
+
+
 ## Expected behavior
 
+<!--
+Describe what you'd like restic to do differently.
+-->
 
 ## Actual behavior
 
+<!--
+In this section, please try to concentrate on observations, so only describe
+what you observed directly.
+-->
 
 ## Steps to reproduce the behavior
 
+<!--
+The more time you spend describing an easy way to reproduce the behavior (if
+this is possible), the easier it is for the project developers to fix it!
+-->
 
+
+## Do you have any idea what may have caused this?
+
+
+## Do you have an idea how to solve the issue?

.gitignore

@@ -1,5 +1,3 @@
-/pkg
-/bin
 /restic
 /.vagrant
-/vendor/pkg
+/doc/_build

.travis.yml

@@ -2,8 +2,8 @@ language: go
 sudo: false
 
 go:
-  - 1.6.3
-  - 1.7.1
+  - 1.8.x
+  - 1.9.x
 
 os:
   - linux
@@ -16,16 +16,19 @@ env:
 matrix:
   exclude:
     - os: osx
-      go: 1.6.3
+      go: 1.8.x
     - os: linux
-      go: 1.7.1
+      go: 1.9.x
   include:
     - os: linux
-      go: 1.7.1
+      go: 1.9.x
       sudo: true
       env:
         RESTIC_TEST_FUSE=1
 
+branches:
+  only:
+    - master
 
 notifications:
   irc:
@@ -40,11 +43,9 @@ install:
   - export GOBIN="$GOPATH/bin"
   - export PATH="$PATH:$GOBIN"
   - go env
-  - ulimit -n 2048
 
 script:
   - go run run_integration_tests.go
 
 after_success:
-  - GOPATH=$PWD:$PWD/vendor goveralls -coverprofile=all.cov -service=travis-ci -repotoken "$COVERALLS_TOKEN"
   - bash <(curl -s https://codecov.io/bash) -f all.cov

CHANGELOG.md

@@ -0,0 +1,416 @@
+This file describes changes relevant to all users that are made in each
+released version of restic from the perspective of the user.
+
+Important Changes in 0.8.0
+==========================
+
+ * A vulnerability was found in the restic restorer, which allowed attackers in
+   special circumstances to restore files to a location outside of the target
+   directory. Due to the circumstances we estimate this to be a low-risk
+   vulnerability, but urge all users to upgrade to the latest version of restic.
+
+   Exploiting the vulnerability requires a Linux/Unix system which saves
+   backups via restic and a Windows systems which restores files from the repo.
+   In addition, the attackers need to be able to create create files with
+   arbitrary names which are then saved to the restic repo. For example, by
+   creating a file named "..\test.txt" (which is a perfectly legal filename on
+   Linux) and restoring a snapshot containing this file on Windows, it would be
+   written to the parent of the target directory.
+
+   We'd like to thank Tyler Spivey for reporting this responsibly!
+
+   https://github.com/restic/restic/pull/1445
+
+ * The s3 backend used the subdir `restic` within a bucket if no explicit path
+   after the bucket name was specified. Since this version, restic does not use
+   this default path any more. If you created a repo on s3 in a bucket without
+   specifying a path within the bucket, you need to add `/restic` at the end of
+   the repository specification to access your repo: `s3:s3.amazonaws.com/bucket/restic`
+   https://github.com/restic/restic/issues/1292
+   https://github.com/restic/restic/pull/1437
+
+ * We've added a local cache for metadata so that restic doesn't need to load
+   all metadata (snapshots, indexes, ...) from the repo each time it starts. By
+   default the cache is active, but there's a new global option `--no-cache`
+   that can be used to disable the cache. By deafult, the cache a standard
+   cache folder for the OS, which can be overridden with `--cache-dir`.  The
+   cache will automatically populate, indexes and snapshots are saved as they
+   are loaded.
+   https://github.com/restic/restic/pull/1040
+   https://github.com/restic/restic/issues/29
+   https://github.com/restic/restic/issues/738
+   https://github.com/restic/restic/issues/282
+   https://github.com/restic/restic/pull/1287
+
+ * A related change was to by default create pack files in the repo that
+   contain either data or metadata, not both mixed together. This allows easy
+   caching of only the metadata files. The next run of `restic prune` will
+   untangle mixed files automatically.
+   https://github.com/restic/restic/pull/1265
+
+ * The Google Cloud Storage backend no longer requires the service account to
+   have the `storage.buckets.get` permission ("Storage Admin" role) in `restic
+   init` if the bucket already exists.
+   https://github.com/restic/restic/pull/1281
+
+ * Added support for rate limiting through `--limit-upload` and
+   `--limit-download` flags.
+   https://github.com/restic/restic/issues/1216
+   https://github.com/restic/restic/pull/1336
+   https://github.com/restic/restic/pull/1358
+
+ * Failed backend requests are now automatically retried.
+   https://github.com/restic/restic/pull/1353
+
+ * We've added the `dump` command which prints a file from a snapshot to
+   stdout. This can e.g. be used to restore files read with `backup --stdin`.
+   https://github.com/restic/restic/issues/510
+   https://github.com/restic/restic/pull/1346
+
+Small changes
+-------------
+
+ * The directory structure in the fuse mount now exposes a symlink `latest`
+   which points to the latest snapshot in that particular directory.
+   https://github.com/restic/restic/pull/1249
+
+ * The option `--compact` was added to the `forget` command to provide the same
+   compact view as the `snapshots` command.
+   https://github.com/restic/restic/pull/1269
+
+ * We've re-enabled a workaround for `minio-go` (the library we're using to
+   access s3 backends), this reduces memory usage.
+   https://github.com/restic/restic/issues/1256
+   https://github.com/restic/restic/pull/1267
+
+ * The sftp backend now prompts for the password if a password is necessary for
+   login.
+   https://github.com/restic/restic/issues/448
+   https://github.com/restic/restic/pull/1270
+
+ * The `generate` command has been added, which replaces the now removed
+   commands `manpage` and `autocomplete`. This release of restic contains the
+   most recent manpages in `doc/man` and the auto-completion files for bash and
+   zsh in `doc/bash-completion.sh` and `doc/zsh-completion.zsh`
+   https://github.com/restic/restic/issues/1274
+   https://github.com/restic/restic/pull/1282
+
+ * A bug was discovered in the library we're using to access Backblaze, it now
+   reuses already established TCP connections which should be a lot faster and
+   not cause network failures any more.
+   https://github.com/restic/restic/issues/1291
+   https://github.com/restic/restic/pull/1301
+
+ * Another bug in the `forget` command caused `prune` not to be run when
+   `--prune` was specified without a policy, e.g. when only snapshot IDs that
+   should be forgotten are listed manually. This is corrected now.
+   https://github.com/restic/restic/pull/1317
+
+ * The `check` command now explicetly prints `No errors were found` when no
+   errors could be found.
+   https://github.com/restic/restic/pull/1319
+   https://github.com/restic/restic/issues/1303
+
+ * The fuse mount now has an `ids` subdirectory which contains the snapshots
+   below their (short) IDs.
+   https://github.com/restic/restic/issues/1102
+   https://github.com/restic/restic/pull/1299
+   https://github.com/restic/restic/pull/1320
+
+ * The `backup` command was improved, it now caches the result of excludes for
+   a directory.
+   https://github.com/restic/restic/issues/1271
+   https://github.com/restic/restic/pull/1326
+
+ * We've added the `--cacert` option which can be used to pass one (or more) CA
+   certificates to restic. These are used in addition to the system CA
+   certificates to verify HTTPS certificates (e.g. for the REST backend).
+   https://github.com/restic/restic/issues/1114
+   https://github.com/restic/restic/pull/1276
+
+ * When the list of files/dirs to be saved is read from a file with
+   `--files-from`, comment lines (starting with `#`) are now ignored.
+   https://github.com/restic/restic/issues/1367
+   https://github.com/restic/restic/pull/1368
+
+Important Changes in 0.7.3
+==========================
+
+ * For large backups stored in Google Cloud Storage, the `prune` command fails
+   because listing only returns the first 1000 files. This has been corrected,
+   no data is lost in the process. In addition, a plausibility check was added
+   to `prune`.
+   https://github.com/restic/restic/issues/1246
+   https://github.com/restic/restic/pull/1247
+
+
+Important Changes in 0.7.2
+==========================
+
+ * We've added an official docker image and a Dockerfile to build this image in
+   `docker/`.
+   https://github.com/restic/restic/pull/1061
+
+ * The git repository layout was changed to resemble the layout typically used
+   in Go projects, we're not using `gb` for building restic any more and
+   vendoring the dependencies is now taken care of by `dep`.
+   https://github.com/restic/restic/pull/1126
+
+ * We now support saving backups on Google Cloud Storage.
+   https://github.com/restic/restic/pull/1134
+   https://github.com/restic/restic/pull/1052
+   https://github.com/restic/restic/issues/211
+
+ * We've added support for Microsoft Azure Blob Storage as a restic backend.
+   https://github.com/restic/restic/pull/1149
+   https://github.com/restic/restic/pull/1059
+   https://github.com/restic/restic/issues/609
+
+ * In the course of supporting Microsoft Azure Blobe Storage Go 1.8 is now a
+   requirement to build restic.
+
+ * The `restore` command has been improved: When dirs are excluded (or not
+   included) in a restore, they are not loaded from the repo any more.
+   https://github.com/restic/restic/pull/1044
+
+ * Name collisions are now resolved by appending a counter.
+   https://github.com/restic/restic/issues/1179
+   https://github.com/restic/restic/pull/1209
+
+
+Small changes
+-------------
+
+ * The `key` command now prompts for a password even if the original password
+   to access a repo has been specified via the `RESTIC_PASSWORD` environment
+   variable or a password file.
+   https://github.com/restic/restic/issues/1132
+   https://github.com/restic/restic/pull/1133
+
+ * Properly report errors when reading files with exclude patterns.
+   https://github.com/restic/restic/pull/1144
+
+ * We now automatically generate man pages for all restic commands, see the
+   subdir `doc/man`.
+   https://github.com/restic/restic/issues/697
+   https://github.com/restic/restic/pull/1147
+
+ * The `key remove` command was corrected and now works as documented.
+   https://github.com/restic/restic/pull/1164
+
+ * When a restic command other than `init` is used with a local repository and
+   the repository directory does not exist, restic creates the directory
+   structure. That's an error, only the `init` command should create the dir.
+   https://github.com/restic/restic/issues/1167
+   https://github.com/restic/restic/pull/1182
+
+ * Restic now prints stats on all BSD systems (not only on darwin) when SIGINFO
+   is received (usually when ctrl+t is pressed).
+   https://github.com/restic/restic/pull/1203
+   https://github.com/restic/restic/pull/1082#issuecomment-326279920
+
+ * Since a few releases restic had the ability to write profiling files for
+   memory and CPU usage when `debug` is enabled. It was discovered that when
+   restic is interrupted (ctrl+c is pressed), the proper shutdown hook is not
+   run. This is now corrected.
+   https://github.com/restic/restic/pull/1191
+
+ * A new option `--exclude-caches` was added that allows excluding cache
+   directories (that are tagged as such). This is a special case of a more
+   generic option `--exclude-if-present` which excludes a directory if a file
+   with a specific name (and contents) is present.
+   https://github.com/restic/restic/issues/317
+   https://github.com/restic/restic/pull/1170
+   https://github.com/restic/restic/pull/1224
+
+ * The `forget` command now has an option `--group-by` that allows flexible
+   grouping policies.
+   https://github.com/restic/restic/pull/1196
+
+ * The date and time restic records for a new backup can now be specified
+   externally by passing `--time` to the `backup` command.
+   https://github.com/restic/restic/pull/1205
+
+ * The option `--compact` was added to the `snapshots` command to get a better
+   overview of the snapshots in a repo. It limits each snapshot to a single
+   line.
+   https://github.com/restic/restic/issues/1218
+   https://github.com/restic/restic/pull/1223
+
+
+Important Changes in 0.7.1
+==========================
+
+ * The `migrate` command for chaning the `s3legacy` layout to the `default`
+   layout for s3 backends has been improved: It can now be restarted with
+   `restic migrate --force s3_layout` and automatically retries operations on
+   error.
+   https://github.com/restic/restic/issues/1073
+   https://github.com/restic/restic/pull/1075
+
+Small changes
+-------------
+
+ * The local and sftp backends now create the subdirs below `data/` on
+   open/init. This way, restic makes sure that they always exist. This is
+   connected to an issue for the sftp server:
+   https://github.com/restic/rest-server/pull/11#issuecomment-309879710
+   https://github.com/restic/restic/issues/1055
+   https://github.com/restic/restic/pull/1077
+   https://github.com/restic/restic/pull/1105
+
+ * When no S3 credentials are specified in the environment variables, restic
+   now tries to load credentials from an IAM instance profile when the s3
+   backend is used.
+   https://github.com/restic/restic/issues/1067
+   https://github.com/restic/restic/pull/1086
+
+ * On Darwin and FreeBSD, restic now prints stats when SIGINFO is received
+   (usually when ctrl+t is pressed).
+   https://github.com/restic/restic/pull/1082
+
+ * The dependencies have been updated.
+   https://github.com/restic/restic/pull/1108
+   https://github.com/restic/restic/pull/1124
+
+ * A bug was found (and corrected) in the index rebuilding after prune, which
+   led to indexes which include blobs that were not present in the repo any
+   more. There were already checks in place which detected this situation and
+   aborted with an error message. A new run of either `prune` or
+   `rebuild-index` corrected the index files. This is now fixed and a test has
+   been added to detect this.
+   https://github.com/restic/restic/pull/1115
+
+ * Errors for chmod() on Unix for filesystems which do not support it (e.g. smb
+   mounted via gvfs) are now ignored.
+   https://github.com/restic/restic/pull/1080
+   https://github.com/restic/restic/pull/1112
+
+ * The semantic for the `--tags` option to `forget` and `snapshots` was
+   clarified:
+   https://github.com/restic/restic/issues/1081
+   https://github.com/restic/restic/pull/1090
+
+Important Changes in 0.7.0
+==========================
+
+ * New "swift" backend: A new backend for the OpenStack Swift cloud storage
+   protocol has been added, https://wiki.openstack.org/wiki/Swift
+   https://github.com/restic/restic/pull/975
+   https://github.com/restic/restic/pull/648
+
+ * New "b2" backend: A new backend for Backblaze B2 cloud storage
+   service has been added, https://www.backblaze.com
+   https://github.com/restic/restic/issues/512
+   https://github.com/restic/restic/pull/978
+
+ * Improved performance for the `find` command: Restic recognizes paths it has
+   already checked for the files in question, so the number of backend requests
+   is reduced a lot.
+   https://github.com/restic/restic/issues/989
+   https://github.com/restic/restic/pull/993
+
+ * Improved performance for the fuse mount: Listing directories which contain
+   large files now is significantly faster.
+   https://github.com/restic/restic/pull/998
+
+ * The default layout for the s3 backend is now `default` (instead of
+   `s3legacy`). Also, there's a new `migrate` command to convert an existing
+   repo, it can be run like this: `restic migrate s3_layout`
+   https://github.com/restic/restic/issues/965
+   https://github.com/restic/restic/pull/1004
+
+ * The fuse mount now has two more directories: `tags` contains a subdir for
+   each tag, which in turn contains only the snapshots that have this tag. The
+   subdir `hosts` contains a subdir for each host that has a snapshot, and the
+   subdir contains the snapshots for that host.
+   https://github.com/restic/restic/issues/636
+   https://github.com/restic/restic/pull/1050
+
+Small changes
+-------------
+
+ * For the s3 backend we're back to using the high-level API the s3 client
+   library for uploading data, a few users reported dropped connections (which
+   the library will automatically retry now).
+   https://github.com/restic/restic/issues/1013
+   https://github.com/restic/restic/issues/1023
+   https://github.com/restic/restic/pull/1025
+
+ * The `prune` command has been improved and will now remove invalid pack
+   files, for example files that have not been uploaded completely because a
+   backup was interrupted.
+   https://github.com/restic/restic/issues/1029
+   https://github.com/restic/restic/pull/1036
+
+ * restic now tries to detect when an invalid/unknown backend is used and
+   returns an error message.
+   https://github.com/restic/restic/issues/1021
+   https://github.com/restic/restic/pull/1070
+
+Important Changes in 0.6.1
+==========================
+
+This is mostly a bugfix release and only contains small changes:
+
+ * We've fixed a bug where `rebuild-index` would corrupt the index when used
+   with the s3 backend together with the `default` layout. This is not the
+   default setting.
+
+ * Backends based on HTTP now allow several idle connections in parallel. This
+   is especially important for the REST backend, which (when used with a local
+   server) may create a lot connections and exhaust available ports quickly.
+   https://github.com/restic/restic/issues/985
+   https://github.com/restic/restic/pull/986
+
+ * Regular status report: We've removed the status report that was printed
+   every 10 seconds when restic is run non-interactively. You can still force
+   reporting the current status by sending a `USR1` signal to the process.
+   https://github.com/restic/restic/pull/974
+
+ * The `build.go` now strips the temporary directory used for compilation from
+   the binary. This is the first step in enabling reproducible builds.
+   https://github.com/restic/restic/pull/981
+
+Important Changes in 0.6.0
+==========================
+
+Consistent forget policy
+------------------------
+
+The `forget` command was corrected to be more consistent in which snapshots are
+to be forgotten. It is possible that the new code removes more snapshots than
+before, so please review what would be deleted by using the `--dry-run` option.
+
+https://github.com/restic/restic/pull/957
+https://github.com/restic/restic/issues/953
+
+Unified repository layout
+-------------------------
+
+Up to now the s3 backend used a special repository layout. We've decided to
+unify the repository layout and implemented the default layout also for the s3
+backend. For creating a new repository on s3 with the default layout, use
+`restic -o s3.layout=default init`. For further commands the option is not
+necessary any more, restic will automatically detect the correct layout to use.
+A future version will switch to the default layout for new repositories.
+
+https://github.com/restic/restic/pull/966
+https://github.com/restic/restic/issues/965
+
+Memory and time improvements for the s3 backend
+-----------------------------------------------
+
+We've updated the library used for accessing s3, switched to using a lower
+level API and added caching for some requests. This lead to a decrease in
+memory usage and a great speedup. In addition, we added benchmark functions for
+all backends, so we can track improvements over time. The Continuous
+Integration test service we're using (Travis) now runs the s3 backend tests not
+only against a Minio server, but also against the Amazon s3 live service, so we
+should be notified of any regressions much sooner.
+
+https://github.com/restic/restic/pull/962
+https://github.com/restic/restic/pull/960
+https://github.com/restic/restic/pull/946
+https://github.com/restic/restic/pull/938
+https://github.com/restic/restic/pull/883

CONTRIBUTING.md

@@ -3,7 +3,10 @@ This document describes the way you can contribute to the restic project.
 Ways to Help Out
 ================
 
-Thank you for your contribution!
+Thank you for your contribution! Please **open an issue first** (or add a
+comment to an existing issue) if you plan to work on any code or add a new
+feature. This way, duplicate work is prevented and we can discuss your ideas
+and design first.
 
 There are several ways you can help us out. First of all code contributions and
 bug fixes are most welcome. However even "minor" details as fixing spelling
@@ -57,50 +60,35 @@ uploading it somewhere or post only the parts that are really relevant.
 Development Environment
 =======================
 
-For development you need the build tool [`gb`](https://getgb.io), it can be
-installed by running the following command:
+In order to compile restic with the `go` tool directly, it needs to be checked
+out at the right path within a `GOPATH`. The concept of a `GOPATH` is explained
+in ["How to write Go code"](https://golang.org/doc/code.html).
 
-    $ go get github.com/constabulary/gb/...
-
-The repository contains two directories with code: `src/` contains the code
-written for restic, whereas `vendor/` contains copies of libraries restic
-depends on. The libraries are managed with the `gb vendor` command.
-
-Just clone the repository, `cd` to it and run `gb build` to build the binary:
+If you do not have a directory with Go code yet, executing the following
+instructions in your shell will create one for you and check out the restic
+repo:
 
+    $ export GOPATH="$HOME/go"
+    $ mkdir -p "$GOPATH/src/github.com/restic"
+    $ cd "$GOPATH/src/github.com/restic"
     $ git clone https://github.com/restic/restic
     $ cd restic
-    $ gb build
-    [...]
-    $ bin/restic version
+
+You can then build restic as follows:
+
+    $ go build ./cmd/restic
+    $ ./restic version
     restic compiled manually
-    compiled at unknown time with go1.6
+    compiled with go1.8.3 on linux/amd64
 
 The following commands can be used to run all the tests:
 
-    $ gb test
-    ok          github.com/restic/restic        8.174s
-    [...]
+    $ go test ./cmd/... ./internal/...
 
-If you want to run your tests on Linux, OpenBSD or FreeBSD, you can use
-[vagrant](https://www.vagrantup.com/) with the proveded `Vagrantfile` to
-quickly set up VMs and run the tests, e.g.:
-
-    $ vagrant up freebsd
-    [...]
-
-    $ vagrant ssh freebsd -c 'cd restic/restic; go test -v ./...'
-    [...]
-
-The default `go` tool can also be used by setting the environment variable
-`GOPATH` to the following value while being in the top level directory in the
-git repository:
-
-    $ export GOPATH=$PWD:$PWD/vendor
-
-The file `.envrc` allows automatic `GOPATH` configuration with
-[direnv](https://direnv.net/), inspect the file and then allow automatic
-configuration by running `direnv allow`.
+The repository contains two sets of directories with code: `cmd/` and
+`internal/` contain the code written for restic, whereas `vendor/` contains
+copies of libraries restic depends on. The libraries are managed with the
+[`dep`](https://github.com/golang/dep) tool.
 
 Providing Patches
 =================
@@ -119,7 +107,8 @@ down to the following steps:
 
  2. Clone the repository locally and create a new branch. If you are working on
     the code itself, please set up the development environment as described in
-    the previous section.
+    the previous section. Especially take care to place your forked repository
+    at the correct path (`src/github.com/restic/restic`) within your `GOPATH`.
 
  3. Then commit your changes as fine grained as possible, as smaller patches,
     that handle one and only one issue are easier to discuss and merge.
@@ -134,8 +123,14 @@ down to the following steps:
     commits to the branch you created for the pull request, they will be
     automatically added to the pull request.
 
- 7. Once your code looks good and passes all the tests, we'll merge it. Thanks
-    a low for your contribution!
+ 7. If your pull request changes anything that users should be aware of (a
+    bugfix, a new feature, ...) please add an entry to the file
+    ['CHANGELOG.md'](CHANGELOG.md). It will be used in the announcement of the
+    next stable release. While writing, ask yourself: If I were the user, what
+    would I need to be aware of with this change.
+
+ 8. Once your code looks good and passes all the tests, we'll merge it. Thanks
+    a lot for your contribution!
 
 Please provide the patches for each bug or feature in a separate branch and
 open up a pull request for each.
@@ -161,7 +156,7 @@ what the tests are there for.
 Git Commits
 -----------
 
-I would be good if you could follow the same general style regarding Git
+It would be good if you could follow the same general style regarding Git
 commits as the rest of the project, this makes reviewing code, browsing the
 history and triaging bugs much easier.
 

Dockerfile

@@ -1,57 +0,0 @@
-# This Dockerfiles configures a container that is similar to the Travis CI
-# environment and can be used to run tests locally.
-#
-# build the image:
-#   docker build -t restic/test .
-#
-# run all tests and cross-compile restic:
-#   docker run --rm -v $PWD:/home/travis/restic restic/test go run run_integration_tests.go -minio minio
-#
-# run interactively:
-#   docker run --interactive --tty --rm -v $PWD:/home/travis/restic restic/test /bin/bash
-#
-# run a subset of tests:
-#   docker run --rm -v $PWD:/home/travis/restic restic/test gb test -v ./backend
-#
-# build the image for an older version of Go:
-#   docker build --build-arg GOVERSION=1.3.3 -t restic/test:go1.3.3 .
-
-FROM ubuntu:14.04
-
-ARG GOVERSION=1.7
-ARG GOARCH=amd64
-
-# install dependencies
-RUN apt-get update
-RUN apt-get install -y --no-install-recommends ca-certificates wget git build-essential openssh-server
-
-# add and configure user
-ENV HOME /home/travis
-RUN useradd -m -d $HOME -s /bin/bash travis
-
-# run everything below as user travis
-USER travis
-WORKDIR $HOME
-
-# download and install Go
-RUN wget -q -O /tmp/go.tar.gz https://storage.googleapis.com/golang/go${GOVERSION}.linux-${GOARCH}.tar.gz
-RUN tar xf /tmp/go.tar.gz && rm -f /tmp/go.tar.gz
-ENV GOROOT $HOME/go
-ENV GOPATH $HOME/gopath
-ENV PATH $PATH:$GOROOT/bin:$GOPATH/bin:$HOME/bin
-
-RUN mkdir -p $HOME/restic
-
-# pre-install tools, this speeds up running the tests itself
-RUN go get github.com/constabulary/gb/...
-RUN go get golang.org/x/tools/cmd/cover
-RUN go get github.com/mitchellh/gox
-RUN go get github.com/pierrre/gotestcover
-RUN mkdir $HOME/bin \
-    && wget -q -O $HOME/bin/minio https://dl.minio.io/server/minio/release/linux-${GOARCH}/minio \
-    && chmod +x $HOME/bin/minio
-
-# set TRAVIS_BUILD_DIR for integration script
-ENV TRAVIS_BUILD_DIR $HOME/restic
-
-WORKDIR $HOME/restic

Gopkg.lock

@@ -0,0 +1,219 @@
+# This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'.
+
+
+[[projects]]
+  branch = "master"
+  name = "bazil.org/fuse"
+  packages = [".","fs","fuseutil"]
+  revision = "371fbbdaa8987b715bdd21d6adc4c9b20155f748"
+
+[[projects]]
+  name = "cloud.google.com/go"
+  packages = ["compute/metadata"]
+  revision = "eaddaf6dd7ee35fd3c2420c8d27478db176b0485"
+  version = "v0.15.0"
+
+[[projects]]
+  name = "github.com/Azure/azure-sdk-for-go"
+  packages = ["storage"]
+  revision = "509eea43b93cec2f3f17acbe2578ef58703923f8"
+  version = "v11.1.1-beta"
+
+[[projects]]
+  name = "github.com/Azure/go-autorest"
+  packages = ["autorest","autorest/adal","autorest/azure","autorest/date"]
+  revision = "7aa5b8a6f18b5c15910c767ab005fc4585221177"
+  version = "v9.1.1"
+
+[[projects]]
+  name = "github.com/cenkalti/backoff"
+  packages = ["."]
+  revision = "61153c768f31ee5f130071d08fc82b85208528de"
+  version = "v1.1.0"
+
+[[projects]]
+  name = "github.com/cpuguy83/go-md2man"
+  packages = ["md2man"]
+  revision = "1d903dcb749992f3741d744c0f8376b4bd7eb3e1"
+  version = "v1.0.7"
+
+[[projects]]
+  name = "github.com/dgrijalva/jwt-go"
+  packages = ["."]
+  revision = "dbeaa9332f19a944acb5736b4456cfcc02140e29"
+  version = "v3.1.0"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/dustin/go-humanize"
+  packages = ["."]
+  revision = "77ed807830b4df581417e7f89eb81d4872832b72"
+
+[[projects]]
+  name = "github.com/elithrar/simple-scrypt"
+  packages = ["."]
+  revision = "2325946f714c95de4a6088202c402fbdfa64163b"
+  version = "v1.2.0"
+
+[[projects]]
+  name = "github.com/go-ini/ini"
+  packages = ["."]
+  revision = "5b3e00af70a9484542169a976dcab8d03e601a17"
+  version = "v1.30.0"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/golang/protobuf"
+  packages = ["proto"]
+  revision = "1643683e1b54a9e88ad26d98f81400c8c9d9f4f9"
+
+[[projects]]
+  name = "github.com/inconshreveable/mousetrap"
+  packages = ["."]
+  revision = "76626ae9c91c4f2a10f34cad8ce83ea42c93bb75"
+  version = "v1.0"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/juju/ratelimit"
+  packages = ["."]
+  revision = "5b9ff866471762aa2ab2dced63c9fb6f53921342"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/kr/fs"
+  packages = ["."]
+  revision = "2788f0dbd16903de03cb8186e5c7d97b69ad387b"
+
+[[projects]]
+  name = "github.com/kurin/blazer"
+  packages = ["b2","base","internal/b2types","internal/blog"]
+  revision = "e269a1a17bb6aec278c06a57cb7e8f8d0d333e04"
+  version = "v0.2.1"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/minio/go-homedir"
+  packages = ["."]
+  revision = "21304a94172ae3a09dee2cd86a12fb6f842138c7"
+
+[[projects]]
+  name = "github.com/minio/minio-go"
+  packages = [".","pkg/credentials","pkg/encrypt","pkg/policy","pkg/s3signer","pkg/s3utils","pkg/set"]
+  revision = "4e0f567303d4cc90ceb055a451959fb9fc391fb9"
+  version = "3.0.3"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/ncw/swift"
+  packages = ["."]
+  revision = "c95c6e5c2d1a3d37fc44c8c6dc9e231c7500667d"
+
+[[projects]]
+  name = "github.com/pkg/errors"
+  packages = ["."]
+  revision = "645ef00459ed84a119197bfb8d8205042c6df63d"
+  version = "v0.8.0"
+
+[[projects]]
+  name = "github.com/pkg/profile"
+  packages = ["."]
+  revision = "5b67d428864e92711fcbd2f8629456121a56d91f"
+  version = "v1.2.1"
+
+[[projects]]
+  name = "github.com/pkg/sftp"
+  packages = ["."]
+  revision = "98203f5a8333288eb3163b7c667d4260fe1333e9"
+  version = "1.0.0"
+
+[[projects]]
+  name = "github.com/pkg/xattr"
+  packages = ["."]
+  revision = "23c75e3f6c1d8b13b3dd905b011a7f38a06044b7"
+  version = "v0.2.1"
+
+[[projects]]
+  name = "github.com/restic/chunker"
+  packages = ["."]
+  revision = "db83917be3b88cc307464b7d8a221c173e34a0db"
+  version = "v0.2.0"
+
+[[projects]]
+  name = "github.com/russross/blackfriday"
+  packages = ["."]
+  revision = "4048872b16cc0fc2c5fd9eacf0ed2c2fedaa0c8c"
+  version = "v1.5"
+
+[[projects]]
+  name = "github.com/satori/uuid"
+  packages = ["."]
+  revision = "879c5887cd475cd7864858769793b2ceb0d44feb"
+  version = "v1.1.0"
+
+[[projects]]
+  name = "github.com/sirupsen/logrus"
+  packages = ["."]
+  revision = "f006c2ac4710855cf0f916dd6b77acf6b048dc6e"
+  version = "v1.0.3"
+
+[[projects]]
+  branch = "master"
+  name = "github.com/spf13/cobra"
+  packages = [".","doc"]
+  revision = "7b2c5ac9fc04fc5efafb60700713d4fa609b777b"
+
+[[projects]]
+  name = "github.com/spf13/pflag"
+  packages = ["."]
+  revision = "e57e3eeb33f795204c1ca35f56c44f83227c6e66"
+  version = "v1.0.0"
+
+[[projects]]
+  branch = "master"
+  name = "golang.org/x/crypto"
+  packages = ["curve25519","ed25519","ed25519/internal/edwards25519","pbkdf2","poly1305","scrypt","ssh","ssh/terminal"]
+  revision = "edd5e9b0879d13ee6970a50153d85b8fec9f7686"
+
+[[projects]]
+  branch = "master"
+  name = "golang.org/x/net"
+  packages = ["context","context/ctxhttp"]
+  revision = "cd69bc3fc700721b709c3a59e16e24c67b58f6ff"
+
+[[projects]]
+  branch = "master"
+  name = "golang.org/x/oauth2"
+  packages = [".","google","internal","jws","jwt"]
+  revision = "bb50c06baba3d0c76f9d125c0719093e315b5b44"
+
+[[projects]]
+  branch = "master"
+  name = "golang.org/x/sys"
+  packages = ["unix","windows"]
+  revision = "8dbc5d05d6edcc104950cc299a1ce6641235bc86"
+
+[[projects]]
+  branch = "master"
+  name = "google.golang.org/api"
+  packages = ["gensupport","googleapi","googleapi/internal/uritemplates","storage/v1"]
+  revision = "7afc123cf726cd2f253faa3e144d2ab65477b18f"
+
+[[projects]]
+  name = "google.golang.org/appengine"
+  packages = [".","internal","internal/app_identity","internal/base","internal/datastore","internal/log","internal/modules","internal/remote_api","internal/urlfetch","urlfetch"]
+  revision = "150dc57a1b433e64154302bdc40b6bb8aefa313a"
+  version = "v1.0.0"
+
+[[projects]]
+  branch = "v2"
+  name = "gopkg.in/yaml.v2"
+  packages = ["."]
+  revision = "eb3733d160e74a9c7e442f435eb3bea458e1d19f"
+
+[solve-meta]
+  analyzer-name = "dep"
+  analyzer-version = 1
+  inputs-digest = "f0a207197cb502238ac87ca8e07b2640c02ec380a50b036e09ef87e40e31ca2d"
+  solver-name = "gps-cdcl"
+  solver-version = 1

Gopkg.toml

@@ -0,0 +1,21 @@
+
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#  name = "github.com/x/y"
+#  version = "2.4.0"

LICENSE

@@ -1,19 +1,21 @@
+BSD 2-Clause License
+
 Copyright (c) 2014, Alexander Neumann <alexander@bumpern.de>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

Makefile

@@ -6,7 +6,8 @@ restic:
 	go run build.go
 
 clean:
-	rm -rf restic
+	rm -f restic
 
 test:
-	go test ./...
+	go test ./cmd/... ./internal/...
+

README.md

@@ -1,77 +0,0 @@
-[![Documentation](https://readthedocs.org/projects/restic/badge/?version=latest)](https://restic.readthedocs.io/en/latest/?badge=latest)
-[![Build Status](https://travis-ci.org/restic/restic.svg?branch=master)](https://travis-ci.org/restic/restic)
-[![Build status](https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true)](https://ci.appveyor.com/project/fd0/restic/branch/master)
-[![Report Card](http://goreportcard.com/badge/github.com/restic/restic)](http://goreportcard.com/report/github.com/restic/restic)
-
-
-Introduction
-============
-
-restic is a backup program that is fast, efficient and secure. Detailed
-information can be found in [the documentation](doc/index.md) and [the user
-manual](doc/Manual.md). The [design document](doc/Design.md) lists the
-technical background and gives detailed information about the structure of the
-repository and the data saved therein.
-
-The latest documentation can be viewed online at
-<https://restic.readthedocs.io/en/latest>. On the bottom left corner there is
-a menu that allows switching to the documentation and user manual for the
-latest released version.
-
-Build restic
-============
-
-Install Go/Golang (at least version 1.6), then run `go run build.go`,
-afterwards you'll find the binary in the current directory:
-
-    $ go run build.go
-
-    $ ./restic --help
-    Usage:
-      restic [OPTIONS] <command>
-    [...]
-
-More documentation can be found in the [user manual](doc/Manual.md).
-
-At the moment, the only tested compiler for restic is the official Go compiler.
-Building restic with gccgo may work, but is not supported.
-
-Contribute and Documentation
-============================
-
-Contributions are welcome! More information and a description of the
-development environment can be found in [`CONTRIBUTING.md`](CONTRIBUTING.md). A
-document describing the design of restic and the data structures stored on the
-back end is contained in [`doc/Design.md`](doc/Design.md).
-
-If you'd like to start contributing to restic, but don't know exactly what do
-to, have a look at this great article by Dave Cheney:
-[Suggestions for contributing to an Open Source project](http://dave.cheney.net/2016/03/12/suggestions-for-contributing-to-an-open-source-project)
-A few issues have been tagged with the label `help wanted`, you can start
-looking at those: https://github.com/restic/restic/labels/help%20wanted
-
-Contact
-=======
-
-If you discover a bug, find something surprising or if you would like to
-discuss or ask something, please [open a github issue](https://github.com/restic/restic/issues/new).
-If you would like to chat about restic, there is also the IRC channel #restic
-on irc.freenode.net.
-
-**Important**: If you discover something that you believe to be a possible critical
-security problem, please do *not* open a GitHub issue but send an email directly to
-alexander@bumpern.de. If possible, please encrypt your email using the following PGP key
-([0x91A6868BD3F7A907](https://pgp.mit.edu/pks/lookup?op=get&search=0xCF8F18F2844575973F79D4E191A6868BD3F7A907)):
-
-```
-pub   4096R/91A6868BD3F7A907 2014-11-01
-      Key fingerprint = CF8F 18F2 8445 7597 3F79  D4E1 91A6 868B D3F7 A907
-      uid                          Alexander Neumann <alexander@bumpern.de>
-      sub   4096R/D5FC2ACF4043FDF1 2014-11-01
-```
-
-License
-=======
-
-Restic is licensed under "BSD 2-Clause License". You can find the complete text
-in the file `LICENSE`.

README.rst

@@ -0,0 +1,124 @@
+|Documentation| |Build Status| |Build status| |Report Card| |Say Thanks| |TestCoverage|
+
+Introduction
+------------
+
+restic is a backup program that is fast, efficient and secure.
+
+For detailed usage and installation instructions check out the `documentation <https://restic.readthedocs.io/en/latest>`__.
+
+You can ask questions in our `Discourse forum <https://forum.restic.net>`__.
+
+Quick start
+-----------
+
+Once you've `installed
+<https://restic.readthedocs.io/en/latest/020_installation.html>`__ restic, start
+off with creating a repository for your backups:
+
+.. code-block:: console
+
+    $ restic init --repo /tmp/backup
+    enter password for new backend:
+    enter password again:
+    created restic backend 085b3c76b9 at /tmp/backup
+    Please note that knowledge of your password is required to access the repository.
+    Losing your password means that your data is irrecoverably lost.
+
+and add some data:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup ~/work
+    enter password for repository:
+    scan [/home/user/work]
+    scanned 764 directories, 1816 files in 0:00
+    [0:29] 100.00%  54.732 MiB/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
+    duration: 0:29, 54.47MiB/s
+    snapshot 40dc1520 saved
+
+Next you can either use ``restic restore`` to restore files or use ``restic
+mount`` to mount the repository via fuse and browse the files from previous
+snapshots.
+
+For more options check out the `online documentation <https://restic.readthedocs.io/en/latest/>`__.
+
+Backends
+--------
+
+Saving a backup on the same machine is nice but not a real backup strategy.
+Therefore, restic supports the following backends for storing backups natively:
+
+- `Local directory <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#local>`__
+- `sftp server (via SSH) <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#sftp>`__
+- `HTTP REST server <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server>`__ (`protocol <doc/rest_backend.rst>`__ `rest-server <https://github.com/restic/rest-server>`__)
+- `AWS S3 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#amazon-s3>`__ (either from Amazon or using the `Minio <https://minio.io>`__ server)
+- `OpenStack Swift <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#openstack-swift>`__
+- `BackBlaze B2 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2>`__
+- `Microsoft Azure Blob Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage>`__
+- `Google Cloud Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage>`__
+
+Design Principles
+-----------------
+
+Restic is a program that does backups right and was designed with the
+following principles in mind:
+
+-  **Easy:** Doing backups should be a frictionless process, otherwise
+   you might be tempted to skip it. Restic should be easy to configure
+   and use, so that, in the event of a data loss, you can just restore
+   it. Likewise, restoring data should not be complicated.
+
+-  **Fast**: Backing up your data with restic should only be limited by
+   your network or hard disk bandwidth so that you can backup your files
+   every day. Nobody does backups if it takes too much time. Restoring
+   backups should only transfer data that is needed for the files that
+   are to be restored, so that this process is also fast.
+
+-  **Verifiable**: Much more important than backup is restore, so restic
+   enables you to easily verify that all data can be restored.
+
+-  **Secure**: Restic uses cryptography to guarantee confidentiality and
+   integrity of your data. The location the backup data is stored is
+   assumed not to be a trusted environment (e.g. a shared space where
+   others like system administrators are able to access your backups).
+   Restic is built to secure your data against such attackers.
+
+-  **Efficient**: With the growth of data, additional snapshots should
+   only take the storage of the actual increment. Even more, duplicate
+   data should be de-duplicated before it is actually written to the
+   storage back end to save precious backup space.
+
+Reproducible Builds
+-------------------
+
+The binaries released with each restic version starting at 0.6.1 are
+`reproducible <https://reproducible-builds.org/>`__, which means that you can
+easily reproduce a byte identical version from the source code for that
+release. Instructions on how to do that are contained in the
+`builder repository <https://github.com/restic/builder>`__.
+
+News
+----
+
+You can follow the restic project on Twitter `@resticbackup <https://twitter.com/resticbackup>`__ or by subscribing to
+the `development blog <https://restic.github.io/blog/>`__.
+
+License
+-------
+
+Restic is licensed under `BSD 2-Clause License <https://opensource.org/licenses/BSD-2-Clause>`__. You can find the
+complete text in ``LICENSE``.
+
+.. |Documentation| image:: https://readthedocs.org/projects/restic/badge/?version=latest
+   :target: https://restic.readthedocs.io/en/latest/?badge=latest
+.. |Build Status| image:: https://travis-ci.org/restic/restic.svg?branch=master
+   :target: https://travis-ci.org/restic/restic
+.. |Build status| image:: https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true
+   :target: https://ci.appveyor.com/project/fd0/restic/branch/master
+.. |Report Card| image:: https://goreportcard.com/badge/github.com/restic/restic
+   :target: https://goreportcard.com/report/github.com/restic/restic
+.. |Say Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
+   :target: https://saythanks.io/to/restic
+.. |TestCoverage| image:: https://codecov.io/gh/restic/restic/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/restic/restic

VERSION

@@ -1 +1 @@
-0.3.2
+0.8.0

Vagrantfile

@@ -1,124 +0,0 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-GO_VERSION = '1.6'
-
-def packages_freebsd
-  return <<-EOF
-    pkg install -y git
-    pkg install -y curl
-
-    echo 'fuse_load="YES"' >> /boot/loader.conf
-    echo 'vfs.usermount=1' >> /etc/sysctl.conf
-
-    kldload fuse
-    sysctl vfs.usermount=1
-    pw groupmod operator -M vagrant
-  EOF
-end
-
-def packages_openbsd
-  return <<-EOF
-    . ~/.profile
-    pkg_add git curl bash gtar--
-    ln -sf /usr/local/bin/gtar /usr/local/bin/tar
-  EOF
-end
-
-def packages_linux
-  return <<-EOF
-    apt-get update
-    apt-get install -y git curl
-  EOF
-end
-
-def packages_darwin
-  return <<-EOF
-    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    brew cask install osxfuse
-  EOF
-end
-
-def install_gimme
-  return <<-EOF
-    rm -rf /opt/gimme
-    mkdir -p /opt/gimme || true
-    git clone https://github.com/meatballhat/gimme /opt/gimme
-    perl -p -i -e 's,/bin/bash,/usr/bin/env bash,' /opt/gimme/gimme
-    ln -sf /opt/gimme/gimme /usr/bin/gimme
-  EOF
-end
-
-def prepare_user(boxname)
-  return <<-EOF
-    mkdir -p ~/go/src
-    export PATH=/usr/local/bin:$PATH
-
-    gimme #{GO_VERSION} >> ~/.profile
-    echo export 'GOPATH=/vagrant/go' >> ~/.profile
-    echo export 'PATH=$GOPATH/bin:/usr/local/bin:$PATH' >> ~/.profile
-
-    . ~/.profile
-
-    go get golang.org/x/tools/cmd/cover
-    go get github.com/constabulary/gb/...
-
-    echo
-    echo "Run:"
-    echo "  vagrant rsync #{boxname}"
-    echo "  vagrant ssh #{boxname} -c 'cd /vagrant; gb build && gb test'"
-  EOF
-end
-
-def fix_perms
-  return <<-EOF
-    chown -R vagrant /vagrant
-  EOF
-end
-
-# All Vagrant configuration is done below. The "2" in Vagrant.configure
-# configures the configuration version (we support older styles for
-# backwards compatibility). Please don't change it unless you know what
-# you're doing.
-Vagrant.configure(2) do |config|
-  # use rsync to copy content to the folder
-  config.vm.synced_folder ".", "/vagrant", :type => "rsync"
-
-  # fix permissions on synced folder
-  config.vm.provision "fix perms", :type => :shell, :inline => fix_perms
-
-  config.vm.define "linux" do |b|
-    b.vm.box = "ubuntu/trusty64"
-    b.vm.provision "packages linux", :type => :shell, :inline => packages_linux
-    b.vm.provision "install gimme",  :type => :shell, :inline => install_gimme
-    b.vm.provision "prepare user",   :type => :shell, :privileged => false, :inline => prepare_user("linux")
-
-    # fix network card
-    config.vm.provider "virtualbox" do |v|
-      v.customize ["modifyvm", :id, "--nictype1", "virtio"]
-    end
-  end
-
-  config.vm.define "freebsd" do |b|
-    b.vm.box = "geoffgarside/freebsd-10.1"
-    b.vm.provision "packages freebsd", :type => :shell, :inline => packages_freebsd
-    b.vm.provision "install gimme",  :type => :shell, :inline => install_gimme
-    b.vm.provision "prepare user",   :type => :shell, :privileged => false, :inline => prepare_user("freebsd")
-  end
-
-  config.vm.define "openbsd" do |b|
-    b.vm.box = "tmatilai/openbsd-5.6"
-    b.vm.provision "packages openbsd", :type => :shell, :inline => packages_openbsd
-    b.vm.provision "install gimme",  :type => :shell, :inline => install_gimme
-    b.vm.provision "prepare user",   :type => :shell, :privileged => false, :inline => prepare_user("openbsd")
-  end
-
-  config.vm.define "darwin" do |b|
-    #b.vm.box = "jhcook/osx-yosemite-10.10"
-    b.vm.box = "jhcook/yosemite-clitools"
-    b.vm.provision "packages darwin", :type => :shell, :privileged => false, :inline => packages_darwin
-    b.vm.provision "install gimme",  :type => :shell, :inline => install_gimme
-    b.vm.provision "prepare user",   :type => :shell, :privileged => false, :inline => prepare_user("darwin")
-  end
-
-end

appveyor.yml

@@ -3,6 +3,10 @@ clone_folder: c:\restic
 environment:
   GOPATH: c:\gopath
 
+branches:
+  only:
+    - master
+
 init:
   - ps: >-
       $app = Get-WmiObject -Class Win32_Product -Filter "Vendor = 'http://golang.org'"
@@ -13,8 +17,8 @@ init:
 
 install:
   - rmdir c:\go /s /q
-  - appveyor DownloadFile https://storage.googleapis.com/golang/go1.7.windows-amd64.msi
-  - msiexec /i go1.7.windows-amd64.msi /q
+  - appveyor DownloadFile https://storage.googleapis.com/golang/go1.9.windows-amd64.msi
+  - msiexec /i go1.9.windows-amd64.msi /q
   - go version
   - go env
   - appveyor DownloadFile http://sourceforge.netcologne.de/project/gnuwin32/tar/1.13-1/tar-1.13-1-bin.zip -FileName tar.zip

build.go

@@ -12,13 +12,13 @@ import (
 	"path/filepath"
 	"runtime"
 	"strings"
-	"time"
 )
 
 var (
 	verbose    bool
 	keepGopath bool
 	runTests   bool
+	enableCGO  bool
 )
 
 var config = struct {
@@ -27,14 +27,14 @@ var config = struct {
 	Main      string
 	Tests     []string
 }{
-	Name:      "restic",                           // name of the program executable and directory
-	Namespace: "",                                 // subdir of GOPATH, e.g. "github.com/foo/bar"
-	Main:      "cmds/restic",                      // package name for the main package
-	Tests:     []string{"restic/...", "cmds/..."}, // tests to run
+	Name:      "restic",                              // name of the program executable and directory
+	Namespace: "github.com/restic/restic",            // subdir of GOPATH, e.g. "github.com/foo/bar"
+	Main:      "github.com/restic/restic/cmd/restic", // package name for the main package
+	Tests: []string{ // tests to run
+		"github.com/restic/restic/internal/...",
+		"github.com/restic/restic/cmd/..."},
 }
 
-const timeFormat = "2006-01-02 15:04:05"
-
 // specialDir returns true if the file begins with a special character ('.' or '_').
 func specialDir(name string) bool {
 	if name == "." {
@@ -52,7 +52,7 @@ func specialDir(name string) bool {
 // excludePath returns true if the file should not be copied to the new GOPATH.
 func excludePath(name string) bool {
 	ext := path.Ext(name)
-	if ext == ".go" || ext == ".s" {
+	if ext == ".go" || ext == ".s" || ext == ".h" {
 		return false
 	}
 
@@ -79,7 +79,12 @@ func excludePath(name string) bool {
 //               └── restic
 //                   └── foo.go
 func updateGopath(dst, src, prefix string) error {
+	verbosePrintf("copy contents of %v to %v\n", src, filepath.Join(dst, prefix))
 	return filepath.Walk(src, func(name string, fi os.FileInfo, err error) error {
+		if name == src {
+			return err
+		}
+
 		if specialDir(name) {
 			if fi.IsDir() {
 				return filepath.SkipDir
@@ -88,6 +93,10 @@ func updateGopath(dst, src, prefix string) error {
 			return nil
 		}
 
+		if err != nil {
+			return err
+		}
+
 		if fi.IsDir() {
 			return nil
 		}
@@ -128,6 +137,7 @@ func copyFile(dst, src string) error {
 	if err != nil {
 		return err
 	}
+	defer fsrc.Close()
 
 	if err = os.MkdirAll(filepath.Dir(dst), 0755); err != nil {
 		fmt.Printf("MkdirAll(%v)\n", filepath.Dir(dst))
@@ -138,28 +148,17 @@ func copyFile(dst, src string) error {
 	if err != nil {
 		return err
 	}
+	defer fdst.Close()
 
-	if _, err = io.Copy(fdst, fsrc); err != nil {
-		return err
-	}
-
-	if err == nil {
-		err = fsrc.Close()
-	}
-
-	if err == nil {
-		err = fdst.Close()
-	}
-
+	_, err = io.Copy(fdst, fsrc)
 	if err == nil {
 		err = os.Chmod(dst, fi.Mode())
 	}
-
 	if err == nil {
 		err = os.Chtimes(dst, fi.ModTime(), fi.ModTime())
 	}
 
-	return nil
+	return err
 }
 
 // die prints the message with fmt.Fprintf() to stderr and exits with an error
@@ -177,6 +176,8 @@ func showUsage(output io.Writer) {
 	fmt.Fprintf(output, "  -t     --tags          specify additional build tags\n")
 	fmt.Fprintf(output, "  -k     --keep-gopath   do not remove the GOPATH after build\n")
 	fmt.Fprintf(output, "  -T     --test          run tests\n")
+	fmt.Fprintf(output, "  -o     --output        set output file name\n")
+	fmt.Fprintf(output, "         --enable-cgo    use CGO to link against libc\n")
 	fmt.Fprintf(output, "         --goos value    set GOOS for cross-compilation\n")
 	fmt.Fprintf(output, "         --goarch value  set GOARCH for cross-compilation\n")
 }
@@ -205,9 +206,16 @@ func cleanEnv() (env []string) {
 
 // build runs "go build args..." with GOPATH set to gopath.
 func build(cwd, goos, goarch, gopath string, args ...string) error {
-	args = append([]string{"build"}, args...)
-	cmd := exec.Command("go", args...)
+	a := []string{"build"}
+	a = append(a, "-asmflags", fmt.Sprintf("-trimpath=%s", gopath))
+	a = append(a, "-gcflags", fmt.Sprintf("-trimpath=%s", gopath))
+	a = append(a, args...)
+	cmd := exec.Command("go", a...)
 	cmd.Env = append(cleanEnv(), "GOPATH="+gopath, "GOARCH="+goarch, "GOOS="+goos)
+	if !enableCGO {
+		cmd.Env = append(cmd.Env, "CGO_ENABLED=0")
+	}
+
 	cmd.Dir = cwd
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
@@ -293,6 +301,12 @@ func (cs Constants) LDFlags() string {
 }
 
 func main() {
+	ver := runtime.Version()
+	if strings.HasPrefix(ver, "go1") && ver < "go1.8" {
+		fmt.Fprintf(os.Stderr, "Go version %s detected, restic requires at least Go 1.8\n", ver)
+		os.Exit(1)
+	}
+
 	buildTags := []string{}
 
 	skipNext := false
@@ -301,6 +315,8 @@ func main() {
 	targetGOOS := runtime.GOOS
 	targetGOARCH := runtime.GOARCH
 
+	var outputFilename string
+
 	for i, arg := range params {
 		if skipNext {
 			skipNext = false
@@ -318,8 +334,13 @@ func main() {
 			}
 			skipNext = true
 			buildTags = strings.Split(params[i+1], " ")
+		case "-o", "--output":
+			skipNext = true
+			outputFilename = params[i+1]
 		case "-T", "--test":
 			runTests = true
+		case "--enable-cgo":
+			enableCGO = true
 		case "--goos":
 			skipNext = true
 			targetGOOS = params[i+1]
@@ -358,13 +379,13 @@ func main() {
 	}
 
 	verbosePrintf("create GOPATH at %v\n", gopath)
-	if err = updateGopath(gopath, filepath.Join(root, "src"), config.Namespace); err != nil {
+	if err = updateGopath(gopath, root, config.Namespace); err != nil {
 		die("copying files from %v/src to %v/src failed: %v\n", root, gopath, err)
 	}
 
-	vendor := filepath.Join(root, "vendor", "src")
+	vendor := filepath.Join(root, "vendor")
 	if directoryExists(vendor) {
-		if err = updateGopath(gopath, vendor, ""); err != nil {
+		if err = updateGopath(gopath, vendor, filepath.Join(config.Namespace, "vendor")); err != nil {
 			die("copying files from %v to %v failed: %v\n", root, gopath, err)
 		}
 	}
@@ -380,20 +401,24 @@ func main() {
 		}
 	}()
 
-	outputFilename := config.Name
-	if targetGOOS == "windows" {
-		outputFilename += ".exe"
+	if outputFilename == "" {
+		outputFilename = config.Name
+		if targetGOOS == "windows" {
+			outputFilename += ".exe"
+		}
 	}
 
 	cwd, err := os.Getwd()
 	if err != nil {
 		die("Getwd() returned %v\n", err)
 	}
-	output := filepath.Join(cwd, outputFilename)
+	output := outputFilename
+	if !filepath.IsAbs(output) {
+		output = filepath.Join(cwd, output)
+	}
 
 	version := getVersion()
-	compileTime := time.Now().Format(timeFormat)
-	constants := Constants{`main.compiledAt`: compileTime}
+	constants := Constants{}
 	if version != "" {
 		constants["main.version"] = version
 	}

cmd/restic/background_linux.go

@@ -4,7 +4,7 @@ import (
 	"syscall"
 	"unsafe"
 
-	"restic/debug"
+	"github.com/restic/restic/internal/debug"
 )
 
 // IsProcessBackground returns true if it is running in the background or false if not

cmd/restic/cleanup.go

@@ -0,0 +1,92 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"os/signal"
+	"sync"
+	"syscall"
+
+	"github.com/restic/restic/internal/debug"
+)
+
+var cleanupHandlers struct {
+	sync.Mutex
+	list []func() error
+	done bool
+	ch   chan os.Signal
+}
+
+var stderr = os.Stderr
+
+func init() {
+	cleanupHandlers.ch = make(chan os.Signal)
+	go CleanupHandler(cleanupHandlers.ch)
+	InstallSignalHandler()
+}
+
+// InstallSignalHandler listens for SIGINT and SIGPIPE, and triggers the cleanup handlers.
+func InstallSignalHandler() {
+	signal.Notify(cleanupHandlers.ch, syscall.SIGINT)
+	signal.Notify(cleanupHandlers.ch, syscall.SIGPIPE)
+}
+
+// SuspendSignalHandler removes the signal handler for SIGINT and SIGPIPE.
+func SuspendSignalHandler() {
+	signal.Reset(syscall.SIGINT)
+	signal.Reset(syscall.SIGPIPE)
+}
+
+// AddCleanupHandler adds the function f to the list of cleanup handlers so
+// that it is executed when all the cleanup handlers are run, e.g. when SIGINT
+// is received.
+func AddCleanupHandler(f func() error) {
+	cleanupHandlers.Lock()
+	defer cleanupHandlers.Unlock()
+
+	// reset the done flag for integration tests
+	cleanupHandlers.done = false
+
+	cleanupHandlers.list = append(cleanupHandlers.list, f)
+}
+
+// RunCleanupHandlers runs all registered cleanup handlers
+func RunCleanupHandlers() {
+	cleanupHandlers.Lock()
+	defer cleanupHandlers.Unlock()
+
+	if cleanupHandlers.done {
+		return
+	}
+	cleanupHandlers.done = true
+
+	for _, f := range cleanupHandlers.list {
+		err := f()
+		if err != nil {
+			fmt.Fprintf(stderr, "error in cleanup handler: %v\n", err)
+		}
+	}
+	cleanupHandlers.list = nil
+}
+
+// CleanupHandler handles the SIGINT and SIGPIPE signals.
+func CleanupHandler(c <-chan os.Signal) {
+	for s := range c {
+		debug.Log("signal %v received, cleaning up", s)
+		fmt.Fprintf(stderr, "%ssignal %v received, cleaning up\n", ClearLine(), s)
+
+		code := 0
+		if s != syscall.SIGINT {
+			code = 1
+		}
+
+		Exit(code)
+	}
+}
+
+// Exit runs the cleanup handlers and then terminates the process with the
+// given exit code.
+func Exit(code int) {
+	RunCleanupHandlers()
+	os.Exit(code)
+}

cmd/restic/cmd_backup.go

@@ -0,0 +1,520 @@
+package main
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+	"time"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/archiver"
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/fs"
+	"github.com/restic/restic/internal/restic"
+)
+
+var cmdBackup = &cobra.Command{
+	Use:   "backup [flags] FILE/DIR [FILE/DIR] ...",
+	Short: "Create a new backup of files and/or directories",
+	Long: `
+The "backup" command creates a new snapshot and saves the files and directories
+given as the arguments.
+`,
+	PreRun: func(cmd *cobra.Command, args []string) {
+		if backupOptions.Hostname == "" {
+			hostname, err := os.Hostname()
+			if err != nil {
+				debug.Log("os.Hostname() returned err: %v", err)
+				return
+			}
+			backupOptions.Hostname = hostname
+		}
+	},
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if backupOptions.Stdin && backupOptions.FilesFrom == "-" {
+			return errors.Fatal("cannot use both `--stdin` and `--files-from -`")
+		}
+
+		if backupOptions.Stdin {
+			return readBackupFromStdin(backupOptions, globalOptions, args)
+		}
+
+		return runBackup(backupOptions, globalOptions, args)
+	},
+}
+
+// BackupOptions bundles all options for the backup command.
+type BackupOptions struct {
+	Parent           string
+	Force            bool
+	Excludes         []string
+	ExcludeFiles     []string
+	ExcludeOtherFS   bool
+	ExcludeIfPresent []string
+	ExcludeCaches    bool
+	Stdin            bool
+	StdinFilename    string
+	Tags             []string
+	Hostname         string
+	FilesFrom        string
+	TimeStamp        string
+}
+
+var backupOptions BackupOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdBackup)
+
+	f := cmdBackup.Flags()
+	f.StringVar(&backupOptions.Parent, "parent", "", "use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)")
+	f.BoolVarP(&backupOptions.Force, "force", "f", false, `force re-reading the target files/directories (overrides the "parent" flag)`)
+	f.StringArrayVarP(&backupOptions.Excludes, "exclude", "e", nil, "exclude a `pattern` (can be specified multiple times)")
+	f.StringArrayVar(&backupOptions.ExcludeFiles, "exclude-file", nil, "read exclude patterns from a `file` (can be specified multiple times)")
+	f.BoolVarP(&backupOptions.ExcludeOtherFS, "one-file-system", "x", false, "exclude other file systems")
+	f.StringArrayVar(&backupOptions.ExcludeIfPresent, "exclude-if-present", nil, "takes filename[:header], exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)")
+	f.BoolVar(&backupOptions.ExcludeCaches, "exclude-caches", false, `excludes cache directories that are marked with a CACHEDIR.TAG file`)
+	f.BoolVar(&backupOptions.Stdin, "stdin", false, "read backup from stdin")
+	f.StringVar(&backupOptions.StdinFilename, "stdin-filename", "stdin", "file name to use when reading from stdin")
+	f.StringArrayVar(&backupOptions.Tags, "tag", nil, "add a `tag` for the new snapshot (can be specified multiple times)")
+	f.StringVar(&backupOptions.Hostname, "hostname", "", "set the `hostname` for the snapshot manually. To prevent an expensive rescan use the \"parent\" flag")
+	f.StringVar(&backupOptions.FilesFrom, "files-from", "", "read the files to backup from file (can be combined with file args)")
+	f.StringVar(&backupOptions.TimeStamp, "time", "", "time of the backup (ex. '2012-11-01 22:08:41') (default: now)")
+}
+
+func newScanProgress(gopts GlobalOptions) *restic.Progress {
+	if gopts.Quiet {
+		return nil
+	}
+
+	p := restic.NewProgress()
+	p.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+		if IsProcessBackground() {
+			return
+		}
+
+		PrintProgress("[%s] %d directories, %d files, %s", formatDuration(d), s.Dirs, s.Files, formatBytes(s.Bytes))
+	}
+
+	p.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
+		PrintProgress("scanned %d directories, %d files in %s\n", s.Dirs, s.Files, formatDuration(d))
+	}
+
+	return p
+}
+
+func newArchiveProgress(gopts GlobalOptions, todo restic.Stat) *restic.Progress {
+	if gopts.Quiet {
+		return nil
+	}
+
+	archiveProgress := restic.NewProgress()
+
+	var bps, eta uint64
+	itemsTodo := todo.Files + todo.Dirs
+
+	archiveProgress.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+		if IsProcessBackground() {
+			return
+		}
+
+		sec := uint64(d / time.Second)
+		if todo.Bytes > 0 && sec > 0 && ticker {
+			bps = s.Bytes / sec
+			if s.Bytes >= todo.Bytes {
+				eta = 0
+			} else if bps > 0 {
+				eta = (todo.Bytes - s.Bytes) / bps
+			}
+		}
+
+		itemsDone := s.Files + s.Dirs
+
+		status1 := fmt.Sprintf("[%s] %s  %s/s  %s / %s  %d / %d items  %d errors  ",
+			formatDuration(d),
+			formatPercent(s.Bytes, todo.Bytes),
+			formatBytes(bps),
+			formatBytes(s.Bytes), formatBytes(todo.Bytes),
+			itemsDone, itemsTodo,
+			s.Errors)
+		status2 := fmt.Sprintf("ETA %s ", formatSeconds(eta))
+
+		if w := stdoutTerminalWidth(); w > 0 {
+			maxlen := w - len(status2) - 1
+
+			if maxlen < 4 {
+				status1 = ""
+			} else if len(status1) > maxlen {
+				status1 = status1[:maxlen-4]
+				status1 += "... "
+			}
+		}
+
+		PrintProgress("%s%s", status1, status2)
+	}
+
+	archiveProgress.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
+		fmt.Printf("\nduration: %s, %s\n", formatDuration(d), formatRate(todo.Bytes, d))
+	}
+
+	return archiveProgress
+}
+
+func newArchiveStdinProgress(gopts GlobalOptions) *restic.Progress {
+	if gopts.Quiet {
+		return nil
+	}
+
+	archiveProgress := restic.NewProgress()
+
+	var bps uint64
+
+	archiveProgress.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+		if IsProcessBackground() {
+			return
+		}
+
+		sec := uint64(d / time.Second)
+		if s.Bytes > 0 && sec > 0 && ticker {
+			bps = s.Bytes / sec
+		}
+
+		status1 := fmt.Sprintf("[%s] %s  %s/s", formatDuration(d),
+			formatBytes(s.Bytes),
+			formatBytes(bps))
+
+		if w := stdoutTerminalWidth(); w > 0 {
+			maxlen := w - len(status1)
+
+			if maxlen < 4 {
+				status1 = ""
+			} else if len(status1) > maxlen {
+				status1 = status1[:maxlen-4]
+				status1 += "... "
+			}
+		}
+
+		PrintProgress("%s", status1)
+	}
+
+	archiveProgress.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
+		fmt.Printf("\nduration: %s, %s\n", formatDuration(d), formatRate(s.Bytes, d))
+	}
+
+	return archiveProgress
+}
+
+// filterExisting returns a slice of all existing items, or an error if no
+// items exist at all.
+func filterExisting(items []string) (result []string, err error) {
+	for _, item := range items {
+		_, err := fs.Lstat(item)
+		if err != nil && os.IsNotExist(errors.Cause(err)) {
+			Warnf("%v does not exist, skipping\n", item)
+			continue
+		}
+
+		result = append(result, item)
+	}
+
+	if len(result) == 0 {
+		return nil, errors.Fatal("all target directories/files do not exist")
+	}
+
+	return
+}
+
+func readBackupFromStdin(opts BackupOptions, gopts GlobalOptions, args []string) error {
+	if len(args) != 0 {
+		return errors.Fatal("when reading from stdin, no additional files can be specified")
+	}
+
+	if opts.StdinFilename == "" {
+		return errors.Fatal("filename for backup from stdin must not be empty")
+	}
+
+	if gopts.password == "" {
+		return errors.Fatal("unable to read password from stdin when data is to be read from stdin, use --password-file or $RESTIC_PASSWORD")
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepo(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	err = repo.LoadIndex(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	r := &archiver.Reader{
+		Repository: repo,
+		Tags:       opts.Tags,
+		Hostname:   opts.Hostname,
+	}
+
+	_, id, err := r.Archive(context.TODO(), opts.StdinFilename, os.Stdin, newArchiveStdinProgress(gopts))
+	if err != nil {
+		return err
+	}
+
+	Verbosef("archived as %v\n", id.Str())
+	return nil
+}
+
+// readFromFile will read all lines from the given filename and write them to a
+// string array, if filename is empty readFromFile returns and empty string
+// array. If filename is a dash (-), readFromFile will read the lines from
+// the standard input.
+func readLinesFromFile(filename string) ([]string, error) {
+	if filename == "" {
+		return nil, nil
+	}
+
+	var r io.Reader = os.Stdin
+	if filename != "-" {
+		f, err := os.Open(filename)
+		if err != nil {
+			return nil, err
+		}
+		defer f.Close()
+		r = f
+	}
+
+	var lines []string
+
+	scanner := bufio.NewScanner(r)
+	for scanner.Scan() {
+		line := scanner.Text()
+		// ignore empty lines
+		if line == "" {
+			continue
+		}
+		// strip comments
+		if strings.HasPrefix(line, "#") {
+			continue
+		}
+		lines = append(lines, line)
+	}
+
+	if err := scanner.Err(); err != nil {
+		return nil, err
+	}
+
+	return lines, nil
+}
+
+func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
+	if opts.FilesFrom == "-" && gopts.password == "" {
+		return errors.Fatal("unable to read password from stdin when data is to be read from stdin, use --password-file or $RESTIC_PASSWORD")
+	}
+
+	fromfile, err := readLinesFromFile(opts.FilesFrom)
+	if err != nil {
+		return err
+	}
+
+	// merge files from files-from into normal args so we can reuse the normal
+	// args checks and have the ability to use both files-from and args at the
+	// same time
+	args = append(args, fromfile...)
+	if len(args) == 0 {
+		return errors.Fatal("nothing to backup, please specify target files/dirs")
+	}
+
+	target := make([]string, 0, len(args))
+	for _, d := range args {
+		if a, err := filepath.Abs(d); err == nil {
+			d = a
+		}
+		target = append(target, d)
+	}
+
+	target, err = filterExisting(target)
+	if err != nil {
+		return err
+	}
+
+	// rejectFuncs collect functions that can reject items from the backup
+	var rejectFuncs []RejectFunc
+
+	// allowed devices
+	if opts.ExcludeOtherFS {
+		f, err := rejectByDevice(target)
+		if err != nil {
+			return err
+		}
+		rejectFuncs = append(rejectFuncs, f)
+	}
+
+	// add patterns from file
+	if len(opts.ExcludeFiles) > 0 {
+		opts.Excludes = append(opts.Excludes, readExcludePatternsFromFiles(opts.ExcludeFiles)...)
+	}
+
+	if len(opts.Excludes) > 0 {
+		rejectFuncs = append(rejectFuncs, rejectByPattern(opts.Excludes))
+	}
+
+	if opts.ExcludeCaches {
+		opts.ExcludeIfPresent = append(opts.ExcludeIfPresent, "CACHEDIR.TAG:Signature: 8a477f597d28d172789f06886806bc55")
+	}
+
+	rc := &rejectionCache{}
+	for _, spec := range opts.ExcludeIfPresent {
+		f, err := rejectIfPresent(spec, rc)
+		if err != nil {
+			return err
+		}
+
+		rejectFuncs = append(rejectFuncs, f)
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepo(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	// exclude restic cache
+	if repo.Cache != nil {
+		f, err := rejectResticCache(repo)
+		if err != nil {
+			return err
+		}
+
+		rejectFuncs = append(rejectFuncs, f)
+	}
+
+	err = repo.LoadIndex(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	var parentSnapshotID *restic.ID
+
+	// Force using a parent
+	if !opts.Force && opts.Parent != "" {
+		id, err := restic.FindSnapshot(repo, opts.Parent)
+		if err != nil {
+			return errors.Fatalf("invalid id %q: %v", opts.Parent, err)
+		}
+
+		parentSnapshotID = &id
+	}
+
+	// Find last snapshot to set it as parent, if not already set
+	if !opts.Force && parentSnapshotID == nil {
+		id, err := restic.FindLatestSnapshot(context.TODO(), repo, target, []restic.TagList{}, opts.Hostname)
+		if err == nil {
+			parentSnapshotID = &id
+		} else if err != restic.ErrNoSnapshotFound {
+			return err
+		}
+	}
+
+	if parentSnapshotID != nil {
+		Verbosef("using parent snapshot %v\n", parentSnapshotID.Str())
+	}
+
+	Verbosef("scan %v\n", target)
+
+	selectFilter := func(item string, fi os.FileInfo) bool {
+		for _, reject := range rejectFuncs {
+			if reject(item, fi) {
+				return false
+			}
+		}
+		return true
+	}
+
+	stat, err := archiver.Scan(target, selectFilter, newScanProgress(gopts))
+	if err != nil {
+		return err
+	}
+
+	arch := archiver.New(repo)
+	arch.Excludes = opts.Excludes
+	arch.SelectFilter = selectFilter
+
+	arch.Warn = func(dir string, fi os.FileInfo, err error) {
+		// TODO: make ignoring errors configurable
+		Warnf("%s\rwarning for %s: %v\n", ClearLine(), dir, err)
+	}
+
+	timeStamp := time.Now()
+	if opts.TimeStamp != "" {
+		timeStamp, err = time.Parse(TimeFormat, opts.TimeStamp)
+		if err != nil {
+			return errors.Fatalf("error in time option: %v\n", err)
+		}
+	}
+
+	_, id, err := arch.Snapshot(context.TODO(), newArchiveProgress(gopts, stat), target, opts.Tags, opts.Hostname, parentSnapshotID, timeStamp)
+	if err != nil {
+		return err
+	}
+
+	Verbosef("snapshot %s saved\n", id.Str())
+
+	return nil
+}
+
+func readExcludePatternsFromFiles(excludeFiles []string) []string {
+	var excludes []string
+	for _, filename := range excludeFiles {
+		err := func() (err error) {
+			file, err := fs.Open(filename)
+			if err != nil {
+				return err
+			}
+			defer func() {
+				// return pre-close error if there was one
+				if errClose := file.Close(); err == nil {
+					err = errClose
+				}
+			}()
+
+			scanner := bufio.NewScanner(file)
+			for scanner.Scan() {
+				line := strings.TrimSpace(scanner.Text())
+
+				// ignore empty lines
+				if line == "" {
+					continue
+				}
+
+				// strip comments
+				if strings.HasPrefix(line, "#") {
+					continue
+				}
+
+				line = os.ExpandEnv(line)
+				excludes = append(excludes, line)
+			}
+			return scanner.Err()
+		}()
+		if err != nil {
+			Warnf("error reading exclude patterns: %v:", err)
+			return nil
+		}
+	}
+	return excludes
+}

cmd/restic/cmd_cat.go

@@ -1,25 +1,26 @@
 package main
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
 
 	"github.com/spf13/cobra"
 
-	"restic"
-	"restic/backend"
-	"restic/debug"
-	"restic/errors"
-	"restic/repository"
+	"github.com/restic/restic/internal/backend"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
 )
 
 var cmdCat = &cobra.Command{
-	Use:   "cat [flags] [pack|blob|tree|snapshot|key|masterkey|config|lock] ID",
-	Short: "print internal objects to stdout",
+	Use:   "cat [flags] [pack|blob|snapshot|index|key|masterkey|config|lock] ID",
+	Short: "Print internal objects to stdout",
 	Long: `
 The "cat" command is used to print internal objects to stdout.
 `,
+	DisableAutoGenTag: true,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return runCat(globalOptions, args)
 	},
@@ -31,7 +32,7 @@ func init() {
 
 func runCat(gopts GlobalOptions, args []string) error {
 	if len(args) < 1 || (args[0] != "masterkey" && args[0] != "config" && len(args) != 2) {
-		return errors.Fatalf("type or ID not specified")
+		return errors.Fatal("type or ID not specified")
 	}
 
 	repo, err := OpenRepository(gopts)
@@ -74,7 +75,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 		fmt.Println(string(buf))
 		return nil
 	case "index":
-		buf, err := repo.LoadAndDecrypt(restic.IndexFile, id)
+		buf, err := repo.LoadAndDecrypt(context.TODO(), restic.IndexFile, id)
 		if err != nil {
 			return err
 		}
@@ -84,7 +85,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 
 	case "snapshot":
 		sn := &restic.Snapshot{}
-		err = repo.LoadJSONUnpacked(restic.SnapshotFile, id, sn)
+		err = repo.LoadJSONUnpacked(context.TODO(), restic.SnapshotFile, id, sn)
 		if err != nil {
 			return err
 		}
@@ -99,7 +100,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 		return nil
 	case "key":
 		h := restic.Handle{Type: restic.KeyFile, Name: id.String()}
-		buf, err := backend.LoadAll(repo.Backend(), h, nil)
+		buf, err := backend.LoadAll(context.TODO(), repo.Backend(), h)
 		if err != nil {
 			return err
 		}
@@ -126,7 +127,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 		fmt.Println(string(buf))
 		return nil
 	case "lock":
-		lock, err := restic.LoadLock(repo, id)
+		lock, err := restic.LoadLock(context.TODO(), repo, id)
 		if err != nil {
 			return err
 		}
@@ -142,7 +143,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 	}
 
 	// load index, handle all the other types
-	err = repo.LoadIndex()
+	err = repo.LoadIndex(context.TODO())
 	if err != nil {
 		return err
 	}
@@ -150,7 +151,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 	switch tpe {
 	case "pack":
 		h := restic.Handle{Type: restic.DataFile, Name: id.String()}
-		buf, err := backend.LoadAll(repo.Backend(), h, nil)
+		buf, err := backend.LoadAll(context.TODO(), repo.Backend(), h)
 		if err != nil {
 			return err
 		}
@@ -172,7 +173,7 @@ func runCat(gopts GlobalOptions, args []string) error {
 			blob := list[0]
 
 			buf := make([]byte, blob.Length)
-			n, err := repo.LoadBlob(restic.DataBlob, id, buf)
+			n, err := repo.LoadBlob(context.TODO(), t, id, buf)
 			if err != nil {
 				return err
 			}
@@ -184,23 +185,6 @@ func runCat(gopts GlobalOptions, args []string) error {
 
 		return errors.Fatal("blob not found")
 
-	case "tree":
-		debug.Log("cat tree %v", id.Str())
-		tree, err := repo.LoadTree(id)
-		if err != nil {
-			debug.Log("unable to load tree %v: %v", id.Str(), err)
-			return err
-		}
-
-		buf, err := json.MarshalIndent(&tree, "", "  ")
-		if err != nil {
-			debug.Log("error json.MarshalIndent(): %v", err)
-			return err
-		}
-
-		_, err = os.Stdout.Write(append(buf, '\n'))
-		return nil
-
 	default:
 		return errors.Fatal("invalid type")
 	}

cmd/restic/cmd_check.go

@@ -0,0 +1,183 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/checker"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/restic"
+)
+
+var cmdCheck = &cobra.Command{
+	Use:   "check [flags]",
+	Short: "Check the repository for errors",
+	Long: `
+The "check" command tests the repository for errors and reports any errors it
+finds. It can also be used to read all data and therefore simulate a restore.
+
+By default, the "check" command will always load all data directly from the
+repository and not use a local cache.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runCheck(checkOptions, globalOptions, args)
+	},
+}
+
+// CheckOptions bundles all options for the 'check' command.
+type CheckOptions struct {
+	ReadData    bool
+	CheckUnused bool
+	WithCache   bool
+}
+
+var checkOptions CheckOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdCheck)
+
+	f := cmdCheck.Flags()
+	f.BoolVar(&checkOptions.ReadData, "read-data", false, "read all data blobs")
+	f.BoolVar(&checkOptions.CheckUnused, "check-unused", false, "find unused blobs")
+	f.BoolVar(&checkOptions.WithCache, "with-cache", false, "use the cache")
+}
+
+func newReadProgress(gopts GlobalOptions, todo restic.Stat) *restic.Progress {
+	if gopts.Quiet {
+		return nil
+	}
+
+	readProgress := restic.NewProgress()
+
+	readProgress.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+		status := fmt.Sprintf("[%s] %s  %d / %d items",
+			formatDuration(d),
+			formatPercent(s.Blobs, todo.Blobs),
+			s.Blobs, todo.Blobs)
+
+		if w := stdoutTerminalWidth(); w > 0 {
+			if len(status) > w {
+				max := w - len(status) - 4
+				status = status[:max] + "... "
+			}
+		}
+
+		PrintProgress("%s", status)
+	}
+
+	readProgress.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
+		fmt.Printf("\nduration: %s\n", formatDuration(d))
+	}
+
+	return readProgress
+}
+
+func runCheck(opts CheckOptions, gopts GlobalOptions, args []string) error {
+	if len(args) != 0 {
+		return errors.Fatal("check has no arguments")
+	}
+
+	if !opts.WithCache {
+		// do not use a cache for the checker
+		gopts.NoCache = true
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		Verbosef("create exclusive lock for repository\n")
+		lock, err := lockRepoExclusive(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	chkr := checker.New(repo)
+
+	Verbosef("load indexes\n")
+	hints, errs := chkr.LoadIndex(context.TODO())
+
+	dupFound := false
+	for _, hint := range hints {
+		Printf("%v\n", hint)
+		if _, ok := hint.(checker.ErrDuplicatePacks); ok {
+			dupFound = true
+		}
+	}
+
+	if dupFound {
+		Printf("\nrun `restic rebuild-index' to correct this\n")
+	}
+
+	if len(errs) > 0 {
+		for _, err := range errs {
+			Warnf("error: %v\n", err)
+		}
+		return errors.Fatal("LoadIndex returned errors")
+	}
+
+	errorsFound := false
+	errChan := make(chan error)
+
+	Verbosef("check all packs\n")
+	go chkr.Packs(context.TODO(), errChan)
+
+	for err := range errChan {
+		errorsFound = true
+		fmt.Fprintf(os.Stderr, "%v\n", err)
+	}
+
+	Verbosef("check snapshots, trees and blobs\n")
+	errChan = make(chan error)
+	go chkr.Structure(context.TODO(), errChan)
+
+	for err := range errChan {
+		errorsFound = true
+		if e, ok := err.(checker.TreeError); ok {
+			fmt.Fprintf(os.Stderr, "error for tree %v:\n", e.ID.Str())
+			for _, treeErr := range e.Errors {
+				fmt.Fprintf(os.Stderr, "  %v\n", treeErr)
+			}
+		} else {
+			fmt.Fprintf(os.Stderr, "error: %v\n", err)
+		}
+	}
+
+	if opts.CheckUnused {
+		for _, id := range chkr.UnusedBlobs() {
+			Verbosef("unused blob %v\n", id.Str())
+			errorsFound = true
+		}
+	}
+
+	if opts.ReadData {
+		Verbosef("read all data\n")
+
+		p := newReadProgress(gopts, restic.Stat{Blobs: chkr.CountPacks()})
+		errChan := make(chan error)
+
+		go chkr.ReadData(context.TODO(), p, errChan)
+
+		for err := range errChan {
+			errorsFound = true
+			fmt.Fprintf(os.Stderr, "%v\n", err)
+		}
+	}
+
+	if errorsFound {
+		return errors.Fatal("repository contains errors")
+	}
+
+	Verbosef("no errors were found\n")
+
+	return nil
+}

cmd/restic/cmd_debug.go

@@ -0,0 +1,217 @@
+// +build debug
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/pack"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/restic/restic/internal/worker"
+)
+
+var cmdDebug = &cobra.Command{
+	Use:   "debug",
+	Short: "Debug commands",
+}
+
+var cmdDebugDump = &cobra.Command{
+	Use:   "dump [indexes|snapshots|all|packs]",
+	Short: "Dump data structures",
+	Long: `
+The "dump" command dumps data structures from the repository as JSON objects. It
+is used for debugging purposes only.`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runDebugDump(globalOptions, args)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdDebug)
+	cmdDebug.AddCommand(cmdDebugDump)
+}
+
+func prettyPrintJSON(wr io.Writer, item interface{}) error {
+	buf, err := json.MarshalIndent(item, "", "  ")
+	if err != nil {
+		return err
+	}
+
+	_, err = wr.Write(append(buf, '\n'))
+	return err
+}
+
+func debugPrintSnapshots(repo *repository.Repository, wr io.Writer) error {
+	for id := range repo.List(context.TODO(), restic.SnapshotFile) {
+		snapshot, err := restic.LoadSnapshot(context.TODO(), repo, id)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "LoadSnapshot(%v): %v", id.Str(), err)
+			continue
+		}
+
+		fmt.Fprintf(wr, "snapshot_id: %v\n", id)
+
+		err = prettyPrintJSON(wr, snapshot)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+const dumpPackWorkers = 10
+
+// Pack is the struct used in printPacks.
+type Pack struct {
+	Name string `json:"name"`
+
+	Blobs []Blob `json:"blobs"`
+}
+
+// Blob is the struct used in printPacks.
+type Blob struct {
+	Type   restic.BlobType `json:"type"`
+	Length uint            `json:"length"`
+	ID     restic.ID       `json:"id"`
+	Offset uint            `json:"offset"`
+}
+
+func printPacks(repo *repository.Repository, wr io.Writer) error {
+	f := func(ctx context.Context, job worker.Job) (interface{}, error) {
+		name := job.Data.(string)
+
+		h := restic.Handle{Type: restic.DataFile, Name: name}
+
+		blobInfo, err := repo.Backend().Stat(ctx, h)
+		if err != nil {
+			return nil, err
+		}
+
+		blobs, err := pack.List(repo.Key(), restic.ReaderAt(repo.Backend(), h), blobInfo.Size)
+		if err != nil {
+			return nil, err
+		}
+
+		return blobs, nil
+	}
+
+	jobCh := make(chan worker.Job)
+	resCh := make(chan worker.Job)
+	wp := worker.New(context.TODO(), dumpPackWorkers, f, jobCh, resCh)
+
+	go func() {
+		for name := range repo.Backend().List(context.TODO(), restic.DataFile) {
+			jobCh <- worker.Job{Data: name}
+		}
+		close(jobCh)
+	}()
+
+	for job := range resCh {
+		name := job.Data.(string)
+
+		if job.Error != nil {
+			fmt.Fprintf(os.Stderr, "error for pack %v: %v\n", name, job.Error)
+			continue
+		}
+
+		entries := job.Result.([]restic.Blob)
+		p := Pack{
+			Name:  name,
+			Blobs: make([]Blob, len(entries)),
+		}
+		for i, blob := range entries {
+			p.Blobs[i] = Blob{
+				Type:   blob.Type,
+				Length: blob.Length,
+				ID:     blob.ID,
+				Offset: blob.Offset,
+			}
+		}
+
+		prettyPrintJSON(os.Stdout, p)
+	}
+
+	wp.Wait()
+
+	return nil
+}
+
+func dumpIndexes(repo restic.Repository) error {
+	for id := range repo.List(context.TODO(), restic.IndexFile) {
+		fmt.Printf("index_id: %v\n", id)
+
+		idx, err := repository.LoadIndex(context.TODO(), repo, id)
+		if err != nil {
+			return err
+		}
+
+		err = idx.Dump(os.Stdout)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func runDebugDump(gopts GlobalOptions, args []string) error {
+	if len(args) != 1 {
+		return errors.Fatal("type not specified")
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = repo.LoadIndex(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	tpe := args[0]
+
+	switch tpe {
+	case "indexes":
+		return dumpIndexes(repo)
+	case "snapshots":
+		return debugPrintSnapshots(repo, os.Stdout)
+	case "packs":
+		return printPacks(repo, os.Stdout)
+	case "all":
+		fmt.Printf("snapshots:\n")
+		err := debugPrintSnapshots(repo, os.Stdout)
+		if err != nil {
+			return err
+		}
+
+		fmt.Printf("\nindexes:\n")
+		err = dumpIndexes(repo)
+		if err != nil {
+			return err
+		}
+
+		return nil
+	default:
+		return errors.Fatalf("no such type %q", tpe)
+	}
+}

cmd/restic/cmd_dump.go

@@ -0,0 +1,181 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdDump = &cobra.Command{
+	Use:   "dump [flags] snapshotID file",
+	Short: "Print a backed-up file to stdout",
+	Long: `
+The "dump" command extracts a single file from a snapshot from the repository and
+prints its contents to stdout.
+
+The special snapshot "latest" can be used to use the latest snapshot in the
+repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runDump(dumpOptions, globalOptions, args)
+	},
+}
+
+// DumpOptions collects all options for the dump command.
+type DumpOptions struct {
+	Host  string
+	Paths []string
+	Tags  restic.TagLists
+}
+
+var dumpOptions DumpOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdDump)
+
+	flags := cmdDump.Flags()
+	flags.StringVarP(&dumpOptions.Host, "host", "H", "", `only consider snapshots for this host when the snapshot ID is "latest"`)
+	flags.Var(&dumpOptions.Tags, "tag", "only consider snapshots which include this `taglist` for snapshot ID \"latest\"")
+	flags.StringArrayVar(&dumpOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path` for snapshot ID \"latest\"")
+}
+
+func splitPath(path string) []string {
+	d, f := filepath.Split(path)
+	if d == "" || d == "/" {
+		return []string{f}
+	}
+	s := splitPath(filepath.Clean(d))
+	return append(s, f)
+}
+
+func dumpNode(ctx context.Context, repo restic.Repository, node *restic.Node) error {
+	var buf []byte
+	for _, id := range node.Content {
+		size, err := repo.LookupBlobSize(id, restic.DataBlob)
+		if err != nil {
+			return err
+		}
+
+		buf = buf[:cap(buf)]
+		if len(buf) < restic.CiphertextLength(int(size)) {
+			buf = restic.NewBlobBuffer(int(size))
+		}
+
+		n, err := repo.LoadBlob(ctx, restic.DataBlob, id, buf)
+		if err != nil {
+			return err
+		}
+		buf = buf[:n]
+
+		_, err = os.Stdout.Write(buf)
+		if err != nil {
+			return errors.Wrap(err, "Write")
+		}
+	}
+	return nil
+}
+
+func printFromTree(ctx context.Context, tree *restic.Tree, repo restic.Repository, prefix string, pathComponents []string) error {
+	if tree == nil {
+		return fmt.Errorf("called with a nil tree")
+	}
+	if repo == nil {
+		return fmt.Errorf("called with a nil repository")
+	}
+	l := len(pathComponents)
+	if l == 0 {
+		return fmt.Errorf("empty path components")
+	}
+	item := filepath.Join(prefix, pathComponents[0])
+	for _, node := range tree.Nodes {
+		if node.Name == pathComponents[0] {
+			switch {
+			case l == 1 && node.Type == "file":
+				return dumpNode(ctx, repo, node)
+			case l > 1 && node.Type == "dir":
+				subtree, err := repo.LoadTree(ctx, *node.Subtree)
+				if err != nil {
+					return errors.Wrapf(err, "cannot load subtree for %q", item)
+				}
+				return printFromTree(ctx, subtree, repo, item, pathComponents[1:])
+			case l > 1:
+				return fmt.Errorf("%q should be a dir, but s a %q", item, node.Type)
+			case node.Type != "file":
+				return fmt.Errorf("%q should be a file, but is a %q", item, node.Type)
+			}
+		}
+	}
+	return fmt.Errorf("path %q not found in snapshot", item)
+}
+
+func runDump(opts DumpOptions, gopts GlobalOptions, args []string) error {
+	ctx := gopts.ctx
+
+	if len(args) != 2 {
+		return errors.Fatal("no file and no snapshot ID specified")
+	}
+
+	snapshotIDString := args[0]
+	pathToPrint := args[1]
+
+	debug.Log("dump file %q from %q", pathToPrint, snapshotIDString)
+
+	splittedPath := splitPath(pathToPrint)
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = repo.LoadIndex(ctx)
+	if err != nil {
+		return err
+	}
+
+	var id restic.ID
+
+	if snapshotIDString == "latest" {
+		id, err = restic.FindLatestSnapshot(ctx, repo, opts.Paths, opts.Tags, opts.Host)
+		if err != nil {
+			Exitf(1, "latest snapshot for criteria not found: %v Paths:%v Host:%v", err, opts.Paths, opts.Host)
+		}
+	} else {
+		id, err = restic.FindSnapshot(repo, snapshotIDString)
+		if err != nil {
+			Exitf(1, "invalid id %q: %v", snapshotIDString, err)
+		}
+	}
+
+	sn, err := restic.LoadSnapshot(context.TODO(), repo, id)
+	if err != nil {
+		Exitf(2, "loading snapshot %q failed: %v", snapshotIDString, err)
+	}
+
+	tree, err := repo.LoadTree(ctx, *sn.Tree)
+	if err != nil {
+		Exitf(2, "loading tree for snapshot %q failed: %v", snapshotIDString, err)
+	}
+
+	err = printFromTree(ctx, tree, repo, "", splittedPath)
+	if err != nil {
+		Exitf(2, "cannot dump file: %v", err)
+	}
+
+	return nil
+}

cmd/restic/cmd_find.go

@@ -0,0 +1,308 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"path/filepath"
+	"strings"
+	"time"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/restic"
+)
+
+var cmdFind = &cobra.Command{
+	Use:   "find [flags] PATTERN",
+	Short: "Find a file or directory",
+	Long: `
+The "find" command searches for files or directories in snapshots stored in the
+repo. `,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runFind(findOptions, globalOptions, args)
+	},
+}
+
+// FindOptions bundles all options for the find command.
+type FindOptions struct {
+	Oldest          string
+	Newest          string
+	Snapshots       []string
+	CaseInsensitive bool
+	ListLong        bool
+	Host            string
+	Paths           []string
+	Tags            restic.TagLists
+}
+
+var findOptions FindOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdFind)
+
+	f := cmdFind.Flags()
+	f.StringVarP(&findOptions.Oldest, "oldest", "O", "", "oldest modification date/time")
+	f.StringVarP(&findOptions.Newest, "newest", "N", "", "newest modification date/time")
+	f.StringArrayVarP(&findOptions.Snapshots, "snapshot", "s", nil, "snapshot `id` to search in (can be given multiple times)")
+	f.BoolVarP(&findOptions.CaseInsensitive, "ignore-case", "i", false, "ignore case for pattern")
+	f.BoolVarP(&findOptions.ListLong, "long", "l", false, "use a long listing format showing size and mode")
+
+	f.StringVarP(&findOptions.Host, "host", "H", "", "only consider snapshots for this `host`, when no snapshot ID is given")
+	f.Var(&findOptions.Tags, "tag", "only consider snapshots which include this `taglist`, when no snapshot-ID is given")
+	f.StringArrayVar(&findOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path`, when no snapshot-ID is given")
+}
+
+type findPattern struct {
+	oldest, newest time.Time
+	pattern        string
+	ignoreCase     bool
+}
+
+var timeFormats = []string{
+	"2006-01-02",
+	"2006-01-02 15:04",
+	"2006-01-02 15:04:05",
+	"2006-01-02 15:04:05 -0700",
+	"2006-01-02 15:04:05 MST",
+	"02.01.2006",
+	"02.01.2006 15:04",
+	"02.01.2006 15:04:05",
+	"02.01.2006 15:04:05 -0700",
+	"02.01.2006 15:04:05 MST",
+	"Mon Jan 2 15:04:05 -0700 MST 2006",
+}
+
+func parseTime(str string) (time.Time, error) {
+	for _, fmt := range timeFormats {
+		if t, err := time.ParseInLocation(fmt, str, time.Local); err == nil {
+			return t, nil
+		}
+	}
+
+	return time.Time{}, errors.Fatalf("unable to parse time: %q", str)
+}
+
+type statefulOutput struct {
+	ListLong bool
+	JSON     bool
+	inuse    bool
+	newsn    *restic.Snapshot
+	oldsn    *restic.Snapshot
+	hits     int
+}
+
+func (s *statefulOutput) PrintJSON(prefix string, node *restic.Node) {
+	type findNode restic.Node
+	b, err := json.Marshal(struct {
+		// Add these attributes
+		Path        string `json:"path,omitempty"`
+		Permissions string `json:"permissions,omitempty"`
+
+		*findNode
+
+		// Make the following attributes disappear
+		Name               byte `json:"name,omitempty"`
+		Inode              byte `json:"inode,omitempty"`
+		ExtendedAttributes byte `json:"extended_attributes,omitempty"`
+		Device             byte `json:"device,omitempty"`
+		Content            byte `json:"content,omitempty"`
+		Subtree            byte `json:"subtree,omitempty"`
+	}{
+		Path:        filepath.Join(prefix, node.Name),
+		Permissions: node.Mode.String(),
+		findNode:    (*findNode)(node),
+	})
+	if err != nil {
+		Warnf("Marshall failed: %v\n", err)
+		return
+	}
+	if !s.inuse {
+		Printf("[")
+		s.inuse = true
+	}
+	if s.newsn != s.oldsn {
+		if s.oldsn != nil {
+			Printf("],\"hits\":%d,\"snapshot\":%q},", s.hits, s.oldsn.ID())
+		}
+		Printf(`{"matches":[`)
+		s.oldsn = s.newsn
+		s.hits = 0
+	}
+	if s.hits > 0 {
+		Printf(",")
+	}
+	Printf(string(b))
+	s.hits++
+}
+
+func (s *statefulOutput) PrintNormal(prefix string, node *restic.Node) {
+	if s.newsn != s.oldsn {
+		if s.oldsn != nil {
+			Verbosef("\n")
+		}
+		s.oldsn = s.newsn
+		Verbosef("Found matching entries in snapshot %s\n", s.oldsn.ID())
+	}
+	Printf(formatNode(prefix, node, s.ListLong) + "\n")
+}
+
+func (s *statefulOutput) Print(prefix string, node *restic.Node) {
+	if s.JSON {
+		s.PrintJSON(prefix, node)
+	} else {
+		s.PrintNormal(prefix, node)
+	}
+}
+
+func (s *statefulOutput) Finish() {
+	if s.JSON {
+		// do some finishing up
+		if s.oldsn != nil {
+			Printf("],\"hits\":%d,\"snapshot\":%q}", s.hits, s.oldsn.ID())
+		}
+		if s.inuse {
+			Printf("]\n")
+		} else {
+			Printf("[]\n")
+		}
+		return
+	}
+}
+
+// Finder bundles information needed to find a file or directory.
+type Finder struct {
+	repo     restic.Repository
+	pat      findPattern
+	out      statefulOutput
+	notfound restic.IDSet
+}
+
+func (f *Finder) findInTree(treeID restic.ID, prefix string) error {
+	if f.notfound.Has(treeID) {
+		debug.Log("%v skipping tree %v, has already been checked", prefix, treeID.Str())
+		return nil
+	}
+
+	debug.Log("%v checking tree %v\n", prefix, treeID.Str())
+
+	tree, err := f.repo.LoadTree(context.TODO(), treeID)
+	if err != nil {
+		return err
+	}
+
+	var found bool
+	for _, node := range tree.Nodes {
+		debug.Log("  testing entry %q\n", node.Name)
+
+		name := node.Name
+		if f.pat.ignoreCase {
+			name = strings.ToLower(name)
+		}
+
+		m, err := filepath.Match(f.pat.pattern, name)
+		if err != nil {
+			return err
+		}
+
+		if m {
+			if !f.pat.oldest.IsZero() && node.ModTime.Before(f.pat.oldest) {
+				debug.Log("    ModTime is older than %s\n", f.pat.oldest)
+				continue
+			}
+
+			if !f.pat.newest.IsZero() && node.ModTime.After(f.pat.newest) {
+				debug.Log("    ModTime is newer than %s\n", f.pat.newest)
+				continue
+			}
+
+			debug.Log("    found match\n")
+			found = true
+			f.out.Print(prefix, node)
+		}
+
+		if node.Type == "dir" {
+			if err := f.findInTree(*node.Subtree, filepath.Join(prefix, node.Name)); err != nil {
+				return err
+			}
+		}
+	}
+
+	if !found {
+		f.notfound.Insert(treeID)
+	}
+
+	return nil
+}
+
+func (f *Finder) findInSnapshot(sn *restic.Snapshot) error {
+	debug.Log("searching in snapshot %s\n  for entries within [%s %s]", sn.ID(), f.pat.oldest, f.pat.newest)
+
+	f.out.newsn = sn
+	if err := f.findInTree(*sn.Tree, string(filepath.Separator)); err != nil {
+		return err
+	}
+	return nil
+}
+
+func runFind(opts FindOptions, gopts GlobalOptions, args []string) error {
+	if len(args) != 1 {
+		return errors.Fatal("wrong number of arguments")
+	}
+
+	var err error
+	pat := findPattern{pattern: args[0]}
+	if opts.CaseInsensitive {
+		pat.pattern = strings.ToLower(pat.pattern)
+		pat.ignoreCase = true
+	}
+
+	if opts.Oldest != "" {
+		if pat.oldest, err = parseTime(opts.Oldest); err != nil {
+			return err
+		}
+	}
+
+	if opts.Newest != "" {
+		if pat.newest, err = parseTime(opts.Newest); err != nil {
+			return err
+		}
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	if err = repo.LoadIndex(context.TODO()); err != nil {
+		return err
+	}
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+
+	f := &Finder{
+		repo:     repo,
+		pat:      pat,
+		out:      statefulOutput{ListLong: opts.ListLong, JSON: globalOptions.JSON},
+		notfound: restic.NewIDSet(),
+	}
+	for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, opts.Snapshots) {
+		if err = f.findInSnapshot(sn); err != nil {
+			return err
+		}
+	}
+	f.out.Finish()
+
+	return nil
+}

cmd/restic/cmd_forget.go

@@ -0,0 +1,242 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"sort"
+	"strings"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/restic"
+	"github.com/spf13/cobra"
+)
+
+var cmdForget = &cobra.Command{
+	Use:   "forget [flags] [snapshot ID] [...]",
+	Short: "Remove snapshots from the repository",
+	Long: `
+The "forget" command removes snapshots according to a policy. Please note that
+this command really only deletes the snapshot object in the repository, which
+is a reference to data stored there. In order to remove this (now unreferenced)
+data after 'forget' was run successfully, see the 'prune' command. `,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runForget(forgetOptions, globalOptions, args)
+	},
+}
+
+// ForgetOptions collects all options for the forget command.
+type ForgetOptions struct {
+	Last     int
+	Hourly   int
+	Daily    int
+	Weekly   int
+	Monthly  int
+	Yearly   int
+	KeepTags restic.TagLists
+
+	Host    string
+	Tags    restic.TagLists
+	Paths   []string
+	Compact bool
+
+	// Grouping
+	GroupBy string
+	DryRun  bool
+	Prune   bool
+}
+
+var forgetOptions ForgetOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdForget)
+
+	f := cmdForget.Flags()
+	f.IntVarP(&forgetOptions.Last, "keep-last", "l", 0, "keep the last `n` snapshots")
+	f.IntVarP(&forgetOptions.Hourly, "keep-hourly", "H", 0, "keep the last `n` hourly snapshots")
+	f.IntVarP(&forgetOptions.Daily, "keep-daily", "d", 0, "keep the last `n` daily snapshots")
+	f.IntVarP(&forgetOptions.Weekly, "keep-weekly", "w", 0, "keep the last `n` weekly snapshots")
+	f.IntVarP(&forgetOptions.Monthly, "keep-monthly", "m", 0, "keep the last `n` monthly snapshots")
+	f.IntVarP(&forgetOptions.Yearly, "keep-yearly", "y", 0, "keep the last `n` yearly snapshots")
+
+	f.Var(&forgetOptions.KeepTags, "keep-tag", "keep snapshots with this `taglist` (can be specified multiple times)")
+	// Sadly the commonly used shortcut `H` is already used.
+	f.StringVar(&forgetOptions.Host, "host", "", "only consider snapshots with the given `host`")
+	// Deprecated since 2017-03-07.
+	f.StringVar(&forgetOptions.Host, "hostname", "", "only consider snapshots with the given `hostname` (deprecated)")
+	f.Var(&forgetOptions.Tags, "tag", "only consider snapshots which include this `taglist` in the format `tag[,tag,...]` (can be specified multiple times)")
+	f.StringArrayVar(&forgetOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path` (can be specified multiple times)")
+	f.BoolVarP(&forgetOptions.Compact, "compact", "c", false, "use compact format")
+
+	f.StringVarP(&forgetOptions.GroupBy, "group-by", "g", "host,paths", "string for grouping snapshots by host,paths,tags")
+	f.BoolVarP(&forgetOptions.DryRun, "dry-run", "n", false, "do not delete anything, just print what would be done")
+	f.BoolVar(&forgetOptions.Prune, "prune", false, "automatically run the 'prune' command if snapshots have been removed")
+
+	f.SortFlags = false
+}
+
+func runForget(opts ForgetOptions, gopts GlobalOptions, args []string) error {
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepoExclusive(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	// group by hostname and dirs
+	type key struct {
+		Hostname string
+		Paths    []string
+		Tags     []string
+	}
+	snapshotGroups := make(map[string]restic.Snapshots)
+
+	var GroupByTag bool
+	var GroupByHost bool
+	var GroupByPath bool
+	var GroupOptionList []string
+
+	GroupOptionList = strings.Split(opts.GroupBy, ",")
+
+	for _, option := range GroupOptionList {
+		switch option {
+		case "host":
+			GroupByHost = true
+		case "paths":
+			GroupByPath = true
+		case "tags":
+			GroupByTag = true
+		case "":
+		default:
+			return errors.Fatal("unknown grouping option: '" + option + "'")
+		}
+	}
+
+	removeSnapshots := 0
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+	for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, args) {
+		if len(args) > 0 {
+			// When explicit snapshots args are given, remove them immediately.
+			if !opts.DryRun {
+				h := restic.Handle{Type: restic.SnapshotFile, Name: sn.ID().String()}
+				if err = repo.Backend().Remove(context.TODO(), h); err != nil {
+					return err
+				}
+				Verbosef("removed snapshot %v\n", sn.ID().Str())
+				removeSnapshots++
+			} else {
+				Verbosef("would have removed snapshot %v\n", sn.ID().Str())
+			}
+		} else {
+			// Determining grouping-keys
+			var tags []string
+			var hostname string
+			var paths []string
+
+			if GroupByTag {
+				tags = sn.Tags
+				sort.StringSlice(tags).Sort()
+			}
+			if GroupByHost {
+				hostname = sn.Hostname
+			}
+			if GroupByPath {
+				paths = sn.Paths
+			}
+
+			sort.StringSlice(sn.Paths).Sort()
+			var k []byte
+			var err error
+
+			k, err = json.Marshal(key{Tags: tags, Hostname: hostname, Paths: paths})
+
+			if err != nil {
+				return err
+			}
+			snapshotGroups[string(k)] = append(snapshotGroups[string(k)], sn)
+		}
+	}
+	if len(args) > 0 {
+		return nil
+	}
+
+	policy := restic.ExpirePolicy{
+		Last:    opts.Last,
+		Hourly:  opts.Hourly,
+		Daily:   opts.Daily,
+		Weekly:  opts.Weekly,
+		Monthly: opts.Monthly,
+		Yearly:  opts.Yearly,
+		Tags:    opts.KeepTags,
+	}
+
+	if policy.Empty() {
+		Verbosef("no policy was specified, no snapshots will be removed\n")
+		return nil
+	}
+
+	for k, snapshotGroup := range snapshotGroups {
+		var key key
+		if json.Unmarshal([]byte(k), &key) != nil {
+			return err
+		}
+
+		// Info
+		Verbosef("snapshots")
+		var infoStrings []string
+		if GroupByTag {
+			infoStrings = append(infoStrings, "tags ["+strings.Join(key.Tags, ", ")+"]")
+		}
+		if GroupByHost {
+			infoStrings = append(infoStrings, "host ["+key.Hostname+"]")
+		}
+		if GroupByPath {
+			infoStrings = append(infoStrings, "paths ["+strings.Join(key.Paths, ", ")+"]")
+		}
+		if infoStrings != nil {
+			Verbosef(" for (" + strings.Join(infoStrings, ", ") + ")")
+		}
+		Verbosef(":\n\n")
+
+		keep, remove := restic.ApplyPolicy(snapshotGroup, policy)
+
+		if len(keep) != 0 && !gopts.Quiet {
+			Printf("keep %d snapshots:\n", len(keep))
+			PrintSnapshots(globalOptions.stdout, keep, opts.Compact)
+			Printf("\n")
+		}
+
+		if len(remove) != 0 && !gopts.Quiet {
+			Printf("remove %d snapshots:\n", len(remove))
+			PrintSnapshots(globalOptions.stdout, remove, opts.Compact)
+			Printf("\n")
+		}
+
+		removeSnapshots += len(remove)
+
+		if !opts.DryRun {
+			for _, sn := range remove {
+				h := restic.Handle{Type: restic.SnapshotFile, Name: sn.ID().String()}
+				err = repo.Backend().Remove(context.TODO(), h)
+				if err != nil {
+					return err
+				}
+			}
+		}
+	}
+
+	if removeSnapshots > 0 && opts.Prune {
+		Verbosef("%d snapshots have been removed, running prune\n", removeSnapshots)
+		if !opts.DryRun {
+			return pruneRepository(gopts, repo)
+		}
+	}
+
+	return nil
+}

cmd/restic/cmd_generate.go

@@ -0,0 +1,94 @@
+package main
+
+import (
+	"time"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/spf13/cobra"
+	"github.com/spf13/cobra/doc"
+)
+
+var cmdGenerate = &cobra.Command{
+	Use:   "generate [command]",
+	Short: "Generate manual pages and auto-completion files (bash, zsh)",
+	Long: `
+The "generate" command writes automatically generated files like the man pages
+and the auto-completion files for bash and zsh).
+`,
+	DisableAutoGenTag: true,
+	RunE:              runGenerate,
+}
+
+type generateOptions struct {
+	ManDir             string
+	BashCompletionFile string
+	ZSHCompletionFile  string
+}
+
+var genOpts generateOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdGenerate)
+	fs := cmdGenerate.Flags()
+	fs.StringVar(&genOpts.ManDir, "man", "", "write man pages to `directory`")
+	fs.StringVar(&genOpts.BashCompletionFile, "bash-completion", "", "write bash completion `file`")
+	fs.StringVar(&genOpts.ZSHCompletionFile, "zsh-completion", "", "write zsh completion `file`")
+}
+
+func writeManpages(dir string) error {
+	// use a fixed date for the man pages so that generating them is deterministic
+	date, err := time.Parse("Jan 2006", "Jan 2017")
+	if err != nil {
+		return err
+	}
+
+	header := &doc.GenManHeader{
+		Title:   "restic backup",
+		Section: "1",
+		Source:  "generated by `restic generate`",
+		Date:    &date,
+	}
+
+	Verbosef("writing man pages to directory %v\n", dir)
+	return doc.GenManTree(cmdRoot, header, dir)
+}
+
+func writeBashCompletion(file string) error {
+	Verbosef("writing bash completion file to %v\n", file)
+	return cmdRoot.GenBashCompletionFile(file)
+}
+
+func writeZSHCompletion(file string) error {
+	Verbosef("writing zsh completion file to %v\n", file)
+	return cmdRoot.GenZshCompletionFile(file)
+}
+
+func runGenerate(cmd *cobra.Command, args []string) error {
+	if genOpts.ManDir != "" {
+		err := writeManpages(genOpts.ManDir)
+		if err != nil {
+			return err
+		}
+	}
+
+	if genOpts.BashCompletionFile != "" {
+		err := writeBashCompletion(genOpts.BashCompletionFile)
+		if err != nil {
+			return err
+		}
+	}
+
+	if genOpts.ZSHCompletionFile != "" {
+		err := writeZSHCompletion(genOpts.ZSHCompletionFile)
+		if err != nil {
+			return err
+		}
+	}
+
+	var empty generateOptions
+	if genOpts == empty {
+		return errors.Fatal("nothing to do, please specify at least one output file/dir")
+	}
+
+	return nil
+}

cmd/restic/cmd_init.go

@@ -0,0 +1,59 @@
+package main
+
+import (
+	"context"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdInit = &cobra.Command{
+	Use:   "init",
+	Short: "Initialize a new repository",
+	Long: `
+The "init" command initializes a new repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runInit(globalOptions, args)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdInit)
+}
+
+func runInit(gopts GlobalOptions, args []string) error {
+	if gopts.Repo == "" {
+		return errors.Fatal("Please specify repository location (-r)")
+	}
+
+	be, err := create(gopts.Repo, gopts.extended)
+	if err != nil {
+		return errors.Fatalf("create backend at %s failed: %v\n", gopts.Repo, err)
+	}
+
+	gopts.password, err = ReadPasswordTwice(gopts,
+		"enter password for new backend: ",
+		"enter password again: ")
+	if err != nil {
+		return err
+	}
+
+	s := repository.New(be)
+
+	err = s.Init(context.TODO(), gopts.password)
+	if err != nil {
+		return errors.Fatalf("create key in backend at %s failed: %v\n", gopts.Repo, err)
+	}
+
+	Verbosef("created restic backend %v at %s\n", s.Config().ID[:10], gopts.Repo)
+	Verbosef("\n")
+	Verbosef("Please note that knowledge of your password is required to access\n")
+	Verbosef("the repository. Losing your password means that your data is\n")
+	Verbosef("irrecoverably lost.\n")
+
+	return nil
+}

cmd/restic/cmd_key.go

@@ -0,0 +1,180 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdKey = &cobra.Command{
+	Use:   "key [list|add|remove|passwd] [ID]",
+	Short: "Manage keys (passwords)",
+	Long: `
+The "key" command manages keys (passwords) for accessing the repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runKey(globalOptions, args)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdKey)
+}
+
+func listKeys(ctx context.Context, s *repository.Repository) error {
+	tab := NewTable()
+	tab.Header = fmt.Sprintf(" %-10s  %-10s  %-10s  %s", "ID", "User", "Host", "Created")
+	tab.RowFormat = "%s%-10s  %-10s  %-10s  %s"
+
+	for id := range s.List(ctx, restic.KeyFile) {
+		k, err := repository.LoadKey(ctx, s, id.String())
+		if err != nil {
+			Warnf("LoadKey() failed: %v\n", err)
+			continue
+		}
+
+		var current string
+		if id.String() == s.KeyName() {
+			current = "*"
+		} else {
+			current = " "
+		}
+		tab.Rows = append(tab.Rows, []interface{}{current, id.Str(),
+			k.Username, k.Hostname, k.Created.Format(TimeFormat)})
+	}
+
+	return tab.Write(globalOptions.stdout)
+}
+
+// testKeyNewPassword is used to set a new password during integration testing.
+var testKeyNewPassword string
+
+func getNewPassword(gopts GlobalOptions) (string, error) {
+	if testKeyNewPassword != "" {
+		return testKeyNewPassword, nil
+	}
+
+	// Since we already have an open repository, temporary remove the password
+	// to prompt the user for the passwd.
+	newopts := gopts
+	newopts.password = ""
+
+	return ReadPasswordTwice(newopts,
+		"enter password for new key: ",
+		"enter password again: ")
+}
+
+func addKey(gopts GlobalOptions, repo *repository.Repository) error {
+	pw, err := getNewPassword(gopts)
+	if err != nil {
+		return err
+	}
+
+	id, err := repository.AddKey(context.TODO(), repo, pw, repo.Key())
+	if err != nil {
+		return errors.Fatalf("creating new key failed: %v\n", err)
+	}
+
+	Verbosef("saved new key as %s\n", id)
+
+	return nil
+}
+
+func deleteKey(repo *repository.Repository, name string) error {
+	if name == repo.KeyName() {
+		return errors.Fatal("refusing to remove key currently used to access repository")
+	}
+
+	h := restic.Handle{Type: restic.KeyFile, Name: name}
+	err := repo.Backend().Remove(context.TODO(), h)
+	if err != nil {
+		return err
+	}
+
+	Verbosef("removed key %v\n", name)
+	return nil
+}
+
+func changePassword(gopts GlobalOptions, repo *repository.Repository) error {
+	pw, err := getNewPassword(gopts)
+	if err != nil {
+		return err
+	}
+
+	id, err := repository.AddKey(context.TODO(), repo, pw, repo.Key())
+	if err != nil {
+		return errors.Fatalf("creating new key failed: %v\n", err)
+	}
+
+	h := restic.Handle{Type: restic.KeyFile, Name: repo.KeyName()}
+	err = repo.Backend().Remove(context.TODO(), h)
+	if err != nil {
+		return err
+	}
+
+	Verbosef("saved new key as %s\n", id)
+
+	return nil
+}
+
+func runKey(gopts GlobalOptions, args []string) error {
+	if len(args) < 1 || (args[0] == "remove" && len(args) != 2) || (args[0] != "remove" && len(args) != 1) {
+		return errors.Fatal("wrong number of arguments")
+	}
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	switch args[0] {
+	case "list":
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+
+		return listKeys(ctx, repo)
+	case "add":
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+
+		return addKey(gopts, repo)
+	case "remove":
+		lock, err := lockRepoExclusive(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+
+		id, err := restic.Find(repo.Backend(), restic.KeyFile, args[1])
+		if err != nil {
+			return err
+		}
+
+		return deleteKey(repo, id)
+	case "passwd":
+		lock, err := lockRepoExclusive(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+
+		return changePassword(gopts, repo)
+	}
+
+	return nil
+}

cmd/restic/cmd_list.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/index"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdList = &cobra.Command{
+	Use:   "list [blobs|packs|index|snapshots|keys|locks]",
+	Short: "List objects in the repository",
+	Long: `
+The "list" command allows listing objects in the repository based on type.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runList(globalOptions, args)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdList)
+}
+
+func runList(opts GlobalOptions, args []string) error {
+	if len(args) != 1 {
+		return errors.Fatal("type not specified")
+	}
+
+	repo, err := OpenRepository(opts)
+	if err != nil {
+		return err
+	}
+
+	if !opts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	var t restic.FileType
+	switch args[0] {
+	case "packs":
+		t = restic.DataFile
+	case "index":
+		t = restic.IndexFile
+	case "snapshots":
+		t = restic.SnapshotFile
+	case "keys":
+		t = restic.KeyFile
+	case "locks":
+		t = restic.LockFile
+	case "blobs":
+		idx, err := index.Load(context.TODO(), repo, nil)
+		if err != nil {
+			return err
+		}
+
+		for _, pack := range idx.Packs {
+			for _, entry := range pack.Entries {
+				fmt.Printf("%v %v\n", entry.Type, entry.ID)
+			}
+		}
+
+		return nil
+	default:
+		return errors.Fatal("invalid type")
+	}
+
+	for id := range repo.List(context.TODO(), t) {
+		Printf("%s\n", id)
+	}
+
+	return nil
+}

cmd/restic/cmd_ls.go

@@ -0,0 +1,92 @@
+package main
+
+import (
+	"context"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+)
+
+var cmdLs = &cobra.Command{
+	Use:   "ls [flags] [snapshot-ID ...]",
+	Short: "List files in a snapshot",
+	Long: `
+The "ls" command allows listing files and directories in a snapshot.
+
+The special snapshot-ID "latest" can be used to list files and directories of the latest snapshot in the repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runLs(lsOptions, globalOptions, args)
+	},
+}
+
+// LsOptions collects all options for the ls command.
+type LsOptions struct {
+	ListLong bool
+	Host     string
+	Tags     restic.TagLists
+	Paths    []string
+}
+
+var lsOptions LsOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdLs)
+
+	flags := cmdLs.Flags()
+	flags.BoolVarP(&lsOptions.ListLong, "long", "l", false, "use a long listing format showing size and mode")
+
+	flags.StringVarP(&lsOptions.Host, "host", "H", "", "only consider snapshots for this `host`, when no snapshot ID is given")
+	flags.Var(&lsOptions.Tags, "tag", "only consider snapshots which include this `taglist`, when no snapshot ID is given")
+	flags.StringArrayVar(&lsOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path`, when no snapshot ID is given")
+}
+
+func printTree(repo *repository.Repository, id *restic.ID, prefix string) error {
+	tree, err := repo.LoadTree(context.TODO(), *id)
+	if err != nil {
+		return err
+	}
+
+	for _, entry := range tree.Nodes {
+		Printf("%s\n", formatNode(prefix, entry, lsOptions.ListLong))
+
+		if entry.Type == "dir" && entry.Subtree != nil {
+			if err = printTree(repo, entry.Subtree, filepath.Join(prefix, entry.Name)); err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
+func runLs(opts LsOptions, gopts GlobalOptions, args []string) error {
+	if len(args) == 0 && opts.Host == "" && len(opts.Tags) == 0 && len(opts.Paths) == 0 {
+		return errors.Fatal("Invalid arguments, either give one or more snapshot IDs or set filters.")
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if err = repo.LoadIndex(context.TODO()); err != nil {
+		return err
+	}
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+	for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, args) {
+		Verbosef("snapshot %s of %v at %s):\n", sn.ID().Str(), sn.Paths, sn.Time)
+
+		if err = printTree(repo, sn.Tree, string(filepath.Separator)); err != nil {
+			return err
+		}
+	}
+	return nil
+}

cmd/restic/cmd_migrate.go

@@ -0,0 +1,108 @@
+package main
+
+import (
+	"github.com/restic/restic/internal/migrations"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdMigrate = &cobra.Command{
+	Use:   "migrate [name]",
+	Short: "Apply migrations",
+	Long: `
+The "migrate" command applies migrations to a repository. When no migration
+name is explicitly given, a list of migrations that can be applied is printed.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runMigrate(migrateOptions, globalOptions, args)
+	},
+}
+
+// MigrateOptions bundles all options for the 'check' command.
+type MigrateOptions struct {
+	Force bool
+}
+
+var migrateOptions MigrateOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdMigrate)
+	f := cmdMigrate.Flags()
+	f.BoolVarP(&migrateOptions.Force, "force", "f", false, `apply a migration a second time`)
+}
+
+func checkMigrations(opts MigrateOptions, gopts GlobalOptions, repo restic.Repository) error {
+	ctx := gopts.ctx
+	Printf("available migrations:\n")
+	for _, m := range migrations.All {
+		ok, err := m.Check(ctx, repo)
+		if err != nil {
+			return err
+		}
+
+		if ok {
+			Printf("  %v: %v\n", m.Name(), m.Desc())
+		}
+	}
+
+	return nil
+}
+
+func applyMigrations(opts MigrateOptions, gopts GlobalOptions, repo restic.Repository, args []string) error {
+	ctx := gopts.ctx
+
+	var firsterr error
+	for _, name := range args {
+		for _, m := range migrations.All {
+			if m.Name() == name {
+				ok, err := m.Check(ctx, repo)
+				if err != nil {
+					return err
+				}
+
+				if !ok {
+					if !opts.Force {
+						Warnf("migration %v cannot be applied: check failed\nIf you want to apply this migration anyway, re-run with option --force\n", m.Name())
+						continue
+					}
+
+					Warnf("check for migration %v failed, continuing anyway\n", m.Name())
+				}
+
+				Printf("applying migration %v...\n", m.Name())
+				if err = m.Apply(ctx, repo); err != nil {
+					Warnf("migration %v failed: %v\n", m.Name(), err)
+					if firsterr == nil {
+						firsterr = err
+					}
+					continue
+				}
+
+				Printf("migration %v: success\n", m.Name())
+			}
+		}
+	}
+
+	return firsterr
+}
+
+func runMigrate(opts MigrateOptions, gopts GlobalOptions, args []string) error {
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepoExclusive(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	if len(args) == 0 {
+		return checkMigrations(opts, gopts, repo)
+	}
+
+	return applyMigrations(opts, gopts, repo, args)
+}

cmd/restic/cmd_mount.go

@@ -0,0 +1,156 @@
+// +build !openbsd
+// +build !windows
+
+package main
+
+import (
+	"context"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/restic"
+
+	resticfs "github.com/restic/restic/internal/fs"
+	"github.com/restic/restic/internal/fuse"
+
+	systemFuse "bazil.org/fuse"
+	"bazil.org/fuse/fs"
+)
+
+var cmdMount = &cobra.Command{
+	Use:   "mount [flags] mountpoint",
+	Short: "Mount the repository",
+	Long: `
+The "mount" command mounts the repository via fuse to a directory. This is a
+read-only mount.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runMount(mountOptions, globalOptions, args)
+	},
+}
+
+// MountOptions collects all options for the mount command.
+type MountOptions struct {
+	OwnerRoot  bool
+	AllowRoot  bool
+	AllowOther bool
+	Host       string
+	Tags       restic.TagLists
+	Paths      []string
+}
+
+var mountOptions MountOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdMount)
+
+	mountFlags := cmdMount.Flags()
+	mountFlags.BoolVar(&mountOptions.OwnerRoot, "owner-root", false, "use 'root' as the owner of files and dirs")
+	mountFlags.BoolVar(&mountOptions.AllowRoot, "allow-root", false, "allow root user to access the data in the mounted directory")
+	mountFlags.BoolVar(&mountOptions.AllowOther, "allow-other", false, "allow other users to access the data in the mounted directory")
+
+	mountFlags.StringVarP(&mountOptions.Host, "host", "H", "", `only consider snapshots for this host`)
+	mountFlags.Var(&mountOptions.Tags, "tag", "only consider snapshots which include this `taglist`")
+	mountFlags.StringArrayVar(&mountOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path`")
+}
+
+func mount(opts MountOptions, gopts GlobalOptions, mountpoint string) error {
+	debug.Log("start mount")
+	defer debug.Log("finish mount")
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepo(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	err = repo.LoadIndex(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	if _, err := resticfs.Stat(mountpoint); os.IsNotExist(errors.Cause(err)) {
+		Verbosef("Mountpoint %s doesn't exist, creating it\n", mountpoint)
+		err = resticfs.Mkdir(mountpoint, os.ModeDir|0700)
+		if err != nil {
+			return err
+		}
+	}
+
+	mountOptions := []systemFuse.MountOption{
+		systemFuse.ReadOnly(),
+		systemFuse.FSName("restic"),
+	}
+
+	if opts.AllowRoot {
+		mountOptions = append(mountOptions, systemFuse.AllowRoot())
+	}
+
+	if opts.AllowOther {
+		mountOptions = append(mountOptions, systemFuse.AllowOther())
+	}
+
+	c, err := systemFuse.Mount(mountpoint, mountOptions...)
+	if err != nil {
+		return err
+	}
+
+	systemFuse.Debug = func(msg interface{}) {
+		debug.Log("fuse: %v", msg)
+	}
+
+	cfg := fuse.Config{
+		OwnerIsRoot: opts.OwnerRoot,
+		Host:        opts.Host,
+		Tags:        opts.Tags,
+		Paths:       opts.Paths,
+	}
+	root, err := fuse.NewRoot(context.TODO(), repo, cfg)
+	if err != nil {
+		return err
+	}
+
+	Printf("Now serving the repository at %s\n", mountpoint)
+	Printf("Don't forget to umount after quitting!\n")
+
+	debug.Log("serving mount at %v", mountpoint)
+	err = fs.Serve(c, root)
+	if err != nil {
+		return err
+	}
+
+	<-c.Ready
+	return c.MountError
+}
+
+func umount(mountpoint string) error {
+	return systemFuse.Unmount(mountpoint)
+}
+
+func runMount(opts MountOptions, gopts GlobalOptions, args []string) error {
+	if len(args) == 0 {
+		return errors.Fatal("wrong number of parameters")
+	}
+
+	mountpoint := args[0]
+
+	AddCleanupHandler(func() error {
+		debug.Log("running umount cleanup handler for mount at %v", mountpoint)
+		err := umount(mountpoint)
+		if err != nil {
+			Warnf("unable to umount (maybe already umounted?): %v\n", err)
+		}
+		return nil
+	})
+
+	return mount(opts, gopts, mountpoint)
+}

cmd/restic/cmd_options.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/restic/restic/internal/options"
+
+	"github.com/spf13/cobra"
+)
+
+var optionsCmd = &cobra.Command{
+	Use:   "options",
+	Short: "Print list of extended options",
+	Long: `
+The "options" command prints a list of extended options.
+`,
+	Hidden:            true,
+	DisableAutoGenTag: true,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("All Extended Options:\n")
+		for _, opt := range options.List() {
+			fmt.Printf("  %-15s   %s\n", opt.Namespace+"."+opt.Name, opt.Text)
+		}
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(optionsCmd)
+}

cmd/restic/cmd_prune.go

@@ -0,0 +1,303 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/index"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdPrune = &cobra.Command{
+	Use:   "prune [flags]",
+	Short: "Remove unneeded data from the repository",
+	Long: `
+The "prune" command checks the repository and removes data that is not
+referenced and therefore not needed any more.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runPrune(globalOptions)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdPrune)
+}
+
+func shortenStatus(maxLength int, s string) string {
+	if len(s) <= maxLength {
+		return s
+	}
+
+	if maxLength < 3 {
+		return s[:maxLength]
+	}
+
+	return s[:maxLength-3] + "..."
+}
+
+// newProgressMax returns a progress that counts blobs.
+func newProgressMax(show bool, max uint64, description string) *restic.Progress {
+	if !show {
+		return nil
+	}
+
+	p := restic.NewProgress()
+
+	p.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+		status := fmt.Sprintf("[%s] %s  %d / %d %s",
+			formatDuration(d),
+			formatPercent(s.Blobs, max),
+			s.Blobs, max, description)
+
+		if w := stdoutTerminalWidth(); w > 0 {
+			status = shortenStatus(w, status)
+		}
+
+		PrintProgress("%s", status)
+	}
+
+	p.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
+		fmt.Printf("\n")
+	}
+
+	return p
+}
+
+func runPrune(gopts GlobalOptions) error {
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepoExclusive(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	return pruneRepository(gopts, repo)
+}
+
+func mixedBlobs(list []restic.Blob) bool {
+	var tree, data bool
+
+	for _, pb := range list {
+		switch pb.Type {
+		case restic.TreeBlob:
+			tree = true
+		case restic.DataBlob:
+			data = true
+		}
+
+		if tree && data {
+			return true
+		}
+	}
+
+	return false
+}
+
+func pruneRepository(gopts GlobalOptions, repo restic.Repository) error {
+	ctx := gopts.ctx
+
+	err := repo.LoadIndex(ctx)
+	if err != nil {
+		return err
+	}
+
+	var stats struct {
+		blobs     int
+		packs     int
+		snapshots int
+		bytes     int64
+	}
+
+	Verbosef("counting files in repo\n")
+	for range repo.List(ctx, restic.DataFile) {
+		stats.packs++
+	}
+
+	Verbosef("building new index for repo\n")
+
+	bar := newProgressMax(!gopts.Quiet, uint64(stats.packs), "packs")
+	idx, invalidFiles, err := index.New(ctx, repo, restic.NewIDSet(), bar)
+	if err != nil {
+		return err
+	}
+
+	for _, id := range invalidFiles {
+		Warnf("incomplete pack file (will be removed): %v\n", id)
+	}
+
+	blobs := 0
+	for _, pack := range idx.Packs {
+		stats.bytes += pack.Size
+		blobs += len(pack.Entries)
+	}
+	Verbosef("repository contains %v packs (%v blobs) with %v\n",
+		len(idx.Packs), blobs, formatBytes(uint64(stats.bytes)))
+
+	blobCount := make(map[restic.BlobHandle]int)
+	duplicateBlobs := 0
+	duplicateBytes := 0
+
+	// find duplicate blobs
+	for _, p := range idx.Packs {
+		for _, entry := range p.Entries {
+			stats.blobs++
+			h := restic.BlobHandle{ID: entry.ID, Type: entry.Type}
+			blobCount[h]++
+
+			if blobCount[h] > 1 {
+				duplicateBlobs++
+				duplicateBytes += int(entry.Length)
+			}
+		}
+	}
+
+	Verbosef("processed %d blobs: %d duplicate blobs, %v duplicate\n",
+		stats.blobs, duplicateBlobs, formatBytes(uint64(duplicateBytes)))
+	Verbosef("load all snapshots\n")
+
+	// find referenced blobs
+	snapshots, err := restic.LoadAllSnapshots(ctx, repo)
+	if err != nil {
+		return err
+	}
+
+	stats.snapshots = len(snapshots)
+
+	Verbosef("find data that is still in use for %d snapshots\n", stats.snapshots)
+
+	usedBlobs := restic.NewBlobSet()
+	seenBlobs := restic.NewBlobSet()
+
+	bar = newProgressMax(!gopts.Quiet, uint64(len(snapshots)), "snapshots")
+	bar.Start()
+	for _, sn := range snapshots {
+		debug.Log("process snapshot %v", sn.ID().Str())
+
+		err = restic.FindUsedBlobs(ctx, repo, *sn.Tree, usedBlobs, seenBlobs)
+		if err != nil {
+			if repo.Backend().IsNotExist(err) {
+				return errors.Fatal("unable to load a tree from the repo: " + err.Error())
+			}
+
+			return err
+		}
+
+		debug.Log("processed snapshot %v", sn.ID().Str())
+		bar.Report(restic.Stat{Blobs: 1})
+	}
+	bar.Done()
+
+	if len(usedBlobs) > stats.blobs {
+		return errors.Fatalf("number of used blobs is larger than number of available blobs!\n" +
+			"Please report this error (along with the output of the 'prune' run) at\n" +
+			"https://github.com/restic/restic/issues/new")
+	}
+
+	Verbosef("found %d of %d data blobs still in use, removing %d blobs\n",
+		len(usedBlobs), stats.blobs, stats.blobs-len(usedBlobs))
+
+	// find packs that need a rewrite
+	rewritePacks := restic.NewIDSet()
+	for _, pack := range idx.Packs {
+		if mixedBlobs(pack.Entries) {
+			rewritePacks.Insert(pack.ID)
+			continue
+		}
+
+		for _, blob := range pack.Entries {
+			h := restic.BlobHandle{ID: blob.ID, Type: blob.Type}
+			if !usedBlobs.Has(h) {
+				rewritePacks.Insert(pack.ID)
+				continue
+			}
+
+			if blobCount[h] > 1 {
+				rewritePacks.Insert(pack.ID)
+			}
+		}
+	}
+
+	removeBytes := duplicateBytes
+
+	// find packs that are unneeded
+	removePacks := restic.NewIDSet()
+
+	Verbosef("will remove %d invalid files\n", len(invalidFiles))
+	for _, id := range invalidFiles {
+		removePacks.Insert(id)
+	}
+
+	for packID, p := range idx.Packs {
+
+		hasActiveBlob := false
+		for _, blob := range p.Entries {
+			h := restic.BlobHandle{ID: blob.ID, Type: blob.Type}
+			if usedBlobs.Has(h) {
+				hasActiveBlob = true
+				continue
+			}
+
+			removeBytes += int(blob.Length)
+		}
+
+		if hasActiveBlob {
+			continue
+		}
+
+		removePacks.Insert(packID)
+
+		if !rewritePacks.Has(packID) {
+			return errors.Fatalf("pack %v is unneeded, but not contained in rewritePacks", packID.Str())
+		}
+
+		rewritePacks.Delete(packID)
+	}
+
+	Verbosef("will delete %d packs and rewrite %d packs, this frees %s\n",
+		len(removePacks), len(rewritePacks), formatBytes(uint64(removeBytes)))
+
+	var obsoletePacks restic.IDSet
+	if len(rewritePacks) != 0 {
+		bar = newProgressMax(!gopts.Quiet, uint64(len(rewritePacks)), "packs rewritten")
+		bar.Start()
+		obsoletePacks, err = repository.Repack(ctx, repo, rewritePacks, usedBlobs, bar)
+		if err != nil {
+			return err
+		}
+		bar.Done()
+	}
+
+	removePacks.Merge(obsoletePacks)
+
+	if err = rebuildIndex(ctx, repo, removePacks); err != nil {
+		return err
+	}
+
+	if len(removePacks) != 0 {
+		bar = newProgressMax(!gopts.Quiet, uint64(len(removePacks)), "packs deleted")
+		bar.Start()
+		for packID := range removePacks {
+			h := restic.Handle{Type: restic.DataFile, Name: packID.String()}
+			err = repo.Backend().Remove(ctx, h)
+			if err != nil {
+				Warnf("unable to remove file %v from the repository\n", packID.Str())
+			}
+			bar.Report(restic.Stat{Blobs: 1})
+		}
+		bar.Done()
+	}
+
+	Verbosef("done\n")
+	return nil
+}

cmd/restic/cmd_rebuild_index.go

@@ -0,0 +1,86 @@
+package main
+
+import (
+	"context"
+
+	"github.com/restic/restic/internal/index"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdRebuildIndex = &cobra.Command{
+	Use:   "rebuild-index [flags]",
+	Short: "Build a new index file",
+	Long: `
+The "rebuild-index" command creates a new index based on the pack files in the
+repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runRebuildIndex(globalOptions)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(cmdRebuildIndex)
+}
+
+func runRebuildIndex(gopts GlobalOptions) error {
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	lock, err := lockRepoExclusive(repo)
+	defer unlockRepo(lock)
+	if err != nil {
+		return err
+	}
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+	return rebuildIndex(ctx, repo, restic.NewIDSet())
+}
+
+func rebuildIndex(ctx context.Context, repo restic.Repository, ignorePacks restic.IDSet) error {
+	Verbosef("counting files in repo\n")
+
+	var packs uint64
+	for range repo.List(ctx, restic.DataFile) {
+		packs++
+	}
+
+	bar := newProgressMax(!globalOptions.Quiet, packs-uint64(len(ignorePacks)), "packs")
+	idx, _, err := index.New(ctx, repo, ignorePacks, bar)
+	if err != nil {
+		return err
+	}
+
+	Verbosef("finding old index files\n")
+
+	var supersedes restic.IDs
+	for id := range repo.List(ctx, restic.IndexFile) {
+		supersedes = append(supersedes, id)
+	}
+
+	id, err := idx.Save(ctx, repo, supersedes)
+	if err != nil {
+		return err
+	}
+
+	Verbosef("saved new index as %v\n", id.Str())
+
+	Verbosef("remove %d old index files\n", len(supersedes))
+
+	for _, id := range supersedes {
+		if err := repo.Backend().Remove(ctx, restic.Handle{
+			Type: restic.IndexFile,
+			Name: id.String(),
+		}); err != nil {
+			Warnf("error removing old index %v: %v\n", id.Str(), err)
+		}
+	}
+
+	return nil
+}

cmd/restic/cmd_restore.go

@@ -0,0 +1,157 @@
+package main
+
+import (
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/filter"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+)
+
+var cmdRestore = &cobra.Command{
+	Use:   "restore [flags] snapshotID",
+	Short: "Extract the data from a snapshot",
+	Long: `
+The "restore" command extracts the data from a snapshot from the repository to
+a directory.
+
+The special snapshot "latest" can be used to restore the latest snapshot in the
+repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runRestore(restoreOptions, globalOptions, args)
+	},
+}
+
+// RestoreOptions collects all options for the restore command.
+type RestoreOptions struct {
+	Exclude []string
+	Include []string
+	Target  string
+	Host    string
+	Paths   []string
+	Tags    restic.TagLists
+}
+
+var restoreOptions RestoreOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdRestore)
+
+	flags := cmdRestore.Flags()
+	flags.StringArrayVarP(&restoreOptions.Exclude, "exclude", "e", nil, "exclude a `pattern` (can be specified multiple times)")
+	flags.StringArrayVarP(&restoreOptions.Include, "include", "i", nil, "include a `pattern`, exclude everything else (can be specified multiple times)")
+	flags.StringVarP(&restoreOptions.Target, "target", "t", "", "directory to extract data to")
+
+	flags.StringVarP(&restoreOptions.Host, "host", "H", "", `only consider snapshots for this host when the snapshot ID is "latest"`)
+	flags.Var(&restoreOptions.Tags, "tag", "only consider snapshots which include this `taglist` for snapshot ID \"latest\"")
+	flags.StringArrayVar(&restoreOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path` for snapshot ID \"latest\"")
+}
+
+func runRestore(opts RestoreOptions, gopts GlobalOptions, args []string) error {
+	ctx := gopts.ctx
+
+	if len(args) != 1 {
+		return errors.Fatal("no snapshot ID specified")
+	}
+
+	if opts.Target == "" {
+		return errors.Fatal("please specify a directory to restore to (--target)")
+	}
+
+	if len(opts.Exclude) > 0 && len(opts.Include) > 0 {
+		return errors.Fatal("exclude and include patterns are mutually exclusive")
+	}
+
+	snapshotIDString := args[0]
+
+	debug.Log("restore %v to %v", snapshotIDString, opts.Target)
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = repo.LoadIndex(ctx)
+	if err != nil {
+		return err
+	}
+
+	var id restic.ID
+
+	if snapshotIDString == "latest" {
+		id, err = restic.FindLatestSnapshot(ctx, repo, opts.Paths, opts.Tags, opts.Host)
+		if err != nil {
+			Exitf(1, "latest snapshot for criteria not found: %v Paths:%v Host:%v", err, opts.Paths, opts.Host)
+		}
+	} else {
+		id, err = restic.FindSnapshot(repo, snapshotIDString)
+		if err != nil {
+			Exitf(1, "invalid id %q: %v", snapshotIDString, err)
+		}
+	}
+
+	res, err := restic.NewRestorer(repo, id)
+	if err != nil {
+		Exitf(2, "creating restorer failed: %v\n", err)
+	}
+
+	totalErrors := 0
+	res.Error = func(dir string, node *restic.Node, err error) error {
+		Warnf("ignoring error for %s: %s\n", dir, err)
+		totalErrors++
+		return nil
+	}
+
+	selectExcludeFilter := func(item string, dstpath string, node *restic.Node) (selectedForRestore bool, childMayBeSelected bool) {
+		matched, _, err := filter.List(opts.Exclude, item)
+		if err != nil {
+			Warnf("error for exclude pattern: %v", err)
+		}
+
+		// An exclude filter is basically a 'wildcard but foo',
+		// so even if a childMayMatch, other children of a dir may not,
+		// therefore childMayMatch does not matter, but we should not go down
+		// unless the dir is selected for restore
+		selectedForRestore = !matched
+		childMayBeSelected = selectedForRestore && node.Type == "dir"
+
+		return selectedForRestore, childMayBeSelected
+	}
+
+	selectIncludeFilter := func(item string, dstpath string, node *restic.Node) (selectedForRestore bool, childMayBeSelected bool) {
+		matched, childMayMatch, err := filter.List(opts.Include, item)
+		if err != nil {
+			Warnf("error for include pattern: %v", err)
+		}
+
+		selectedForRestore = matched
+		childMayBeSelected = childMayMatch && node.Type == "dir"
+
+		return selectedForRestore, childMayBeSelected
+	}
+
+	if len(opts.Exclude) > 0 {
+		res.SelectFilter = selectExcludeFilter
+	} else if len(opts.Include) > 0 {
+		res.SelectFilter = selectIncludeFilter
+	}
+
+	Verbosef("restoring %s to %s\n", res.Snapshot(), opts.Target)
+
+	err = res.RestoreTo(ctx, opts.Target)
+	if totalErrors > 0 {
+		Printf("There were %d errors\n", totalErrors)
+	}
+	return err
+}

cmd/restic/cmd_snapshots.go

@@ -0,0 +1,239 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"sort"
+	"strings"
+
+	"github.com/restic/restic/internal/restic"
+	"github.com/spf13/cobra"
+)
+
+var cmdSnapshots = &cobra.Command{
+	Use:   "snapshots [snapshotID ...]",
+	Short: "List all snapshots",
+	Long: `
+The "snapshots" command lists all snapshots stored in the repository.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runSnapshots(snapshotOptions, globalOptions, args)
+	},
+}
+
+// SnapshotOptions bundles all options for the snapshots command.
+type SnapshotOptions struct {
+	Host    string
+	Tags    restic.TagLists
+	Paths   []string
+	Compact bool
+	Last    bool
+}
+
+var snapshotOptions SnapshotOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdSnapshots)
+
+	f := cmdSnapshots.Flags()
+	f.StringVarP(&snapshotOptions.Host, "host", "H", "", "only consider snapshots for this `host`")
+	f.Var(&snapshotOptions.Tags, "tag", "only consider snapshots which include this `taglist` (can be specified multiple times)")
+	f.StringArrayVar(&snapshotOptions.Paths, "path", nil, "only consider snapshots for this `path` (can be specified multiple times)")
+	f.BoolVarP(&snapshotOptions.Compact, "compact", "c", false, "use compact format")
+	f.BoolVar(&snapshotOptions.Last, "last", false, "only show the last snapshot for each host and path")
+}
+
+func runSnapshots(opts SnapshotOptions, gopts GlobalOptions, args []string) error {
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		lock, err := lockRepo(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+
+	var list restic.Snapshots
+	for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, args) {
+		list = append(list, sn)
+	}
+
+	if opts.Last {
+		list = FilterLastSnapshots(list)
+	}
+
+	sort.Sort(sort.Reverse(list))
+
+	if gopts.JSON {
+		err := printSnapshotsJSON(gopts.stdout, list)
+		if err != nil {
+			Warnf("error printing snapshot: %v\n", err)
+		}
+		return nil
+	}
+	PrintSnapshots(gopts.stdout, list, opts.Compact)
+
+	return nil
+}
+
+// filterLastSnapshotsKey is used by FilterLastSnapshots.
+type filterLastSnapshotsKey struct {
+	Hostname    string
+	JoinedPaths string
+}
+
+// newFilterLastSnapshotsKey initializes a filterLastSnapshotsKey from a Snapshot
+func newFilterLastSnapshotsKey(sn *restic.Snapshot) filterLastSnapshotsKey {
+	// Shallow slice copy
+	var paths = make([]string, len(sn.Paths))
+	copy(paths, sn.Paths)
+	sort.Strings(paths)
+	return filterLastSnapshotsKey{sn.Hostname, strings.Join(paths, "|")}
+}
+
+// FilterLastSnapshots filters a list of snapshots to only return the last
+// entry for each hostname and path. If the snapshot contains multiple paths,
+// they will be joined and treated as one item.
+func FilterLastSnapshots(list restic.Snapshots) restic.Snapshots {
+	// Sort the snapshots so that the newer ones are listed first
+	sort.SliceStable(list, func(i, j int) bool {
+		return list[i].Time.After(list[j].Time)
+	})
+
+	var results restic.Snapshots
+	seen := make(map[filterLastSnapshotsKey]bool)
+	for _, sn := range list {
+		key := newFilterLastSnapshotsKey(sn)
+		if !seen[key] {
+			seen[key] = true
+			results = append(results, sn)
+		}
+	}
+	return results
+}
+
+// PrintSnapshots prints a text table of the snapshots in list to stdout.
+func PrintSnapshots(stdout io.Writer, list restic.Snapshots, compact bool) {
+
+	// always sort the snapshots so that the newer ones are listed last
+	sort.SliceStable(list, func(i, j int) bool {
+		return list[i].Time.Before(list[j].Time)
+	})
+
+	// Determine the max widths for host and tag.
+	maxHost, maxTag := 10, 6
+	for _, sn := range list {
+		if len(sn.Hostname) > maxHost {
+			maxHost = len(sn.Hostname)
+		}
+		for _, tag := range sn.Tags {
+			if len(tag) > maxTag {
+				maxTag = len(tag)
+			}
+		}
+	}
+
+	tab := NewTable()
+	if !compact {
+		tab.Header = fmt.Sprintf("%-8s  %-19s  %-*s  %-*s  %-3s %s", "ID", "Date", -maxHost, "Host", -maxTag, "Tags", "", "Directory")
+		tab.RowFormat = fmt.Sprintf("%%-8s  %%-19s  %%%ds  %%%ds  %%-3s %%s", -maxHost, -maxTag)
+	} else {
+		tab.Header = fmt.Sprintf("%-8s  %-19s  %-*s  %-*s", "ID", "Date", -maxHost, "Host", -maxTag, "Tags")
+		tab.RowFormat = fmt.Sprintf("%%-8s  %%-19s  %%%ds  %%s", -maxHost)
+	}
+
+	for _, sn := range list {
+		if len(sn.Paths) == 0 {
+			continue
+		}
+
+		firstTag := ""
+		if len(sn.Tags) > 0 {
+			firstTag = sn.Tags[0]
+		}
+
+		rows := len(sn.Paths)
+		if rows < len(sn.Tags) {
+			rows = len(sn.Tags)
+		}
+
+		treeElement := "   "
+		if rows != 1 {
+			treeElement = "┌──"
+		}
+
+		if !compact {
+			tab.Rows = append(tab.Rows, []interface{}{sn.ID().Str(), sn.Time.Format(TimeFormat), sn.Hostname, firstTag, treeElement, sn.Paths[0]})
+		} else {
+			allTags := ""
+			for _, tag := range sn.Tags {
+				allTags += tag + " "
+			}
+			tab.Rows = append(tab.Rows, []interface{}{sn.ID().Str(), sn.Time.Format(TimeFormat), sn.Hostname, allTags})
+			continue
+		}
+
+		if len(sn.Tags) > rows {
+			rows = len(sn.Tags)
+		}
+
+		for i := 1; i < rows; i++ {
+			path := ""
+			if len(sn.Paths) > i {
+				path = sn.Paths[i]
+			}
+
+			tag := ""
+			if len(sn.Tags) > i {
+				tag = sn.Tags[i]
+			}
+
+			treeElement := "│"
+			if i == (rows - 1) {
+				treeElement = "└──"
+			}
+
+			tab.Rows = append(tab.Rows, []interface{}{"", "", "", tag, treeElement, path})
+		}
+	}
+
+	tab.Footer = fmt.Sprintf("%d snapshots", len(list))
+
+	tab.Write(stdout)
+}
+
+// Snapshot helps to print Snaphots as JSON with their ID included.
+type Snapshot struct {
+	*restic.Snapshot
+
+	ID      *restic.ID `json:"id"`
+	ShortID string     `json:"short_id"`
+}
+
+// printSnapshotsJSON writes the JSON representation of list to stdout.
+func printSnapshotsJSON(stdout io.Writer, list restic.Snapshots) error {
+
+	var snapshots []Snapshot
+
+	for _, sn := range list {
+
+		k := Snapshot{
+			Snapshot: sn,
+			ID:       sn.ID(),
+			ShortID:  sn.ID().Str(),
+		}
+		snapshots = append(snapshots, k)
+	}
+
+	return json.NewEncoder(stdout).Encode(snapshots)
+}

cmd/restic/cmd_tag.go

@@ -0,0 +1,143 @@
+package main
+
+import (
+	"context"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+)
+
+var cmdTag = &cobra.Command{
+	Use:   "tag [flags] [snapshot-ID ...]",
+	Short: "Modify tags on snapshots",
+	Long: `
+The "tag" command allows you to modify tags on exiting snapshots.
+
+You can either set/replace the entire set of tags on a snapshot, or
+add tags to/remove tags from the existing set.
+
+When no snapshot-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
+`,
+	DisableAutoGenTag: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runTag(tagOptions, globalOptions, args)
+	},
+}
+
+// TagOptions bundles all options for the 'tag' command.
+type TagOptions struct {
+	Host       string
+	Paths      []string
+	Tags       restic.TagLists
+	SetTags    []string
+	AddTags    []string
+	RemoveTags []string
+}
+
+var tagOptions TagOptions
+
+func init() {
+	cmdRoot.AddCommand(cmdTag)
+
+	tagFlags := cmdTag.Flags()
+	tagFlags.StringSliceVar(&tagOptions.SetTags, "set", nil, "`tag` which will replace the existing tags (can be given multiple times)")
+	tagFlags.StringSliceVar(&tagOptions.AddTags, "add", nil, "`tag` which will be added to the existing tags (can be given multiple times)")
+	tagFlags.StringSliceVar(&tagOptions.RemoveTags, "remove", nil, "`tag` which will be removed from the existing tags (can be given multiple times)")
+
+	tagFlags.StringVarP(&tagOptions.Host, "host", "H", "", "only consider snapshots for this `host`, when no snapshot ID is given")
+	tagFlags.Var(&tagOptions.Tags, "tag", "only consider snapshots which include this `taglist`, when no snapshot-ID is given")
+	tagFlags.StringArrayVar(&tagOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path`, when no snapshot-ID is given")
+}
+
+func changeTags(repo *repository.Repository, sn *restic.Snapshot, setTags, addTags, removeTags []string) (bool, error) {
+	var changed bool
+
+	if len(setTags) != 0 {
+		// Setting the tag to an empty string really means no tags.
+		if len(setTags) == 1 && setTags[0] == "" {
+			setTags = nil
+		}
+		sn.Tags = setTags
+		changed = true
+	} else {
+		changed = sn.AddTags(addTags)
+		if sn.RemoveTags(removeTags) {
+			changed = true
+		}
+	}
+
+	if changed {
+		// Retain the original snapshot id over all tag changes.
+		if sn.Original == nil {
+			sn.Original = sn.ID()
+		}
+
+		// Save the new snapshot.
+		id, err := repo.SaveJSONUnpacked(context.TODO(), restic.SnapshotFile, sn)
+		if err != nil {
+			return false, err
+		}
+
+		debug.Log("new snapshot saved as %v", id.Str())
+
+		if err = repo.Flush(); err != nil {
+			return false, err
+		}
+
+		// Remove the old snapshot.
+		h := restic.Handle{Type: restic.SnapshotFile, Name: sn.ID().String()}
+		if err = repo.Backend().Remove(context.TODO(), h); err != nil {
+			return false, err
+		}
+
+		debug.Log("old snapshot %v removed", sn.ID())
+	}
+	return changed, nil
+}
+
+func runTag(opts TagOptions, gopts GlobalOptions, args []string) error {
+	if len(opts.SetTags) == 0 && len(opts.AddTags) == 0 && len(opts.RemoveTags) == 0 {
+		return errors.Fatal("nothing to do!")
+	}
+	if len(opts.SetTags) != 0 && (len(opts.AddTags) != 0 || len(opts.RemoveTags) != 0) {
+		return errors.Fatal("--set and --add/--remove cannot be given at the same time")
+	}
+
+	repo, err := OpenRepository(gopts)
+	if err != nil {
+		return err
+	}
+
+	if !gopts.NoLock {
+		Verbosef("create exclusive lock for repository\n")
+		lock, err := lockRepoExclusive(repo)
+		defer unlockRepo(lock)
+		if err != nil {
+			return err
+		}
+	}
+
+	changeCnt := 0
+	ctx, cancel := context.WithCancel(gopts.ctx)
+	defer cancel()
+	for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, args) {
+		changed, err := changeTags(repo, sn, opts.SetTags, opts.AddTags, opts.RemoveTags)
+		if err != nil {
+			Warnf("unable to modify the tags for snapshot ID %q, ignoring: %v\n", sn.ID(), err)
+			continue
+		}
+		if changed {
+			changeCnt++
+		}
+	}
+	if changeCnt == 0 {
+		Verbosef("no snapshots were modified\n")
+	} else {
+		Verbosef("modified tags on %v snapshots\n", changeCnt)
+	}
+	return nil
+}

cmd/restic/cmd_unlock.go

@@ -1,17 +1,19 @@
 package main
 
 import (
-	"restic"
+	"context"
 
+	"github.com/restic/restic/internal/restic"
 	"github.com/spf13/cobra"
 )
 
 var unlockCmd = &cobra.Command{
 	Use:   "unlock",
-	Short: "remove locks other processes created",
+	Short: "Remove locks other processes created",
 	Long: `
 The "unlock" command removes stale locks that have been created by other restic processes.
 `,
+	DisableAutoGenTag: true,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return runUnlock(unlockOptions, globalOptions)
 	},
@@ -27,7 +29,7 @@ var unlockOptions UnlockOptions
 func init() {
 	cmdRoot.AddCommand(unlockCmd)
 
-	unlockCmd.Flags().BoolVar(&unlockOptions.RemoveAll, "remove-all", false, "Remove all locks, even non-stale ones")
+	unlockCmd.Flags().BoolVar(&unlockOptions.RemoveAll, "remove-all", false, "remove all locks, even non-stale ones")
 }
 
 func runUnlock(opts UnlockOptions, gopts GlobalOptions) error {
@@ -41,7 +43,7 @@ func runUnlock(opts UnlockOptions, gopts GlobalOptions) error {
 		fn = restic.RemoveAllLocks
 	}
 
-	err = fn(repo)
+	err = fn(context.TODO(), repo)
 	if err != nil {
 		return err
 	}

cmd/restic/cmd_version.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"fmt"
+	"runtime"
+
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Print version information",
+	Long: `
+The "version" command prints detailed information about the build environment
+and the version of this software.
+`,
+	DisableAutoGenTag: true,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("restic %s\ncompiled with %v on %v/%v\n",
+			version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
+	},
+}
+
+func init() {
+	cmdRoot.AddCommand(versionCmd)
+}

cmd/restic/exclude.go

@@ -0,0 +1,266 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+	"sync"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/filter"
+	"github.com/restic/restic/internal/fs"
+	"github.com/restic/restic/internal/repository"
+)
+
+type rejectionCache struct {
+	m   map[string]bool
+	mtx sync.Mutex
+}
+
+// Lock locks the mutex in rc.
+func (rc *rejectionCache) Lock() {
+	if rc != nil {
+		rc.mtx.Lock()
+	}
+}
+
+// Unlock unlocks the mutex in rc.
+func (rc *rejectionCache) Unlock() {
+	if rc != nil {
+		rc.mtx.Unlock()
+	}
+}
+
+// Get returns the last stored value for dir and a second boolean that
+// indicates whether that value was actually written to the cache. It is the
+// callers responsibility to call rc.Lock and rc.Unlock before using this
+// method, otherwise data races may occur.
+func (rc *rejectionCache) Get(dir string) (bool, bool) {
+	if rc == nil || rc.m == nil {
+		return false, false
+	}
+	v, ok := rc.m[dir]
+	return v, ok
+}
+
+// Store stores a new value for dir.  It is the callers responsibility to call
+// rc.Lock and rc.Unlock before using this method, otherwise data races may
+// occur.
+func (rc *rejectionCache) Store(dir string, rejected bool) {
+	if rc == nil {
+		return
+	}
+	if rc.m == nil {
+		rc.m = make(map[string]bool)
+	}
+	rc.m[dir] = rejected
+}
+
+// RejectFunc is a function that takes a filename and os.FileInfo of a
+// file that would be included in the backup. The function returns true if it
+// should be excluded (rejected) from the backup.
+type RejectFunc func(path string, fi os.FileInfo) bool
+
+// rejectByPattern returns a RejectFunc which rejects files that match
+// one of the patterns.
+func rejectByPattern(patterns []string) RejectFunc {
+	return func(item string, fi os.FileInfo) bool {
+		matched, _, err := filter.List(patterns, item)
+		if err != nil {
+			Warnf("error for exclude pattern: %v", err)
+		}
+
+		if matched {
+			debug.Log("path %q excluded by an exclude pattern", item)
+			return true
+		}
+
+		return false
+	}
+}
+
+// rejectIfPresent returns a RejectFunc which itself returns whether a path
+// should be excluded. The RejectFunc considers a file to be excluded when
+// it resides in a directory with an exclusion file, that is specified by
+// excludeFileSpec in the form "filename[:content]". The returned error is
+// non-nil if the filename component of excludeFileSpec is empty. If rc is
+// non-nil, it is going to be used in the RejectFunc to expedite the evaluation
+// of a directory based on previous visits.
+func rejectIfPresent(excludeFileSpec string, rc *rejectionCache) (RejectFunc, error) {
+	if excludeFileSpec == "" {
+		return nil, errors.New("name for exclusion tagfile is empty")
+	}
+	colon := strings.Index(excludeFileSpec, ":")
+	if colon == 0 {
+		return nil, fmt.Errorf("no name for exclusion tagfile provided")
+	}
+	tf, tc := "", ""
+	if colon > 0 {
+		tf = excludeFileSpec[:colon]
+		tc = excludeFileSpec[colon+1:]
+	} else {
+		tf = excludeFileSpec
+	}
+	debug.Log("using %q as exclusion tagfile", tf)
+	fn := func(filename string, _ os.FileInfo) bool {
+		return isExcludedByFile(filename, tf, tc, rc)
+	}
+	return fn, nil
+}
+
+// isExcludedByFile interprets filename as a path and returns true if that file
+// is in a excluded directory. A directory is identified as excluded if it contains a
+// tagfile which bears the name specified in tagFilename and starts with
+// header. If rc is non-nil, it is used to expedite the evaluation of a
+// directory based on previous visits.
+func isExcludedByFile(filename, tagFilename, header string, rc *rejectionCache) bool {
+	if tagFilename == "" {
+		return false
+	}
+	dir, base := filepath.Split(filename)
+	if base == tagFilename {
+		return false // do not exclude the tagfile itself
+	}
+	rc.Lock()
+	defer rc.Unlock()
+
+	rejected, visited := rc.Get(dir)
+	if visited {
+		return rejected
+	}
+	rejected = isDirExcludedByFile(dir, tagFilename, header)
+	rc.Store(dir, rejected)
+	return rejected
+}
+
+func isDirExcludedByFile(dir, tagFilename, header string) bool {
+	tf := filepath.Join(dir, tagFilename)
+	_, err := fs.Lstat(tf)
+	if os.IsNotExist(err) {
+		return false
+	}
+	if err != nil {
+		Warnf("could not access exclusion tagfile: %v", err)
+		return false
+	}
+	// when no signature is given, the mere presence of tf is enough reason
+	// to exclude filename
+	if len(header) == 0 {
+		return true
+	}
+	// From this stage, errors mean tagFilename exists but it is malformed.
+	// Warnings will be generated so that the user is informed that the
+	// indented ignore-action is not performed.
+	f, err := os.Open(tf)
+	if err != nil {
+		Warnf("could not open exclusion tagfile: %v", err)
+		return false
+	}
+	defer f.Close()
+	buf := make([]byte, len(header))
+	_, err = io.ReadFull(f, buf)
+	// EOF is handled with a dedicated message, otherwise the warning were too cryptic
+	if err == io.EOF {
+		Warnf("invalid (too short) signature in exclusion tagfile %q\n", tf)
+		return false
+	}
+	if err != nil {
+		Warnf("could not read signature from exclusion tagfile %q: %v\n", tf, err)
+		return false
+	}
+	if bytes.Compare(buf, []byte(header)) != 0 {
+		Warnf("invalid signature in exclusion tagfile %q\n", tf)
+		return false
+	}
+	return true
+}
+
+// gatherDevices returns the set of unique device ids of the files and/or
+// directory paths listed in "items".
+func gatherDevices(items []string) (deviceMap map[string]uint64, err error) {
+	deviceMap = make(map[string]uint64)
+	for _, item := range items {
+		fi, err := fs.Lstat(item)
+		if err != nil {
+			return nil, err
+		}
+		id, err := fs.DeviceID(fi)
+		if err != nil {
+			return nil, err
+		}
+		deviceMap[item] = id
+	}
+	if len(deviceMap) == 0 {
+		return nil, errors.New("zero allowed devices")
+	}
+	return deviceMap, nil
+}
+
+// rejectByDevice returns a RejectFunc that rejects files which are on a
+// different file systems than the files/dirs in samples.
+func rejectByDevice(samples []string) (RejectFunc, error) {
+	allowed, err := gatherDevices(samples)
+	if err != nil {
+		return nil, err
+	}
+	debug.Log("allowed devices: %v\n", allowed)
+
+	return func(item string, fi os.FileInfo) bool {
+		if fi == nil {
+			return false
+		}
+
+		id, err := fs.DeviceID(fi)
+		if err != nil {
+			// This should never happen because gatherDevices() would have
+			// errored out earlier. If it still does that's a reason to panic.
+			panic(err)
+		}
+
+		for dir := item; dir != ""; dir = filepath.Dir(dir) {
+			debug.Log("item %v, test dir %v", item, dir)
+
+			allowedID, ok := allowed[dir]
+			if !ok {
+				continue
+			}
+
+			if allowedID != id {
+				debug.Log("path %q on disallowed device %d", item, id)
+				return true
+			}
+
+			return false
+		}
+
+		panic(fmt.Sprintf("item %v, device id %v not found, allowedDevs: %v", item, id, allowed))
+	}, nil
+}
+
+// rejectResticCache returns a RejectFunc that rejects the restic cache
+// directory (if set).
+func rejectResticCache(repo *repository.Repository) (RejectFunc, error) {
+	if repo.Cache == nil {
+		return func(string, os.FileInfo) bool {
+			return false
+		}, nil
+	}
+	cacheBase := repo.Cache.BaseDir()
+
+	if cacheBase == "" {
+		return nil, errors.New("cacheBase is empty string")
+	}
+
+	return func(item string, _ os.FileInfo) bool {
+		if fs.HasPathPrefix(cacheBase, item) {
+			debug.Log("rejecting restic cache directory %v", item)
+			return true
+		}
+
+		return false
+	}, nil
+}

cmd/restic/exclude_test.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"io/ioutil"
+	"path/filepath"
+	"testing"
+
+	"github.com/restic/restic/internal/test"
+)
+
+func TestRejectByPattern(t *testing.T) {
+	var tests = []struct {
+		filename string
+		reject   bool
+	}{
+		{filename: "/home/user/foo.go", reject: true},
+		{filename: "/home/user/foo.c", reject: false},
+		{filename: "/home/user/foobar", reject: false},
+		{filename: "/home/user/foobar/x", reject: true},
+		{filename: "/home/user/README", reject: false},
+		{filename: "/home/user/README.md", reject: true},
+	}
+
+	patterns := []string{"*.go", "README.md", "/home/user/foobar/*"}
+
+	for _, tc := range tests {
+		t.Run("", func(t *testing.T) {
+			reject := rejectByPattern(patterns)
+			res := reject(tc.filename, nil)
+			if res != tc.reject {
+				t.Fatalf("wrong result for filename %v: want %v, got %v",
+					tc.filename, tc.reject, res)
+			}
+		})
+	}
+}
+
+func TestIsExcludedByFile(t *testing.T) {
+	const (
+		tagFilename = "CACHEDIR.TAG"
+		header      = "Signature: 8a477f597d28d172789f06886806bc55"
+	)
+	tests := []struct {
+		name    string
+		tagFile string
+		content string
+		want    bool
+	}{
+		{"NoTagfile", "", "", false},
+		{"EmptyTagfile", tagFilename, "", true},
+		{"UnnamedTagFile", "", header, false},
+		{"WrongTagFile", "notatagfile", header, false},
+		{"IncorrectSig", tagFilename, header[1:], false},
+		{"ValidSig", tagFilename, header, true},
+		{"ValidPlusStuff", tagFilename, header + "foo", true},
+		{"ValidPlusNewlineAndStuff", tagFilename, header + "\nbar", true},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			tempDir, cleanup := test.TempDir(t)
+			defer cleanup()
+
+			foo := filepath.Join(tempDir, "foo")
+			err := ioutil.WriteFile(foo, []byte("foo"), 0666)
+			if err != nil {
+				t.Fatalf("could not write file: %v", err)
+			}
+			if tc.tagFile != "" {
+				tagFile := filepath.Join(tempDir, tc.tagFile)
+				err = ioutil.WriteFile(tagFile, []byte(tc.content), 0666)
+				if err != nil {
+					t.Fatalf("could not write tagfile: %v", err)
+				}
+			}
+			h := header
+			if tc.content == "" {
+				h = ""
+			}
+			if got := isExcludedByFile(foo, tagFilename, h, nil); tc.want != got {
+				t.Fatalf("expected %v, got %v", tc.want, got)
+			}
+		})
+	}
+}

cmd/restic/excludes

@@ -0,0 +1,31 @@
+/boot
+/dev
+/etc
+/home
+/lost+found
+/mnt
+/proc
+/root
+/run
+/sys
+/tmp
+/usr
+/var
+/opt/android-sdk
+/opt/bullet
+/opt/dex2jar
+/opt/jameica
+/opt/google
+/opt/JDownloader
+/opt/JDownloaderScripts
+/opt/opencascade
+/opt/vagrant
+/opt/visual-studio-code
+/opt/vtk6
+/bin
+/fonts*
+/srv/ftp
+/srv/http
+/sbin
+/lib
+/lib64

cmd/restic/find.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"context"
+
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+)
+
+// FindFilteredSnapshots yields Snapshots, either given explicitly by `snapshotIDs` or filtered from the list of all snapshots.
+func FindFilteredSnapshots(ctx context.Context, repo *repository.Repository, host string, tags []restic.TagList, paths []string, snapshotIDs []string) <-chan *restic.Snapshot {
+	out := make(chan *restic.Snapshot)
+	go func() {
+		defer close(out)
+		if len(snapshotIDs) != 0 {
+			var (
+				id         restic.ID
+				usedFilter bool
+				err        error
+			)
+			ids := make(restic.IDs, 0, len(snapshotIDs))
+			// Process all snapshot IDs given as arguments.
+			for _, s := range snapshotIDs {
+				if s == "latest" {
+					id, err = restic.FindLatestSnapshot(ctx, repo, paths, tags, host)
+					if err != nil {
+						Warnf("Ignoring %q, no snapshot matched given filter (Paths:%v Tags:%v Host:%v)\n", s, paths, tags, host)
+						usedFilter = true
+						continue
+					}
+				} else {
+					id, err = restic.FindSnapshot(repo, s)
+					if err != nil {
+						Warnf("Ignoring %q, it is not a snapshot id\n", s)
+						continue
+					}
+				}
+				ids = append(ids, id)
+			}
+
+			// Give the user some indication their filters are not used.
+			if !usedFilter && (host != "" || len(tags) != 0 || len(paths) != 0) {
+				Warnf("Ignoring filters as there are explicit snapshot ids given\n")
+			}
+
+			for _, id := range ids.Uniq() {
+				sn, err := restic.LoadSnapshot(ctx, repo, id)
+				if err != nil {
+					Warnf("Ignoring %q, could not load snapshot: %v\n", id, err)
+					continue
+				}
+				select {
+				case <-ctx.Done():
+					return
+				case out <- sn:
+				}
+			}
+			return
+		}
+
+		for _, sn := range restic.FindFilteredSnapshots(ctx, repo, host, tags, paths) {
+			select {
+			case <-ctx.Done():
+				return
+			case out <- sn:
+			}
+		}
+	}()
+	return out
+}

cmd/restic/flags_test.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"io/ioutil"
+	"testing"
+)
+
+// TestFlags checks for double defined flags, the commands will panic on
+// ParseFlags() when a shorthand flag is defined twice.
+func TestFlags(t *testing.T) {
+	for _, cmd := range cmdRoot.Commands() {
+		t.Run(cmd.Name(), func(t *testing.T) {
+			cmd.Flags().SetOutput(ioutil.Discard)
+			err := cmd.ParseFlags([]string{"--help"})
+			if err.Error() == "pflag: help requested" {
+				err = nil
+			}
+
+			if err != nil {
+				t.Fatal(err)
+			}
+		})
+	}
+}

cmd/restic/format.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"time"
+
+	"github.com/restic/restic/internal/restic"
+)
+
+func formatBytes(c uint64) string {
+	b := float64(c)
+
+	switch {
+	case c > 1<<40:
+		return fmt.Sprintf("%.3f TiB", b/(1<<40))
+	case c > 1<<30:
+		return fmt.Sprintf("%.3f GiB", b/(1<<30))
+	case c > 1<<20:
+		return fmt.Sprintf("%.3f MiB", b/(1<<20))
+	case c > 1<<10:
+		return fmt.Sprintf("%.3f KiB", b/(1<<10))
+	default:
+		return fmt.Sprintf("%dB", c)
+	}
+}
+
+func formatSeconds(sec uint64) string {
+	hours := sec / 3600
+	sec -= hours * 3600
+	min := sec / 60
+	sec -= min * 60
+	if hours > 0 {
+		return fmt.Sprintf("%d:%02d:%02d", hours, min, sec)
+	}
+
+	return fmt.Sprintf("%d:%02d", min, sec)
+}
+
+func formatPercent(numerator uint64, denominator uint64) string {
+	if denominator == 0 {
+		return ""
+	}
+
+	percent := 100.0 * float64(numerator) / float64(denominator)
+
+	if percent > 100 {
+		percent = 100
+	}
+
+	return fmt.Sprintf("%3.2f%%", percent)
+}
+
+func formatRate(bytes uint64, duration time.Duration) string {
+	sec := float64(duration) / float64(time.Second)
+	rate := float64(bytes) / sec / (1 << 20)
+	return fmt.Sprintf("%.2fMiB/s", rate)
+}
+
+func formatDuration(d time.Duration) string {
+	sec := uint64(d / time.Second)
+	return formatSeconds(sec)
+}
+
+func formatNode(prefix string, n *restic.Node, long bool) string {
+	if !long {
+		return filepath.Join(prefix, n.Name)
+	}
+
+	switch n.Type {
+	case "file":
+		return fmt.Sprintf("%s %5d %5d %6d %s %s",
+			n.Mode, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name))
+	case "dir":
+		return fmt.Sprintf("%s %5d %5d %6d %s %s",
+			n.Mode|os.ModeDir, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name))
+	case "symlink":
+		return fmt.Sprintf("%s %5d %5d %6d %s %s -> %s",
+			n.Mode|os.ModeSymlink, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name), n.LinkTarget)
+	default:
+		return fmt.Sprintf("<Node(%s) %s>", n.Type, n.Name)
+	}
+}

cmd/restic/global.go

@@ -0,0 +1,590 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+	"runtime"
+	"strings"
+	"syscall"
+	"time"
+
+	"github.com/restic/restic/internal/backend"
+	"github.com/restic/restic/internal/backend/azure"
+	"github.com/restic/restic/internal/backend/b2"
+	"github.com/restic/restic/internal/backend/gs"
+	"github.com/restic/restic/internal/backend/local"
+	"github.com/restic/restic/internal/backend/location"
+	"github.com/restic/restic/internal/backend/rest"
+	"github.com/restic/restic/internal/backend/s3"
+	"github.com/restic/restic/internal/backend/sftp"
+	"github.com/restic/restic/internal/backend/swift"
+	"github.com/restic/restic/internal/cache"
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/limiter"
+	"github.com/restic/restic/internal/options"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/restic/restic/internal/errors"
+
+	"golang.org/x/crypto/ssh/terminal"
+)
+
+var version = "compiled manually"
+
+// GlobalOptions hold all global options for restic.
+type GlobalOptions struct {
+	Repo         string
+	PasswordFile string
+	Quiet        bool
+	NoLock       bool
+	JSON         bool
+	CacheDir     string
+	NoCache      bool
+	CACerts      []string
+
+	LimitUploadKb   int
+	LimitDownloadKb int
+
+	ctx      context.Context
+	password string
+	stdout   io.Writer
+	stderr   io.Writer
+
+	Options []string
+
+	extended options.Options
+}
+
+var globalOptions = GlobalOptions{
+	stdout: os.Stdout,
+	stderr: os.Stderr,
+}
+
+func init() {
+	var cancel context.CancelFunc
+	globalOptions.ctx, cancel = context.WithCancel(context.Background())
+	AddCleanupHandler(func() error {
+		cancel()
+		return nil
+	})
+
+	f := cmdRoot.PersistentFlags()
+	f.StringVarP(&globalOptions.Repo, "repo", "r", os.Getenv("RESTIC_REPOSITORY"), "repository to backup to or restore from (default: $RESTIC_REPOSITORY)")
+	f.StringVarP(&globalOptions.PasswordFile, "password-file", "p", os.Getenv("RESTIC_PASSWORD_FILE"), "read the repository password from a file (default: $RESTIC_PASSWORD_FILE)")
+	f.BoolVarP(&globalOptions.Quiet, "quiet", "q", false, "do not output comprehensive progress report")
+	f.BoolVar(&globalOptions.NoLock, "no-lock", false, "do not lock the repo, this allows some operations on read-only repos")
+	f.BoolVarP(&globalOptions.JSON, "json", "", false, "set output mode to JSON for commands that support it")
+	f.StringVar(&globalOptions.CacheDir, "cache-dir", "", "set the cache directory")
+	f.BoolVar(&globalOptions.NoCache, "no-cache", false, "do not use a local cache")
+	f.StringSliceVar(&globalOptions.CACerts, "cacert", nil, "path to load root certificates from (default: use system certificates)")
+	f.IntVar(&globalOptions.LimitUploadKb, "limit-upload", 0, "limits uploads to a maximum rate in KiB/s. (default: unlimited)")
+	f.IntVar(&globalOptions.LimitDownloadKb, "limit-download", 0, "limits downloads to a maximum rate in KiB/s. (default: unlimited)")
+	f.StringSliceVarP(&globalOptions.Options, "option", "o", []string{}, "set extended option (`key=value`, can be specified multiple times)")
+
+	restoreTerminal()
+}
+
+// checkErrno returns nil when err is set to syscall.Errno(0), since this is no
+// error condition.
+func checkErrno(err error) error {
+	e, ok := err.(syscall.Errno)
+	if !ok {
+		return err
+	}
+
+	if e == 0 {
+		return nil
+	}
+
+	return err
+}
+
+func stdinIsTerminal() bool {
+	return terminal.IsTerminal(int(os.Stdin.Fd()))
+}
+
+func stdoutIsTerminal() bool {
+	return terminal.IsTerminal(int(os.Stdout.Fd()))
+}
+
+func stdoutTerminalWidth() int {
+	w, _, err := terminal.GetSize(int(os.Stdout.Fd()))
+	if err != nil {
+		return 0
+	}
+	return w
+}
+
+// restoreTerminal installs a cleanup handler that restores the previous
+// terminal state on exit.
+func restoreTerminal() {
+	if !stdoutIsTerminal() {
+		return
+	}
+
+	fd := int(os.Stdout.Fd())
+	state, err := terminal.GetState(fd)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "unable to get terminal state: %v\n", err)
+		return
+	}
+
+	AddCleanupHandler(func() error {
+		err := checkErrno(terminal.Restore(fd, state))
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "unable to get restore terminal state: %#+v\n", err)
+		}
+		return err
+	})
+}
+
+// ClearLine creates a platform dependent string to clear the current
+// line, so it can be overwritten. ANSI sequences are not supported on
+// current windows cmd shell.
+func ClearLine() string {
+	if runtime.GOOS == "windows" {
+		if w := stdoutTerminalWidth(); w > 0 {
+			return strings.Repeat(" ", w-1) + "\r"
+		}
+		return ""
+	}
+	return "\x1b[2K"
+}
+
+// Printf writes the message to the configured stdout stream.
+func Printf(format string, args ...interface{}) {
+	_, err := fmt.Fprintf(globalOptions.stdout, format, args...)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "unable to write to stdout: %v\n", err)
+		Exit(100)
+	}
+}
+
+// Verbosef calls Printf to write the message when the verbose flag is set.
+func Verbosef(format string, args ...interface{}) {
+	if globalOptions.Quiet {
+		return
+	}
+
+	Printf(format, args...)
+}
+
+// PrintProgress wraps fmt.Printf to handle the difference in writing progress
+// information to terminals and non-terminal stdout
+func PrintProgress(format string, args ...interface{}) {
+	var (
+		message         string
+		carriageControl string
+	)
+	message = fmt.Sprintf(format, args...)
+
+	if !(strings.HasSuffix(message, "\r") || strings.HasSuffix(message, "\n")) {
+		if stdoutIsTerminal() {
+			carriageControl = "\r"
+		} else {
+			carriageControl = "\n"
+		}
+		message = fmt.Sprintf("%s%s", message, carriageControl)
+	}
+
+	if stdoutIsTerminal() {
+		message = fmt.Sprintf("%s%s", ClearLine(), message)
+	}
+
+	fmt.Print(message)
+}
+
+// Warnf writes the message to the configured stderr stream.
+func Warnf(format string, args ...interface{}) {
+	_, err := fmt.Fprintf(globalOptions.stderr, format, args...)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "unable to write to stderr: %v\n", err)
+		Exit(100)
+	}
+}
+
+// Exitf uses Warnf to write the message and then terminates the process with
+// the given exit code.
+func Exitf(exitcode int, format string, args ...interface{}) {
+	if format[len(format)-1] != '\n' {
+		format += "\n"
+	}
+
+	Warnf(format, args...)
+	Exit(exitcode)
+}
+
+// resolvePassword determines the password to be used for opening the repository.
+func resolvePassword(opts GlobalOptions, env string) (string, error) {
+	if opts.PasswordFile != "" {
+		s, err := ioutil.ReadFile(opts.PasswordFile)
+		if os.IsNotExist(err) {
+			return "", errors.Fatalf("%s does not exist", opts.PasswordFile)
+		}
+		return strings.TrimSpace(string(s)), errors.Wrap(err, "Readfile")
+	}
+
+	if pwd := os.Getenv(env); pwd != "" {
+		return pwd, nil
+	}
+
+	return "", nil
+}
+
+// readPassword reads the password from the given reader directly.
+func readPassword(in io.Reader) (password string, err error) {
+	buf := make([]byte, 1000)
+	n, err := io.ReadFull(in, buf)
+	buf = buf[:n]
+
+	if err != nil && errors.Cause(err) != io.ErrUnexpectedEOF {
+		return "", errors.Wrap(err, "ReadFull")
+	}
+
+	return strings.TrimRight(string(buf), "\r\n"), nil
+}
+
+// readPasswordTerminal reads the password from the given reader which must be a
+// tty. Prompt is printed on the writer out before attempting to read the
+// password.
+func readPasswordTerminal(in *os.File, out io.Writer, prompt string) (password string, err error) {
+	fmt.Fprint(out, prompt)
+	buf, err := terminal.ReadPassword(int(in.Fd()))
+	fmt.Fprintln(out)
+	if err != nil {
+		return "", errors.Wrap(err, "ReadPassword")
+	}
+
+	password = string(buf)
+	return password, nil
+}
+
+// ReadPassword reads the password from a password file, the environment
+// variable RESTIC_PASSWORD or prompts the user.
+func ReadPassword(opts GlobalOptions, prompt string) (string, error) {
+	if opts.password != "" {
+		return opts.password, nil
+	}
+
+	var (
+		password string
+		err      error
+	)
+
+	if stdinIsTerminal() {
+		password, err = readPasswordTerminal(os.Stdin, os.Stderr, prompt)
+	} else {
+		password, err = readPassword(os.Stdin)
+	}
+
+	if err != nil {
+		return "", errors.Wrap(err, "unable to read password")
+	}
+
+	if len(password) == 0 {
+		return "", errors.Fatal("an empty password is not a password")
+	}
+
+	return password, nil
+}
+
+// ReadPasswordTwice calls ReadPassword two times and returns an error when the
+// passwords don't match.
+func ReadPasswordTwice(gopts GlobalOptions, prompt1, prompt2 string) (string, error) {
+	pw1, err := ReadPassword(gopts, prompt1)
+	if err != nil {
+		return "", err
+	}
+	pw2, err := ReadPassword(gopts, prompt2)
+	if err != nil {
+		return "", err
+	}
+
+	if pw1 != pw2 {
+		return "", errors.Fatal("passwords do not match")
+	}
+
+	return pw1, nil
+}
+
+const maxKeys = 20
+
+// OpenRepository reads the password and opens the repository.
+func OpenRepository(opts GlobalOptions) (*repository.Repository, error) {
+	if opts.Repo == "" {
+		return nil, errors.Fatal("Please specify repository location (-r)")
+	}
+
+	be, err := open(opts.Repo, opts.extended)
+	if err != nil {
+		return nil, err
+	}
+
+	if opts.LimitUploadKb > 0 || opts.LimitDownloadKb > 0 {
+		debug.Log("rate limiting backend to %d KiB/s upload and %d KiB/s download", opts.LimitUploadKb, opts.LimitDownloadKb)
+		be = limiter.LimitBackend(be, limiter.NewStaticLimiter(opts.LimitUploadKb, opts.LimitDownloadKb))
+	}
+
+	be = backend.NewRetryBackend(be, 10, func(msg string, err error, d time.Duration) {
+		Warnf("%v returned error, retrying after %v: %v\n", msg, d, err)
+	})
+
+	s := repository.New(be)
+
+	opts.password, err = ReadPassword(opts, "enter password for repository: ")
+	if err != nil {
+		return nil, err
+	}
+
+	err = s.SearchKey(context.TODO(), opts.password, maxKeys)
+	if err != nil {
+		return nil, err
+	}
+
+	if stdoutIsTerminal() {
+		Verbosef("password is correct\n")
+	}
+
+	if opts.NoCache {
+		return s, nil
+	}
+
+	cache, err := cache.New(s.Config().ID, opts.CacheDir)
+	if err != nil {
+		Warnf("unable to open cache: %v\n", err)
+	} else {
+		s.UseCache(cache)
+	}
+
+	return s, nil
+}
+
+func parseConfig(loc location.Location, opts options.Options) (interface{}, error) {
+	// only apply options for a particular backend here
+	opts = opts.Extract(loc.Scheme)
+
+	switch loc.Scheme {
+	case "local":
+		cfg := loc.Config.(local.Config)
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening local repository at %#v", cfg)
+		return cfg, nil
+
+	case "sftp":
+		cfg := loc.Config.(sftp.Config)
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening sftp repository at %#v", cfg)
+		return cfg, nil
+
+	case "s3":
+		cfg := loc.Config.(s3.Config)
+		if cfg.KeyID == "" {
+			cfg.KeyID = os.Getenv("AWS_ACCESS_KEY_ID")
+		}
+
+		if cfg.Secret == "" {
+			cfg.Secret = os.Getenv("AWS_SECRET_ACCESS_KEY")
+		}
+
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening s3 repository at %#v", cfg)
+		return cfg, nil
+
+	case "gs":
+		cfg := loc.Config.(gs.Config)
+		if cfg.ProjectID == "" {
+			cfg.ProjectID = os.Getenv("GOOGLE_PROJECT_ID")
+		}
+
+		if cfg.JSONKeyPath == "" {
+			if path := os.Getenv("GOOGLE_APPLICATION_CREDENTIALS"); path != "" {
+				// Check read access
+				if _, err := ioutil.ReadFile(path); err != nil {
+					return nil, errors.Fatalf("Failed to read google credential from file %v: %v", path, err)
+				}
+				cfg.JSONKeyPath = path
+			} else {
+				return nil, errors.Fatal("No credential file path is set")
+			}
+		}
+
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening gs repository at %#v", cfg)
+		return cfg, nil
+
+	case "azure":
+		cfg := loc.Config.(azure.Config)
+		if cfg.AccountName == "" {
+			cfg.AccountName = os.Getenv("AZURE_ACCOUNT_NAME")
+		}
+
+		if cfg.AccountKey == "" {
+			cfg.AccountKey = os.Getenv("AZURE_ACCOUNT_KEY")
+		}
+
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening gs repository at %#v", cfg)
+		return cfg, nil
+
+	case "swift":
+		cfg := loc.Config.(swift.Config)
+
+		if err := swift.ApplyEnvironment("", &cfg); err != nil {
+			return nil, err
+		}
+
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening swift repository at %#v", cfg)
+		return cfg, nil
+
+	case "b2":
+		cfg := loc.Config.(b2.Config)
+
+		if cfg.AccountID == "" {
+			cfg.AccountID = os.Getenv("B2_ACCOUNT_ID")
+		}
+
+		if cfg.Key == "" {
+			cfg.Key = os.Getenv("B2_ACCOUNT_KEY")
+		}
+
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening b2 repository at %#v", cfg)
+		return cfg, nil
+	case "rest":
+		cfg := loc.Config.(rest.Config)
+		if err := opts.Apply(loc.Scheme, &cfg); err != nil {
+			return nil, err
+		}
+
+		debug.Log("opening rest repository at %#v", cfg)
+		return cfg, nil
+	}
+
+	return nil, errors.Fatalf("invalid backend: %q", loc.Scheme)
+}
+
+// Open the backend specified by a location config.
+func open(s string, opts options.Options) (restic.Backend, error) {
+	debug.Log("parsing location %v", s)
+	loc, err := location.Parse(s)
+	if err != nil {
+		return nil, errors.Fatalf("parsing repository location failed: %v", err)
+	}
+
+	var be restic.Backend
+
+	cfg, err := parseConfig(loc, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	rt, err := backend.Transport(globalOptions.CACerts)
+	if err != nil {
+		return nil, err
+	}
+
+	switch loc.Scheme {
+	case "local":
+		be, err = local.Open(cfg.(local.Config))
+	case "sftp":
+		be, err = sftp.Open(cfg.(sftp.Config), SuspendSignalHandler, InstallSignalHandler)
+	case "s3":
+		be, err = s3.Open(cfg.(s3.Config), rt)
+	case "gs":
+		be, err = gs.Open(cfg.(gs.Config))
+	case "azure":
+		be, err = azure.Open(cfg.(azure.Config), rt)
+	case "swift":
+		be, err = swift.Open(cfg.(swift.Config), rt)
+	case "b2":
+		be, err = b2.Open(cfg.(b2.Config), rt)
+	case "rest":
+		be, err = rest.Open(cfg.(rest.Config), rt)
+
+	default:
+		return nil, errors.Fatalf("invalid backend: %q", loc.Scheme)
+	}
+
+	if err != nil {
+		return nil, errors.Fatalf("unable to open repo at %v: %v", s, err)
+	}
+
+	// check if config is there
+	fi, err := be.Stat(context.TODO(), restic.Handle{Type: restic.ConfigFile})
+	if err != nil {
+		return nil, errors.Fatalf("unable to open config file: %v\nIs there a repository at the following location?\n%v", err, s)
+	}
+
+	if fi.Size == 0 {
+		return nil, errors.New("config file has zero size, invalid repository?")
+	}
+
+	return be, nil
+}
+
+// Create the backend specified by URI.
+func create(s string, opts options.Options) (restic.Backend, error) {
+	debug.Log("parsing location %v", s)
+	loc, err := location.Parse(s)
+	if err != nil {
+		return nil, err
+	}
+
+	cfg, err := parseConfig(loc, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	rt, err := backend.Transport(globalOptions.CACerts)
+	if err != nil {
+		return nil, err
+	}
+
+	switch loc.Scheme {
+	case "local":
+		return local.Create(cfg.(local.Config))
+	case "sftp":
+		return sftp.Create(cfg.(sftp.Config), SuspendSignalHandler, InstallSignalHandler)
+	case "s3":
+		return s3.Create(cfg.(s3.Config), rt)
+	case "gs":
+		return gs.Create(cfg.(gs.Config))
+	case "azure":
+		return azure.Create(cfg.(azure.Config), rt)
+	case "swift":
+		return swift.Open(cfg.(swift.Config), rt)
+	case "b2":
+		return b2.Create(cfg.(b2.Config), rt)
+	case "rest":
+		return rest.Create(cfg.(rest.Config), rt)
+	}
+
+	debug.Log("invalid repository scheme: %v", s)
+	return nil, errors.Fatalf("invalid scheme %q", loc.Scheme)
+}

cmd/restic/global_debug.go

@@ -0,0 +1,75 @@
+// +build debug
+
+package main
+
+import (
+	"fmt"
+	"net/http"
+	_ "net/http/pprof"
+	"os"
+
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+
+	"github.com/pkg/profile"
+)
+
+var (
+	listenMemoryProfile string
+	memProfilePath      string
+	cpuProfilePath      string
+	insecure            bool
+)
+
+func init() {
+	f := cmdRoot.PersistentFlags()
+	f.StringVar(&listenMemoryProfile, "listen-profile", "", "listen on this `address:port` for memory profiling")
+	f.StringVar(&memProfilePath, "mem-profile", "", "write memory profile to `dir`")
+	f.StringVar(&cpuProfilePath, "cpu-profile", "", "write cpu profile to `dir`")
+	f.BoolVar(&insecure, "insecure-kdf", false, "use insecure KDF settings")
+}
+
+type fakeTestingTB struct{}
+
+func (fakeTestingTB) Logf(msg string, args ...interface{}) {
+	fmt.Fprintf(os.Stderr, msg, args...)
+}
+
+func runDebug() error {
+	if listenMemoryProfile != "" {
+		fmt.Fprintf(os.Stderr, "running memory profile HTTP server on %v\n", listenMemoryProfile)
+		go func() {
+			err := http.ListenAndServe(listenMemoryProfile, nil)
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "memory profile listen failed: %v\n", err)
+			}
+		}()
+	}
+
+	if memProfilePath != "" && cpuProfilePath != "" {
+		return errors.Fatal("only one profile (memory or CPU) may be activated at the same time")
+	}
+
+	var prof interface {
+		Stop()
+	}
+
+	if memProfilePath != "" {
+		prof = profile.Start(profile.Quiet, profile.NoShutdownHook, profile.MemProfile, profile.ProfilePath(memProfilePath))
+	} else if cpuProfilePath != "" {
+		prof = profile.Start(profile.Quiet, profile.NoShutdownHook, profile.CPUProfile, profile.ProfilePath(cpuProfilePath))
+	}
+
+	if prof != nil {
+		AddCleanupHandler(func() error {
+			prof.Stop()
+			return nil
+		})
+	}
+
+	if insecure {
+		repository.TestUseLowSecurityKDFParameters(fakeTestingTB{})
+	}
+
+	return nil
+}

cmd/restic/global_release.go

@@ -0,0 +1,6 @@
+// +build !debug
+
+package main
+
+// runDebug is a noop without the debug tag.
+func runDebug() error { return nil }

cmd/restic/integration_fuse_test.go

@@ -0,0 +1,216 @@
+// +build !openbsd
+// +build !windows
+
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+	rtest "github.com/restic/restic/internal/test"
+)
+
+const (
+	mountWait       = 20
+	mountSleep      = 100 * time.Millisecond
+	mountTestSubdir = "snapshots"
+)
+
+func snapshotsDirExists(t testing.TB, dir string) bool {
+	f, err := os.Open(filepath.Join(dir, mountTestSubdir))
+	if err != nil && os.IsNotExist(err) {
+		return false
+	}
+
+	if err != nil {
+		t.Error(err)
+	}
+
+	if err := f.Close(); err != nil {
+		t.Error(err)
+	}
+
+	return true
+}
+
+// waitForMount blocks (max mountWait * mountSleep) until the subdir
+// "snapshots" appears in the dir.
+func waitForMount(t testing.TB, dir string) {
+	for i := 0; i < mountWait; i++ {
+		if snapshotsDirExists(t, dir) {
+			t.Log("mounted directory is ready")
+			return
+		}
+
+		time.Sleep(mountSleep)
+	}
+
+	t.Errorf("subdir %q of dir %s never appeared", mountTestSubdir, dir)
+}
+
+func testRunMount(t testing.TB, gopts GlobalOptions, dir string) {
+	opts := MountOptions{}
+	rtest.OK(t, runMount(opts, gopts, []string{dir}))
+}
+
+func testRunUmount(t testing.TB, gopts GlobalOptions, dir string) {
+	var err error
+	for i := 0; i < mountWait; i++ {
+		if err = umount(dir); err == nil {
+			t.Logf("directory %v umounted", dir)
+			return
+		}
+
+		time.Sleep(mountSleep)
+	}
+
+	t.Errorf("unable to umount dir %v, last error was: %v", dir, err)
+}
+
+func listSnapshots(t testing.TB, dir string) []string {
+	snapshotsDir, err := os.Open(filepath.Join(dir, "snapshots"))
+	rtest.OK(t, err)
+	names, err := snapshotsDir.Readdirnames(-1)
+	rtest.OK(t, err)
+	rtest.OK(t, snapshotsDir.Close())
+	return names
+}
+
+func checkSnapshots(t testing.TB, global GlobalOptions, repo *repository.Repository, mountpoint, repodir string, snapshotIDs restic.IDs, expectedSnapshotsInFuseDir int) {
+	t.Logf("checking for %d snapshots: %v", len(snapshotIDs), snapshotIDs)
+
+	go testRunMount(t, global, mountpoint)
+	waitForMount(t, mountpoint)
+	defer testRunUmount(t, global, mountpoint)
+
+	if !snapshotsDirExists(t, mountpoint) {
+		t.Fatal(`virtual directory "snapshots" doesn't exist`)
+	}
+
+	ids := listSnapshots(t, repodir)
+	t.Logf("found %v snapshots in repo: %v", len(ids), ids)
+
+	namesInSnapshots := listSnapshots(t, mountpoint)
+	t.Logf("found %v snapshots in fuse mount: %v", len(namesInSnapshots), namesInSnapshots)
+	rtest.Assert(t,
+		expectedSnapshotsInFuseDir == len(namesInSnapshots),
+		"Invalid number of snapshots: expected %d, got %d", expectedSnapshotsInFuseDir, len(namesInSnapshots))
+
+	namesMap := make(map[string]bool)
+	for _, name := range namesInSnapshots {
+		namesMap[name] = false
+	}
+
+	// Is "latest" present?
+	if len(namesMap) != 0 {
+		_, ok := namesMap["latest"]
+		if !ok {
+			t.Errorf("Symlink latest isn't present in fuse dir")
+		} else {
+			namesMap["latest"] = true
+		}
+	}
+
+	for _, id := range snapshotIDs {
+		snapshot, err := restic.LoadSnapshot(context.TODO(), repo, id)
+		rtest.OK(t, err)
+
+		ts := snapshot.Time.Format(time.RFC3339)
+		present, ok := namesMap[ts]
+		if !ok {
+			t.Errorf("Snapshot %v (%q) isn't present in fuse dir", id.Str(), ts)
+		}
+
+		for i := 1; present; i++ {
+			ts = fmt.Sprintf("%s-%d", snapshot.Time.Format(time.RFC3339), i)
+			present, ok = namesMap[ts]
+			if !ok {
+				t.Errorf("Snapshot %v (%q) isn't present in fuse dir", id.Str(), ts)
+			}
+
+			if !present {
+				break
+			}
+		}
+
+		namesMap[ts] = true
+	}
+
+	for name, present := range namesMap {
+		rtest.Assert(t, present, "Directory %s is present in fuse dir but is not a snapshot", name)
+	}
+}
+
+func TestMount(t *testing.T) {
+	if !rtest.RunFuseTest {
+		t.Skip("Skipping fuse tests")
+	}
+
+	env, cleanup := withTestEnvironment(t)
+	defer cleanup()
+
+	testRunInit(t, env.gopts)
+
+	repo, err := OpenRepository(env.gopts)
+	rtest.OK(t, err)
+
+	// We remove the mountpoint now to check that cmdMount creates it
+	rtest.RemoveAll(t, env.mountpoint)
+
+	checkSnapshots(t, env.gopts, repo, env.mountpoint, env.repo, []restic.ID{}, 0)
+
+	rtest.SetupTarTestFixture(t, env.testdata, filepath.Join("testdata", "backup-data.tar.gz"))
+
+	// first backup
+	testRunBackup(t, []string{env.testdata}, BackupOptions{}, env.gopts)
+	snapshotIDs := testRunList(t, "snapshots", env.gopts)
+	rtest.Assert(t, len(snapshotIDs) == 1,
+		"expected one snapshot, got %v", snapshotIDs)
+
+	checkSnapshots(t, env.gopts, repo, env.mountpoint, env.repo, snapshotIDs, 2)
+
+	// second backup, implicit incremental
+	testRunBackup(t, []string{env.testdata}, BackupOptions{}, env.gopts)
+	snapshotIDs = testRunList(t, "snapshots", env.gopts)
+	rtest.Assert(t, len(snapshotIDs) == 2,
+		"expected two snapshots, got %v", snapshotIDs)
+
+	checkSnapshots(t, env.gopts, repo, env.mountpoint, env.repo, snapshotIDs, 3)
+
+	// third backup, explicit incremental
+	bopts := BackupOptions{Parent: snapshotIDs[0].String()}
+	testRunBackup(t, []string{env.testdata}, bopts, env.gopts)
+	snapshotIDs = testRunList(t, "snapshots", env.gopts)
+	rtest.Assert(t, len(snapshotIDs) == 3,
+		"expected three snapshots, got %v", snapshotIDs)
+
+	checkSnapshots(t, env.gopts, repo, env.mountpoint, env.repo, snapshotIDs, 4)
+}
+
+func TestMountSameTimestamps(t *testing.T) {
+	if !rtest.RunFuseTest {
+		t.Skip("Skipping fuse tests")
+	}
+
+	env, cleanup := withTestEnvironment(t)
+	defer cleanup()
+
+	rtest.SetupTarTestFixture(t, env.base, filepath.Join("testdata", "repo-same-timestamps.tar.gz"))
+
+	repo, err := OpenRepository(env.gopts)
+	rtest.OK(t, err)
+
+	ids := []restic.ID{
+		restic.TestParseID("280303689e5027328889a06d718b729e96a1ce6ae9ef8290bff550459ae611ee"),
+		restic.TestParseID("75ad6cdc0868e082f2596d5ab8705e9f7d87316f5bf5690385eeff8dbe49d9f5"),
+		restic.TestParseID("5fd0d8b2ef0fa5d23e58f1e460188abb0f525c0f0c4af8365a1280c807a80a1b"),
+	}
+
+	checkSnapshots(t, env.gopts, repo, env.mountpoint, env.repo, ids, 4)
+}

cmd/restic/integration_helpers_test.go

@@ -0,0 +1,232 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/restic/restic/internal/options"
+	"github.com/restic/restic/internal/repository"
+	rtest "github.com/restic/restic/internal/test"
+)
+
+type dirEntry struct {
+	path string
+	fi   os.FileInfo
+	link uint64
+}
+
+func walkDir(dir string) <-chan *dirEntry {
+	ch := make(chan *dirEntry, 100)
+
+	go func() {
+		err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "error: %v\n", err)
+				return nil
+			}
+
+			name, err := filepath.Rel(dir, path)
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "error: %v\n", err)
+				return nil
+			}
+
+			ch <- &dirEntry{
+				path: name,
+				fi:   info,
+				link: nlink(info),
+			}
+
+			return nil
+		})
+
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Walk() error: %v\n", err)
+		}
+
+		close(ch)
+	}()
+
+	// first element is root
+	_ = <-ch
+
+	return ch
+}
+
+func isSymlink(fi os.FileInfo) bool {
+	mode := fi.Mode() & (os.ModeType | os.ModeCharDevice)
+	return mode == os.ModeSymlink
+}
+
+func sameModTime(fi1, fi2 os.FileInfo) bool {
+	switch runtime.GOOS {
+	case "darwin", "freebsd", "openbsd":
+		if isSymlink(fi1) && isSymlink(fi2) {
+			return true
+		}
+	}
+
+	same := fi1.ModTime().Equal(fi2.ModTime())
+	if !same && (runtime.GOOS == "darwin" || runtime.GOOS == "openbsd") {
+		// Allow up to 1μs difference, because macOS <10.13 cannot restore
+		// with nanosecond precision and the current version of Go (1.9.2)
+		// does not yet support the new syscall. (#1087)
+		mt1 := fi1.ModTime()
+		mt2 := fi2.ModTime()
+		usecDiff := (mt1.Nanosecond()-mt2.Nanosecond())/1000 + (mt1.Second()-mt2.Second())*1000000
+		same = usecDiff <= 1 && usecDiff >= -1
+	}
+	return same
+}
+
+// directoriesEqualContents checks if both directories contain exactly the same
+// contents.
+func directoriesEqualContents(dir1, dir2 string) bool {
+	ch1 := walkDir(dir1)
+	ch2 := walkDir(dir2)
+
+	changes := false
+
+	var a, b *dirEntry
+	for {
+		var ok bool
+
+		if ch1 != nil && a == nil {
+			a, ok = <-ch1
+			if !ok {
+				ch1 = nil
+			}
+		}
+
+		if ch2 != nil && b == nil {
+			b, ok = <-ch2
+			if !ok {
+				ch2 = nil
+			}
+		}
+
+		if ch1 == nil && ch2 == nil {
+			break
+		}
+
+		if ch1 == nil {
+			fmt.Printf("+%v\n", b.path)
+			changes = true
+		} else if ch2 == nil {
+			fmt.Printf("-%v\n", a.path)
+			changes = true
+		} else if !a.equals(b) {
+			if a.path < b.path {
+				fmt.Printf("-%v\n", a.path)
+				changes = true
+				a = nil
+				continue
+			} else if a.path > b.path {
+				fmt.Printf("+%v\n", b.path)
+				changes = true
+				b = nil
+				continue
+			} else {
+				fmt.Printf("%%%v\n", a.path)
+				changes = true
+			}
+		}
+
+		a, b = nil, nil
+	}
+
+	if changes {
+		return false
+	}
+
+	return true
+}
+
+type dirStat struct {
+	files, dirs, other uint
+	size               uint64
+}
+
+func isFile(fi os.FileInfo) bool {
+	return fi.Mode()&(os.ModeType|os.ModeCharDevice) == 0
+}
+
+// dirStats walks dir and collects stats.
+func dirStats(dir string) (stat dirStat) {
+	for entry := range walkDir(dir) {
+		if isFile(entry.fi) {
+			stat.files++
+			stat.size += uint64(entry.fi.Size())
+			continue
+		}
+
+		if entry.fi.IsDir() {
+			stat.dirs++
+			continue
+		}
+
+		stat.other++
+	}
+
+	return stat
+}
+
+type testEnvironment struct {
+	base, cache, repo, mountpoint, testdata string
+	gopts                                   GlobalOptions
+}
+
+// withTestEnvironment creates a test environment and returns a cleanup
+// function which removes it.
+func withTestEnvironment(t testing.TB) (env *testEnvironment, cleanup func()) {
+	if !rtest.RunIntegrationTest {
+		t.Skip("integration tests disabled")
+	}
+
+	repository.TestUseLowSecurityKDFParameters(t)
+
+	tempdir, err := ioutil.TempDir(rtest.TestTempDir, "restic-test-")
+	rtest.OK(t, err)
+
+	env = &testEnvironment{
+		base:       tempdir,
+		cache:      filepath.Join(tempdir, "cache"),
+		repo:       filepath.Join(tempdir, "repo"),
+		testdata:   filepath.Join(tempdir, "testdata"),
+		mountpoint: filepath.Join(tempdir, "mount"),
+	}
+
+	rtest.OK(t, os.MkdirAll(env.mountpoint, 0700))
+	rtest.OK(t, os.MkdirAll(env.testdata, 0700))
+	rtest.OK(t, os.MkdirAll(env.cache, 0700))
+	rtest.OK(t, os.MkdirAll(env.repo, 0700))
+
+	env.gopts = GlobalOptions{
+		Repo:     env.repo,
+		Quiet:    true,
+		CacheDir: env.cache,
+		ctx:      context.Background(),
+		password: rtest.TestPassword,
+		stdout:   os.Stdout,
+		stderr:   os.Stderr,
+		extended: make(options.Options),
+	}
+
+	// always overwrite global options
+	globalOptions = env.gopts
+
+	cleanup = func() {
+		if !rtest.TestCleanupTempDirs {
+			t.Logf("leaving temporary directory %v used for test", tempdir)
+			return
+		}
+		rtest.RemoveAll(t, tempdir)
+	}
+
+	return env, cleanup
+}

cmd/restic/integration_helpers_unix_test.go

@@ -0,0 +1,70 @@
+//+build !windows
+
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"syscall"
+)
+
+func (e *dirEntry) equals(other *dirEntry) bool {
+	if e.path != other.path {
+		fmt.Fprintf(os.Stderr, "%v: path does not match (%v != %v)\n", e.path, e.path, other.path)
+		return false
+	}
+
+	if e.fi.Mode() != other.fi.Mode() {
+		fmt.Fprintf(os.Stderr, "%v: mode does not match (%v != %v)\n", e.path, e.fi.Mode(), other.fi.Mode())
+		return false
+	}
+
+	if !sameModTime(e.fi, other.fi) {
+		fmt.Fprintf(os.Stderr, "%v: ModTime does not match (%v != %v)\n", e.path, e.fi.ModTime(), other.fi.ModTime())
+		return false
+	}
+
+	stat, _ := e.fi.Sys().(*syscall.Stat_t)
+	stat2, _ := other.fi.Sys().(*syscall.Stat_t)
+
+	if stat.Uid != stat2.Uid {
+		fmt.Fprintf(os.Stderr, "%v: UID does not match (%v != %v)\n", e.path, stat.Uid, stat2.Uid)
+		return false
+	}
+
+	if stat.Gid != stat2.Gid {
+		fmt.Fprintf(os.Stderr, "%v: GID does not match (%v != %v)\n", e.path, stat.Gid, stat2.Gid)
+		return false
+	}
+
+	if stat.Nlink != stat2.Nlink {
+		fmt.Fprintf(os.Stderr, "%v: Number of links do not match (%v != %v)\n", e.path, stat.Nlink, stat2.Nlink)
+		return false
+	}
+
+	return true
+}
+
+func nlink(info os.FileInfo) uint64 {
+	stat, _ := info.Sys().(*syscall.Stat_t)
+	return uint64(stat.Nlink)
+}
+
+func createFileSetPerHardlink(dir string) map[uint64][]string {
+	var stat syscall.Stat_t
+	linkTests := make(map[uint64][]string)
+	files, err := ioutil.ReadDir(dir)
+	if err != nil {
+		return nil
+	}
+	for _, f := range files {
+
+		if err := syscall.Stat(filepath.Join(dir, f.Name()), &stat); err != nil {
+			return nil
+		}
+		linkTests[uint64(stat.Ino)] = append(linkTests[uint64(stat.Ino)], f.Name())
+	}
+	return linkTests
+}

cmd/restic/integration_helpers_windows_test.go

@@ -0,0 +1,49 @@
+//+build windows
+
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+)
+
+func (e *dirEntry) equals(other *dirEntry) bool {
+	if e.path != other.path {
+		fmt.Fprintf(os.Stderr, "%v: path does not match (%v != %v)\n", e.path, e.path, other.path)
+		return false
+	}
+
+	if e.fi.Mode() != other.fi.Mode() {
+		fmt.Fprintf(os.Stderr, "%v: mode does not match (%v != %v)\n", e.path, e.fi.Mode(), other.fi.Mode())
+		return false
+	}
+
+	if !sameModTime(e.fi, other.fi) {
+		fmt.Fprintf(os.Stderr, "%v: ModTime does not match (%v != %v)\n", e.path, e.fi.ModTime(), other.fi.ModTime())
+		return false
+	}
+
+	return true
+}
+
+func nlink(info os.FileInfo) uint64 {
+	return 1
+}
+
+func inode(info os.FileInfo) uint64 {
+	return uint64(0)
+}
+
+func createFileSetPerHardlink(dir string) map[uint64][]string {
+	linkTests := make(map[uint64][]string)
+	files, err := ioutil.ReadDir(dir)
+	if err != nil {
+		return nil
+	}
+	for i, f := range files {
+		linkTests[uint64(i)] = append(linkTests[uint64(i)], f.Name())
+		i++
+	}
+	return linkTests
+}

cmd/restic/local_layout_test.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"path/filepath"
+	"testing"
+
+	rtest "github.com/restic/restic/internal/test"
+)
+
+func TestRestoreLocalLayout(t *testing.T) {
+	env, cleanup := withTestEnvironment(t)
+	defer cleanup()
+
+	var tests = []struct {
+		filename string
+		layout   string
+	}{
+		{"repo-layout-default.tar.gz", ""},
+		{"repo-layout-s3legacy.tar.gz", ""},
+		{"repo-layout-default.tar.gz", "default"},
+		{"repo-layout-s3legacy.tar.gz", "s3legacy"},
+	}
+
+	for _, test := range tests {
+		datafile := filepath.Join("..", "..", "internal", "backend", "testdata", test.filename)
+
+		rtest.SetupTarTestFixture(t, env.base, datafile)
+
+		env.gopts.extended["local.layout"] = test.layout
+
+		// check the repo
+		testRunCheck(t, env.gopts)
+
+		// restore latest snapshot
+		target := filepath.Join(env.base, "restore")
+		testRunRestoreLatest(t, env.gopts, target, nil, "")
+
+		rtest.RemoveAll(t, filepath.Join(env.base, "repo"))
+		rtest.RemoveAll(t, target)
+	}
+}

cmd/restic/lock.go

@@ -0,0 +1,128 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"sync"
+	"time"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/errors"
+	"github.com/restic/restic/internal/repository"
+	"github.com/restic/restic/internal/restic"
+)
+
+var globalLocks struct {
+	locks         []*restic.Lock
+	cancelRefresh chan struct{}
+	refreshWG     sync.WaitGroup
+	sync.Mutex
+}
+
+func lockRepo(repo *repository.Repository) (*restic.Lock, error) {
+	return lockRepository(repo, false)
+}
+
+func lockRepoExclusive(repo *repository.Repository) (*restic.Lock, error) {
+	return lockRepository(repo, true)
+}
+
+func lockRepository(repo *repository.Repository, exclusive bool) (*restic.Lock, error) {
+	lockFn := restic.NewLock
+	if exclusive {
+		lockFn = restic.NewExclusiveLock
+	}
+
+	lock, err := lockFn(context.TODO(), repo)
+	if err != nil {
+		return nil, errors.Fatalf("unable to create lock in backend: %v", err)
+	}
+	debug.Log("create lock %p (exclusive %v)", lock, exclusive)
+
+	globalLocks.Lock()
+	if globalLocks.cancelRefresh == nil {
+		debug.Log("start goroutine for lock refresh")
+		globalLocks.cancelRefresh = make(chan struct{})
+		globalLocks.refreshWG = sync.WaitGroup{}
+		globalLocks.refreshWG.Add(1)
+		go refreshLocks(&globalLocks.refreshWG, globalLocks.cancelRefresh)
+	}
+
+	globalLocks.locks = append(globalLocks.locks, lock)
+	globalLocks.Unlock()
+
+	return lock, err
+}
+
+var refreshInterval = 5 * time.Minute
+
+func refreshLocks(wg *sync.WaitGroup, done <-chan struct{}) {
+	debug.Log("start")
+	defer func() {
+		wg.Done()
+		globalLocks.Lock()
+		globalLocks.cancelRefresh = nil
+		globalLocks.Unlock()
+	}()
+
+	ticker := time.NewTicker(refreshInterval)
+
+	for {
+		select {
+		case <-done:
+			debug.Log("terminate")
+			return
+		case <-ticker.C:
+			debug.Log("refreshing locks")
+			globalLocks.Lock()
+			for _, lock := range globalLocks.locks {
+				err := lock.Refresh(context.TODO())
+				if err != nil {
+					fmt.Fprintf(os.Stderr, "unable to refresh lock: %v\n", err)
+				}
+			}
+			globalLocks.Unlock()
+		}
+	}
+}
+
+func unlockRepo(lock *restic.Lock) error {
+	globalLocks.Lock()
+	defer globalLocks.Unlock()
+
+	debug.Log("unlocking repository with lock %p", lock)
+	if err := lock.Unlock(); err != nil {
+		debug.Log("error while unlocking: %v", err)
+		return err
+	}
+
+	for i := 0; i < len(globalLocks.locks); i++ {
+		if lock == globalLocks.locks[i] {
+			globalLocks.locks = append(globalLocks.locks[:i], globalLocks.locks[i+1:]...)
+			return nil
+		}
+	}
+
+	return nil
+}
+
+func unlockAll() error {
+	globalLocks.Lock()
+	defer globalLocks.Unlock()
+
+	debug.Log("unlocking %d locks", len(globalLocks.locks))
+	for _, lock := range globalLocks.locks {
+		if err := lock.Unlock(); err != nil {
+			debug.Log("error while unlocking: %v", err)
+			return err
+		}
+		debug.Log("successfully removed lock")
+	}
+
+	return nil
+}
+
+func init() {
+	AddCleanupHandler(unlockAll)
+}

cmd/restic/main.go

@@ -0,0 +1,94 @@
+package main
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"log"
+	"os"
+	"runtime"
+
+	"github.com/restic/restic/internal/debug"
+	"github.com/restic/restic/internal/options"
+	"github.com/restic/restic/internal/restic"
+
+	"github.com/spf13/cobra"
+
+	"github.com/restic/restic/internal/errors"
+)
+
+// cmdRoot is the base command when no other command has been specified.
+var cmdRoot = &cobra.Command{
+	Use:   "restic",
+	Short: "Backup and restore files",
+	Long: `
+restic is a backup program which allows saving multiple revisions of files and
+directories in an encrypted repository stored on different backends.
+`,
+	SilenceErrors:     true,
+	SilenceUsage:      true,
+	DisableAutoGenTag: true,
+
+	PersistentPreRunE: func(*cobra.Command, []string) error {
+		// parse extended options
+		opts, err := options.Parse(globalOptions.Options)
+		if err != nil {
+			return err
+		}
+		globalOptions.extended = opts
+
+		pwd, err := resolvePassword(globalOptions, "RESTIC_PASSWORD")
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Resolving password failed: %v\n", err)
+			Exit(1)
+		}
+		globalOptions.password = pwd
+
+		// run the debug functions for all subcommands (if build tag "debug" is
+		// enabled)
+		if err := runDebug(); err != nil {
+			return err
+		}
+
+		return nil
+	},
+}
+
+var logBuffer = bytes.NewBuffer(nil)
+
+func init() {
+	// install custom global logger into a buffer, if an error occurs
+	// we can show the logs
+	log.SetOutput(logBuffer)
+}
+
+func main() {
+	debug.Log("main %#v", os.Args)
+	debug.Log("restic %s, compiled with %v on %v/%v",
+		version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
+	err := cmdRoot.Execute()
+
+	switch {
+	case restic.IsAlreadyLocked(errors.Cause(err)):
+		fmt.Fprintf(os.Stderr, "%v\nthe `unlock` command can be used to remove stale locks\n", err)
+	case errors.IsFatal(errors.Cause(err)):
+		fmt.Fprintf(os.Stderr, "%v\n", err)
+	case err != nil:
+		fmt.Fprintf(os.Stderr, "%+v\n", err)
+
+		if logBuffer.Len() > 0 {
+			fmt.Fprintf(os.Stderr, "also, the following messages were logged by a library:\n")
+			sc := bufio.NewScanner(logBuffer)
+			for sc.Scan() {
+				fmt.Fprintln(os.Stderr, sc.Text())
+			}
+		}
+	}
+
+	var exitCode int
+	if err != nil {
+		exitCode = 1
+	}
+
+	Exit(exitCode)
+}

cmd/restic/table.go

@@ -0,0 +1,63 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"strings"
+)
+
+// Table contains data for a table to be printed.
+type Table struct {
+	Header string
+	Rows   [][]interface{}
+	Footer string
+
+	RowFormat string
+}
+
+// NewTable initializes a new Table.
+func NewTable() Table {
+	return Table{
+		Rows: [][]interface{}{},
+	}
+}
+
+func (t Table) printSeparationLine(w io.Writer) error {
+	_, err := fmt.Fprintln(w, strings.Repeat("-", 70))
+	return err
+}
+
+// Write prints the table to w.
+func (t Table) Write(w io.Writer) error {
+	_, err := fmt.Fprintln(w, t.Header)
+	if err != nil {
+		return err
+	}
+
+	err = t.printSeparationLine(w)
+	if err != nil {
+		return err
+	}
+
+	for _, row := range t.Rows {
+		_, err = fmt.Fprintf(w, t.RowFormat+"\n", row...)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = t.printSeparationLine(w)
+	if err != nil {
+		return err
+	}
+
+	_, err = fmt.Fprintln(w, t.Footer)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// TimeFormat is the format used for all timestamps printed by restic.
+const TimeFormat = "2006-01-02 15:04:05"

doc/010_introduction.rst

@@ -0,0 +1,16 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+############
+Introduction
+############
+

doc/020_installation.rst

@@ -0,0 +1,149 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+############
+Installation
+############
+
+Packages
+********
+
+Mac OS X
+========
+
+If you are using Mac OS X, you can install restic using the
+`homebrew <http://brew.sh/>`__ package manager:
+
+.. code-block:: console
+
+    $ brew install restic
+
+Arch Linux
+==========
+
+On `Arch Linux <https://www.archlinux.org/>`__, there is a package called ``restic-git``
+which can be installed from AUR, e.g. with ``pacaur``:
+
+.. code-block:: console
+
+    $ pacaur -S restic-git
+
+Nix & NixOS
+===========
+
+If you are using `Nix <https://nixos.org/nix/>`__ or `NixOS <https://nixos.org/>`__
+there is a package available named ``restic``.
+It can be installed uisng ``nix-env``:
+
+.. code-block:: console
+
+    $ nix-env --install restic 
+
+Debian
+======
+
+On Debian, there's a package called ``restic`` which can be
+installed from the official repos, e.g. with ``apt-get``:
+
+.. code-block:: console
+
+    $ apt-get install restic
+
+
+.. warning:: Please be aware that, at the time of writing, Debian *stable*
+   has ``restic`` version 0.3.3 which is very old. The *testing* and *unstable*
+   branches have recent versions of ``restic``.
+
+Pre-compiled Binary
+*******************
+
+You can download the latest pre-compiled binary from the `restic release
+page <https://github.com/restic/restic/releases/latest>`__.
+
+Docker Container
+****************
+
+.. note::
+   | A docker container is available as a contribution (Thank you!).
+   | You can find it at https://github.com/Lobaro/restic-backup-docker
+
+From Source
+***********
+
+restic is written in the Go programming language and you need at least
+Go version 1.8. Building restic may also work with older versions of Go,
+but that's not supported. See the `Getting
+started <https://golang.org/doc/install>`__ guide of the Go project for
+instructions how to install Go.
+
+In order to build restic from source, execute the following steps:
+
+.. code-block:: console
+
+    $ git clone https://github.com/restic/restic
+    [...]
+
+    $ cd restic
+
+    $ go run build.go
+
+You can easily cross-compile restic for all supported platforms, just
+supply the target OS and platform via the command-line options like this
+(for Windows and FreeBSD respectively):
+
+::
+
+    $ go run build.go --goos windows --goarch amd64
+
+    $ go run build.go --goos freebsd --goarch 386
+
+The resulting binary is statically linked and does not require any
+libraries.
+
+At the moment, the only tested compiler for restic is the official Go
+compiler. Building restic with gccgo may work, but is not supported.
+
+Autocompletion
+**************
+
+Restic can write out a bash compatible autocompletion script:
+
+.. code-block:: console
+
+    $ ./restic autocomplete --help
+    The "autocomplete" command generates a shell autocompletion script.
+
+    NOTE: The current version supports Bash only.
+          This should work for *nix systems with Bash installed.
+
+By default, the file is written directly to ``/etc/bash_completion.d/``
+for convenience, and the command may need superuser rights, e.g.
+
+.. code-block:: console
+
+    $ sudo restic autocomplete
+
+    Usage:
+      restic autocomplete [flags]
+
+    Flags:
+          --completionfile string   autocompletion file (default "/etc/bash_completion.d/restic.sh")
+
+    Global Flags:
+          --json                   set output mode to JSON for commands that support it
+          --no-lock                do not lock the repo, this allows some operations on read-only repos
+      -o, --option key=value       set extended option (key=value, can be specified multiple times)
+      -p, --password-file string   read the repository password from a file
+      -q, --quiet                  do not output comprehensive progress report
+      -r, --repo string            repository to backup to or restore from (default: $RESTIC_REPOSITORY)
+
+

doc/030_preparing_a_new_repo.rst

@@ -0,0 +1,402 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+##########################
+Preparing a new repository
+##########################
+
+The place where your backups will be saved at is called a "repository".
+This chapter explains how to create ("init") such a repository.
+
+Local
+*****
+
+In order to create a repository at ``/tmp/backup``, run the following
+command and enter the same password twice:
+
+.. code-block:: console
+
+    $ restic init --repo /tmp/backup
+    enter password for new backend:
+    enter password again:
+    created restic backend 085b3c76b9 at /tmp/backup
+    Please note that knowledge of your password is required to access the repository.
+    Losing your password means that your data is irrecoverably lost.
+
+.. warning::
+
+   Remembering your password is important! If you lose it, you won't be
+   able to access data stored in the repository.
+
+For automated backups, restic accepts the repository location in the
+environment variable ``RESTIC_REPOSITORY``. The password can be read
+from a file (via the option ``--password-file`` or the environment variable
+``RESTIC_PASSWORD_FILE``) or the environment variable ``RESTIC_PASSWORD``.
+
+SFTP
+****
+
+In order to backup data via SFTP, you must first set up a server with
+SSH and let it know your public key. Passwordless login is really
+important since restic fails to connect to the repository if the server
+prompts for credentials.
+
+Once the server is configured, the setup of the SFTP repository can
+simply be achieved by changing the URL scheme in the ``init`` command:
+
+.. code-block:: console
+
+    $ restic -r sftp:user@host:/tmp/backup init
+    enter password for new backend:
+    enter password again:
+    created restic backend f1c6108821 at sftp:user@host:/tmp/backup
+    Please note that knowledge of your password is required to access the repository.
+    Losing your password means that your data is irrecoverably lost.
+
+You can also specify a relative (read: no slash (``/``) character at the
+beginning) directory, in this case the dir is relative to the remote
+user's home directory.
+
+.. note:: Please be aware that sftp servers do not expand the tilde character
+          (``~``) normally used as an alias for a user's home directory. If you
+          want to specify a path relative to the user's home directory, pass a
+          relative path to the sftp backend.
+
+The backend config string does not allow specifying a port. If you need
+to contact an sftp server on a different port, you can create an entry
+in the ``ssh`` file, usually located in your user's home directory at
+``~/.ssh/config`` or in ``/etc/ssh/ssh_config``:
+
+::
+
+    Host foo
+        User bar
+        Port 2222
+
+Then use the specified host name ``foo`` normally (you don't need to
+specify the user name in this case):
+
+::
+
+    $ restic -r sftp:foo:/tmp/backup init
+
+You can also add an entry with a special host name which does not exist,
+just for use with restic, and use the ``Hostname`` option to set the
+real host name:
+
+::
+
+    Host restic-backup-host
+        Hostname foo
+        User bar
+        Port 2222
+
+Then use it in the backend specification:
+
+::
+
+    $ restic -r sftp:restic-backup-host:/tmp/backup init
+
+Last, if you'd like to use an entirely different program to create the
+SFTP connection, you can specify the command to be run with the option
+``-o sftp.command="foobar"``.
+
+
+REST Server
+***********
+
+In order to backup data to the remote server via HTTP or HTTPS protocol,
+you must first set up a remote `REST
+server <https://github.com/restic/rest-server>`__ instance. Once the
+server is configured, accessing it is achieved by changing the URL
+scheme like this:
+
+.. code-block:: console
+
+    $ restic -r rest:http://host:8000/
+
+Depending on your REST server setup, you can use HTTPS protocol,
+password protection, or multiple repositories. Or any combination of
+those features, as you see fit. TCP/IP port is also configurable. Here
+are some more examples:
+
+.. code-block:: console
+
+    $ restic -r rest:https://host:8000/
+    $ restic -r rest:https://user:pass@host:8000/
+    $ restic -r rest:https://user:pass@host:8000/my_backup_repo/
+
+If you use TLS, restic will use the system's CA certificates to verify the
+server certificate. When the verification fails, restic refuses to proceed and
+exits with an error. If you have your own self-signed certificate, or a custom
+CA certificate should be used for verification, you can pass restic the
+certificate filename via the `--cacert` option.
+
+REST server uses exactly the same directory structure as local backend,
+so you should be able to access it both locally and via HTTP, even
+simultaneously.
+
+Amazon S3
+*********
+
+Restic can backup data to any Amazon S3 bucket. However, in this case,
+changing the URL scheme is not enough since Amazon uses special security
+credentials to sign HTTP requests. By consequence, you must first setup
+the following environment variables with the credentials you obtained
+while creating the bucket.
+
+.. code-block:: console
+
+    $ export AWS_ACCESS_KEY_ID=<MY_ACCESS_KEY>
+    $ export AWS_SECRET_ACCESS_KEY=<MY_SECRET_ACCESS_KEY>
+
+You can then easily initialize a repository that uses your Amazon S3 as
+a backend, if the bucket does not exist yet it will be created in the
+default location:
+
+.. code-block:: console
+
+    $ restic -r s3:s3.amazonaws.com/bucket_name init
+    enter password for new backend:
+    enter password again:
+    created restic backend eefee03bbd at s3:s3.amazonaws.com/bucket_name
+    Please note that knowledge of your password is required to access the repository.
+    Losing your password means that your data is irrecoverably lost.
+
+It is not possible at the moment to have restic create a new bucket in a
+different location, so you need to create it using a different program.
+Afterwards, the S3 server (``s3.amazonaws.com``) will redirect restic to
+the correct endpoint.
+
+Until version 0.8.0, restic used a default prefix of ``restic``, so the files
+in the bucket were placed in a directory named ``restic``. If you want to
+access a repository created with an older version of restic, specify the path
+after the bucket name like this:
+
+.. code-block:: console
+
+    $ restic -r s3:s3.amazonaws.com/bucket_name/restic [...]
+
+For an S3-compatible server that is not Amazon (like Minio, see below),
+or is only available via HTTP, you can specify the URL to the server
+like this: ``s3:http://server:port/bucket_name``.
+
+Minio Server
+************
+
+`Minio <https://www.minio.io>`__ is an Open Source Object Storage,
+written in Go and compatible with AWS S3 API.
+
+-  Download and Install `Minio
+   Server <https://minio.io/downloads/#minio-server>`__.
+-  You can also refer to https://docs.minio.io for step by step guidance
+   on installation and getting started on Minio Client and Minio Server.
+
+You must first setup the following environment variables with the
+credentials of your running Minio Server.
+
+.. code-block:: console
+
+    $ export AWS_ACCESS_KEY_ID=<YOUR-MINIO-ACCESS-KEY-ID>
+    $ export AWS_SECRET_ACCESS_KEY= <YOUR-MINIO-SECRET-ACCESS-KEY>
+
+Now you can easily initialize restic to use Minio server as backend with
+this command.
+
+.. code-block:: console
+
+    $ ./restic -r s3:http://localhost:9000/restic init
+    enter password for new backend:
+    enter password again:
+    created restic backend 6ad29560f5 at s3:http://localhost:9000/restic1
+    Please note that knowledge of your password is required to access
+    the repository. Losing your password means that your data is irrecoverably lost.
+
+OpenStack Swift
+***************
+
+Restic can backup data to an OpenStack Swift container. Because Swift supports
+various authentication methods, credentials are passed through environment
+variables. In order to help integration with existing OpenStack installations,
+the naming convention of those variables follows official python swift client:
+
+.. code-block:: console
+
+   # For keystone v1 authentication
+   $ export ST_AUTH=<MY_AUTH_URL>
+   $ export ST_USER=<MY_USER_NAME>
+   $ export ST_KEY=<MY_USER_PASSWORD>
+
+   # For keystone v2 authentication (some variables are optional)
+   $ export OS_AUTH_URL=<MY_AUTH_URL>
+   $ export OS_REGION_NAME=<MY_REGION_NAME>
+   $ export OS_USERNAME=<MY_USERNAME>
+   $ export OS_PASSWORD=<MY_PASSWORD>
+   $ export OS_TENANT_ID=<MY_TENANT_ID>
+   $ export OS_TENANT_NAME=<MY_TENANT_NAME>
+
+   # For keystone v3 authentication (some variables are optional)
+   $ export OS_AUTH_URL=<MY_AUTH_URL>
+   $ export OS_REGION_NAME=<MY_REGION_NAME>
+   $ export OS_USERNAME=<MY_USERNAME>
+   $ export OS_PASSWORD=<MY_PASSWORD>
+   $ export OS_USER_DOMAIN_NAME=<MY_DOMAIN_NAME>
+   $ export OS_PROJECT_NAME=<MY_PROJECT_NAME>
+   $ export OS_PROJECT_DOMAIN_NAME=<MY_PROJECT_DOMAIN_NAME>
+
+   # For authentication based on tokens
+   $ export OS_STORAGE_URL=<MY_STORAGE_URL>
+   $ export OS_AUTH_TOKEN=<MY_AUTH_TOKEN>
+
+
+Restic should be compatible with `OpenStack RC file
+<https://docs.openstack.org/user-guide/common/cli-set-environment-variables-using-openstack-rc.html>`__
+in most cases.
+
+Once environment variables are set up, a new repository can be created. The
+name of swift container and optional path can be specified. If
+the container does not exist, it will be created automatically:
+
+.. code-block:: console
+
+   $ restic -r swift:container_name:/path init   # path is optional
+   enter password for new backend:
+   enter password again:
+   created restic backend eefee03bbd at swift:container_name:/path
+   Please note that knowledge of your password is required to access the repository.
+   Losing your password means that your data is irrecoverably lost.
+
+The policy of new container created by restic can be changed using environment variable:
+
+.. code-block:: console
+
+   $ export SWIFT_DEFAULT_CONTAINER_POLICY=<MY_CONTAINER_POLICY>
+
+
+Backblaze B2
+************
+
+Restic can backup data to any Backblaze B2 bucket. You need to first setup the
+following environment variables with the credentials you obtained when signed
+into your B2 account:
+
+.. code-block:: console
+
+    $ export B2_ACCOUNT_ID=<MY_ACCOUNT_ID>
+    $ export B2_ACCOUNT_KEY=<MY_SECRET_ACCOUNT_KEY>
+
+You can then easily initialize a repository stored at Backblaze B2. If the
+bucket does not exist yet, it will be created:
+
+.. code-block:: console
+
+    $ restic -r b2:bucketname:path/to/repo init
+    enter password for new backend:
+    enter password again:
+    created restic backend eefee03bbd at b2:bucketname:path/to/repo
+    Please note that knowledge of your password is required to access the repository.
+    Losing your password means that your data is irrecoverably lost.
+
+The number of concurrent connections to the B2 service can be set with the `-o
+b2.connections=10`. By default, at most five parallel connections are
+established.
+
+Microsoft Azure Blob Storage
+****************************
+
+You can also store backups on Microsoft Azure Blob Storage. Export the Azure
+account name and key as follows:
+
+.. code-block:: console
+
+    $ export AZURE_ACCOUNT_NAME=<ACCOUNT_NAME>
+    $ export AZURE_ACCOUNT_KEY=<SECRET_KEY>
+
+Afterwards you can initialize a repository in a container called `foo` in the
+root path like this:
+
+.. code-block:: console
+
+    $ restic -r azure:foo:/ init
+    enter password for new backend:
+    enter password again:
+
+    created restic backend a934bac191 at azure:foo:/
+    [...]
+
+The number of concurrent connections to the B2 service can be set with the
+`-o azure.connections=10`. By default, at most five parallel connections are
+established.
+
+Google Cloud Storage
+********************
+
+Restic supports Google Cloud Storage as a backend.
+
+Restic connects to Google Cloud Storage via a `service account`_.
+
+For normal restic operation, the service account must have the
+``storage.objects.{create,delete,get,list}`` permissions for the bucket. These
+are included in the "Storage Object Admin" role.
+``restic init`` can create the repository bucket. Doing so requires the
+``storage.buckets.create`` permission ("Storage Admin" role). If the bucket
+already exists, that permission is unnecessary.
+
+To use the Google Cloud Storage backend, first `create a service account key`_
+and download the JSON credentials file.
+Second, find the Google Project ID that you can see in the Google Cloud
+Platform console at the "Storage/Settings" menu. Export the path to the JSON
+key file and the project ID as follows:
+
+.. code-block:: console
+
+    $ export GOOGLE_PROJECT_ID=123123123123
+    $ export GOOGLE_APPLICATION_CREDENTIALS=$HOME/.config/gs-secret-restic-key.json
+
+Then you can use the ``gs:`` backend type to create a new repository in the
+bucket `foo` at the root path:
+
+.. code-block:: console
+
+    $ restic -r gs:foo:/ init
+    enter password for new backend:
+    enter password again:
+
+    created restic backend bde47d6254 at gs:foo2/
+    [...]
+
+The number of concurrent connections to the GCS service can be set with the
+`-o gs.connections=10`. By default, at most five parallel connections are
+established.
+
+.. _service account: https://cloud.google.com/storage/docs/authentication#service_accounts
+.. _create a service account key: https://cloud.google.com/storage/docs/authentication#generating-a-private-key
+
+Password prompt on Windows
+**************************
+
+At the moment, restic only supports the default Windows console
+interaction. If you use emulation environments like
+`MSYS2 <https://msys2.github.io/>`__ or
+`Cygwin <https://www.cygwin.com/>`__, which use terminals like
+``Mintty`` or ``rxvt``, you may get a password error:
+
+You can workaround this by using a special tool called ``winpty`` (look
+`here <https://sourceforge.net/p/msys2/wiki/Porting/>`__ and
+`here <https://github.com/rprichard/winpty>`__ for detail information).
+On MSYS2, you can install ``winpty`` as follows:
+
+.. code-block:: console
+
+    $ pacman -S winpty
+    $ winpty restic -r /tmp/backup init
+

doc/040_backup.rst

@@ -0,0 +1,180 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+##########
+Backing up
+##########
+
+Now we're ready to backup some data. The contents of a directory at a
+specific point in time is called a "snapshot" in restic. Run the
+following command and enter the repository password you chose above
+again:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup ~/work
+    enter password for repository:
+    scan [/home/user/work]
+    scanned 764 directories, 1816 files in 0:00
+    [0:29] 100.00%  54.732 MiB/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
+    duration: 0:29, 54.47MiB/s
+    snapshot 40dc1520 saved
+
+As you can see, restic created a backup of the directory and was pretty
+fast! The specific snapshot just created is identified by a sequence of
+hexadecimal characters, ``40dc1520`` in this case.
+
+If you run the command again, restic will create another snapshot of
+your data, but this time it's even faster. This is de-duplication at
+work!
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup ~/work
+    enter password for repository:
+    using parent snapshot 40dc1520aa6a07b7b3ae561786770a01951245d2367241e71e9485f18ae8228c
+    scan [/home/user/work]
+    scanned 764 directories, 1816 files in 0:00
+    [0:00] 100.00%  0B/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
+    duration: 0:00, 6572.38MiB/s
+    snapshot 79766175 saved
+
+You can even backup individual files in the same repository.
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup ~/work.txt
+    scan [/home/user/work.txt]
+    scanned 0 directories, 1 files in 0:00
+    [0:00] 100.00%  0B/s  220B / 220B  1 / 1 items  0 errors  ETA 0:00
+    duration: 0:00, 0.03MiB/s
+    snapshot 31f7bd63 saved
+
+In fact several hosts may use the same repository to backup directories
+and files leading to a greater de-duplication.
+
+Please be aware that when you backup different directories (or the
+directories to be saved have a variable name component like a
+time/date), restic always needs to read all files and only afterwards
+can compute which parts of the files need to be saved. When you backup
+the same directory again (maybe with new or changed files) restic will
+find the old snapshot in the repo and by default only reads those files
+that are new or have been modified since the last snapshot. This is
+decided based on the modify date of the file in the file system.
+
+Now is a good time to run ``restic check`` to verify that all data
+is properly stored in the repository. You should run this command regularly
+to make sure the internal structure of the repository is free of errors.
+
+You can exclude folders and files by specifying exclude-patterns. Either
+specify them with multiple ``--exclude``'s or one ``--exclude-file``
+
+.. code-block:: console
+
+    $ cat exclude
+    # exclude go-files
+    *.go
+    # exclude foo/x/y/z/bar foo/x/bar foo/bar
+    foo/**/bar
+    $ restic -r /tmp/backup backup ~/work --exclude=*.c --exclude-file=exclude
+
+Patterns use `filepath.Glob <https://golang.org/pkg/path/filepath/#Glob>`__ internally,
+see `filepath.Match <https://golang.org/pkg/path/filepath/#Match>`__ for syntax.
+Additionally ``**`` excludes arbitrary subdirectories.
+Environment-variables in exclude-files are expanded with
+`os.ExpandEnv <https://golang.org/pkg/os/#ExpandEnv>`__.
+
+By specifying the option ``--one-file-system`` you can instruct restic
+to only backup files from the file systems the initially specified files
+or directories reside on. For example, calling restic like this won't
+backup ``/sys`` or ``/dev`` on a Linux system:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup --one-file-system /
+
+By using the ``--files-from`` option you can read the files you want to
+backup from a file. This is especially useful if a lot of files have to
+be backed up that are not in the same folder or are maybe pre-filtered
+by other software.
+
+or example maybe you want to backup files that have a certain filename
+in them:
+
+.. code-block:: console
+
+    $ find /tmp/somefiles | grep 'PATTERN' > /tmp/files_to_backup
+
+You can then use restic to backup the filtered files:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup --files-from /tmp/files_to_backup
+
+Incidentally you can also combine ``--files-from`` with the normal files
+args:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup --files-from /tmp/files_to_backup /tmp/some_additional_file
+
+Backing up special items
+************************
+
+**Symlinks** are archived as symlinks, ``restic`` does not follow them.
+When you restore, you get the same symlink again, with the same link target
+and the same timestamps.
+
+If there is a **bind-mount** below a directory that is to be saved, restic descends into it.
+
+**Device files** are saved and restored as device files. This means that e.g. ``/dev/sda`` is
+archived as a block device file and restored as such. This also means that the content of the
+corresponding disk is not read, at least not from the device file.
+
+
+Reading data from stdin
+***********************
+
+Sometimes it can be nice to directly save the output of a program, e.g.
+``mysqldump`` so that the SQL can later be restored. Restic supports
+this mode of operation, just supply the option ``--stdin`` to the
+``backup`` command like this:
+
+.. code-block:: console
+
+    $ mysqldump [...] | restic -r /tmp/backup backup --stdin
+
+This creates a new snapshot of the output of ``mysqldump``. You can then
+use e.g. the fuse mounting option (see below) to mount the repository
+and read the file.
+
+By default, the file name ``stdin`` is used, a different name can be
+specified with ``--stdin-filename``, e.g. like this:
+
+.. code-block:: console
+
+    $ mysqldump [...] | restic -r /tmp/backup backup --stdin --stdin-filename production.sql
+
+Tags for backup
+***************
+
+Snapshots can have one or more tags, short strings which add identifying
+information. Just specify the tags for a snapshot one by one with ``--tag``:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup backup --tag projectX --tag foo --tag bar ~/work
+    [...]
+
+The tags can later be used to keep (or forget) snapshots with the ``forget``
+command. The command ``tag`` can be used to modify tags on an existing
+snapshot.

doc/045_working_with_repos.rst

@@ -0,0 +1,89 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+
+#########################
+Working with repositories
+#########################
+
+Listing all snapshots
+=====================
+
+Now, you can list all the snapshots stored in the repository:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup snapshots
+    enter password for repository:
+    ID        Date                 Host    Tags   Directory
+    ----------------------------------------------------------------------
+    40dc1520  2015-05-08 21:38:30  kasimir        /home/user/work
+    79766175  2015-05-08 21:40:19  kasimir        /home/user/work
+    bdbd3439  2015-05-08 21:45:17  luigi          /home/art
+    590c8fc8  2015-05-08 21:47:38  kazik          /srv
+    9f0bc19e  2015-05-08 21:46:11  luigi          /srv
+
+You can filter the listing by directory path:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup snapshots --path="/srv"
+    enter password for repository:
+    ID        Date                 Host    Tags   Directory
+    ----------------------------------------------------------------------
+    590c8fc8  2015-05-08 21:47:38  kazik          /srv
+    9f0bc19e  2015-05-08 21:46:11  luigi          /srv
+
+Or filter by host:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup snapshots --host luigi
+    enter password for repository:
+    ID        Date                 Host    Tags   Directory
+    ----------------------------------------------------------------------
+    bdbd3439  2015-05-08 21:45:17  luigi          /home/art
+    9f0bc19e  2015-05-08 21:46:11  luigi          /srv
+
+Combining filters is also possible.
+
+
+Checking a repo's integrity and consistency
+===========================================
+
+Imagine your repository is saved on a server that has a faulty hard
+drive, or even worse, attackers get privileged access and modify your
+backup with the intention to make you restore malicious data:
+
+.. code-block:: console
+
+    $ sudo echo "boom" >> backup/index/d795ffa99a8ab8f8e42cec1f814df4e48b8f49129360fb57613df93739faee97
+
+In order to detect these things, it is a good idea to regularly use the
+``check`` command to test whether everything is alright, your precious
+backup data is consistent and the integrity is unharmed:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup check
+    Load indexes
+    ciphertext verification failed
+
+Trying to restore a snapshot which has been modified as shown above will
+yield the same error:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup restore 79766175 --target /tmp/restore-work
+    Load indexes
+    ciphertext verification failed
+

doc/050_restore.rst

@@ -0,0 +1,82 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+#####################
+Restoring from backup
+#####################
+
+Restoring from a snapshot
+=========================
+
+Restoring a snapshot is as easy as it sounds, just use the following
+command to restore the contents of the latest snapshot to
+``/tmp/restore-work``:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup restore 79766175 --target /tmp/restore-work
+    enter password for repository:
+    restoring <Snapshot of [/home/user/work] at 2015-05-08 21:40:19.884408621 +0200 CEST> to /tmp/restore-work
+
+Use the word ``latest`` to restore the last backup. You can also combine
+``latest`` with the ``--host`` and ``--path`` filters to choose the last
+backup for a specific host, path or both.
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup restore latest --target /tmp/restore-art --path "/home/art" --host luigi
+    enter password for repository:
+    restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-art
+
+Use ``--exclude`` and ``--include`` to restrict the restore to a subset of
+files in the snapshot. For example, to restore a single file:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup restore 79766175 --target /tmp/restore-work --include /work/foo
+    enter password for repository:
+    restoring <Snapshot of [/home/user/work] at 2015-05-08 21:40:19.884408621 +0200 CEST> to /tmp/restore-work
+
+This will restore the file ``foo`` to ``/tmp/restore-work/work/foo``.
+
+Restore using mount
+===================
+
+Browsing your backup as a regular file system is also very easy. First,
+create a mount point such as ``/mnt/restic`` and then use the following
+command to serve the repository with FUSE:
+
+.. code-block:: console
+
+    $ mkdir /mnt/restic
+    $ restic -r /tmp/backup mount /mnt/restic
+    enter password for repository:
+    Now serving /tmp/backup at /mnt/restic
+    Don't forget to umount after quitting!
+
+Mounting repositories via FUSE is not possible on Windows and OpenBSD.
+
+Restic supports storage and preservation of hard links. However, since
+hard links exist in the scope of a filesystem by definition, restoring
+hard links from a fuse mount should be done by a program that preserves
+hard links. A program that does so is ``rsync``, used with the option
+--hard-links.
+
+Printing files to stdout
+========================
+
+Sometimes it's helpful to print files to stdout so that other programs can read
+the data directly. This can be achieved by using the `dump` command, like this:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup dump latest production.sql | mysql

doc/060_forget.rst

@@ -0,0 +1,208 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+#########################
+Removing backup snapshots
+#########################
+
+All backup space is finite, so restic allows removing old snapshots.
+This can be done either manually (by specifying a snapshot ID to remove)
+or by using a policy that describes which snapshots to forget. For all
+remove operations, two commands need to be called in sequence:
+``forget`` to remove a snapshot and ``prune`` to actually remove the
+data that was referenced by the snapshot from the repository. This can
+be automated with the ``--prune`` option of the ``forget`` command,
+which runs ``prune`` automatically if snapshots have been removed.
+
+It is advisable to run ``restic check`` after pruning, to make sure
+you are alerted, should the internal data structures of the repository
+be damaged.
+
+Remove a single snapshot
+************************
+
+The command ``snapshots`` can be used to list all snapshots in a
+repository like this:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup snapshots
+    enter password for repository:
+    ID        Date                 Host      Tags  Directory
+    ----------------------------------------------------------------------
+    40dc1520  2015-05-08 21:38:30  kasimir         /home/user/work
+    79766175  2015-05-08 21:40:19  kasimir         /home/user/work
+    bdbd3439  2015-05-08 21:45:17  luigi           /home/art
+    590c8fc8  2015-05-08 21:47:38  kazik           /srv
+    9f0bc19e  2015-05-08 21:46:11  luigi           /srv
+
+In order to remove the snapshot of ``/home/art``, use the ``forget``
+command and specify the snapshot ID on the command line:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup forget bdbd3439
+    enter password for repository:
+    removed snapshot d3f01f63
+
+Afterwards this snapshot is removed:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup snapshots
+    enter password for repository:
+    ID        Date                 Host     Tags  Directory
+    ----------------------------------------------------------------------
+    40dc1520  2015-05-08 21:38:30  kasimir        /home/user/work
+    79766175  2015-05-08 21:40:19  kasimir        /home/user/work
+    590c8fc8  2015-05-08 21:47:38  kazik          /srv
+    9f0bc19e  2015-05-08 21:46:11  luigi          /srv
+
+But the data that was referenced by files in this snapshot is still
+stored in the repository. To cleanup unreferenced data, the ``prune``
+command must be run:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup prune
+    enter password for repository:
+
+    counting files in repo
+    building new index for repo
+    [0:00] 100.00%  22 / 22 files
+    repository contains 22 packs (8512 blobs) with 100.092 MiB bytes
+    processed 8512 blobs: 0 duplicate blobs, 0B duplicate
+    load all snapshots
+    find data that is still in use for 1 snapshots
+    [0:00] 100.00%  1 / 1 snapshots
+    found 8433 of 8512 data blobs still in use
+    will rewrite 3 packs
+    creating new index
+    [0:00] 86.36%  19 / 22 files
+    saved new index as 544a5084
+    done
+
+Afterwards the repository is smaller.
+
+You can automate this two-step process by using the ``--prune`` switch
+to ``forget``:
+
+.. code-block:: console
+
+    $ restic forget --keep-last 1 --prune
+    snapshots for host mopped, directories /home/user/work:
+
+    keep 1 snapshots:
+    ID        Date                 Host        Tags        Directory
+    ----------------------------------------------------------------------
+    4bba301e  2017-02-21 10:49:18  mopped                  /home/user/work
+
+    remove 1 snapshots:
+    ID        Date                 Host        Tags        Directory
+    ----------------------------------------------------------------------
+    8c02b94b  2017-02-21 10:48:33  mopped                  /home/user/work
+
+    1 snapshots have been removed, running prune
+    counting files in repo
+    building new index for repo
+    [0:00] 100.00%  37 / 37 packs
+    repository contains 37 packs (5521 blobs) with 151.012 MiB bytes
+    processed 5521 blobs: 0 duplicate blobs, 0B duplicate
+    load all snapshots
+    find data that is still in use for 1 snapshots
+    [0:00] 100.00%  1 / 1 snapshots
+    found 5323 of 5521 data blobs still in use, removing 198 blobs
+    will delete 0 packs and rewrite 27 packs, this frees 22.106 MiB
+    creating new index
+    [0:00] 100.00%  30 / 30 packs
+    saved new index as b49f3e68
+    done
+
+Removing snapshots according to a policy
+****************************************
+
+Removing snapshots manually is tedious and error-prone, therefore restic
+allows specifying which snapshots should be removed automatically
+according to a policy. You can specify how many hourly, daily, weekly,
+monthly and yearly snapshots to keep, any other snapshots are removed.
+The most important command-line parameter here is ``--dry-run`` which
+instructs restic to not remove anything but print which snapshots would
+be removed.
+
+When ``forget`` is run with a policy, restic loads the list of all
+snapshots, then groups these by host name and list of directories. The grouping
+options can be set with ``--group-by``, to only group snapshots by paths and
+tags use ``--group-by paths,tags``. The policy is then applied to each group of
+snapshots separately. This is a safety feature.
+
+The ``forget`` command accepts the following parameters:
+-  ``--keep-last n`` never delete the ``n`` last (most recent) snapshots
+-  ``--keep-hourly n`` for the last ``n`` hours in which a snapshot was
+made, keep only the last snapshot for each hour.
+-  ``--keep-daily n`` for the last ``n`` days which have one or more
+snapshots, only keep the last one for that day.
+-  ``--keep-weekly n`` for the last ``n`` weeks which have one or more
+snapshots, only keep the last one for that week.
+-  ``--keep-monthly n`` for the last ``n`` months which have one or more
+snapshots, only keep the last one for that month.
+-  ``--keep-yearly n`` for the last ``n`` years which have one or more
+snapshots, only keep the last one for that year.
+-  ``--keep-tag`` keep all snapshots which have all tags specified by
+this option (can be specified multiple times).
+
+Additionally, you can restrict removing snapshots to those which have a
+particular hostname with the ``--hostname`` parameter, or tags with the
+``--tag`` option. When multiple tags are specified, only the snapshots
+which have all the tags are considered. For example, the following command
+removes all but the latest snapshot of all snapshots that have the tag ``foo``:
+
+.. code-block:: console
+
+   $ restic forget --tag foo --keep-last 1
+
+This command removes all but the last snapshot of all snapshots that have
+either the ``foo`` or ``bar`` tag set:
+
+.. code-block:: console
+
+   $ restic forget --tag foo --tag bar --keep-last 1
+
+To only keep the last snapshot of all snapshots with both the tag ``foo`` and
+``bar`` set use:
+
+.. code-block:: console
+
+   $ restic forget --tag foo,tag bar --keep-last 1
+
+All the ``--keep-*`` options above only count
+hours/days/weeks/months/years which have a snapshot, so those without a
+snapshot are ignored.
+
+All snapshots are evaluated counted against all matching keep-* counts. A
+single snapshot on 2017-09-30 (Sun) will count as a daily, weekly and monthly.
+
+Let's explain this with an example: Suppose you have only made a backup
+on each Sunday for 12 weeks. Then ``forget --keep-daily 4`` will keep
+the last four snapshots for the last four Sundays, but remove the rest.
+Only counting the days which have a backup and ignore the ones without
+is a safety feature: it prevents restic from removing many snapshots
+when no new ones are created. If it was implemented otherwise, running
+``forget --keep-daily 4`` on a Friday would remove all snapshots!
+
+Another example: Suppose you make daily backups for 100 years. Then
+``forget --keep-daily 7 --keep-weekly 5 --keep-monthly 12 --keep-yearly 75``
+will keep the most recent 7 daily snapshots, then 4 (remember, 7 dailies
+already include a week!) last-day-of-the-weeks and 11 or 12
+last-day-of-the-months (11 or 12 depends if the 5 weeklies cross a month).
+And finally 75 last-day-of-the-year snapshots. All other snapshots are
+removed.
+

doc/070_encryption.rst

@@ -0,0 +1,51 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+##########
+Encryption
+##########
+
+
+*"The design might not be perfect, but it’s good. Encryption is a first-class feature,
+the implementation looks sane and I guess the deduplication trade-off is worth it. So… I’m going to use restic for 
+my personal backups.*" `Filippo Valsorda`_
+
+.. _Filippo Valsorda: https://blog.filippo.io/restic-cryptography/
+
+**********************
+Manage repository keys
+**********************
+
+The ``key`` command allows you to set multiple access keys or passwords
+per repository. In fact, you can use the ``list``, ``add``, ``remove``
+and ``passwd`` sub-commands to manage these keys very precisely:
+
+.. code-block:: console
+
+    $ restic -r /tmp/backup key list
+    enter password for repository:
+     ID          User        Host        Created
+    ----------------------------------------------------------------------
+    *eb78040b    username    kasimir   2015-08-12 13:29:57
+
+    $ restic -r /tmp/backup key add
+    enter password for repository:
+    enter password for new key:
+    enter password again:
+    saved new key as <Key of username@kasimir, created on 2015-08-12 13:35:05.316831933 +0200 CEST>
+
+    $ restic -r backup key list
+    enter password for repository:
+     ID          User        Host        Created
+    ----------------------------------------------------------------------
+     5c657874    username    kasimir   2015-08-12 13:35:05
+    *eb78040b    username    kasimir   2015-08-12 13:29:57

doc/080_examples.rst

@@ -0,0 +1,272 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+########
+Examples
+########
+
+********************************
+Setting up restic with Amazon S3
+********************************
+
+Preface
+=======
+
+This tutorial will show you how to use restic with AWS S3. It will show you how
+to navigate the AWS web interface, create an S3 bucket, create a user with
+access to only this bucket, and finally how to connect restic to this bucket.
+
+Prerequisites
+=============
+
+You should already have a ``restic`` binary available on your system that you can
+run. Furthermore, you should also have an account with
+`AWS <https://aws.amazon.com/>`__. You will likely need to provide credit card
+details for billing purposes, even if you use their
+`free-tier <https://aws.amazon.com/free/>`__.
+
+
+Logging into AWS
+================
+
+Point your browser to
+https://console.aws.amazon.com
+and log in using your AWS account. You will be presented with the AWS homepage:
+
+.. image:: images/aws_s3/01_aws_start.png
+   :alt: AWS Homepage
+
+By using the "Services" button in the upper left corder, a menu of all services
+provided by AWS can be opened:
+
+.. image:: images/aws_s3/02_aws_menu.png
+   :alt: AWS Services Menu
+
+For this tutorial, the Simple Storage Service (S3), as well as Identity and
+Access Management (IAM) are relevant.
+
+
+Creating the bucket
+===================
+
+First, a bucket to store your backups in must be created. Using the "Services"
+menu, navigate to S3. In case you already have some S3 buckets, you will see a
+list of them here:
+
+.. image:: images/aws_s3/03_buckets_list_before.png
+   :alt: List of S3 Buckets
+
+Click the "Create bucket" button and choose a name and region for your new
+bucket. For the purpose of this tutorial, the bucket will be named
+``restic-demo`` and reside in Frankfurt. Because the bucket name space is
+shared among all AWS users, the name ``restic-demo`` may not be available to
+you. Be creative and choose a unique bucket name.
+
+.. image:: images/aws_s3/04_bucket_create_start.png
+   :alt: Create a Bucket
+
+It is not necessary to configure any special properties or permissions of the
+bucket just yet. Therefore, just finish the wizard without making any further
+changes:
+
+.. image:: images/aws_s3/05_bucket_create_review.png
+   :alt: Review Bucket Creation
+
+The newly created ``restic-demo`` bucket will now appear on the list of S3
+buckets:
+
+.. image:: images/aws_s3/06_buckets_list_after.png
+   :alt: List With New Bucket
+
+Creating a user
+===============
+
+Use the "Services" menu of the AWS web interface to navigate to IAM. This will
+bring you to the IAM homepage. To create a new user, click on the "Users" menu
+entry on the left:
+
+.. image:: images/aws_s3/07_iam_start.png
+   :alt: IAM Home Page
+
+In case you already have set-up users with IAM before, you will see a list of
+them here. Use the "Add user" button at the top to create a new user:
+
+.. image:: images/aws_s3/08_user_list.png
+   :alt: IAM User List
+
+For this tutorial, the new user will be named ``restic-demo-user``. Feel free to
+choose your own name that best fits your needs. This user will only ever access
+AWS through the ``restic`` program and not through the web interface. Therefore,
+"Programmatic access" is selected for "Access type":
+
+.. image:: images/aws_s3/09_user_name.png
+   :alt: Choose User Name and Access Type
+
+During the next step, permissions can be assigned to the new user. To use this
+user with restic, it only needs access to the ``restic-demo`` bucket. Select
+"Attach existing policies directly", which will bring up a list of pre-defined
+policies below. Afterwards, click the "Create policy" button to create a custom
+policy:
+
+.. image:: images/aws_s3/10_user_pre_policy.png
+   :alt: Assign a Policy
+
+A new browser window or tab will open with the policy wizard. In Amazon IAM,
+policies are defined as JSON documents. For this tutorial, the "Policy
+Generator" will be used to generate a policy file using a web interface:
+
+.. image:: images/aws_s3/11_policy_start.png
+   :alt: Create a New Policy
+
+After invoking the policy generator, you will be presented with a user
+interface to generate individual permission statements. For restic to work, two
+such statements must be created. The first statement is set up as follows:
+
+.. code::
+
+   Effect: Allow
+   Service: Amazon S3
+   Actions: DeleteObject, GetObject, PutObject
+   Resource: arn:aws:s3:::restic-demo/*
+
+This statement allows restic to create, read and delete objects inside the S3
+bucket named ``restic-demo``. Adjust the bucket's name to the name of the bucket
+you created earlier. Using the "Add Statement" button, this statement can be
+saved. Now a second statement is created:
+
+.. code::
+
+   Effect: Allow
+   Service: Amazon S3
+   Actions: ListBucket
+   Resource: arn:aws:s3:::restic-demo
+
+Again, substitute ``restic-demo`` with the actual name of your bucket. Note that,
+unlike before, there is no ``/*`` after the bucket name. This statement allows
+restic to list the objects stored in the ``restic-demo`` bucket. Again, use "Add
+Statement" to save this statement. The policy creator interface should now
+look as follows:
+
+.. image:: images/aws_s3/12_policy_permissions_done.png
+   :alt: Policy Creator With Two Statements
+
+Continue to the next step and enter a name and description for this policy. For
+this tutorial, the policy will be named ``restic-demo-policy``. In this step you
+can also examine the JSON document created by the policy generator. Click
+"Create Policy" to finish the process:
+
+.. image:: images/aws_s3/13_policy_review.png
+   :alt: Policy Review
+
+Go back to the browser window or tab where you were previously creating the new
+user. Click the button labeled "Refresh" above the list of policies to make
+sure the newly created policy is available to you. Afterwards, use the search
+function to search for the ``restic-demo-policy``. Select this policy using the
+checkbox on the left. Then, continue to the next step.
+
+.. image:: images/aws_s3/14_user_attach_policy.png
+   :alt: Attach Policy to User
+
+The next page will present an overview of the user account that is about to be
+created. If everything looks good, click "Create user" to complete the process:
+
+.. image:: images/aws_s3/15_user_review.png
+   :alt: User Creation Review
+
+After the user has been created, its access credentials will be displayed. They
+consist of the "Access key ID" (think user name), and the "Secret access key"
+(think password). Copy these down to a safe place.
+
+.. image:: images/aws_s3/16_user_created.png
+   :alt: User Credentials
+
+You have now completed the configuration in AWS. Feel free to close your web
+browser now.
+
+
+Initializing the restic repository
+==================================
+
+Open a terminal and make sure you have the ``restic`` binary ready. First, choose
+a password to encrypt your backups with. In this tutorial, ``apg`` is used for
+this purpose:
+
+.. code-block:: console
+
+   $ apg -a 1 -m 32 -n 1 -M NCL
+   I9n7G7G0ZpDWA3GOcJbIuwQCGvGUBkU5
+
+Note this password somewhere safe along with your AWS credentials. Next, the
+configuration of restic will be placed into environment variables. This will
+include sensitive information, such as your AWS secret and repository password.
+Therefore, make sure the next commands **do not** end up in your shell's
+history file. Adjust the contents of the environment variables to fit your
+bucket's name and your user's API credentials.
+
+.. code-block:: console
+
+   $ unset HISTFILE
+   $ export RESTIC_REPOSITORY="s3:https://s3.amazonaws.com/restic-demo"
+   $ export AWS_ACCESS_KEY_ID="AKIAJAJSLTZCAZ4SRI5Q"
+   $ export AWS_SECRET_ACCESS_KEY="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"
+   $ export RESTIC_PASSWORD="I9n7G7G0ZpDWA3GOcJbIuwQCGvGUBkU5"
+
+
+After the environment is set up, restic may be called to initialize the
+repository:
+
+
+.. code-block:: console
+
+   $ ./restic init
+   created restic backend b5c661a86a at s3:https://s3.amazonaws.com/restic-demo
+
+   Please note that knowledge of your password is required to access
+   the repository. Losing your password means that your data is
+   irrecoverably lost.
+
+restic is now ready to be used with AWS S3. Try to create a backup:
+
+.. code-block:: console
+
+   $ dd if=/dev/urandom bs=1M count=10 of=test.bin
+   10+0 records in
+   10+0 records out
+   10485760 bytes (10 MB, 10 MiB) copied, 0,0891322 s, 118 MB/s
+
+   $ ./restic backup test.bin
+   scan [/home/philip/restic-demo/test.bin]
+   scanned 0 directories, 1 files in 0:00
+   [0:04] 100.00%  2.500 MiB/s  10.000 MiB / 10.000 MiB  1 / 1 items ... ETA 0:00 
+   duration: 0:04, 2.47MiB/s
+   snapshot 10fdbace saved
+
+   $ ./restic snapshots
+   ID        Date                 Host        Tags        Directory
+   ----------------------------------------------------------------------
+   10fdbace  2017-03-26 16:41:50  blackbox                /home/philip/restic-demo/test.bin
+
+A snapshot was created and stored in the S3 bucket. This snapshot may now be
+restored:
+
+.. code-block:: console
+
+   $ mkdir restore
+
+   $ ./restic restore 10fdbace --target restore
+   restoring <Snapshot 10fdbace of [/home/philip/restic-demo/test.bin] at 2017-03-26 16:41:50.201418102 +0200 CEST by philip@blackbox> to restore
+
+   $ ls restore/
+   test.bin
+
+The snapshot was successfully restored. This concludes the tutorial.
+

doc/090_participating.rst

@@ -0,0 +1,140 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+#############
+Participating
+#############
+
+*********
+Debugging
+*********
+
+The program can be built with debug support like this:
+
+.. code-block:: console
+
+    $ go run build.go -tags debug
+
+Afterwards, extensive debug messages are written to the file in
+environment variable ``DEBUG_LOG``, e.g.:
+
+.. code-block:: console
+
+    $ DEBUG_LOG=/tmp/restic-debug.log restic backup ~/work
+
+If you suspect that there is a bug, you can have a look at the debug
+log. Please be aware that the debug log might contain sensitive
+information such as file and directory names.
+
+The debug log will always contain all log messages restic generates. You
+can also instruct restic to print some or all debug messages to stderr.
+These can also be limited to e.g. a list of source files or a list of
+patterns for function names. The patterns are globbing patterns (see the
+documentation for `path.Glob <https://golang.org/pkg/path/#Glob>`__), multiple
+patterns are separated by commas. Patterns are case sensitive.
+
+Printing all log messages to the console can be achieved by setting the
+file filter to ``*``:
+
+.. code-block:: console
+
+    $ DEBUG_FILES=* restic check
+
+If you want restic to just print all debug log messages from the files
+``main.go`` and ``lock.go``, set the environment variable
+``DEBUG_FILES`` like this:
+
+.. code-block:: console
+
+    $ DEBUG_FILES=main.go,lock.go restic check
+
+The following command line instructs restic to only print debug
+statements originating in functions that match the pattern ``*unlock*``
+(case sensitive):
+
+.. code-block:: console
+
+    $ DEBUG_FUNCS=*unlock* restic check
+
+
+************
+Contributing
+************
+
+Contributions are welcome! Please **open an issue first** (or add a
+comment to an existing issue) if you plan to work on any code or add a
+new feature. This way, duplicate work is prevented and we can discuss
+your ideas and design first.
+
+More information and a description of the development environment can be
+found in `CONTRIBUTING.md <https://github.com/restic/restic/blob/master/CONTRIBUTING.md>`__.
+A document describing the design of restic and the data structures stored on the
+back end is contained in `Design <https://restic.readthedocs.io/en/latest/design.html>`__.
+
+If you'd like to start contributing to restic, but don't know exactly
+what do to, have a look at this great article by Dave Cheney:
+`Suggestions for contributing to an Open Source
+project <http://dave.cheney.net/2016/03/12/suggestions-for-contributing-to-an-open-source-project>`__
+A few issues have been tagged with the label ``help wanted``, you can
+start looking at those:
+https://github.com/restic/restic/labels/help%20wanted
+
+********
+Security
+********
+
+**Important**: If you discover something that you believe to be a
+possible critical security problem, please do *not* open a GitHub issue
+but send an email directly to alexander@bumpern.de. If possible, please
+encrypt your email using the following PGP key
+(`0x91A6868BD3F7A907 <https://pgp.mit.edu/pks/lookup?op=get&search=0xCF8F18F2844575973F79D4E191A6868BD3F7A907>`__):
+
+::
+
+    pub   4096R/91A6868BD3F7A907 2014-11-01
+          Key fingerprint = CF8F 18F2 8445 7597 3F79  D4E1 91A6 868B D3F7 A907
+          uid                          Alexander Neumann <alexander@bumpern.de>
+          sub   4096R/D5FC2ACF4043FDF1 2014-11-01
+
+*************
+Compatibility
+*************
+
+Backward compatibility for backups is important so that our users are
+always able to restore saved data. Therefore restic follows `Semantic
+Versioning <http://semver.org>`__ to clearly define which versions are
+compatible. The repository and data structures contained therein are
+considered the "Public API" in the sense of Semantic Versioning. This
+goes for all released versions of restic, this may not be the case for
+the master branch.
+
+We guarantee backward compatibility of all repositories within one major
+version; as long as we do not increment the major version, data can be
+read and restored. We strive to be fully backward compatible to all
+prior versions.
+
+**********************
+Building documentation
+**********************
+
+The restic documentation is built with `Sphinx <http://sphinx-doc.org>`__,
+therefore building it locally requires a recent Python version and requirements listed in ``doc/requirements.txt``.
+This example will guide you through the process using `virtualenv <https://virtualenv.pypa.io>`__:
+
+::
+
+  $ virtualenv venv # create virtual python environment
+  $ source venv/bin/activate # activate the virtual environment
+  $ cd doc
+  $ pip install -r requirements.txt # install dependencies
+  $ make html # build html documentation
+  $ # open _build/html/index.html with your favorite browser

doc/100_references.rst

@@ -0,0 +1,763 @@
+..
+  Normally, there are no heading levels assigned to certain characters as the structure is
+  determined from the succession of headings. However, this convention is used in Python’s
+  Style Guide for documenting which you may follow:
+
+  # with overline, for parts
+  * for chapters
+  = for sections
+  - for subsections
+  ^ for subsubsections
+  " for paragraphs
+
+##########
+References
+##########
+
+******
+Design
+******
+
+Terminology
+===========
+
+This section introduces terminology used in this document.
+
+*Repository*: All data produced during a backup is sent to and stored in
+a repository in a structured form, for example in a file system
+hierarchy with several subdirectories. A repository implementation must
+be able to fulfill a number of operations, e.g. list the contents.
+
+*Blob*: A Blob combines a number of data bytes with identifying
+information like the SHA-256 hash of the data and its length.
+
+*Pack*: A Pack combines one or more Blobs, e.g. in a single file.
+
+*Snapshot*: A Snapshot stands for the state of a file or directory that
+has been backed up at some point in time. The state here means the
+content and meta data like the name and modification time for the file
+or the directory and its contents.
+
+*Storage ID*: A storage ID is the SHA-256 hash of the content stored in
+the repository. This ID is required in order to load the file from the
+repository.
+
+Repository Format
+=================
+
+All data is stored in a restic repository. A repository is able to store
+data of several different types, which can later be requested based on
+an ID. This so-called "storage ID" is the SHA-256 hash of the content of
+a file. All files in a repository are only written once and never
+modified afterwards. This allows accessing and even writing to the
+repository with multiple clients in parallel. Only the delete operation
+removes data from the repository.
+
+Repositories consist of several directories and a top-level file called
+``config``. For all other files stored in the repository, the name for
+the file is the lower case hexadecimal representation of the storage ID,
+which is the SHA-256 hash of the file's contents. This allows for easy
+verification of files for accidental modifications, like disk read
+errors, by simply running the program ``sha256sum`` on the file and
+comparing its output to the file name. If the prefix of a filename is
+unique amongst all the other files in the same directory, the prefix may
+be used instead of the complete filename.
+
+Apart from the files stored within the ``keys`` directory, all files are
+encrypted with AES-256 in counter mode (CTR). The integrity of the
+encrypted data is secured by a Poly1305-AES message authentication code
+(sometimes also referred to as a "signature").
+
+In the first 16 bytes of each encrypted file the initialisation vector
+(IV) is stored. It is followed by the encrypted data and completed by
+the 16 byte MAC. The format is: ``IV || CIPHERTEXT || MAC``. The
+complete encryption overhead is 32 bytes. For each file, a new random IV
+is selected.
+
+The file ``config`` is encrypted this way and contains a JSON document
+like the following:
+
+.. code:: json
+
+    {
+      "version": 1,
+      "id": "5956a3f67a6230d4a92cefb29529f10196c7d92582ec305fd71ff6d331d6271b",
+      "chunker_polynomial": "25b468838dcb75"
+    }
+
+After decryption, restic first checks that the version field contains a
+version number that it understands, otherwise it aborts. At the moment,
+the version is expected to be 1. The field ``id`` holds a unique ID
+which consists of 32 random bytes, encoded in hexadecimal. This uniquely
+identifies the repository, regardless if it is accessed via SFTP or
+locally. The field ``chunker_polynomial`` contains a parameter that is
+used for splitting large files into smaller chunks (see below).
+
+Repository Layout
+-----------------
+
+The ``local`` and ``sftp`` backends are implemented using files and
+directories stored in a file system. The directory layout is the same
+for both backend types.
+
+The basic layout of a repository stored in a ``local`` or ``sftp``
+backend is shown here:
+
+::
+
+    /tmp/restic-repo
+    ├── config
+    ├── data
+    │   ├── 21
+    │   │   └── 2159dd48f8a24f33c307b750592773f8b71ff8d11452132a7b2e2a6a01611be1
+    │   ├── 32
+    │   │   └── 32ea976bc30771cebad8285cd99120ac8786f9ffd42141d452458089985043a5
+    │   ├── 59
+    │   │   └── 59fe4bcde59bd6222eba87795e35a90d82cd2f138a27b6835032b7b58173a426
+    │   ├── 73
+    │   │   └── 73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c
+    │   [...]
+    ├── index
+    │   ├── c38f5fb68307c6a3e3aa945d556e325dc38f5fb68307c6a3e3aa945d556e325d
+    │   └── ca171b1b7394d90d330b265d90f506f9984043b342525f019788f97e745c71fd
+    ├── keys
+    │   └── b02de829beeb3c01a63e6b25cbd421a98fef144f03b9a02e46eff9e2ca3f0bd7
+    ├── locks
+    ├── snapshots
+    │   └── 22a5af1bdc6e616f8a29579458c49627e01b32210d09adb288d1ecda7c5711ec
+    └── tmp
+
+A local repository can be initialized with the ``restic init`` command,
+e.g.:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo init
+
+The local and sftp backends will auto-detect and accept all layouts described
+in the following sections, so that remote repositories mounted locally e.g. via
+fuse can be accessed. The layout auto-detection can be overridden by specifying
+the option ``-o local.layout=default``, valid values are ``default`` and
+``s3legacy``. The option for the sftp backend is named ``sftp.layout``, for the
+s3 backend ``s3.layout``.
+
+S3 Legacy Layout
+----------------
+
+Unfortunately during development the AWS S3 backend uses slightly different
+paths (directory names use singular instead of plural for ``key``,
+``lock``, and ``snapshot`` files), and the data files are stored directly below
+the ``data`` directory. The S3 Legacy repository layout looks like this:
+
+::
+
+    /config
+    /data
+     ├── 2159dd48f8a24f33c307b750592773f8b71ff8d11452132a7b2e2a6a01611be1
+     ├── 32ea976bc30771cebad8285cd99120ac8786f9ffd42141d452458089985043a5
+     ├── 59fe4bcde59bd6222eba87795e35a90d82cd2f138a27b6835032b7b58173a426
+     ├── 73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c
+    [...]
+    /index
+     ├── c38f5fb68307c6a3e3aa945d556e325dc38f5fb68307c6a3e3aa945d556e325d
+     └── ca171b1b7394d90d330b265d90f506f9984043b342525f019788f97e745c71fd
+    /key
+     └── b02de829beeb3c01a63e6b25cbd421a98fef144f03b9a02e46eff9e2ca3f0bd7
+    /lock
+    /snapshot
+     └── 22a5af1bdc6e616f8a29579458c49627e01b32210d09adb288d1ecda7c5711ec
+
+The S3 backend understands and accepts both forms, new backends are
+always created with the default layout for compatibility reasons.
+
+Pack Format
+===========
+
+All files in the repository except Key and Pack files just contain raw
+data, stored as ``IV || Ciphertext || MAC``. Pack files may contain one
+or more Blobs of data.
+
+A Pack's structure is as follows:
+
+::
+
+    EncryptedBlob1 || ... || EncryptedBlobN || EncryptedHeader || Header_Length
+
+At the end of the Pack file is a header, which describes the content.
+The header is encrypted and authenticated. ``Header_Length`` is the
+length of the encrypted header encoded as a four byte integer in
+little-endian encoding. Placing the header at the end of a file allows
+writing the blobs in a continuous stream as soon as they are read during
+the backup phase. This reduces code complexity and avoids having to
+re-write a file once the pack is complete and the content and length of
+the header is known.
+
+All the blobs (``EncryptedBlob1``, ``EncryptedBlobN`` etc.) are
+authenticated and encrypted independently. This enables repository
+reorganisation without having to touch the encrypted Blobs. In addition
+it also allows efficient indexing, for only the header needs to be read
+in order to find out which Blobs are contained in the Pack. Since the
+header is authenticated, authenticity of the header can be checked
+without having to read the complete Pack.
+
+After decryption, a Pack's header consists of the following elements:
+
+::
+
+    Type_Blob1 || Length(EncryptedBlob1) || Hash(Plaintext_Blob1) ||
+    [...]
+    Type_BlobN || Length(EncryptedBlobN) || Hash(Plaintext_Blobn) ||
+
+This is enough to calculate the offsets for all the Blobs in the Pack.
+Length is the length of a Blob as a four byte integer in little-endian
+format. The type field is a one byte field and labels the content of a
+blob according to the following table:
+
++--------+-----------+
+| Type   | Meaning   |
++========+===========+
+| 0      | data      |
++--------+-----------+
+| 1      | tree      |
++--------+-----------+
+
+All other types are invalid, more types may be added in the future.
+
+For reconstructing the index or parsing a pack without an index, first
+the last four bytes must be read in order to find the length of the
+header. Afterwards, the header can be read and parsed, which yields all
+plaintext hashes, types, offsets and lengths of all included blobs.
+
+Indexing
+========
+
+Index files contain information about Data and Tree Blobs and the Packs
+they are contained in and store this information in the repository. When
+the local cached index is not accessible any more, the index files can
+be downloaded and used to reconstruct the index. The files are encrypted
+and authenticated like Data and Tree Blobs, so the outer structure is
+``IV || Ciphertext || MAC`` again. The plaintext consists of a JSON
+document like the following:
+
+.. code:: json
+
+    {
+      "supersedes": [
+        "ed54ae36197f4745ebc4b54d10e0f623eaaaedd03013eb7ae90df881b7781452"
+      ],
+      "packs": [
+        {
+          "id": "73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c",
+          "blobs": [
+            {
+              "id": "3ec79977ef0cf5de7b08cd12b874cd0f62bbaf7f07f3497a5b1bbcc8cb39b1ce",
+              "type": "data",
+              "offset": 0,
+              "length": 25
+            },{
+              "id": "9ccb846e60d90d4eb915848add7aa7ea1e4bbabfc60e573db9f7bfb2789afbae",
+              "type": "tree",
+              "offset": 38,
+              "length": 100
+            },
+            {
+              "id": "d3dc577b4ffd38cc4b32122cabf8655a0223ed22edfd93b353dc0c3f2b0fdf66",
+              "type": "data",
+              "offset": 150,
+              "length": 123
+            }
+          ]
+        }, [...]
+      ]
+    }
+
+This JSON document lists Packs and the blobs contained therein. In this
+example, the Pack ``73d04e61`` contains two data Blobs and one Tree
+blob, the plaintext hashes are listed afterwards.
+
+The field ``supersedes`` lists the storage IDs of index files that have
+been replaced with the current index file. This happens when index files
+are repacked, for example when old snapshots are removed and Packs are
+recombined.
+
+There may be an arbitrary number of index files, containing information
+on non-disjoint sets of Packs. The number of packs described in a single
+file is chosen so that the file size is kept below 8 MiB.
+
+Keys, Encryption and MAC
+========================
+
+All data stored by restic in the repository is encrypted with AES-256 in
+counter mode and authenticated using Poly1305-AES. For encrypting new
+data first 16 bytes are read from a cryptographically secure
+pseudorandom number generator as a random nonce. This is used both as
+the IV for counter mode and the nonce for Poly1305. This operation needs
+three keys: A 32 byte for AES-256 for encryption, a 16 byte AES key and
+a 16 byte key for Poly1305. For details see the original paper `The
+Poly1305-AES message-authentication
+code <http://cr.yp.to/mac/poly1305-20050329.pdf>`__ by Dan Bernstein.
+The data is then encrypted with AES-256 and afterwards a message
+authentication code (MAC) is computed over the ciphertext, everything is
+then stored as IV \|\| CIPHERTEXT \|\| MAC.
+
+The directory ``keys`` contains key files. These are simple JSON
+documents which contain all data that is needed to derive the
+repository's master encryption and message authentication keys from a
+user's password. The JSON document from the repository can be
+pretty-printed for example by using the Python module ``json``
+(shortened to increase readability):
+
+::
+
+    $ python -mjson.tool /tmp/restic-repo/keys/b02de82*
+    {
+        "hostname": "kasimir",
+        "username": "fd0"
+        "kdf": "scrypt",
+        "N": 65536,
+        "r": 8,
+        "p": 1,
+        "created": "2015-01-02T18:10:13.48307196+01:00",
+        "data": "tGwYeKoM0C4j4/9DFrVEmMGAldvEn/+iKC3te/QE/6ox/V4qz58FUOgMa0Bb1cIJ6asrypCx/Ti/pRXCPHLDkIJbNYd2ybC+fLhFIJVLCvkMS+trdywsUkglUbTbi+7+Ldsul5jpAj9vTZ25ajDc+4FKtWEcCWL5ICAOoTAxnPgT+Lh8ByGQBH6KbdWabqamLzTRWxePFoYuxa7yXgmj9A==",
+        "salt": "uW4fEI1+IOzj7ED9mVor+yTSJFd68DGlGOeLgJELYsTU5ikhG/83/+jGd4KKAaQdSrsfzrdOhAMftTSih5Ux6w==",
+    }
+
+When the repository is opened by restic, the user is prompted for the
+repository password. This is then used with ``scrypt``, a key derivation
+function (KDF), and the supplied parameters (``N``, ``r``, ``p`` and
+``salt``) to derive 64 key bytes. The first 32 bytes are used as the
+encryption key (for AES-256) and the last 32 bytes are used as the
+message authentication key (for Poly1305-AES). These last 32 bytes are
+divided into a 16 byte AES key ``k`` followed by 16 bytes of secret key
+``r``. The key ``r`` is then masked for use with Poly1305 (see the paper
+for details).
+
+Those keys are used to authenticate and decrypt the bytes contained in
+the JSON field ``data`` with AES-256 and Poly1305-AES as if they were
+any other blob (after removing the Base64 encoding). If the
+password is incorrect or the key file has been tampered with, the
+computed MAC will not match the last 16 bytes of the data, and restic
+exits with an error. Otherwise, the data yields a JSON document
+which contains the master encryption and message authentication keys for
+this repository (encoded in Base64). The command
+``restic cat masterkey`` can be used as follows to decrypt and
+pretty-print the master key:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat masterkey
+    {
+        "mac": {
+          "k": "evFWd9wWlndL9jc501268g==",
+          "r": "E9eEDnSJZgqwTOkDtOp+Dw=="
+        },
+        "encrypt": "UQCqa0lKZ94PygPxMRqkePTZnHRYh1k1pX2k2lM2v3Q=",
+    }
+
+All data in the repository is encrypted and authenticated with these
+master keys. For encryption, the AES-256 algorithm in Counter mode is
+used. For message authentication, Poly1305-AES is used as described
+above.
+
+A repository can have several different passwords, with a key file for
+each. This way, the password can be changed without having to re-encrypt
+all data.
+
+Snapshots
+=========
+
+A snapshot represents a directory with all files and sub-directories at
+a given point in time. For each backup that is made, a new snapshot is
+created. A snapshot is a JSON document that is stored in an encrypted
+file below the directory ``snapshots`` in the repository. The filename
+is the storage ID. This string is unique and used within restic to
+uniquely identify a snapshot.
+
+The command ``restic cat snapshot`` can be used as follows to decrypt
+and pretty-print the contents of a snapshot file:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat snapshot 251c2e58
+    enter password for repository:
+    {
+      "time": "2015-01-02T18:10:50.895208559+01:00",
+      "tree": "2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf",
+      "dir": "/tmp/testdata",
+      "hostname": "kasimir",
+      "username": "fd0",
+      "uid": 1000,
+      "gid": 100,
+      "tags": [
+        "NL"
+      ]
+    }
+
+Here it can be seen that this snapshot represents the contents of the
+directory ``/tmp/testdata``. The most important field is ``tree``. When
+the meta data (e.g. the tags) of a snapshot change, the snapshot needs
+to be re-encrypted and saved. This will change the storage ID, so in
+order to relate these seemingly different snapshots, a field
+``original`` is introduced which contains the ID of the original
+snapshot, e.g. after adding the tag ``DE`` to the snapshot above it
+becomes:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat snapshot 22a5af1b
+    enter password for repository:
+    {
+      "time": "2015-01-02T18:10:50.895208559+01:00",
+      "tree": "2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf",
+      "dir": "/tmp/testdata",
+      "hostname": "kasimir",
+      "username": "fd0",
+      "uid": 1000,
+      "gid": 100,
+      "tags": [
+        "NL",
+        "DE"
+      ],
+      "original": "251c2e5841355f743f9d4ffd3260bee765acee40a6229857e32b60446991b837"
+    }
+
+Once introduced, the ``original`` field is not modified when the
+snapshot's meta data is changed again.
+
+All content within a restic repository is referenced according to its
+SHA-256 hash. Before saving, each file is split into variable sized
+Blobs of data. The SHA-256 hashes of all Blobs are saved in an ordered
+list which then represents the content of the file.
+
+In order to relate these plaintext hashes to the actual location within
+a Pack file , an index is used. If the index is not available, the
+header of all data Blobs can be read.
+
+Trees and Data
+==============
+
+A snapshot references a tree by the SHA-256 hash of the JSON string
+representation of its contents. Trees and data are saved in pack files
+in a subdirectory of the directory ``data``.
+
+The command ``restic cat blob`` can be used to inspect the tree
+referenced above (piping the output of the command to ``jq .`` so that
+the JSON is indented):
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat blob 2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf | jq .
+    enter password for repository:
+    {
+      "nodes": [
+        {
+          "name": "testdata",
+          "type": "dir",
+          "mode": 493,
+          "mtime": "2014-12-22T14:47:59.912418701+01:00",
+          "atime": "2014-12-06T17:49:21.748468803+01:00",
+          "ctime": "2014-12-22T14:47:59.912418701+01:00",
+          "uid": 1000,
+          "gid": 100,
+          "user": "fd0",
+          "inode": 409704562,
+          "content": null,
+          "subtree": "b26e315b0988ddcd1cee64c351d13a100fedbc9fdbb144a67d1b765ab280b4dc"
+        }
+      ]
+    }
+
+A tree contains a list of entries (in the field ``nodes``) which contain
+meta data like a name and timestamps. When the entry references a
+directory, the field ``subtree`` contains the plain text ID of another
+tree object.
+
+When the command ``restic cat blob`` is used, the plaintext ID is needed
+to print a tree. The tree referenced above can be dumped as follows:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat blob b26e315b0988ddcd1cee64c351d13a100fedbc9fdbb144a67d1b765ab280b4dc
+    enter password for repository:
+    {
+      "nodes": [
+        {
+          "name": "testfile",
+          "type": "file",
+          "mode": 420,
+          "mtime": "2014-12-06T17:50:23.34513538+01:00",
+          "atime": "2014-12-06T17:50:23.338468713+01:00",
+          "ctime": "2014-12-06T17:50:23.34513538+01:00",
+          "uid": 1000,
+          "gid": 100,
+          "user": "fd0",
+          "inode": 416863351,
+          "size": 1234,
+          "links": 1,
+          "content": [
+            "50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d"
+          ]
+        },
+        [...]
+      ]
+    }
+
+This tree contains a file entry. This time, the ``subtree`` field is not
+present and the ``content`` field contains a list with one plain text
+SHA-256 hash.
+
+The command ``restic cat blob`` can also be used to extract and decrypt
+data given a plaintext ID, e.g. for the data mentioned above:
+
+.. code-block:: console
+
+    $ restic -r /tmp/restic-repo cat blob 50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d | sha256sum
+    enter password for repository:
+    50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d  -
+
+As can be seen from the output of the program ``sha256sum``, the hash
+matches the plaintext hash from the map included in the tree above, so
+the correct data has been returned.
+
+Locks
+=====
+
+The restic repository structure is designed in a way that allows
+parallel access of multiple instance of restic and even parallel writes.
+However, there are some functions that work more efficient or even
+require exclusive access of the repository. In order to implement these
+functions, restic processes are required to create a lock on the
+repository before doing anything.
+
+Locks come in two types: Exclusive and non-exclusive locks. At most one
+process can have an exclusive lock on the repository, and during that
+time there must not be any other locks (exclusive and non-exclusive).
+There may be multiple non-exclusive locks in parallel.
+
+A lock is a file in the subdir ``locks`` whose filename is the storage
+ID of the contents. It is encrypted and authenticated the same way as
+other files in the repository and contains the following JSON structure:
+
+.. code:: json
+
+    {
+      "time": "2015-06-27T12:18:51.759239612+02:00",
+      "exclusive": false,
+      "hostname": "kasimir",
+      "username": "fd0",
+      "pid": 13607,
+      "uid": 1000,
+      "gid": 100
+    }
+
+The field ``exclusive`` defines the type of lock. When a new lock is to
+be created, restic checks all locks in the repository. When a lock is
+found, it is tested if the lock is stale, which is the case for locks
+with timestamps older than 30 minutes. If the lock was created on the
+same machine, even for younger locks it is tested whether the process is
+still alive by sending a signal to it. If that fails, restic assumes
+that the process is dead and considers the lock to be stale.
+
+When a new lock is to be created and no other conflicting locks are
+detected, restic creates a new lock, waits, and checks if other locks
+appeared in the repository. Depending on the type of the other locks and
+the lock to be created, restic either continues or fails.
+
+Backups and Deduplication
+=========================
+
+For creating a backup, restic scans the source directory for all files,
+sub-directories and other entries. The data from each file is split into
+variable length Blobs cut at offsets defined by a sliding window of 64
+byte. The implementation uses Rabin Fingerprints for implementing this
+Content Defined Chunking (CDC). An irreducible polynomial is selected at
+random and saved in the file ``config`` when a repository is
+initialized, so that watermark attacks are much harder.
+
+Files smaller than 512 KiB are not split, Blobs are of 512 KiB to 8 MiB
+in size. The implementation aims for 1 MiB Blob size on average.
+
+For modified files, only modified Blobs have to be saved in a subsequent
+backup. This even works if bytes are inserted or removed at arbitrary
+positions within the file.
+
+Threat Model
+============
+
+The design goals for restic include being able to securely store backups
+in a location that is not completely trusted, e.g. a shared system where
+others can potentially access the files or (in the case of the system
+administrator) even modify or delete them.
+
+General assumptions:
+
+-  The host system a backup is created on is trusted. This is the most
+   basic requirement, and essential for creating trustworthy backups.
+
+The restic backup program guarantees the following:
+
+-  Accessing the unencrypted content of stored files and metadata should
+   not be possible without a password for the repository. Everything
+   except the metadata included for informational purposes in the key
+   files is encrypted and authenticated.
+
+-  Modifications (intentional or unintentional) can be detected
+   automatically on several layers:
+
+   1. For all accesses of data stored in the repository it is checked
+      whether the cryptographic hash of the contents matches the storage
+      ID (the file's name). This way, modifications (bad RAM, broken
+      harddisk) can be detected easily.
+
+   2. Before decrypting any data, the MAC on the encrypted data is
+      checked. If there has been a modification, the MAC check will
+      fail. This step happens even before the data is decrypted, so data
+      that has been tampered with is not decrypted at all.
+
+However, the restic backup program is not designed to protect against
+attackers deleting files at the storage location. There is nothing that
+can be done about this. If this needs to be guaranteed, get a secure
+location without any access from third parties. If you assume that
+attackers have write access to your files at the storage location,
+attackers are able to figure out (e.g. based on the timestamps of the
+stored files) which files belong to what snapshot. When only these files
+are deleted, the particular snapshot vanished and all snapshots
+depending on data that has been added in the snapshot cannot be restored
+completely. Restic is not designed to detect this attack.
+
+Local Cache
+===========
+
+In order to speed up certain operations, restic manages a local cache of data.
+This document describes the data structures for the local cache with version 1.
+
+Versions
+--------
+
+The cache directory is selected according to the `XDG base dir specification
+<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__.
+Each repository has its own cache sub-directory, consting of the repository ID
+which is chosen at ``init``. All cache directories for different repos are
+independent of each other.
+
+The cache dir for a repo contains a file named ``version``, which contains a
+single ASCII integer line that stands for the current version of the cache. If
+a lower version number is found the cache is recreated with the current
+version. If a higher version number is found the cache is ignored and left as
+is.
+
+Snapshots and Indexes
+---------------------
+
+Snapshot, Data and Index files are cached in the sub-directories ``snapshots``,
+``data`` and  ``index``, as read from the repository.
+
+
+************
+REST Backend
+************
+
+Restic can interact with HTTP Backend that respects the following REST
+API. The following values are valid for ``{type}``: ``data``, ``keys``,
+``locks``, ``snapshots``, ``index``, ``config``. ``{path}`` is a path to
+the repository, so that multiple different repositories can be accessed.
+The default path is ``/``.
+
+POST {path}?create=true
+=======================
+
+This request is used to initially create a new repository. The server
+responds with "200 OK" if the repository structure was created
+successfully or already exists, otherwise an error is returned.
+
+DELETE {path}
+=============
+
+Deletes the repository on the server side. The server responds with "200
+OK" if the repository was successfully removed. If this function is not
+implemented the server returns "501 Not Implemented", if this it is
+denied by the server it returns "403 Forbidden".
+
+HEAD {path}/config
+==================
+
+Returns "200 OK" if the repository has a configuration, an HTTP error
+otherwise.
+
+GET {path}/config
+=================
+
+Returns the content of the configuration file if the repository has a
+configuration, an HTTP error otherwise.
+
+Response format: binary/octet-stream
+
+POST {path}/config
+==================
+
+Returns "200 OK" if the configuration of the request body has been
+saved, an HTTP error otherwise.
+
+GET {path}/{type}/
+==================
+
+Returns a JSON array containing the names of all the blobs stored for a
+given type.
+
+Response format: JSON
+
+HEAD {path}/{type}/{name}
+=========================
+
+Returns "200 OK" if the blob with the given name and type is stored in
+the repository, "404 not found" otherwise. If the blob exists, the HTTP
+header ``Content-Length`` is set to the file size.
+
+GET {path}/{type}/{name}
+========================
+
+Returns the content of the blob with the given name and type if it is
+stored in the repository, "404 not found" otherwise.
+
+If the request specifies a partial read with a Range header field, then
+the status code of the response is 206 instead of 200 and the response
+only contains the specified range.
+
+Response format: binary/octet-stream
+
+POST {path}/{type}/{name}
+=========================
+
+Saves the content of the request body as a blob with the given name and
+type, an HTTP error otherwise.
+
+Request format: binary/octet-stream
+
+DELETE {path}/{type}/{name}
+===========================
+
+Returns "200 OK" if the blob with the given name and type has been
+deleted from the repository, an HTTP error otherwise.
+
+
+*****
+Talks
+*****
+
+The following talks will be or have been given about restic:
+
+-  2016-01-31: Lightning Talk at the Go Devroom at FOSDEM 2016,
+   Brussels, Belgium
+-  2016-01-29: `restic - Backups mal
+   richtig <https://media.ccc.de/v/c4.openchaos.2016.01.restic>`__:
+   Public lecture in German at `CCC Cologne
+   e.V. <https://koeln.ccc.de>`__ in Cologne, Germany
+-  2015-08-23: `A Solution to the Backup
+   Inconvenience <https://programm.froscon.de/2015/events/1515.html>`__:
+   Lecture at `FROSCON 2015 <https://www.froscon.de>`__ in Bonn, Germany
+-  2015-02-01: `Lightning Talk at FOSDEM
+   2015 <https://www.youtube.com/watch?v=oM-MfeflUZ8&t=11m40s>`__: A
+   short introduction (with slightly outdated command line)
+-  2015-01-27: `Talk about restic at CCC
+   Aachen <https://videoag.fsmpi.rwth-aachen.de/?view=player&lectureid=4442#content>`__
+   (in German)

doc/Design.md

@@ -1,507 +0,0 @@
-This document gives a high-level overview of the design and repository layout
-of the restic backup program.
-
-Terminology
-===========
-
-This section introduces terminology used in this document.
-
-*Repository*: All data produced during a backup is sent to and stored in a
-repository in a structured form, for example in a file system hierarchy with
-several subdirectories. A repository implementation must be able to fulfill a
-number of operations, e.g. list the contents.
-
-*Blob*: A Blob combines a number of data bytes with identifying information
-like the SHA-256 hash of the data and its length.
-
-*Pack*: A Pack combines one or more Blobs, e.g. in a single file.
-
-*Snapshot*: A Snapshot stands for the state of a file or directory that has
-been backed up at some point in time. The state here means the content and meta
-data like the name and modification time for the file or the directory and its
-contents.
-
-*Storage ID*: A storage ID is the SHA-256 hash of the content stored in the
-repository. This ID is required in order to load the file from the repository.
-
-Repository Format
-=================
-
-All data is stored in a restic repository. A repository is able to store data
-of several different types, which can later be requested based on an ID. This
-so-called "storage ID" is the SHA-256 hash of the content of a file. All files
-in a repository are only written once and never modified afterwards. This
-allows accessing and even writing to the repository with multiple clients in
-parallel. Only the delete operation removes data from the repository.
-
-At the time of writing, the only implemented repository type is based on
-directories and files. Such repositories can be accessed locally on the same
-system or via the integrated SFTP client (or any other storage back end).
-The directory layout is the same for both access methods.
-This repository type is described in the following section.
-
-Repositories consist of several directories and a file called `config`. For
-all other files stored in the repository, the name for the file is the lower
-case hexadecimal representation of the storage ID, which is the SHA-256 hash of
-the file's contents. This allows for easy verification of files for accidental
-modifications, like disk read errors, by simply running the program `sha256sum`
-and comparing its output to the file name. If the prefix of a filename is
-unique amongst all the other files in the same directory, the prefix may be
-used instead of the complete filename.
-
-Apart from the files stored within the `keys` directory, all files are encrypted
-with AES-256 in counter mode (CTR). The integrity of the encrypted data is
-secured by a Poly1305-AES message authentication code (sometimes also referred
-to as a "signature").
-
-In the first 16 bytes of each encrypted file the initialisation vector (IV) is
-stored. It is followed by the encrypted data and completed by the 16 byte
-MAC. The format is: `IV || CIPHERTEXT || MAC`. The complete encryption
-overhead is 32 bytes. For each file, a new random IV is selected.
-
-The file `config` is encrypted this way and contains a JSON document like the
-following:
-
-```json
-{
-  "version": 1,
-  "id": "5956a3f67a6230d4a92cefb29529f10196c7d92582ec305fd71ff6d331d6271b",
-  "chunker_polynomial": "25b468838dcb75"
-}
-```
-
-After decryption, restic first checks that the version field contains a version
-number that it understands, otherwise it aborts. At the moment, the version is
-expected to be 1. The field `id` holds a unique ID which consists of 32
-random bytes, encoded in hexadecimal. This uniquely identifies the repository,
-regardless if it is accessed via SFTP or locally. The field
-`chunker_polynomial` contains a parameter that is used for splitting large
-files into smaller chunks (see below).
-
-The basic layout of a sample restic repository is shown here:
-
-    /tmp/restic-repo
-    ├── config
-    ├── data
-    │   ├── 21
-    │   │   └── 2159dd48f8a24f33c307b750592773f8b71ff8d11452132a7b2e2a6a01611be1
-    │   ├── 32
-    │   │   └── 32ea976bc30771cebad8285cd99120ac8786f9ffd42141d452458089985043a5
-    │   ├── 59
-    │   │   └── 59fe4bcde59bd6222eba87795e35a90d82cd2f138a27b6835032b7b58173a426
-    │   ├── 73
-    │   │   └── 73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c
-    │   [...]
-    ├── index
-    │   ├── c38f5fb68307c6a3e3aa945d556e325dc38f5fb68307c6a3e3aa945d556e325d
-    │   └── ca171b1b7394d90d330b265d90f506f9984043b342525f019788f97e745c71fd
-    ├── keys
-    │   └── b02de829beeb3c01a63e6b25cbd421a98fef144f03b9a02e46eff9e2ca3f0bd7
-    ├── locks
-    ├── snapshots
-    │   └── 22a5af1bdc6e616f8a29579458c49627e01b32210d09adb288d1ecda7c5711ec
-    └── tmp
-
-A repository can be initialized with the `restic init` command, e.g.:
-
-```console
-$ restic -r /tmp/restic-repo init
-```
-
-Pack Format
------------
-
-All files in the repository except Key and Pack files just contain raw data,
-stored as `IV || Ciphertext || MAC`. Pack files may contain one or more Blobs
-of data.
-
-A Pack's structure is as follows:
-
-    EncryptedBlob1 || ... || EncryptedBlobN || EncryptedHeader || Header_Length
-
-At the end of the Pack file is a header, which describes the content. The
-header is encrypted and authenticated. `Header_Length` is the length of the
-encrypted header encoded as a four byte integer in little-endian encoding.
-Placing the header at the end of a file allows writing the blobs in a
-continuous stream as soon as they are read during the backup phase. This
-reduces code complexity and avoids having to re-write a file once the pack is
-complete and the content and length of the header is known.
-
-All the blobs (`EncryptedBlob1`, `EncryptedBlobN` etc.) are authenticated and
-encrypted independently. This enables repository reorganisation without having
-to touch the encrypted Blobs. In addition it also allows efficient indexing,
-for only the header needs to be read in order to find out which Blobs are
-contained in the Pack. Since the header is authenticated, authenticity of the
-header can be checked without having to read the complete Pack.
-
-After decryption, a Pack's header consists of the following elements:
-
-    Type_Blob1 || Length(EncryptedBlob1) || Hash(Plaintext_Blob1) ||
-    [...]
-    Type_BlobN || Length(EncryptedBlobN) || Hash(Plaintext_Blobn) ||
-
-This is enough to calculate the offsets for all the Blobs in the Pack. Length
-is the length of a Blob as a four byte integer in little-endian format. The
-type field is a one byte field and labels the content of a blob according to
-the following table:
-
- Type | Meaning
- -----|---------
-    0 | data
-    1 | tree
-
-All other types are invalid, more types may be added in the future.
-
-For reconstructing the index or parsing a pack without an index, first the last
-four bytes must be read in order to find the length of the header. Afterwards,
-the header can be read and parsed, which yields all plaintext hashes, types,
-offsets and lengths of all included blobs.
-
-Indexing
---------
-
-Index files contain information about Data and Tree Blobs and the Packs they
-are contained in and store this information in the repository. When the local
-cached index is not accessible any more, the index files can be downloaded and
-used to reconstruct the index. The files are encrypted and authenticated like
-Data and Tree Blobs, so the outer structure is `IV || Ciphertext || MAC` again.
-The plaintext consists of a JSON document like the following:
-
-```json
-{
-  "supersedes": [
-    "ed54ae36197f4745ebc4b54d10e0f623eaaaedd03013eb7ae90df881b7781452"
-  ],
-  "packs": [
-    {
-      "id": "73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c",
-      "blobs": [
-        {
-          "id": "3ec79977ef0cf5de7b08cd12b874cd0f62bbaf7f07f3497a5b1bbcc8cb39b1ce",
-          "type": "data",
-          "offset": 0,
-          "length": 25
-        },{
-          "id": "9ccb846e60d90d4eb915848add7aa7ea1e4bbabfc60e573db9f7bfb2789afbae",
-          "type": "tree",
-          "offset": 38,
-          "length": 100
-        },
-        {
-          "id": "d3dc577b4ffd38cc4b32122cabf8655a0223ed22edfd93b353dc0c3f2b0fdf66",
-          "type": "data",
-          "offset": 150,
-          "length": 123
-        }
-      ]
-    }, [...]
-  ]
-}
-```
-
-This JSON document lists Packs and the blobs contained therein. In this
-example, the Pack `73d04e61` contains two data Blobs and one Tree blob, the
-plaintext hashes are listed afterwards.
-
-The field `supersedes` lists the storage IDs of index files that have been
-replaced with the current index file. This happens when index files are
-repacked, for example when old snapshots are removed and Packs are recombined.
-
-There may be an arbitrary number of index files, containing information on
-non-disjoint sets of Packs. The number of packs described in a single file is
-chosen so that the file size is kept below 8 MiB.
-
-Keys, Encryption and MAC
-------------------------
-
-All data stored by restic in the repository is encrypted with AES-256 in
-counter mode and authenticated using Poly1305-AES. For encrypting new data first
-16 bytes are read from a cryptographically secure pseudorandom number generator
-as a random nonce. This is used both as the IV for counter mode and the nonce
-for Poly1305. This operation needs three keys: A 32 byte for AES-256 for
-encryption, a 16 byte AES key and a 16 byte key for Poly1305. For details see
-the original paper [The Poly1305-AES message-authentication
-code](http://cr.yp.to/mac/poly1305-20050329.pdf) by Dan Bernstein.
-The data is then encrypted with AES-256 and afterwards a message authentication
-code (MAC) is computed over the ciphertext, everything is then stored as
-IV || CIPHERTEXT || MAC.
-
-The directory `keys` contains key files. These are simple JSON documents which
-contain all data that is needed to derive the repository's master encryption and
-message authentication keys from a user's password. The JSON document from the
-repository can be pretty-printed for example by using the Python module `json`
-(shortened to increase readability):
-
-    $ python -mjson.tool /tmp/restic-repo/keys/b02de82*
-    {
-        "hostname": "kasimir",
-        "username": "fd0"
-        "kdf": "scrypt",
-        "N": 65536,
-        "r": 8,
-        "p": 1,
-        "created": "2015-01-02T18:10:13.48307196+01:00",
-        "data": "tGwYeKoM0C4j4/9DFrVEmMGAldvEn/+iKC3te/QE/6ox/V4qz58FUOgMa0Bb1cIJ6asrypCx/Ti/pRXCPHLDkIJbNYd2ybC+fLhFIJVLCvkMS+trdywsUkglUbTbi+7+Ldsul5jpAj9vTZ25ajDc+4FKtWEcCWL5ICAOoTAxnPgT+Lh8ByGQBH6KbdWabqamLzTRWxePFoYuxa7yXgmj9A==",
-        "salt": "uW4fEI1+IOzj7ED9mVor+yTSJFd68DGlGOeLgJELYsTU5ikhG/83/+jGd4KKAaQdSrsfzrdOhAMftTSih5Ux6w==",
-    }
-
-When the repository is opened by restic, the user is prompted for the
-repository password. This is then used with `scrypt`, a key derivation function
-(KDF), and the supplied parameters (`N`, `r`, `p` and `salt`) to derive 64 key
-bytes. The first 32 bytes are used as the encryption key (for AES-256) and the
-last 32 bytes are used as the message authentication key (for Poly1305-AES).
-These last 32 bytes are divided into a 16 byte AES key `k` followed by 16 bytes
-of secret key `r`. The key `r` is then masked for use with Poly1305 (see the
-paper for details).
-
-Those message authentication keys (`k` and `r`) are used to compute a MAC over
-the bytes contained in the JSON field `data` (after removing the Base64
-encoding and not including the last 32 byte). If the password is incorrect or
-the key file has been tampered with, the computed MAC will not match the last
-16 bytes of the data, and restic exits with an error. Otherwise, the data is
-decrypted with the encryption key derived from `scrypt`. This yields a JSON
-document which contains the master encryption and message authentication keys
-for this repository (encoded in Base64). The command `restic cat masterkey` can
-be used as follows to decrypt and pretty-print the master key:
-
-```console
-$ restic -r /tmp/restic-repo cat masterkey
-{
-    "mac": {
-      "k": "evFWd9wWlndL9jc501268g==",
-      "r": "E9eEDnSJZgqwTOkDtOp+Dw=="
-    },
-    "encrypt": "UQCqa0lKZ94PygPxMRqkePTZnHRYh1k1pX2k2lM2v3Q=",
-}
-```
-
-All data in the repository is encrypted and authenticated with these master keys.
-For encryption, the AES-256 algorithm in Counter mode is used. For message
-authentication, Poly1305-AES is used as described above.
-
-A repository can have several different passwords, with a key file for each.
-This way, the password can be changed without having to re-encrypt all data.
-
-Snapshots
----------
-
-A snapshots represents a directory with all files and sub-directories at a
-given point in time. For each backup that is made, a new snapshot is created. A
-snapshot is a JSON document that is stored in an encrypted file below the
-directory `snapshots` in the repository. The filename is the storage ID. This
-string is unique and used within restic to uniquely identify a snapshot.
-
-The command `restic cat snapshot` can be used as follows to decrypt and
-pretty-print the contents of a snapshot file:
-
-```console
-$ restic -r /tmp/restic-repo cat snapshot 22a5af1b
-enter password for repository:
-{
-  "time": "2015-01-02T18:10:50.895208559+01:00",
-  "tree": "2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf",
-  "dir": "/tmp/testdata",
-  "hostname": "kasimir",
-  "username": "fd0",
-  "uid": 1000,
-  "gid": 100
-}
-```
-
-Here it can be seen that this snapshot represents the contents of the directory
-`/tmp/testdata`. The most important field is `tree`.
-
-All content within a restic repository is referenced according to its SHA-256
-hash. Before saving, each file is split into variable sized Blobs of data. The
-SHA-256 hashes of all Blobs are saved in an ordered list which then represents
-the content of the file.
-
-In order to relate these plaintext hashes to the actual location within a Pack
-file , an index is used. If the index is not available, the header of all data
-Blobs can be read.
-
-Trees and Data
---------------
-
-A snapshot references a tree by the SHA-256 hash of the JSON string
-representation of its contents. Trees and data are saved in pack files in a
-subdirectory of the directory `data`.
-
-The command `restic cat tree` can be used to inspect the tree referenced above:
-
-```console
-$ restic -r /tmp/restic-repo cat tree b8138ab08a4722596ac89c917827358da4672eac68e3c03a8115b88dbf4bfb59
-enter password for repository:
-{
-  "nodes": [
-    {
-      "name": "testdata",
-      "type": "dir",
-      "mode": 493,
-      "mtime": "2014-12-22T14:47:59.912418701+01:00",
-      "atime": "2014-12-06T17:49:21.748468803+01:00",
-      "ctime": "2014-12-22T14:47:59.912418701+01:00",
-      "uid": 1000,
-      "gid": 100,
-      "user": "fd0",
-      "inode": 409704562,
-      "content": null,
-      "subtree": "b26e315b0988ddcd1cee64c351d13a100fedbc9fdbb144a67d1b765ab280b4dc"
-    }
-  ]
-}
-```
-
-A tree contains a list of entries (in the field `nodes`) which contain meta
-data like a name and timestamps. When the entry references a directory, the
-field `subtree` contains the plain text ID of another tree object.
-
-When the command `restic cat tree` is used, the storage hash is needed to print
-a tree. The tree referenced above can be dumped as follows:
-
-```console
-$ restic -r /tmp/restic-repo cat tree 8b238c8811cc362693e91a857460c78d3acf7d9edb2f111048691976803cf16e
-enter password for repository:
-{
-  "nodes": [
-    {
-      "name": "testfile",
-      "type": "file",
-      "mode": 420,
-      "mtime": "2014-12-06T17:50:23.34513538+01:00",
-      "atime": "2014-12-06T17:50:23.338468713+01:00",
-      "ctime": "2014-12-06T17:50:23.34513538+01:00",
-      "uid": 1000,
-      "gid": 100,
-      "user": "fd0",
-      "inode": 416863351,
-      "size": 1234,
-      "links": 1,
-      "content": [
-        "50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d"
-      ]
-    },
-    [...]
-  ]
-}
-```
-
-This tree contains a file entry. This time, the `subtree` field is not present
-and the `content` field contains a list with one plain text SHA-256 hash.
-
-The command `restic cat data` can be used to extract and decrypt data given a
-plaintext ID, e.g. for the data mentioned above:
-
-```console
-$ restic -r /tmp/restic-repo cat blob 50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d | sha256sum
-enter password for repository:
-50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d  -
-```
-
-As can be seen from the output of the program `sha256sum`, the hash matches the
-plaintext hash from the map included in the tree above, so the correct data has
-been returned.
-
-Locks
------
-
-The restic repository structure is designed in a way that allows parallel
-access of multiple instance of restic and even parallel writes. However, there
-are some functions that work more efficient or even require exclusive access of
-the repository. In order to implement these functions, restic processes are
-required to create a lock on the repository before doing anything.
-
-Locks come in two types: Exclusive and non-exclusive locks. At most one
-process can have an exclusive lock on the repository, and during that time
-there must not be any other locks (exclusive and non-exclusive). There may be
-multiple non-exclusive locks in parallel.
-
-A lock is a file in the subdir `locks` whose filename is the storage ID of
-the contents. It is encrypted and authenticated the same way as other files
-in the repository and contains the following JSON structure:
-
-```json
-{
-  "time": "2015-06-27T12:18:51.759239612+02:00",
-  "exclusive": false,
-  "hostname": "kasimir",
-  "username": "fd0",
-  "pid": 13607,
-  "uid": 1000,
-  "gid": 100
-}
-```
-
-The field `exclusive` defines the type of lock. When a new lock is to be
-created, restic checks all locks in the repository. When a lock is found, it
-is tested if the lock is stale, which is the case for locks with timestamps
-older than 30 minutes. If the lock was created on the same machine, even for
-younger locks it is tested whether the process is still alive by sending a
-signal to it. If that fails, restic assumes that the process is dead and
-considers the lock to be stale.
-
-When a new lock is to be created and no other conflicting locks are
-detected, restic creates a new lock, waits, and checks if other locks
-appeared in the repository. Depending on the type of the other locks and the
-lock to be created, restic either continues or fails.
-
-Backups and Deduplication
-=========================
-
-For creating a backup, restic scans the source directory for all files,
-sub-directories and other entries. The data from each file is split into
-variable length Blobs cut at offsets defined by a sliding window of 64 byte.
-The implementation uses Rabin Fingerprints for implementing this Content
-Defined Chunking (CDC). An irreducible polynomial is selected at random and
-saved in the file `config` when a repository is initialized, so that watermark
-attacks are much harder.
-
-Files smaller than 512 KiB are not split, Blobs are of 512 KiB to 8 MiB in
-size. The implementation aims for 1 MiB Blob size on average.
-
-For modified files, only modified Blobs have to be saved in a subsequent
-backup. This even works if bytes are inserted or removed at arbitrary positions
-within the file.
-
-Threat Model
-============
-
-The design goals for restic include being able to securely store backups in a
-location that is not completely trusted, e.g. a shared system where others can
-potentially access the files or (in the case of the system administrator) even
-modify or delete them.
-
-General assumptions:
-
- * The host system a backup is created on is trusted. This is the most basic
-   requirement, and essential for creating trustworthy backups.
-
-The restic backup program guarantees the following:
-
- * Accessing the unencrypted content of stored files and metadata should not
-   be possible without a password for the repository. Everything except the
-   metadata included for informational purposes in the key files is encrypted and
-   authenticated.
-
- * Modifications (intentional or unintentional) can be detected automatically
-   on several layers:
-
-     1. For all accesses of data stored in the repository it is checked whether
-        the cryptographic hash of the contents matches the storage ID (the
-        file's name). This way, modifications (bad RAM, broken harddisk) can be
-        detected easily.
-
-     2. Before decrypting any data, the MAC on the encrypted data is
-        checked. If there has been a modification, the MAC check will
-        fail. This step happens even before the data is decrypted, so data that
-        has been tampered with is not decrypted at all.
-
-However, the restic backup program is not designed to protect against attackers
-deleting files at the storage location. There is nothing that can be done about
-this. If this needs to be guaranteed, get a secure location without any access
-from third parties. If you assume that attackers have write access to your
-files at the storage location, attackers are able to figure out (e.g. based on
-the timestamps of the stored files) which files belong to what snapshot. When
-only these files are deleted, the particular snapshot vanished and all
-snapshots depending on data that has been added in the snapshot cannot be
-restored completely. Restic is not designed to detect this attack.

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = restic
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/Manual.md

@@ -1,706 +0,0 @@
-Thanks for using restic. This document will give you an overview of the basic
-functionality provided by restic.
-
-# Building/installing restic
-
-If you are using Mac OS X, you can install restic using the
-[homebrew](http://brew.sh/) packet manager:
-
-```console
-$ brew tap restic/restic
-$ brew install restic
-```
-
-On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`:
-
-```console
-$ pacaur -S restic-git
-```
-
-At debian stable you can install 'go' directly from the repositories (as root):
-
-```console
-$ apt-get install golang-go
-```
-
-after installation of 'go' go straight forward to 'git clone [...]'
-
-If you are using Linux, BSD or Windows, the only way to install restic on your
-system right now is to compile it from source. restic is written in the Go
-programming language and you need at least Go version 1.6. Building restic may
-also work with older versions of Go, but that's not supported. See the [Getting
-started](https://golang.org/doc/install) guide of the Go project for
-instructions how to install Go.
-
-In order to build restic from source, execute the following steps:
-
-```console
-$ git clone https://github.com/restic/restic
-[...]
-
-$ cd restic
-
-$ go run build.go
-```
-
-At the moment, the only tested compiler for restic is the official Go compiler.
-Building restic with gccgo may work, but is not supported.
-
-Usage help is available:
-
-```console
-$ ./restic --help
-restic is a backup program which allows saving multiple revisions of files and
-directories in an encrypted repository stored on different backends.
-
-Usage:
-  restic [command]
-
-Available Commands:
-  backup        create a new backup of files and/or directories
-  cat           print internal objects to stdout
-  check         check the repository for errors
-  find          find a file or directory
-  forget        forget removes snapshots from the repository
-  init          initialize a new repository
-  key           manage keys (passwords)
-  list          list items in the repository
-  ls            list files in a snapshot
-  mount         mount the repository
-  prune         remove unneeded data from the repository
-  rebuild-index build a new index file
-  restore       extract the data from a snapshot
-  snapshots     list all snapshots
-  unlock        remove locks other processes created
-  version       Print version information
-
-Flags:
-      --no-lock                do not lock the repo, this allows some operations on read-only repos
-  -p, --password-file string   read the repository password from a file
-  -q, --quiet                  do not outputcomprehensive progress report
-  -r, --repo string            repository to backup to or restore from (default: $RESTIC_REPOSITORY)
-
-Use "restic [command] --help" for more information about a command.
-```
-
-Similar to programs such as `git`, restic has a number of sub-commands. You can
-see these commands in the listing above. Each sub-command may have own
-command-line options, and there is a help option for each command which lists
-them, e.g. for the `backup` command:
-
-```console
-$ ./restic backup --help
-The "backup" command creates a new snapshot and saves the files and directories
-given as the arguments.
-
-Usage:
-  restic backup [flags] FILE/DIR [FILE/DIR] ...
-
-Flags:
-  -e, --exclude pattern         exclude a pattern (can be specified multiple times)
-      --exclude-file string     read exclude patterns from a file
-      --files-from string       read the files to backup from file (can be combined with file args)
-  -f, --force                   force re-reading the target files/directories. Overrides the "parent" flag
-  -x, --one-file-system         Exclude other file systems
-      --parent string           use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)
-      --stdin                   read backup from stdin
-      --stdin-filename string   file name to use when reading from stdin
-      --tag tag                 add a tag for the new snapshot (can be specified multiple times)
-
-Global Flags:
-      --no-lock                do not lock the repo, this allows some operations on read-only repos
-  -p, --password-file string   read the repository password from a file
-  -q, --quiet                  do not outputcomprehensive progress report
-  -r, --repo string            repository to backup to or restore from (default: $RESTIC_REPOSITORY)
-```
-
-Subcommand that support showing progress information such as `backup`, `check` and `prune` will do so unless
-the quiet flag `-q` or `--quiet` is set. When running from a non-interactive console progress reporting will
-be limited to once every 10 seconds to not fill your logs.
-
-Additionally on Unix systems if `restic` receives a SIGUSR signal the current progress will written to the
-standard output so you can check up on the status at will.
-
-
-# Initialize a repository
-
-First, we need to create a "repository". This is the place where your backups
-will be saved at.
-
-In order to create a repository at `/tmp/backup`, run the following command and
-enter the same password twice:
-
-```console
-$ restic init --repo /tmp/backup
-enter password for new backend:
-enter password again:
-created restic backend 085b3c76b9 at /tmp/backup
-Please note that knowledge of your password is required to access the repository.
-Losing your password means that your data is irrecoverably lost.
-```
-
-Remembering your password is important! If you lose it, you won't be able to
-access data stored in the repository.
-
-For automated backups, restic accepts the repository location in the
-environment variable `RESTIC_REPOSITORY`. The password can be read from a file
-(via the option `--password-file`) or the environment variable
-`RESTIC_PASSWORD`.
-
-## Password prompt on Windows
-
-At the moment, restic only supports the default Windows console interaction.
-If you use emulation environments like [MSYS2](https://msys2.github.io/) or
-[Cygwin](https://www.cygwin.com/), which use terminals like `Mintty` or `rxvt`,
-you may get a password error:
-
-You can workaround this by using a special tool called `winpty` (look
-[here](https://sourceforge.net/p/msys2/wiki/Porting/) and
-[here](https://github.com/rprichard/winpty) for detail information). On MSYS2,
-you can install `winpty` as follows:
-
-```console
-$ pacman -S winpty
-$ winpty restic -r /tmp/backup init
-```
-
-# Create a snapshot
-
-Now we're ready to backup some data. The contents of a directory at a specific
-point in time is called a "snapshot" in restic. Run the following command and
-enter the repository password you chose above again:
-
-```console
-$ restic -r /tmp/backup backup ~/work
-enter password for repository:
-scan [/home/user/work]
-scanned 764 directories, 1816 files in 0:00
-[0:29] 100.00%  54.732 MiB/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
-duration: 0:29, 54.47MiB/s
-snapshot 40dc1520 saved
-```
-
-As you can see, restic created a backup of the directory and was pretty fast!
-The specific snapshot just created is identified by a sequence of hexadecimal
-characters, `40dc1520` in this case.
-
-If you run the command again, restic will create another snapshot of your data,
-but this time it's even faster. This is de-duplication at work!
-
-```console
-$ restic -r /tmp/backup backup ~/shared/work/web
-enter password for repository:
-using parent snapshot 40dc1520aa6a07b7b3ae561786770a01951245d2367241e71e9485f18ae8228c
-scan [/home/user/work]
-scanned 764 directories, 1816 files in 0:00
-[0:00] 100.00%  0B/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
-duration: 0:00, 6572.38MiB/s
-snapshot 79766175 saved
-```
-
-You can even backup individual files in the same repository.
-
-```console
-$ restic -r /tmp/backup backup ~/work.txt
-scan [~/work.txt]
-scanned 0 directories, 1 files in 0:00
-[0:00] 100.00%  0B/s  220B / 220B  1 / 1 items  0 errors  ETA 0:00
-duration: 0:00, 0.03MiB/s
-snapshot 31f7bd63 saved
-```
-
-In fact several hosts may use the same repository to backup directories and
-files leading to a greater de-duplication.
-
-You can exclude folders and files by specifying exclude-patterns.
-Either specify them with multiple `--exclude`'s or one `--exclude-file`
-
-```console
-$ cat exclude
-# exclude go-files
-*.go
-# exclude foo/x/y/z/bar foo/x/bar foo/bar
-foo/**/bar
-$ restic -r /tmp/backup backup ~/work --exclude=*.c --exclude-file=exclude
-```
-
-Patterns use [`filepath.Glob`](https://golang.org/pkg/path/filepath/#Glob) internally,
-see [`filepath.Match`](https://golang.org/pkg/path/filepath/#Match) for syntax.
-Additionally `**` exludes arbitrary subdirectories.
-Environment-variables in exclude-files are expanded with [`os.ExpandEnv`](https://golang.org/pkg/os/#ExpandEnv).
-
-By specifying the option `--one-file-system` you can instruct restic to only
-backup files from the file systems the initially specified files or directories
-reside on. For example, calling restic like this won't backup `/sys` or
-`/dev` on a Linux system:
-
-```console
-$ restic -r /tmp/backup backup --one-file-system /
-```
-By using the `--files-from` option you can read the files you want to backup
-from a file. This is especially useful if a lot of files have to be backed up
-that are not in the same folder or are maybe pre-filtered by other software.
-
-For example maybe you want to backup files that have a certain filename in them:
-
-```console
-$ find /tmp/somefiles | grep 'PATTERN' > /tmp/files_to_backup
-```
-
-You can then use restic to backup the filtered files:
-
-```console
-$ restic -r /tmp/backup backup --files-from /tmp/files_to_backup
-```
-
-Incidentally you can also combine `--files-from` with the normal files args:
-
-```console
-$ restic -r /tmp/backup backup --files-from /tmp/files_to_backup /tmp/some_additional_file
-```
-
-## Reading data from stdin
-
-Sometimes it can be nice to directly save the output of a program, e.g.
-`mysqldump` so that the SQL can later be restored. Restic supports this mode of
-operation, just supply the option `--stdin` to the `backup` command like this:
-
-```console
-$ mysqldump [...] | restic -r /tmp/backup backup --stdin
-```
-
-This creates a new snapshot of the output of `mysqldump`. You can then use e.g.
-the fuse mounting option (see below) to mount the repository and read the file.
-
-By default, the file name `stdin` is used, a different name can be specified
-with `--stdin-filename`, e.g. like this:
-
-```console
-$ mysqldump [...] | restic -r /tmp/backup backup --stdin --stdin-filename production.sql
-```
-
-## Tags
-
-Snapshots can have one or more tags, short strings which add identifying
-information. Just specify the tags for a snapshot with `--tag`:
-
-```console
-$ restic -r /tmp/backup backup --tag projectX ~/shared/work/web
-[...]
-```
-
-The tags can later be used to keep (or forget) snapshots.
-
-# List all snapshots
-
-Now, you can list all the snapshots stored in the repository:
-
-```console
-$ restic -r /tmp/backup snapshots
-enter password for repository:
-ID        Date                 Host    Tags   Directory
-----------------------------------------------------------------------
-40dc1520  2015-05-08 21:38:30  kasimir        /home/user/work
-79766175  2015-05-08 21:40:19  kasimir        /home/user/work
-bdbd3439  2015-05-08 21:45:17  luigi          /home/art
-590c8fc8  2015-05-08 21:47:38  kazik          /srv
-9f0bc19e  2015-05-08 21:46:11  luigi          /srv
-```
-
-You can filter the listing by directory path:
-
-```console
-$ restic -r /tmp/backup snapshots --path="/srv"
-enter password for repository:
-ID        Date                 Host    Tags   Directory
-----------------------------------------------------------------------
-590c8fc8  2015-05-08 21:47:38  kazik          /srv
-9f0bc19e  2015-05-08 21:46:11  luigi          /srv
-```
-
-Or filter by host:
-
-```console
-$ restic -r /tmp/backup snapshots --host luigi
-enter password for repository:
-ID        Date                 Host    Tags   Directory
-----------------------------------------------------------------------
-bdbd3439  2015-05-08 21:45:17  luigi          /home/art
-9f0bc19e  2015-05-08 21:46:11  luigi          /srv
-```
-
-Combining filters is also possible.
-
-# Restore a snapshot
-
-Restoring a snapshot is as easy as it sounds, just use the following command to
-restore the contents of the latest snapshot to `/tmp/restore-work`:
-
-```console
-$ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
-enter password for repository:
-restoring <Snapshot of [/home/user/work] at 2015-05-08 21:40:19.884408621 +0200 CEST> to /tmp/restore-work
-```
-
-Use the word `latest` to restore the last backup. You can also combine `latest`
-with the `--host` and `--path` filters to choose the last backup for a specific
-host, path or both.
-
-```console
-$ restic -r /tmp/backup restore latest --target ~/tmp/restore-work --path "/home/art" --host luigi
-enter password for repository:
-restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-work
-```
-
-
-# Manage repository keys
-
-The `key` command allows you to set multiple access keys or passwords per
-repository. In fact, you can use the `list`, `add`, `remove` and `passwd`
-sub-commands to manage these keys very precisely:
-
-```console
-$ restic -r /tmp/backup key list
-enter password for repository:
- ID          User        Host        Created
-----------------------------------------------------------------------
-*eb78040b    username    kasimir   2015-08-12 13:29:57
-
-$ restic -r /tmp/backup key add
-enter password for repository:
-enter password for new key:
-enter password again:
-saved new key as <Key of username@kasimir, created on 2015-08-12 13:35:05.316831933 +0200 CEST>
-
-$ restic -r backup key list
-enter password for repository:
- ID          User        Host        Created
-----------------------------------------------------------------------
- 5c657874    username    kasimir   2015-08-12 13:35:05
-*eb78040b    username    kasimir   2015-08-12 13:29:57
-```
-
-# Check integrity and consistency
-
-Imagine your repository is saved on a server that has a faulty hard drive, or
-even worse, attackers get privileged access and modify your backup with the
-intention to make you restore malicious data:
-
-```console
-$ sudo echo "boom" >> backup/index/d795ffa99a8ab8f8e42cec1f814df4e48b8f49129360fb57613df93739faee97
-```
-
-In order to detect these things, it is a good idea to regularly use the `check`
-command to test whether everything is alright, your precious backup data is
-consistent and the integrity is unharmed:
-
-```console
-$ restic -r /tmp/backup check
-Load indexes
-ciphertext verification failed
-```
-
-Trying to restore a snapshot which has been modified as shown above will yield
-the same error:
-
-```console
-$ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
-Load indexes
-ciphertext verification failed
-```
-
-# Mount a repository
-
-Browsing your backup as a regular file system is also very easy. First, create
-a mount point such as `/mnt/restic` and then use the following command to serve
-the repository with FUSE:
-
-```console
-$ mkdir /mnt/restic
-$ restic -r /tmp/backup mount /mnt/restic
-enter password for repository:
-Now serving /tmp/backup at /tmp/restic
-Don't forget to umount after quitting!
-```
-
-Mounting repositories via FUSE is not possible on Windows and OpenBSD.
-
-# Create an SFTP repository
-
-In order to backup data via SFTP, you must first set up a server with SSH and
-let it know your public key. Passwordless login is really important since
-restic fails to connect to the repository if the server prompts for
-credentials.
-
-Once the server is configured, the setup of the SFTP repository can simply be
-achieved by changing the URL scheme in the `init` command:
-
-```console
-$ restic -r sftp:user@host:/tmp/backup init
-enter password for new backend:
-enter password again:
-created restic backend f1c6108821 at sftp:user@host:/tmp/backup
-Please note that knowledge of your password is required to access the repository.
-Losing your password means that your data is irrecoverably lost.
-```
-
-You can also specify a relative (read: no slash (`/`) character at the
-beginning) directory, in this case the dir is relative to the remote user's
-home directory.
-
-# Create an Amazon S3 repository
-
-Restic can backup data to any Amazon S3 bucket. However, in this case, changing the URL scheme is not enough since Amazon uses special security credentials to sign HTTP requests. By consequence, you must first setup the following environment variables with the credentials you obtained while creating the bucket.
-
-```console
-$ export AWS_ACCESS_KEY_ID=<MY_ACCESS_KEY>
-$ export AWS_SECRET_ACCESS_KEY=<MY_SECRET_ACCESS_KEY>
-```
-
-You can then easily initialize a repository that uses your Amazon S3 as a backend, if the bucket does not exist yet it will be created in the default location:
-
-```console
-$ restic -r s3:s3.amazonaws.com/bucket_name init
-enter password for new backend:
-enter password again:
-created restic backend eefee03bbd at s3:s3.amazonaws.com/bucket_name
-Please note that knowledge of your password is required to access the repository.
-Losing your password means that your data is irrecoverably lost.
-```
-
-It is not possible at the moment to have restic create a new bucket in a different location, so you need to create it using a different program. Afterwards, the S3 server (`s3.amazonaws.com`) will redirect restic to the correct endpoint.
-
-For an S3-compatible server that is not Amazon (like Minio, see below), or is
-only available via HTTP, you can specify the URL to the server like this:
-`s3:http://server:port/bucket_name`.
-
-## Create a Minio Server repository
-
-[Minio](https://www.minio.io) is an Open Source Object Storage, written in Go and compatible with AWS S3 API.
-
-### Pre-Requisites
-
-* Download and Install [Minio Server](https://minio.io/download/).
-* You can also refer to [https://docs.minio.io](https://docs.minio.io) for step by step guidance on installation and getting started on Minio CLient and Minio Server.
-
-You must first setup the following environment variables with the credentials of your running Minio Server.
-
-```console
-$ export AWS_ACCESS_KEY_ID=<YOUR-MINIO-ACCESS-KEY-ID>
-$ export AWS_SECRET_ACCESS_KEY= <YOUR-MINIO-SECRET-ACCESS-KEY>
-```
-
-Now you can easily initialize restic to use Minio server as backend with this command.
-
-```console
-$ ./restic -r s3:http://localhost:9000/restic init
-enter password for new backend:
-enter password again:
-created restic backend 6ad29560f5 at s3:http://localhost:9000/restic1
-Please note that knowledge of your password is required to access
-the repository. Losing your password means that your data is irrecoverably lost.
-```
-
-# Removing old snapshots
-
-All backup space is finite, so restic allows removing old snapshots. This can
-be done either manually (by specifying a snapshot ID to remove) or by using a
-policy that describes which snapshots to forget. For all remove operations, two
-commands need to be called in sequence: `forget` to remove a snapshot and
-`prune` to actually remove the data that was referenced by the snapshot from
-the repository.
-
-## Remove a single snapshot
-
-The command `snapshots` can be used to list all snapshots in a repository like this:
-
-```console
-$ restic -r /tmp/backup snapshots
-enter password for repository:
-ID        Date                 Host      Tags  Directory
-----------------------------------------------------------------------
-40dc1520  2015-05-08 21:38:30  kasimir         /home/user/work
-79766175  2015-05-08 21:40:19  kasimir         /home/user/work
-bdbd3439  2015-05-08 21:45:17  luigi           /home/art
-590c8fc8  2015-05-08 21:47:38  kazik           /srv
-9f0bc19e  2015-05-08 21:46:11  luigi           /srv
-```
-
-In order to remove the snapshot of `/home/art`, use the `forget` command and
-specify the snapshot ID on the command line:
-
-```console
-$ restic -r /tmp/backup forget bdbd3439
-enter password for repository:
-removed snapshot d3f01f63
-```
-
-Afterwards this snapshot is removed:
-
-```console
-$ restic -r /tmp/backup snapshots
-enter password for repository:
-ID        Date                 Host     Tags  Directory
-----------------------------------------------------------------------
-40dc1520  2015-05-08 21:38:30  kasimir        /home/user/work
-79766175  2015-05-08 21:40:19  kasimir        /home/user/work
-590c8fc8  2015-05-08 21:47:38  kazik          /srv
-9f0bc19e  2015-05-08 21:46:11  luigi          /srv
-```
-
-But the data that was referenced by files in this snapshot is still stored in
-the repository. To cleanup unreferenced data, the `prune` command must be run:
-
-```console
-$ restic -r /tmp/backup prune
-enter password for repository:
-
-counting files in repo
-building new index for repo
-[0:00] 100.00%  22 / 22 files
-repository contains 22 packs (8512 blobs) with 100.092 MiB bytes
-processed 8512 blobs: 0 duplicate blobs, 0B duplicate
-load all snapshots
-find data that is still in use for 1 snapshots
-[0:00] 100.00%  1 / 1 snapshots
-found 8433 of 8512 data blobs still in use
-will rewrite 3 packs
-creating new index
-[0:00] 86.36%  19 / 22 files
-saved new index as 544a5084
-done
-```
-
-Afterwards the repository is smaller.
-
-## Removing snapshots according to a policy
-
-Removing snapshots manually is tedious and error-prone, therefore restic allows
-specifying which snapshots should be removed automatically according to a
-policy. You can specify how many hourly, daily, weekly, monthly and yearly
-snapshots to keep, any other snapshots are removed. The most important
-command-line parameter here is `--dry-run` which instructs restic to not remove
-anything but print which snapshots would be removed.
-
-When `forget` is run with a policy, restic loads the list of all snapshots,
-then groups these by host name and list of directories. The policy is then
-applied to each group of snapshots separately. This is a safety feature.
-
-The `forget` command accepts the following parameters:
-
- * `--keep-last n` never delete the `n` last (most recent) snapshots
- * `--keep-hourly n` for the last `n` hours in which a snapshot was made, keep
-   only the last snapshot for each hour.
- * `--keep-daily n` for the last `n` days which have one or more snapshots, only
-   keep the last one for that day.
- * `--keep-weekly n` for the last `n` weeks which have one or more snapshots, only
-   keep the last one for that week.
- * `--keep-monthly n` for the last `n` months which have one or more snapshots, only
-   keep the last one for that month.
- * `--keep-yearly n` for the last `n` years which have one or more snapshots, only
-   keep the last one for that year.
- * `--keep-tag` keep all snapshots which have all tags specified by this option
-   (can be specified multiple times).
-
-Additionally, you can restrict removing snapshots to those which have a
-particular hostname with the `--hostname` parameter, or tags with the `--tag`
-option. When multiple tags are specified, only the snapshots which have all the
-tags are considered.
-
-All the `--keep-*` options above only count hours/days/weeks/months/years which
-have a snapshot, so those without a snapshot are ignored.
-
-Let's explain this with an example: Suppose you have only made a backup on each
-Sunday for 12 weeks. Then `forget --keep-daily 4` will keep the last four snapshots
-for the last four Sundays, but remove the rest. Only counting the days which
-have a backup and ignore the ones without is a safety feature: it prevents
-restic from removing many snapshots when no new ones are created. If it was
-implemented otherwise, running `forget --keep-daily 4` on a Friday would remove
-all snapshots!
-
-# Debugging restic
-
-The program can be built with debug support like this:
-
-```console
-$ go run build.go -tags debug
-```
-
-Afterwards, extensive debug messages are written to the file in environment
-variable `DEBUG_LOG`, e.g.:
-
-```console
-$ DEBUG_LOG=/tmp/restic-debug.log restic backup ~/work
-```
-
-If you suspect that there is a bug, you can have a look at the debug log.
-Please be aware that the debug log might contain sensitive information such as
-file and directory names.
-
-The debug log will always contain all log messages restic generates. You can
-also instruct restic to print some or all debug messages to stderr. These can
-also be limited to e.g. a list of source files or a list of patterns for
-function names. The patterns are globbing patterns (see the documentation for
-[`path.Glob`](https://golang.org/pkg/path/#Glob)), multiple patterns are
-separated by commas. Patterns are case sensitive.
-
-Printing all log messages to the console can be achieved by setting the file
-filter to `*`:
-
-```console
-$ DEBUG_FILES=* restic check
-```
-
-If you want restic to just print all debug log messages from the files
-`main.go` and `lock.go`, set the environment variable `DEBUG_FILES` like this:
-
-```console
-$ DEBUG_FILES=main.go,lock.go restic check
-```
-
-The following command line instructs restic to only print debug statements
-originating in functions that match the pattern `*unlock*` (case sensitive):
-
-```console
-$ DEBUG_FUNCS=*unlock* restic check
-```
-
-# Under the hood: Browse repository objects
-
-Internally, a repository stores data of several different types described in the [design documentation](https://github.com/restic/restic/blob/master/doc/Design.md). You can `list` objects such as blobs, packs, index, snapshots, keys or locks with the following command:
-
-```console
-$ restic -r /tmp/backup list snapshots
-d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
-```
-
-The `find` command searches for a given
-[pattern](http://golang.org/pkg/path/filepath/#Match) in the repository.
-
-```console
-$ restic -r backup find test.txt
-debug log file restic.log
-debug enabled
-enter password for repository:
-found 1 matching entries in snapshot 196bc5760c909a7681647949e80e5448e276521489558525680acf1bd428af36
-  -rw-r--r--   501    20      5 2015-08-26 14:09:57 +0200 CEST path/to/test.txt
-```
-
-The `cat` command allows you to display the JSON representation of the objects
-or its raw content.
-
-```console
-$ restic -r /tmp/backup cat snapshot d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
-enter password for repository:
-{
-  "time": "2015-08-12T12:52:44.091448856+02:00",
-  "tree": "05cec17e8d3349f402576d02576a2971fc0d9f9776ce2f441c7010849c4ff5af",
-  "paths": [
-    "/home/user/work"
-  ],
-  "hostname": "kasimir",
-  "username": "username",
-  "uid": 501,
-  "gid": 20
-}
-```

doc/PKGBUILD

@@ -1,38 +0,0 @@
-# Maintainer: Florian Daniel <fd@noxa.de>
-# Contributor: Eldar Tsraev <elts@culab.org>
-# Contributor: Andreas Guth <andreas.guth@rwth-aachen.de>
-# Contributor: Alexander Neumann <alexander@bumpern.de>
-options=(!strip)
-pkgname=restic-git
-pkgver=v0.1.0.r172.g1f1b8e1
-pkgrel=1
-pkgdesc="restic is a program that does backups right."
-arch=('i686' 'x86_64')
-url="https://github.com/restic/restic"
-license=('BSD')
-depends=('glibc')
-makedepends=('git' 'go>=1.3')
-provides=('restic')
-conflicts=('restic')
-source=("${pkgname}::git+https://github.com/restic/restic")
-md5sums=('SKIP')
-
-importpath='github.com/restic/restic'
-
-pkgver() {
-  cd "$pkgname"
-  git describe --long | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
-}
-
-build() {
-  cd "$pkgname"
-  go run build.go
-}
-
-package() {
-  install -Dm755 "$pkgname/restic"    "$pkgdir/usr/bin/restic"
-  install -Dm644 "$pkgname/LICENSE"   "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
-  install -Dm644 "$pkgname/README.md" "$pkgdir/usr/share/doc/$pkgname/README"
-}
-
-# vim:set ts=2 sw=2 et:

doc/REST_backend.md

@@ -1,59 +0,0 @@
-REST Backend
-============
-
-Restic can interact with HTTP Backend that respects the following REST API. The
-following values are valid for `{type}`: `data`, `keys`, `locks`, `snapshots`,
-`index`, `config`. `{path}` is a path to the repository, so that multiple
-different repositories can be accessed. The default path is `/`.
-
-## HEAD {path}/config
-
-Returns "200 OK" if the repository has a configuration,
-an HTTP error otherwise.
-
-## GET {path}/config
-
-Returns the content of the configuration file if the repository has a configuration,
-an HTTP error otherwise.
-
-Response format: binary/octet-stream
-
-## POST {path}/config
-
-Returns "200 OK" if the configuration of the request body has been saved,
-an HTTP error otherwise.
-
-## GET {path}/{type}/
-
-Returns a JSON array containing the names of all the blobs stored for a given type.
-
-Response format: JSON
-
-## HEAD {path}/{type}/{name}
-
-Returns "200 OK" if the blob with the given name and type is stored in the repository,
-"404 not found" otherwise. If the blob exists, the HTTP header `Content-Length`
-is set to the file size.
-
-## GET {path}/{type}/{name}
-
-Returns the content of the blob with the given name and type if it is stored in the repository,
-"404 not found" otherwise.
-
-If the request specifies a partial read with a Range header field,
-then the status code of the response is 206 instead of 200
-and the response only contains the specified range.
-
-Response format: binary/octet-stream
-
-## POST {path}/{type}/{name}
-
-Saves the content of the request body as a blob with the given name and type,
-an HTTP error otherwise.
-
-Request format: binary/octet-stream
-
-## DELETE {path}/{type}/{name}
-
-Returns "200 OK" if the blob with the given name and type has been deleted from the repository,
-an HTTP error otherwise.

doc/_static/css/restic.css

@@ -0,0 +1,10 @@
+@import url('theme.css');
+
+.wy-side-nav-search {
+  background-color: #0000b4;
+}
+
+.logo {
+  height: 50% !important;
+  width: 50% !important;
+}

doc/cache.rst

@@ -0,0 +1,26 @@
+Local Cache
+===========
+
+In order to speed up certain operations, restic manages a local cache of data.
+This document describes the data structures for the local cache with version 1.
+
+Versions
+--------
+
+The cache directory is selected according to the `XDG base dir specification
+<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__.
+Each repository has its own cache sub-directory, consting of the repository ID
+which is chosen at ``init``. All cache directories for different repos are
+independent of each other.
+
+The cache dir for a repo contains a file named ``version``, which contains a
+single ASCII integer line that stands for the current version of the cache. If
+a lower version number is found the cache is recreated with the current
+version. If a higher version number is found the cache is ignored and left as
+is.
+
+Snapshots and Indexes
+---------------------
+
+Snapshot, Data and Index files are cached in the sub-directories ``snapshots``,
+``data`` and  ``index``, as read from the repository.

doc/code.css

@@ -1,124 +0,0 @@
-code {
-    font-size: 90%;
-}
-
-/* based on https://github.com/mkdocs/mkdocs/issues/1019 */
-
-.codehilite code, .codehilite pre {
-    color:#3F3F3F;background-color:#F7F7F7;
-    overflow: auto;
-    box-sizing: border-box;
-
-    padding: 0.01em 4px;
-    padding-top: 0.01em;
-    padding-right-value: 4px;
-    padding-bottom: 0.01em;
-    padding-left-value: 4px;
-    padding-left-ltr-source: physical;
-    padding-left-rtl-source: physical;
-    padding-right-ltr-source: physical;
-    padding-right-rtl-source: physical;
-
-    border-radius: 4px !important;
-    border-top-left-radius: 4px;
-    border-top-right-radius: 4px;
-    border-bottom-right-radius: 4px;
-    border-bottom-left-radius: 4px;
-
-    border: 1px solid #CCC !important;
-    border-top-width: 1px;
-    border-right-width-value: 1px;
-    border-right-width-ltr-source: physical;
-    border-right-width-rtl-source: physical;
-    border-bottom-width: 1px;
-    border-left-width-value: 1px;
-    border-left-width-ltr-source: physical;
-    border-left-width-rtl-source: physical;
-    border-top-style: solid;
-    border-right-style-value: solid;
-    border-right-style-ltr-source: physical;
-    border-right-style-rtl-source: physical;
-    border-bottom-style: solid;
-    border-left-style-value: solid;
-    border-left-style-ltr-source: physical;
-    border-left-style-rtl-source: physical;
-    border-top-color: #CCC;
-    border-right-color-value: #CCC;
-    border-right-color-ltr-source: physical;
-    border-right-color-rtl-source: physical;
-    border-bottom-color: #CCC;
-    border-left-color-value: #CCC;
-    border-left-color-ltr-source: physical;
-    border-left-color-rtl-source: physical;
-    -moz-border-top-colors: none;
-    -moz-border-right-colors: none;
-    -moz-border-bottom-colors: none;
-    -moz-border-left-colors: none;
-    border-image-source: none;
-    border-image-slice: 100% 100% 100% 100%;
-    border-image-width: 1 1 1 1;
-    border-image-outset: 0 0 0 0;
-    border-image-repeat: stretch stretch;
-}
-
-.codehilite .hll { background-color: #ffffcc  }
-.codehilite .c { color: #999988; font-style: italic  } /* Comment */
-.codehilite .err { color: #a61717; background-color: #e3d2d2  } /* Error */
-.codehilite .k { color: #000000; font-weight: bold  } /* Keyword */
-.codehilite .o { color: #000000; font-weight: bold  } /* Operator */
-.codehilite .cm { color: #999988; font-style: italic  } /* Comment.Multiline */
-.codehilite .cp { color: #999999; font-weight: bold; font-style: italic  } /* Comment.Preproc */
-.codehilite .c1 { color: #999988; font-style: italic  } /* Comment.Single */
-.codehilite .cs { color: #999999; font-weight: bold; font-style: italic  } /* Comment.Special */
-.codehilite .gd { color: #000000; background-color: #ffdddd  } /* Generic.Deleted */
-.codehilite .ge { color: #000000; font-style: italic  } /* Generic.Emph */
-.codehilite .gr { color: #aa0000  } /* Generic.Error */
-.codehilite .gh { color: #999999  } /* Generic.Heading */
-.codehilite .gi { color: #000000; background-color: #ddffdd  } /* Generic.Inserted */
-.codehilite .go { color: #888888  } /* Generic.Output */
-.codehilite .gp { color: #555555  } /* Generic.Prompt */
-.codehilite .gs { font-weight: bold  } /* Generic.Strong */
-.codehilite .gu { color: #aaaaaa  } /* Generic.Subheading */
-.codehilite .gt { color: #aa0000  } /* Generic.Traceback */
-.codehilite .kc { color: #000000; font-weight: bold  } /* Keyword.Constant */
-.codehilite .kd { color: #000000; font-weight: bold  } /* Keyword.Declaration */
-.codehilite .kn { color: #000000; font-weight: bold  } /* Keyword.Namespace */
-.codehilite .kp { color: #000000; font-weight: bold  } /* Keyword.Pseudo */
-.codehilite .kr { color: #000000; font-weight: bold  } /* Keyword.Reserved */
-.codehilite .kt { color: #445588; font-weight: bold  } /* Keyword.Type */
-.codehilite .m { color: #009999  } /* Literal.Number */
-.codehilite .s { color: #d01040  } /* Literal.String */
-.codehilite .na { color: #008080  } /* Name.Attribute */
-.codehilite .nb { color: #0086B3  } /* Name.Builtin */
-.codehilite .nc { color: #445588; font-weight: bold  } /* Name.Class */
-.codehilite .no { color: #008080  } /* Name.Constant */
-.codehilite .nd { color: #3c5d5d; font-weight: bold  } /* Name.Decorator */
-.codehilite .ni { color: #800080  } /* Name.Entity */
-.codehilite .ne { color: #990000; font-weight: bold  } /* Name.Exception */
-.codehilite .nf { color: #990000; font-weight: bold  } /* Name.Function */
-.codehilite .nl { color: #990000; font-weight: bold  } /* Name.Label */
-.codehilite .nn { color: #555555  } /* Name.Namespace */
-.codehilite .nt { color: #000080  } /* Name.Tag */
-.codehilite .nv { color: #008080  } /* Name.Variable */
-.codehilite .ow { color: #000000; font-weight: bold  } /* Operator.Word */
-.codehilite .w { color: #bbbbbb  } /* Text.Whitespace */
-.codehilite .mf { color: #009999  } /* Literal.Number.Float */
-.codehilite .mh { color: #009999  } /* Literal.Number.Hex */
-.codehilite .mi { color: #009999  } /* Literal.Number.Integer */
-.codehilite .mo { color: #009999  } /* Literal.Number.Oct */
-.codehilite .sb { color: #d01040  } /* Literal.String.Backtick */
-.codehilite .sc { color: #d01040  } /* Literal.String.Char */
-.codehilite .sd { color: #d01040  } /* Literal.String.Doc */
-.codehilite .s2 { color: #d01040  } /* Literal.String.Double */
-.codehilite .se { color: #d01040  } /* Literal.String.Escape */
-.codehilite .sh { color: #d01040  } /* Literal.String.Heredoc */
-.codehilite .si { color: #d01040  } /* Literal.String.Interpol */
-.codehilite .sx { color: #d01040  } /* Literal.String.Other */
-.codehilite .sr { color: #009926  } /* Literal.String.Regex */
-.codehilite .s1 { color: #d01040  } /* Literal.String.Single */
-.codehilite .ss { color: #990073  } /* Literal.String.Symbol */
-.codehilite .bp { color: #999999  } /* Name.Builtin.Pseudo */
-.codehilite .vc { color: #008080  } /* Name.Variable.Class */
-.codehilite .vg { color: #008080  } /* Name.Variable.Global */
-.codehilite .vi { color: #008080  } /* Name.Variable.Instance */
-.codehilite .il { color: #009999  } /* Literal.Number.Integer.Long */

doc/conf.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# restic documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr 14 22:44:43 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+import os
+
+# -- General configuration ------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.extlinks']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'restic'
+copyright = '2017, restic authors'
+author = 'fd0'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+
+# read version from ../VERSION
+version = open('../VERSION').readlines()[0]
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+if os.environ.get('READTHEDOCS') == 'True':
+    html_context = {
+        'css_files': [
+            'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
+            'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
+            '_static/css/restic.css',
+        ]
+    }
+else:
+    # we're not built by rtd => add rtd-theme
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    html_style = 'css/restic.css'
+
+html_logo = 'logo/logo.png'
+
+html_favicon = '_static/favicon.ico'
+
+html_show_version = False
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'resticdoc'
+
+extlinks = {
+    'issue': ('https://github.com/restic/restic/issues/%s', '#'),
+}

doc/faq.rst

@@ -0,0 +1,117 @@
+FAQ
+===
+
+This is the list of Frequently Asked Questions for restic.
+
+``restic check`` reports packs that aren't referenced in any index, is my repository broken?
+--------------------------------------------------------------------------------------------
+
+When ``restic check`` reports that there are pack files in the
+repository that are not referenced in any index, that's (in contrast to
+what restic reports at the moment) not a source for concern. The output
+looks like this:
+
+::
+
+    $ restic check
+    Create exclusive lock for repository
+    Load indexes
+    Check all packs
+    pack 819a9a52e4f51230afa89aefbf90df37fb70996337ae57e6f7a822959206a85e: not referenced in any index
+    pack de299e69fb075354a3775b6b045d152387201f1cdc229c31d1caa34c3b340141: not referenced in any index
+    Check snapshots, trees and blobs
+    Fatal: repository contains errors
+
+The message means that there is more data stored in the repo than
+strictly necessary. With high probability this is duplicate data. In
+order to clean it up, the command ``restic prune`` can be used. The
+cause of this bug is not yet known.
+
+How can I specify encryption passwords automatically?
+-----------------------------------------------------
+
+When you run ``restic backup``, you need to enter the passphrase on
+the console. This is not very convenient for automated backups, so you
+can also provide the password through the ``--password-file`` option, or one of
+the environment variables ``RESTIC_PASSWORD`` or ``RESTIC_PASSWORD_FILE``.
+A discussion is in progress over implementing unattended backups happens in
+:issue:`533`.
+
+.. important:: Be careful how you set the environment; using the env
+               command, a `system()` call or using inline shell
+               scripts (e.g. `RESTIC_PASSWORD=password restic ...`)
+               might expose the credentials in the process list
+               directly and they will be readable to all users on a
+               system. Using export in a shell script file should be
+               safe, however, as the environment of a process is
+               `accessible only to that user`_. Please make sure that
+               the permissions on the files where the password is
+               eventually stored are safe (e.g. `0600` and owned by
+               root).
+
+.. _accessible only to that user: https://security.stackexchange.com/questions/14000/environment-variable-accessibility-in-linux/14009#14009
+
+How to prioritize restic's IO and CPU time
+------------------------------------------
+
+If you'd like to change the **IO priority** of restic, run it in the following way
+
+::
+
+$ ionice -c2 -n0 ./restic -r /media/your/backup/ backup /home
+
+This runs ``restic`` in the so-called best *effort class* (``-c2``),
+with the highest possible priority (``-n0``).
+
+Take a look at the `ionice manpage`_ to learn about the other classes.
+
+.. _ionice manpage: https://linux.die.net/man/1/ionice
+
+
+To change the **CPU scheduling priority** to a higher-than-standard
+value, use would run:
+
+::
+
+$ nice --10 ./restic -r /media/your/backup/ backup /home
+
+Again, the `nice manpage`_ has more information.
+
+.. _nice manpage: https://linux.die.net/man/1/nice
+
+You can also **combine IO and CPU scheduling priority**:
+
+::
+
+$ ionice -c2 nice -n19 ./restic -r /media/gour/backup/ backup /home
+
+This example puts restic in the IO class 2 (best effort) and tells the CPU
+scheduling algorithm to give it the least favorable niceness (19).
+
+The above example makes sure that the system the backup runs on
+is not slowed down, which is particularly useful for servers.
+
+Creating new repo on a Synology NAS via sftp fails
+--------------------------------------------------
+
+Sometimes creating a new restic repository on a Synology NAS via sftp fails
+with an error similar to the following:
+
+::
+
+    $ restic init -r sftp:user@nas:/volume1/restic-repo init
+    create backend at sftp:user@nas:/volume1/restic-repo/ failed:
+        mkdirAll(/volume1/restic-repo/index): unable to create directories: [...]
+
+Although you can log into the NAS via SSH and see that the directory structure
+is there.
+
+The reason for this behavior is that apparently Synology NAS expose a different
+directory structure via sftp, so the path that needs to be specified is
+different than the directory structure on the device and maybe even as exposed
+via other protocols.
+
+The following may work:
+
+::
+    $ restic init -r sftp:user@nas:/restic-repo init