git-tresor v1.0.2

Encrypt and decrypt files to store them inside a git repository. git-tresor uses AES-256 encryption. Every file or directory has it's own password. This enables you to commit encrypted files either in a separate git repository or inside the same repository where your secret files are needed (f.e. Android-Keystores or Signing-Certificates for Apple).

Setup

git-tresor can be installed via npm. If you want to install it globally simply type the following command:

npm i -g git-tresor 

For a local installation you run npm i git-tresor --save-dev from your npm-folder.

Requirements

git-tresor runs on systems that support npm/node. If you have issues with your local environment let us know!

Initialization

To initialize a new repository you should start by setting up git:

git init

Of course you do not need this step if the git repository is already initialized. After that you can go ahead and initialize git-tresor by running:

git-tresor init

It will guide you trough the process of initialization.

Usage

Below you can see the currently available options.

Options

  -e, --encrypt              Flag to use encryption mode.
  -d, --decrypt              Flag to use decryption mode.
  -f, --file string          Path to the file that should be en- or decrypted.
  -dir, --directory string   Path to a directory that should be en- or decrypted.
  -p, --password string      Password that is used to en- or decrypt.

To de- or encrypt files you need to set the -d or -e flag. In both cases you need to specify a file and a password.

# Encryption
git-tresor -e -f secretFile.txt -p secretPassword

# Decryption
git-tresor -d -f secretFile.txt.enc -p secretPassword

If you want to de- or encrypt folders you need to set the -dir option instead of -f.

# Encryption
git-tresor -e -dir ./secretFolder -p secretPassword

# Decryption
git-tresor -d -dir ./secretFolder -p secretPassword

In all cases, you will be prompted to enter a password if you do not set --password (or -p).

Sources & Further Readings

• Brandonstilson - Let's encrypt with node - Source and inspiration for core encryption code
• git-secret - A bash-tool to store your private data inside a git repository.
• fastlane-match - Easily sync your certificates and profiles across your team