Skip to main content

Simple email whitelist checker backed by the AWS Secrets Manager

Project description

Build Status

bouncer

Simple email whitelist checker backed by the AWS Secrets Manager

setup

regular

Either add cgp-bouncer to your project requirements or

pip install cgp-bouncer

in a Python 3 virtualenv.

for development

Instead of the steps above clone the repo, cd into the repo, and run

pip install -e .

and

pip install -r requirements-dev.txt

To test, run

tox

how to use

setting up the whitelist

  1. Go to the AWS Console and find the Secrets Manager service.
  2. Select Store a new secret.
  3. For secret type select Other type of secrets.
  4. Under the Secret key/value tab enter email as the key and a comma separated (no spaces) list of whitelisted emails as the value. Select Next.
  5. Name your secret something descriptive, such as commons/dev/whitelist and give it a description. Select Next.
  6. Make sure Disable automatic rotation is selected. Then select Next.
  7. Review your configuration and select Store.

adding someone to the whitelist

  1. Go to the AWS Console and find the Secrets Manager service.
  2. Find the secret to which you want to add. For example, one might search for commons/dev/whitelist.
  3. Under Secret value, select Retrieve secret value. Then select Edit.
  4. Add your email with NO WHITESPACE to the comma separated list under the key email and select Save.

using bouncer to check the whitelist

Using is simple!

Here's an example

>>> from bouncer import Bouncer
>>> b = Bouncer('commons/dev/whitelist')
>>> b.is_authorized('valid.email@example.com')
True
>>> b.is_authorized('evil.gnomes@example.com')
False

This checks the AWS Secret Keeper called commons/dev/whitelist to see if the users valid.email@example.com and evil.gnomes@example.com are in the whitelist.

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
cgp-bouncer-0.1.0.tar.gz (3.4 kB) Copy SHA256 hash SHA256 Source None Aug 4, 2018

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page