scrambler

Scrambler aims to provide a simple way to let you secure sensible information such as credentials you don't want to put into source control.

Install

#1 the go way

obviously for this approach you'll need to have GO installed and configured

go install github.com/dbldots/scrambler@latest

#2 using the binaries

Download the package matching your env from here: https://github.com/dbldots/scrambler/releases

Well, you know how this works, but an example of commands would be

wget https://github.com/dbldots/scrambler/releases/download/v1.0.2/scrambler_1.0.2_linux_amd64.tar.gz
tar xvfz scrambler_1.0.2_linux_amd64.tar.gz
sudo cp scrambler /usr/local/bin/
sudo chmod 755 /usr/local/bin/scrambler

#3 within github actions

There is a couple of github actions available that take care of installing binaries, e.g. https://github.com/jaxxstorm/action-install-gh-release

Example usage:

steps:
  ...
  - name: Install scrambler
    uses: jaxxstorm/[email protected]
    with:
      repo: dbldots/scrambler
      tag: v1.0.2
      cache: enable

Usage

Secret config

There are to ways to let scrambler know what secret to use. See below.

1. Environment variable

export SCRAMBLER_SECRET=P@ssw0rd

2. Via config file

To use a config file for scrambler, create a file in your home directory called .scrambler.yml:

secret: P@ssw0rd

Encrypt

To encrypt a value

scrambler encrypt [your-value]

This will print a line with your encrypted value. Copy and paste into your favorite editor.

Decrypt

To decrypt (read) a file

scrambler read [your-file]

Edit

Encrypt single values

To change values of a file that contains (or should contain) encrypted values:

scrambler edit [your-file]

This will open up the editor specified in EDITOR. An example:

the config file config.yml with content

one: one
two: SCRAMBLED:LIsPNA==
three: SCRAMBLED:L4twOw==
four:
  five: SCRAMBLED:L4twdA==

will be decrypted and opened in the editor in the following format:

one: one
two: SCRAMBLE:foo
three: SCRAMBLE:bar
four:
  five: SCRAMBLE:baz

Change anything after SCRAMBLE: to alter the values. You can also encrypt existing values or add new values by using the SCRAMBLE:[value] pattern.

Encrypt whole file

Alternatively you can also choose to encrypt the entire content of a file (e.g. keyfiles).

As an example, to encrypt all content of an existing file, run scrambler edit [your-file] and insert this line at the top

:SCRAMBLE

The config.yml file from above, if encrypted as a whole, after saving looks like this:

:SCRAMBLED
FNQDLqFAbbdYvhYkSL7f5spxSJGr+94GXZ97rA6W7X5QHIb7j41Mp5qRB0cYl+bvrR8hsuoINk7gupO5esgPUA==%

You can edit the contents of the file via scrambler edit [your-file], still.