Skip to main content

Secret distribution tool, written as a wrapper on credstash

Project description

https://travis-ci.com/razorpay/alohomora.svg?token=qzqszeBhnN4z5pes5mg9&branch=master

Razorpay’s Secret Credential management system.

Installation

alohomora is distributed via PyPi:

pip install razorpay.alohomora

What?

Alohomora is an opinionated project that relies on our conventions to intelligently fetch secrets at run-time.

We don’t do our own crypto. We rely on these libraries instead:

This is how the template file looks in our app repository:

# {{ alohomora_managed }}
DB_PASSWORD      = {{ lookup('db_password') }}
APP_ENV          = {{ env }}
ENV_DEBUG        = {{ ENV['DEBUG'] }}
APP_NAME         = {{ app }}

This repo runs directly on the same template and generates the equivalent file as the output.

The steps it follows are the following:

  1. Figure out the tables from which to read. All secrets are stored in a credstash-env-app table structure in dynamoDB.

  2. Fetch all secrets from that table using credstash

  3. Render the template with the secrets using jinja

How it Works?

Alohomora expects the secrets for any application to be stored in a table called credstash-{env}-{app}. The IAM roles for this table must be configured by you. Once you try to render a template, alohomora will do the following:

  1. Read the entire table and decrypt all secrets and cache them locally.

  2. Render the template with these files and 3 extra variables: env, app, and ENV variables.

ENV is same as os.environ inside the jinja template.

Configuration?

Alohomora is designed to be a zero-config solution.

We perform a few transforms on the arguments that are passed:

  • Change both app and env to lowercase

  • Replace production with prod in the env name

  • Ignore anything after - in the environment. So beta-birdie becomes beta

Usage

Please see the wiki regarding alohomora binary usage.

LICENSE

alohomora is released under the same license as credstash.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

razorpay.alohomora-0.4.6.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file razorpay.alohomora-0.4.6.tar.gz.

File metadata

  • Download URL: razorpay.alohomora-0.4.6.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for razorpay.alohomora-0.4.6.tar.gz
Algorithm Hash digest
SHA256 b2410274a18f75e8ce6657227381e9bd53ced95be0ee3e4358c380fa2f222ca4
MD5 b2f75ec933dff7a2eaf4d05f0cfa30ab
BLAKE2b-256 785a60dbb095d38d32ae3fbef205c369ab1a93516b22708231c2876b8de0b9bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page