diff options
author | Joey Hess <joeyh@joeyh.name> | 2017-02-24 13:41:29 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2017-02-24 13:41:29 -0400 |
commit | d884cdfbed61fa451c54562711ab5a12f41a7f7a (patch) | |
tree | 0bc5abf072bc945c849d4de898ac0dd6eadbc2c5 /doc/backends.mdwn | |
parent | d79fc1fc6fc5b8f3c0f60e1cba37c984bc5af901 (diff) |
pointer to a todo
Diffstat (limited to 'doc/backends.mdwn')
-rw-r--r-- | doc/backends.mdwn | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/backends.mdwn b/doc/backends.mdwn index d26cadce5..f69f655d6 100644 --- a/doc/backends.mdwn +++ b/doc/backends.mdwn @@ -3,7 +3,9 @@ The file checked into git symlinks to the key. This key can later be used to retrieve the file's content (its value). Multiple pluggable key-value backends are supported, and a single repository -can use different ones for different files. +can use different ones for different files. + +These are the recommended backends to use. * `SHA256E` -- The default backend for new files, combines a 256 bit SHA-2 hash of the file's content with the file's extension. This allows @@ -20,6 +22,10 @@ can use different ones for different files. * `SKEIN512`, `SKEIN512E`, `SKEIN256`, `SKEIN256E` -- [Skein hash](http://en.wikipedia.org/wiki/Skein_hash), a well-regarded SHA3 hash competition finalist. + +The backends below do not guarantee cryptographically that the +content of an annexed file remains unchanged. + * `SHA1`, `SHA1E`, `MD5`, `MD5E` -- Smaller hashes than `SHA256` for those who want a checksum but are not concerned about security. * `WORM` ("Write Once, Read Many") -- This assumes that any file with @@ -30,6 +36,11 @@ can use different ones for different files. It's generated when using eg, `git annex addurl --fast`, when the file content is not available for hashing. +If you want to be able to prove that you're working with the same file +contents that were checked into a repository earlier, you should avoid +using the non-cryptographically-secure backends, and will need to use +signed git commits. See [[tips/using_signed_git_commits]] for details. + Note that the various 512 and 384 length hashes result in long paths, which are known to not work on Windows. If interoperability on Windows is a concern, avoid those. |