You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Nikita Sobolev c328723f2b Removes duplicate `git version`, closes #177 [ci skip]		6 years ago
.Dockerfiles	Fixing issues with docker 17.07 ce and systemd	7 years ago
.ci	Merge branch 'small-fixes' of github.com:joshrabinowitz/git-secret into small-fixes	6 years ago
.github	Removes duplicate `git version`, closes #177 [ci skip]	6 years ago
man	fix typo and update man pages	6 years ago
src	fix	6 years ago
tests	fixes for git secret changes (#160 )	6 years ago
utils	typos fixed	6 years ago
.editorconfig	fixes after makefile crash	8 years ago
.gitattributes	fixes after makefile crash	8 years ago
.gitignore	Updating ignore files	7 years ago
.kitchen.yml	use ansible version 2.5.0	6 years ago
.travis.yml	fix	6 years ago
CHANGELOG.md	update CHANGELOG	6 years ago
CONTRIBUTING.md	Updated CONTRIBUTING.md (optional)	6 years ago
Gemfile	Add local ci tests.	7 years ago
LICENSE.md	CONTRIBUTING.md added	8 years ago
Makefile	Fix install-fpm target, typo in apk	7 years ago
README.md	improve text and break long lines	6 years ago
git-secret.plugin.zsh	Adds fixes to subdirectories bug.	7 years ago

README.md

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 users whom you trust using gpg, allowing permitted users to access encrypted data using their secret keys. With git-secret, changes to access rights are made easy and private-public key issues are handled for you. Passwords do not need to be changed with git-secret when someone's permission is revoked - just remove their key from the keychain using git secret killperson their@email.com, and 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