safekeeper

safekeeper is a command-line tool meant to help maintain your secrets (passwords, client ids/secrets) safe from your source.

It does a single thing and this is replacing all occurences of keys by the value mapped to the corresponding environment variable.

It works with go generate to replace tokens in your source code.

Why You Might Use safekeeper

First, if you have a better solution, don't!

If you can directly use env variables, that might be an easier and simpler solution. Unfortunately, Google App Engine won't allow this. An alternative for GAE might be to use the datastore to keep your secrets but that's sometimes cumbersome.

I use it personally because:

I'm running on the Google App Engine which doesn't allow the use of env variables.
I have many app secrets that would start to be cumbersome to manage via the datastore.
I like a little more formal dev/contribution workflow than having to require contributors to create a file with a set of constants.

Example

Let's have all of our application secrets in one place. Let's put this in a secrets package. We'll need a <yourname>.go.safekeeper file that will serve as the template for the generated go code as well as a matching <yourname>.go file with the go:generate directive.

secrets.go:

package secrets
//go:generate safekeeper --output=appsecrets.go --keys=CLIENT_ID,CLIENT_SECRET $GOFILE

secrets.go.safekeeper:

package secrets

// AppSecrets is the source for all application secrets (client ids/secrets/passwords)
type AppSecrets struct {
    ClientId       string
    ClientSecret   string    
}

// NewAppSecrets returns the AppSecrets with all values set
func NewAppSecrets() *AppSecrets {
    appSecrets := new(AppSecrets)
    appSecrets.ClientId = "ENV_CLIENT_ID"
    appSecrets.ClientSecret = "ENV_CLIENT_SECRET"

    return appSecrets
}

Since you'd want to avoid committing the generate source with the resolved secrets, you'll want to have the generated file be in your .gitignore. We achieve this here by generating the output to a 3rd file called appsecrets.go (using the --output flag) in the same package.

Once ready, generate the resolved appsecrets by running go generate <path.to.secrets.package>

I'm currently using this in glukit so have a look there for an example of actual integration.

LICENSE

Licensed under MIT license.

alexandre-normand/safekeeper

safekeeper

Why You Might Use safekeeper

Example

LICENSE