mirror of https://github.com/sobolevn/git-secret synced 2024-11-08 19:10:31 +00:00

Made the description more formal and emphasize on the name of the product, git-secret.

2018-03-27 19:26:57 -07:00

5.2 KiB

Raw Blame History

git-secret

What is `git-secret`?

git-secret is a bash tool which stores private data inside a git repo. git-secret encrypts tracked files with public keys for all users whom you trust using gpg. Therefore, everyone has access to these tracked files using only their personal secret key. With git-secret changes to access rights is made easy and private-public key issues are avoided. Passwords do not needed changing with git-secret and when someone is out - just delete their public key, re-encrypt the files, and they won’t be able to decrypt secrets anymore.

Preview

Installation

git-secret supports brew, just type: brew install git-secret

It also supports apt and yum. You can also use make if you want to. See the installation section for the details.

Requirements

git-secret relies on several external packages:

bash since 3.2.57 (it is hard to tell the correct patch release)
gawk since 4.0.2
git since 1.8.3.1
gpg since gnupg 1.4 to gnupg 2.X
sha256sum since 8.21

Contributing

Do you want to help the project? Find an issue and send a PR. It is more than welcomed! See CONTRIBUTING.md on how to do that.

Security

In order to encrypt (git-secret hide -m) files only when modified, the path mappings file tracks sha256sum checksums of the files added (git-secret add) to git-secret's path mappings filesystem database. Although, the chances of encountering a sha collision are low, it is recommend that you pad files with random data for greater security. Or avoid using the -m option altogether. If your secret file holds more data than just a single password these precautions should not be necessary, but could be followed for greater security.

If you found any security related issues, please do not enclose it in public. Send an email to security@wemake.services