{ "info": { "author": "Jesse Brennan", "author_email": "brennan@ucsc.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: Bio-Informatics" ], "description": "[![Build Status](https://travis-ci.org/ucsc-cgp/bouncer.svg?branch=master)](https://travis-ci.org/ucsc-cgp/bouncer)\n\n# bouncer\nSimple email whitelist checker backed by the AWS Secrets Manager\n\n## setup\n\n### regular\nEither add `cgp-bouncer` to your project requirements or\n```\npip install cgp-bouncer\n```\nin a Python 3 virtualenv.\n\n### for development\nInstead of the steps above clone the repo, `cd` into the repo, and run\n```\npip install -e .\n```\nand\n```\npip install -r requirements-dev.txt\n```\n\nTo test, run\n```\ntox\n```\n## how to use\n\n### setting up the whitelist\n1. Go to the AWS Console and find the **Secrets Manager** service.\n1. Select **Store a new secret**.\n1. For secret type select **Other type of secrets**.\n1. Under the **Secret key/value** tab enter `email` as the key and a\n comma separated (no spaces) list of whitelisted emails as the\n value. Select **Next**.\n1. Name your secret something descriptive, such as \n `commons/dev/whitelist` and give it a description. Select **Next**.\n1. Make sure **Disable automatic rotation** is selected. Then select\n **Next**.\n1. Review your configuration and select **Store**.\n\n### adding someone to the whitelist\n1. Go to the AWS Console and find the **Secrets Manager** service.\n1. Find the secret to which you want to add. For example, one might\n search for `commons/dev/whitelist`.\n1. Under **Secret value**, select **Retrieve secret value**. Then\n select **Edit**. \n1. Add your email with **NO WHITESPACE** to the comma separated list\n under the key `email` and select **Save**.\n\n### using bouncer to check the whitelist\nUsing is simple!\n\nHere's an example\n\n```python\n>>> from bouncer import Bouncer\n>>> b = Bouncer('commons/dev/whitelist')\n>>> b.is_authorized('valid.email@example.com')\nTrue\n>>> b.is_authorized('evil.gnomes@example.com')\nFalse\n```\n\nThis checks the AWS Secret Keeper called `commons/dev/whitelist` to see\nif the users `valid.email@example.com` and `evil.gnomes@example.com`\nare in the whitelist.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ucsc-cgp/bouncer", "keywords": "genomics,secret,client,whitelist,NIHDataCommons", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "cgp-bouncer", "package_url": "https://pypi.org/project/cgp-bouncer/", "platform": "", "project_url": "https://pypi.org/project/cgp-bouncer/", "project_urls": { "Homepage": "https://github.com/ucsc-cgp/bouncer" }, "release_url": "https://pypi.org/project/cgp-bouncer/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "Simple email whitelist checker backed by the AWS Secrets Manager", "version": "0.1.0" }, "last_serial": 4134583, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "88dadb0424134609e714832786e8b9c7", "sha256": "37f8e37d5e5c651231e35c3417701a6c67f9398f8754277bb8454559ab63d0e0" }, "downloads": -1, "filename": "cgp-bouncer-0.0.1.tar.gz", "has_sig": false, "md5_digest": "88dadb0424134609e714832786e8b9c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2909, "upload_time": "2018-08-02T22:30:09", "url": "https://files.pythonhosted.org/packages/97/97/e9cb97d5a9602464b5014c4663d9412a89cf12ce5448933fb6a1677b8aae/cgp-bouncer-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "bd1077ee59b9bab0b772684380196f83", "sha256": "bffe4c9aaaea9b835c616c9449fc5ea8084228e1dba29a6a1554ccf15b058617" }, "downloads": -1, "filename": "cgp-bouncer-0.0.2.tar.gz", "has_sig": false, "md5_digest": "bd1077ee59b9bab0b772684380196f83", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3379, "upload_time": "2018-08-03T20:06:58", "url": "https://files.pythonhosted.org/packages/32/6b/a54d76935f152c0681ee23edb1e6fad128f5d7d289101660a44bbb4f7611/cgp-bouncer-0.0.2.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "cd39b863dabaa344f5abaa642e18b3dc", "sha256": "c6a6add36f173f9f70bad98114a5baf2feb0be0553d980f2ccb2b4313a4a91f6" }, "downloads": -1, "filename": "cgp-bouncer-0.1.0.tar.gz", "has_sig": false, "md5_digest": "cd39b863dabaa344f5abaa642e18b3dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3448, "upload_time": "2018-08-04T00:55:57", "url": "https://files.pythonhosted.org/packages/38/cd/9af40560aca4b177830aeb9cc6252dcb05585a766ff90bceae4c1159ee98/cgp-bouncer-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cd39b863dabaa344f5abaa642e18b3dc", "sha256": "c6a6add36f173f9f70bad98114a5baf2feb0be0553d980f2ccb2b4313a4a91f6" }, "downloads": -1, "filename": "cgp-bouncer-0.1.0.tar.gz", "has_sig": false, "md5_digest": "cd39b863dabaa344f5abaa642e18b3dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3448, "upload_time": "2018-08-04T00:55:57", "url": "https://files.pythonhosted.org/packages/38/cd/9af40560aca4b177830aeb9cc6252dcb05585a766ff90bceae4c1159ee98/cgp-bouncer-0.1.0.tar.gz" } ] }