mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

expand encryption warning

Browse source
This commit is contained in:
Joey Hess 2019-08-05 10:43:51 -04:00
parent 922434bccc
commit 87e9ed38b8
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/special_remotes/git-lfs.mdwn
View file

@ -19,7 +19,7 @@ the git-lfs special remote:
at different times as long as they point to the same git-lfs repository. at different times as long as they point to the same git-lfs repository.
* `encryption` - One of "none", "hybrid", "shared", or "pubkey". * `encryption` - One of "none", "hybrid", "shared", or "pubkey".
Required. See [[encryption]]. Required. See [[encryption]]. Also see the encryption notes below.
* `keyid` - Specifies the gpg key to use for encryption of both the files * `keyid` - Specifies the gpg key to use for encryption of both the files
git-annex stores in the repository, as well as to encrypt the git git-annex stores in the repository, as well as to encrypt the git
@ -36,14 +36,19 @@ other backend, git-annex has to additionally store the SHA256 checksum
into the git-annex branch when storing content in git-lfs. That adds a into the git-annex branch when storing content in git-lfs. That adds a
small bit of size overhead to using this remote. small bit of size overhead to using this remote.
When encrypting data sent to the git-lfs remote, git-annex always has to
store its SHA256 checksum in the git-annex branch.
## encryption notes ## encryption notes
The encryption= parameter only makes git-annex encrypt data stored on the The encryption= parameter only makes git-annex encrypt data stored on the
remote, `git push` can also be used with the remote (it is a git repository remote. `git push` can also be used with the remote (it is a git repository
after all), and data pushed to it with git will *not* be encrypted. after all), and data pushed to it with git will *not* be encrypted.
When encrypting data sent to the git-lfs remote, git-annex always has to This makes using encryption=shared with a git-lfs special remote very
store its SHA256 checksum in the git-annex branch. unlikely to be secure, because the encryption key is committed to the git
repository. It would only make sense if you never pushed it to the
remote, or trusted the remote's host to keep it secure.
## limitations ## limitations