|
|
# git-secret
|
|
|
|
|
|
[](#backers) [](#sponsors) [](https://travis-ci.org/sobolevn/git-secret) [](http://braumeister.org/formula/git-secret) [](https://bintray.com/sobolevn/deb/git-secret/view)
|
|
|
|
|
|
[](http://git-secret.io/)
|
|
|
|
|
|
|
|
|
## What is `git-secret`?
|
|
|
|
|
|
`git-secret` is a bash tool to store your private data inside a git repo. How’s that? Basically, it just encrypts, using `gpg`, the tracked files with the public keys of all the users that you trust. So everyone of them can decrypt these files using only their personal secret key. Why deal with all this private-public keys stuff? Well, to make it easier for everyone to manage access rights. There are no passwords that change. When someone is out - just delete their public key, re-encrypt the files, and they won’t be able to decrypt secrets anymore.
|
|
|
|
|
|
|
|
|
## Preview
|
|
|
|
|
|
[](https://asciinema.org/a/41811?autoplay=1)
|
|
|
|
|
|
|
|
|
## 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](http://git-secret.io/installation) 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](https://github.com/sobolevn/git-secret/issues) and send a PR. It is more than welcomed! See [CONTRIBUTING.md](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`
|
|
|
|
|
|
|
|
|
## Changelog
|
|
|
|
|
|
`git-secret` uses semver. See [CHANGELOG.md](CHANGELOG.md).
|
|
|
|
|
|
|
|
|
## Contributors
|
|
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
|
<a href="graphs/contributors"><img src="https://opencollective.com/git-secret/contributors.svg?width=890" /></a>
|
|
|
|
|
|
|
|
|
## Backers
|
|
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-secret#backer)]
|
|
|
|
|
|
<a href="https://opencollective.com/git-secret#backers" target="_blank"><img src="https://opencollective.com/git-secret/backers.svg?width=890"></a>
|
|
|
|
|
|
|
|
|
## Sponsors
|
|
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-secret#sponsor)]
|
|
|
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/0/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/1/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/2/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/3/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/4/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/5/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/6/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/7/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/8/avatar.svg"></a>
|
|
|
<a href="https://opencollective.com/git-secret/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-secret/sponsor/9/avatar.svg"></a>
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
MIT. See [LICENSE.md](LICENSE.md) for details.
|
|
|
|
|
|
|
|
|
## Thanks
|
|
|
|
|
|
Special thanks to [Elio Qoshi](https://elioqoshi.me/sq/) from [ura](http://ura.design/) for the awesome logo.
|