Skip to main content

utility tool that load secret information safely.

Project description

Documentation Status https://travis-ci.org/MacHu-GWU/pysecret-project.svg?branch=master https://codecov.io/gh/MacHu-GWU/pysecret-project/branch/master/graph/badge.svg https://img.shields.io/pypi/v/pysecret.svg https://img.shields.io/pypi/l/pysecret.svg https://img.shields.io/pypi/pyversions/pysecret.svg https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to pysecret Documentation

pysecret is a library to ease your life dealing with secret information.

For example, if you have a database connection information, so you can’t include it in your source code, but you want to easily and securely access it, then pysecret is the library for you. It provides several options out of the box:

Features:

  1. access secret in environment variable from commandline, shell scripts, or Python.
  2. access secret in json file from Python.
  3. use AWS Key Management Service or AWS Secret Manager to access your secret info.

For large file or binary data encryption, I highly recommend you to use AWS Key Management Service and AWS Secret Manager to fetch your encryption key, then use windtalker library to encrypt it.

Load Data From Environment

The idea is: put your secret information in ~/.bashrc_pysecret file.

# content of ~/.bashrc_pysecret file
export DB_SECRET_MY_DB_PASSWORD="mypassword"
...

And put source ~/.bashrc_pysecret into your ~/.bashrc / ~/.bash_profile / .zshrc

Whenever you need your secret info:

  1. Your interactive command line interface gives you easy access to those secrets.
  2. You can put source ~/.bashrc_pysecret in your CI / CD scripts.
  3. pysecret allows you to load secret value in python code. By doing this:
>>> from pysecret import EnvSecret
>>> env = EnvSecret()
>>> env.load_pysecret_script()
>>> env.get("DB_SECRET_MY_DB_PASSWORD")
mypassword

You can write your secret to ~/.bashrc_pysecret file in a pythonic way:

from pysecret import EnvSecret

env = EnvSecret()

# will create ~/.bashrc_pysecret file if not exists
# will update ~/.bashrc_pysecret file too
# if you don't want to update ~/.bashrc_pysecret file, just set .set(..., temp=True)
env.set("DB_SECRET_MYDB_HOST", "123.456.789.000")
env.set("DB_SECRET_MYDB_USERNAME", "username")
env.set("DB_SECRET_MYDB_PASSWORD", "password")

Load Data From Json File

The idea is, put your secret info in a json file and load info from it. You can create it manually by your own, or do it in pythonic way:

from pysecret import JsonSecret, get_home_path

SECRET_FILE = get_home_path(".pysecret.json")
js = JsonSecret.new(secret_file=SECRET_FILE)

# construct / update secret json file
js.set("mydb.host": "123.456.789.000")
js.set("mydb.username": "username")
js.set("mydb.password": "password")

or you can just create $HOME/.pysecret.json includes:

{
    "mydb": {
        "host": "123.456.789.000",
        "username": "username",
        "password": "password
    }
}

Load secret safely:

host = js.get("mydb.host")
username = js.get("mydb.username")
password = js.get("mydb.password")

AWS Key Management Service and Secret Manager Integration

Create a encryption key in AWS KMS, then encrypt your secret info with the key in AWS Secret Manger. Access it is easy with pysecret.

Suppose you defined a “secret” called “my-secret” in AWS Secret Manger:

  • username: “myusername”
  • password: “mypassword”
>>> from pysecret import AWSSecret

>>> aws_profile = "my_aws_profile"
>>> aws = AWSSecret(profile_name=aws_profile)
>>> aws.get_secret_value(secret_id="my-secret", key="password")
mypassword

Install

pysecret is released on PyPI, so all you need is:

$ pip install pysecret

To upgrade to latest version:

$ pip install --upgrade pysecret

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pysecret-0.0.2-py2.py3-none-any.whl (52.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3
pysecret-0.0.2.tar.gz (28.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page