Fast, secure, efficient backup program
Go to file
Alexander Neumann 662e07d17a Refactor crypto layer, switch HMAC for Poyl1305-AES
HMAC-SHA256 calls SHA256() twice which is very expensive. Therefore,
this commit uses Poly1305-AES instead of HMAC-SHA256.

benchcmp:

     benchmark                         old ns/op      new ns/op      delta
     BenchmarkChunkEncrypt             261033772      195114818      -25.25%
     BenchmarkChunkEncryptParallel     260973195      195787368      -24.98%
     BenchmarkArchiveDirectory         1050500651     1002615884     -4.56%
     BenchmarkPreload                  23544286       24994508       +6.16%
     BenchmarkLoadTree                 350065         427665         +22.17%
     BenchmarkEncryptWriter            87789753       31069126       -64.61%
     BenchmarkEncrypt                  88283197       38259043       -56.66%
     BenchmarkDecryptReader            90478843       40714818       -55.00%
     BenchmarkEncryptDecryptReader     179917626      81231730       -54.85%
     BenchmarkDecrypt                  87871591       37784207       -57.00%
     BenchmarkSaveJSON                 52481          56861          +8.35%
     BenchmarkSaveFrom                 75404085       51108596       -32.22%
     BenchmarkLoadJSONID               90545437       82696805       -8.67%

     benchmark                         old MB/s     new MB/s     speedup
     BenchmarkChunkEncrypt             40.17        53.74        1.34x
     BenchmarkChunkEncryptParallel     40.18        53.56        1.33x
     BenchmarkEncryptWriter            95.55        270.00       2.83x
     BenchmarkEncrypt                  95.02        219.26       2.31x
     BenchmarkDecryptReader            92.71        206.03       2.22x
     BenchmarkEncryptDecryptReader     46.62        103.27       2.22x
     BenchmarkDecrypt                  95.46        222.01       2.33x
     BenchmarkSaveFrom                 55.62        82.07        1.48x

     benchmark                         old allocs     new allocs     delta
     BenchmarkChunkEncrypt             112            110            -1.79%
     BenchmarkChunkEncryptParallel     103            100            -2.91%
     BenchmarkArchiveDirectory         383704         392083         +2.18%
     BenchmarkPreload                  21765          21874          +0.50%
     BenchmarkLoadTree                 341            436            +27.86%
     BenchmarkEncryptWriter            20             17             -15.00%
     BenchmarkEncrypt                  14             13             -7.14%
     BenchmarkDecryptReader            18             15             -16.67%
     BenchmarkEncryptDecryptReader     46             39             -15.22%
     BenchmarkDecrypt                  16             12             -25.00%
     BenchmarkSaveJSON                 81             86             +6.17%
     BenchmarkSaveFrom                 117            121            +3.42%
     BenchmarkLoadJSONID               80525          80264          -0.32%

     benchmark                         old bytes     new bytes     delta
     BenchmarkChunkEncrypt             118956        64697         -45.61%
     BenchmarkChunkEncryptParallel     118972        64681         -45.63%
     BenchmarkArchiveDirectory         160236600     177498232     +10.77%
     BenchmarkPreload                  2772488       3302992       +19.13%
     BenchmarkLoadTree                 49102         46484         -5.33%
     BenchmarkEncryptWriter            28927         8388146       +28897.64%
     BenchmarkEncrypt                  2473          1950          -21.15%
     BenchmarkDecryptReader            527827        2774          -99.47%
     BenchmarkEncryptDecryptReader     4100875       1528036       -62.74%
     BenchmarkDecrypt                  2509          2154          -14.15%
     BenchmarkSaveJSON                 4971          5892          +18.53%
     BenchmarkSaveFrom                 40117         31742         -20.88%
     BenchmarkLoadJSONID               9444217       9442106       -0.02%

This closes #102.
2015-03-14 20:00:41 +01:00
backend Set file-mode in repository read-only (Closes #48) 2015-03-14 14:30:26 +01:00
chunker Slightly improve performance for chunker 2015-02-13 20:03:40 +01:00
cmd Refactor cache and 'cache' command 2015-03-14 12:57:29 +01:00
debug debug: do not seek after creating log file 2015-02-08 14:46:29 +01:00
doc Remove zlib compression 2015-03-02 10:02:55 +01:00
pipe Remove code duplication 2015-03-08 21:06:51 +01:00
testsuite Re-enable dedup, add test (closes #95) 2015-03-07 12:05:33 +01:00
.travis.yml Try different spelling of 'go' 2015-03-14 15:38:59 +01:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile Refactor testsuite 2015-01-17 16:32:24 +01:00
README.md Exchange build-status icon 2015-03-14 13:23:44 +01:00
archiver.go Recreate blob cache if missing (closes #104) 2015-03-14 18:15:47 +01:00
archiver_int_test.go Fix comparison for new files with '.' 2015-03-10 14:17:50 +01:00
archiver_test.go Fix counting for tests for Preload 2015-03-10 15:58:23 +01:00
blob.go Implement streaming chunker using io.Reader 2015-02-09 00:28:54 +01:00
cache.go Recreate blob cache if missing (closes #104) 2015-03-14 18:15:47 +01:00
cache_darwin.go Fix darwin support 2015-03-08 14:32:49 +01:00
cache_linux.go Add local cache 2015-03-02 10:04:01 +01:00
cache_test.go Recreate blob cache if missing (closes #104) 2015-03-14 18:15:47 +01:00
crypto.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
crypto_int_test.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
crypto_test.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
generic_test.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00
key.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
key_test.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
map.go Recreate blob cache if missing (closes #104) 2015-03-14 18:15:47 +01:00
map_test.go Refactor repository structure 2015-01-14 16:34:30 +01:00
node.go Refactor backup pipeline 2015-03-08 14:16:01 +01:00
node_darwin.go Fix darwin support 2015-03-08 14:32:49 +01:00
node_linux.go Refactor backup pipeline 2015-03-08 14:16:01 +01:00
node_windows.go Move platform specific code to different files 2015-02-03 21:18:19 +01:00
pools.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
progress.go Add progress report for loading blobs 2015-02-21 15:32:48 +01:00
restorer.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
server.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
server_test.go Add test for incremental backup 2015-03-10 14:17:54 +01:00
snapshot.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
snapshot_darwin.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
snapshot_linux.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
snapshot_test.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
snapshot_windows.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
testsuite.sh wip 2015-02-15 15:17:24 +01:00
tree.go Remove unused code 2015-03-08 14:22:35 +01:00
tree_test.go Allow configuring temp dir for tests 2015-02-21 16:53:14 +01:00
walk.go Remove extra argument 2015-03-08 21:21:31 +01:00
walk_test.go Refactor backup pipeline 2015-03-08 14:16:01 +01:00
zerrors_linux.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00

README.md

Stories in Ready Build Status sourcegraph status

WARNING

WARNING: At the moment, consider restic as alpha quality software, it is not yet finished. Do not use it for real data!

Restic

Restic is a program that does backups right. The design goals are:

  • Easy: Doing backups should be a frictionless process, otherwise you are tempted to skip it. Restic should be easy to configure and use, so that in the unlikely 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 harddisk 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 backend to save precious backup space.

Building

Install Go (at least 1.3), then run:

export GOPATH=~/src/go
go get github.com/restic/restic/cmd/restic
$GOPATH/bin/restic --help

Contribute

Contributions are welcome! Please make sure that all code submitted in pull-requests is properly formatted with gofmt. Installing the script fmt-check from https://github.com/edsrzf/gofmt-git-hook locally as a pre-commit hook checks formatting before commiting, just copy this script to .git/hooks/pre-commit.

If you are unsure what to do, please have a look at the github issues, especially those tagged minor complexity.

Contact

If you discover a bug or find something surprising, please feel free to open a github issue. If you would like to chat about restic, there is also the IRC channel #restic on irc.freenode.net. Or just write me an email :)

License

Restic is licensed under "BSD 2-Clause License". You can find the complete text in the file LICENSE.