git-secret - bash tool to store private data inside a git repo.
Usage: Setting up git-secret in a repository
These steps cover the basic process of using
Before starting, make sure you have created a
gpgRSA key-pair: a public and a secret key identified by your email address.
Begin with an existing or new git repository. You’ll use the
git-secretcommands to add the keyrings and information to make
git-secrethide and reveal files in this repository.
git-secretrepository by running
git secret initcommand. The
.gitsecret/folder will be created. Note all the contents of the
.gitsecret/folder should be checked in, /except/ the
random_seedfile. In other words, of all the files in
.gitsecret/, only the
random_seedfile should be mentioned in your
.gitignorefile. By default,
git secret initwill add the file
Add the first user to the
git-secretrepo keyring by running
git secret tell firstname.lastname@example.org.
Now it’s time to add files you wish to encrypt inside the
git-secretrepository. This can be done by running
git secret add <filenames...>command. Make sure these files are ignored by mentions in
git-secretwon’t allow you to add them, as these files could be stored unencrypted. In the default configuration,
git-secret addwill automatically add the unencrypted versions of the files to
When done, run
git secret hideto encrypt all files which you have added by the
git secret addcommand. The data will be encrypted with the public-keys described by the
git secret tellcommand. After using
git secret hideto encrypt your data, it is safe to commit your changes. NOTE: It’s recommended to add the
git secret hidecommand to your
pre-commithook, so you won’t miss any changes.
Later you can decrypt files with the
git secret revealcommand, or just print their contents to stdout with the
git secret catcommand. If you used a password on your GPG key (always recommended), it will ask you for your password. And you’re done!
Usage: Adding someone to a repository using git-secret
gpgpublic-key. You won’t need their secret key.
Import this key into your
~/.gnupgor similar) by running
gpg --import KEY_NAME.txt
Now add this person to your secrets repo by running
git secret tell email@example.com(this will be the email address associated with the public key)
The newly added user cannot yet read the encrypted files. Now, re-encrypt the files using
git secret reveal; git secret hide -d, and then commit and push the newly encrypted files. (The -d options deletes the unencrypted file after re-encrypting it). Now the newly added user will be able to decrypt the files in the repo using
Note that it is possible to add yourself to the git-secret repo without decrypting existing files.
It will be possible to decrypt them after re-encrypting them with the new keyring. So, if you don’t
want unexpected keys added, you can configure some server-side security policy with the
You can follow a quick
gpg tutorial at devdungeon. Here are the most useful commands to get started:
To generate a RSA key-pair, run:
To export your public key, run:
gpg --armor --export firstname.lastname@example.org > public-key.gpg
To import the public key of someone else (to share the secret with them for instance), run:
gpg --import public-key.gpg
To make sure you get the original public keys of the indicated persons, be sure to use a secure channel to transfer it, or use a service you trust, preferably one that uses encryption such as Keybase, to retrieve their public key. Otherwise you could grant the wrong person access to your secrets by mistake!
Using git-secret for Continuous Integration / Continuous Deployment (CI/CD)
git-secret for CI/CD, you get the benefit that any deployment is necessarily done with the correct configuration, since it is collocated
with the changes in your code.
One way of doing it is the following:
- create a gpg key for your CI/CD environment. You can chose any name and email address you want: for instance
MyApp CodeShip <email@example.com>if your app is called MyApp and your CI/CD provider is CodeShip. It is easier not to define a password for that key.
gpg --armor --export-secret-key firstname.lastname@example.org get your private key value
- Create an env var on your CI/CD server
GPG_PRIVATE_KEYand assign it the private key value.
- Then write your Continuous Deployment build script. For instance:
# As the first step: install git-secret, # see: https://git-secret.io/installation # Create private key file echo $GPG_PRIVATE_KEY > ./private_key.gpg # Import private key gpg --import ./private_key.gpg # Reveal secrets git secret reveal # carry on with your build script, secret files are available ...
Note: your CI/CD might not allow you to create a multiline value. In that case, you can export it on one line with
gpg --armor --export-secret-key email@example.com | tr '\n' ','
You can then create your private key file with:
echo $GPG_PRIVATE_KEY | tr ',' '\n' > ./private_key.gpg
Environment Variables and Configuration
You can configure the version of
gpg used, or the extension your encrypted files use, to suit your workflow better.
To do so, just set the required variable to the value you need.
This can be done in your shell environment file or with each
See below, or the man page of
git-secret for an explanation of the environment variables
The settings available to be changed are:
$SECRETS_VERBOSE- sets the verbose flag to on for all
git-secretcommands; is identical to using
-von each command that supports it.
$SECRETS_GPG_COMMAND- sets the
gpgalternatives, defaults to
gpg. It can be changed to
/usr/local/gpgor any other value. After doing so rerun the tests to be sure that it won’t break anything. Tested to be working with:
$SECRETS_GPG_ARMOR- sets the
--armormode. Can be set to
1to store secrets file as text. By default is
0and store files as binaries.
$SECRETS_EXTENSION- sets the secret files extension, defaults to
.secret. It can be changed to any valid file extension.
$SECRETS_DIR- sets the directory where
git-secretstores its files, defaults to
.gitsecret. It can be changed to any valid directory name.
$SECRETS_PINENTRY- allows user to specify a setting for
gpgdocs for details about gpg’s
.gitsecret folder (can be overridden with
This folder contains information about the files encrypted by git-secret, and about which public/private key sets can access the encrypted data.
You can change the name of this directory using the SECRETS_DIR environment variable.
Use the various
git-secret commands to manipulate the files in
you should not change the data in these files directly.
Exactly which files exist in the
.gitsecret folder and what their contents are
vary slightly across different versions of gpg. Thus it is best to use
git-secret with the same version of gpg being used by all users.
This can be forced using
SECRETS_GPG_COMMAND environment variable.
Specifically, there is an issue between
gpg version 2.1.20 and later versions
which can cause problems reading and writing keyring files between systems
(this shows up in errors like ‘gpg: skipped packet of type 12 in keybox’).
git-secret internal data is separated into two directories:
This directory currently contains only the file
mapping.cfg, which lists all the files your storing encrypted.
In other words, the path mappings: what files are tracked to be hidden and revealed.
All the other internal data is stored in the directory:
This directory contains data used by git-secret and PGP to allow and maintain the correct encryption and access rights for the permitted parties.
Generally speaking, all the files in this directory except
random_seed should be checked into your repo.
git secret init will add the file
.gitsecret/keys/random_seed to your
Again, you can change the name of this directory using the SECRETS_DIR environment variable.