Add `del-gpg-user` to delete (and re-encrypt) repository
reedloden opened this issue · 36 comments
Need to be able to remove a GPG key for a user and then re-encrypt the repository. Obviously, the user would be able to decrypt old revisions but any new revisions would not be encrypted with the user's key.
This is definitely an issue that should also be addressed in the documentation - for security to be meaningful it is important for end-users to fully understand the security implications of the use of a tool - and even if there is a del-gpg-user subcommand that re-encrypts the repository, end users need to understand that they need to revoke and regenerate any credentials that were (ever) stored in the repository - and that is something that git-crypt cannot implement itself as revocation/regeneration is entirely outside the Git ecosystem.
Something that del-gpg-user could do to "help" or "encourage" such revocation/regeneration would be to replace all encrypted files with empty ones, but the implications of that need to be examined as it might just make things more confusing for less experienced users.
Perhaps rather than (or as a simpler step before) adding del-gpg-user a better approach might be to add a re-init command that just does the regeneration of encryption key (with optional removal of encrypted files and/or their contents).
Anyhow, I've no experience with Go, but can probably contribute to the documentation a section on the implications of putting credentials or other types of secrets in a git-crypt-enabled repository, and what revocation of access may mean - I'll look at what I could do and try to submit a PR with an outline sometime next week.
This issue has been on my radar for a while. It's surprisingly complicated, because you have to rotate git-crypt's internal symmetric key and re-encrypt all files with the new symmetric key, in order to preserve confidentiality of future commits. To avoid breaking history, you have to keep around the old versions of the key and use them when dealing with old commits. Fortunately, git-crypt already has the framework for this - it just needs to be wired up, and tested extensively. I suspect that there will be big problems with merging if the key has been rotated on one branch of the merge. So, a lot of the work will be testing how key rotation interacts with various other Git operations. Fortunately, that's something anyone can help with, without having to do any coding.
@dupey you are correct about credentials protected by git-crypt needing to be rotated too, but that's definitely outside the domain of git-crypt, and I don't like the idea of git-crypt automatically truncating files. A discussion in the documentation would definitely be warranted though. Thanks for offering to help with this.
👍
👍
Just curious - what are the use cases people have in mind for this feature? I had convinced myself I needed it if I wanted to revoke access from a former employee, but after thinking some more, I don't actually need it. In my situation github's access controls + secret rotation are sufficient.
@redterror git-crypt supports two forms of encryption -- symmetric key and GPG. In the former case (which it sounds like you use), rotation of the key is all you can do. In the latter, you need to be able to remove a user's GPG public key and re-encrypt the entire repository. The user would be able to access old copies of the repository that were encrypted with his/her public key, but any new changes would not be encrypted with his/her GPG public key, so they would be inaccessible.
@reedloden Technically, a symmetric key is used for encryption of files in every case - it is just that in the second case the symmetric key itself is encrypted with one or more GPG keys and those copies of the encrypted key are committed to the repository, allowing a user whose GPG key was "added" to decrypt the encrypted contents in the repository using nothing more than their private key and the repository itself.
@dupuy - I'm with you on all that, what I was suggesting was that the use-case of a privileged user that becomes unprivileged but still retains repo access at all may be uncommon. In my case removing access at the github level solves the problem entirely.
I get that this is useful out of completeness, it just seems like a scenario that folks may think they need but actually don't. I don't know really know, I'm just suggesting that this may not be all that important in real deployments.
With the thoughts in #23 (comment) , I'd like to make a step forward with further progressing git-crypt, by making it be fair about its deficiencies: #72
This would be a nice feature. I had to jump through some interesting hoops to re-initialize the repo after a coworker left. For my use case, I don't really care about history; the value of the old database password isn't exactly useful.
So here's what I did to re-encrypt files to remove a user:
- Make a backup (with decrypted files):
cp -r . /path/to/backup - Save a list of files that are encrypted:
git crypt status | grep -v 'not encrypted' > ../encrypted-files.txt - Make git-crypt forget about itself:
rm .git-crypt - Delete the encrypted files:
awk '{print $2}' ../encrypted-files.txt | xargs rm - Commit (at this point you get a repo without git-crypt stuff)
- Add git-crypt from scratch (init and add-gpg-user)
- Copy the decrypted files from the backup:
awk '{print $2}' ../encrypted-files.txt | while read l; do cp /path/to/backup/$l $l; done - Commit (at this point you are done, but be sure to verify things are properly encrypted before publishing)
Hope that help until we get there 😅
I have a suggestion for the implementation that may work.
- Each encrypted file would include the encryption key name in its header metadata.
git-crypt unlockwould be able to load multiple git-crypt secret keys into.git/git-crypt/keys.git-cryptwould use the right key to decrypt each file automatically based on the header metadata..gitattributeswould be checked only for encryption rules, but not for decryption anymore.
It might be possible to use the existing support for multiple keys to achieve the desired user access revocation (for the future commits only of course).
Consider the following steps:
- Create new key:
git-crypt init -k A. - Add all users except the one to remove to the new key:
git-crypt add-gpg-user -k A user. - Swap the new key A with the default key.
All new or updated files would be encrypted with the new default key.
All old files would be decrypted with the old key.
Would this work?
Based on phunehehe's comment I hacked together a script to get the job done. You can find it here https://gist.github.com/glogiotatidis/e0ab45ed5575a9d7973390dace0552b0
Any updates on this?
Any thoughts on using the oft-misunderstood-and-avoided-but-very-powerful-and-actually-not-scary-at-all feature git rebase for when a user is removed?
I'd like to poke the proverbial bear.
Bump. 😈
For some odd reason, I now need this feature. 😛
Halp!
Bump
I wrote a bash script that will rekey the repo on-demand using a remote list of users (currently, JSON in S3).
Use git-crypt-team -e to edit the user file and upload it to S3. It should be formatted like [{"key": "KEYID123", ...}, ...]. You can include any additional attributes with each key, but only key is required. Then run git-crypt-team -r to re-encrypt everything using the current team list in S3.
The script will take care of getting GPG keys from public sources, signing them, backing up and restoring encrypted files, plus all of the cleanup, init, and git work required. It even does it all in a branch, if things go wrong just run git reset --hard HEAD && git checkout master.
I also need this feature - be able to revoke access to encrypted files.
Another thing which is not quite clear to me is how to get the list already added users ? so that we know which GPG key to delete ...
So, what is the best approach ? Use symmetric key and rotate?
I am also interested in what the recommended approach is.
I have seen this gist from @glogiotatidis do we have another approach to remove GPG key added ?
I have seen this gist from @glogiotatidis do we have another approach to remove GPG key added ?
slightly off-topic but since i'm mentioned: For new repos we have experimenting with keybase's encrypted git and teams and so far works OK.
@glogiotatidis thanks for the feedback
I found simpler way to rotate the key. Simpler as in "closer to the basics" :).
- Unlock the repository (
git-crypt unlock). - Replace
.git/git-crypt/keys/default(see below). - At this moment Git will show that your encrypted files are modified.
- Remove
.git-crypt/keys/default/0/*.gpg. - Add new users in the normal way (
git-crypt add-gpg-user ...). - Commit these changes (prefer to amend the commit made by
git-crypt add-gpg-user ...)
About .git/git-crypt/keys/default:
This is the key used by git-crypt to encrypt files. This file only exist after you execute git-crypt unlock. This file is secret! This file is also encrypted for each user as .git-crypt/keys/default/0/*.gpg and commited to the Git history. You can compare git/git-crypt/keys/default and .git-crypt/keys/default/0/<you-gpg-key>.gpg (with gpg -d ...).
How to get a new .git/git-crypt/keys/default? When the repository is locked, execute git-crypt init and save the new key somewhere (otherwise it will be overwritten on git-crypt unlock) :)
P. S. Or better use another empty repository for a new encryption key.
FWIW, I found a procedure to rotate the symmetric key that doesn't need poking at hidden git-crypt dependent files:
- Delete .gitattributes files. This will unencrypt your secrets.
- Stash the changes (to store the unencrypted secrets locally)
- Delete .gitattributes and all your secrets files.
- Commit. (operation 2+3 are so as you don't have to commit any plaintext secrets)
- do 'git-crypt lock' which in this instance just throws away your key
- do 'git-crypt init' to create a new key.
- Unstash the stashed files and recreate .gitattributes
- commit
Note that collaborators need to do 'git-crypt lock' before pulling the new changes in order to throw away the old key and work with just text files in plain git mode (although the secrets are encrypted still).
After updating, just git-crypt unlock with the new key.
I reworked a little the script made by @glogiotatidis from the initial proposal of @phunehehe (for endling the case of absence of encrypted files, expired keys etc.). The resulting extended version is available on https://gist.github.com/Falkor/7b29f16f5f79404fe41476be0d992783
I rework @Falkor rework to make the script safer, compliant with shellcheck:
https://gist.github.com/thomsh/ed14fa82cf43a6b283c1eea9574fb76e
Note that @Falkor version works on my simple repository, few files, no space or special char in filenames
[Reminder]: As said previously a couple of times, this script only rotate key for future commit, git history is not rewritten at all.
If you protect few secret in your repository, change them after rotating the git-crypt key
I created a script that only updates the key and the encrypted files. This should be used after removing 1 or more collaborators gpg files.
https://gist.github.com/bartv2/7e1c127d6af397bc0e4da6d11fb7ea6c
Hey, thank you all for the hints.
I was needed to migrate repository using multiple keys, so I went my own way and fully replaced git-crypt configuration:
# Make a branch for these changes
git checkout -b fix-git-crypt
# Unlock repo and preserve all the secrets into unencrypted-secrets directory
git-crypt unlock
mkdir -p unencrypted-secrets
git-crypt status -e | while read s f; do
mkdir -p "unencrypted-secrets/$(dirname "$f")"
cp -a "$f" "unencrypted-secrets/$f"
done
# Lock repo and remove all the secrets and git-crypt configuration
git-crypt lock
git-crypt status -e | while read s f; do
git rm "$f"
done
git rm -r .git-crypt/
rm -rf .git/git-crypt
git commit -m "cleanup old secrets"
# Setup new git-crypt configuration
git crypt init
gir-crypt add-gpg-user ...
gir-crypt add-gpg-user ...
gir-crypt add-gpg-user ...
# Move secrets back in places
cp -r unencrypted-secrets/* .
git add .
git rm -rf unencrypted-secrets
git commit -m "add new secrets"
# Lock repo and checkout to the previous branch
git-crypt lock -a
git checkout -
# Squash and merge our branch
git merge -X theirs --squash fix-git-crypt
git commitI hope someone will find these steps useful.
FYI: I've updated git-crypt-rm-gpg-user.sh to support multiple git-crypt keys
Any progress on this @AGWA? In the meantime, are the comments from #47 (comment) and #47 (comment) the recommended best practice?
I am so confused!
To avoid multiple commits and moved around or temporally removed files the following worked for me:
- clean checkout and unlock repo (
git-crypt unlock) - remove current key(s) (
rm -vr .git-crypt/keys .git/git-crypt) - re-init key(s) (
git-crypt init [-k KEYNAME]) - reencrypt files by removing them (only from the index) and re-adding them
git-crypt status -e | sed -E 's/^\s+encrypted: //' | while read -r FILE ; do git rm --cached $FILE ; git add $FILE ; done - re-add remaining gpg user(s) (
git-crypt add-gpg-user -n [-k KEYNAME] KEYID) - stage all changes (
git add .) - commit changes (
git -c commit.verbose=false commit) - verify commit and git push