Skip to main content

JupyterHub authenticator that uses GH orgs as whitelists

Project description

# sqre-ghowlauth

GitHub Organization WhiteList Authentication

JupyterHub authentication that uses GitHub OAuth2 but additionally checks user org membership against a list defined in the environment variable GITHUB_ORGANIZATION_WHITELIST.

## Installation

sqre-ghowlauth runs on Python 3.3 or greater. You can install it with

`bash pip install sqre-ghowlauth `

This will also install dependencies: jupyterhub and tornado.

## Example usage

Your jupyterhub_config.py file should contain c.JupyterHub.authenticator_class = ‘ghowlauth.GHOWLAuthenticator’ (or you can use LocalGHOWLAuthenticator to handle both local and GitHub auth).

You also must have set the environment variable GITHUB_ORGANIZATION_WHITELIST to be a comma-separated list of organizations whose members you want to permit, e.g. GITHUB_ORGANIZATION_WHITELIST=lsst,lsst-sqre.

The rest of the instructions are the same as those found at https://github.com/jupyterhub/oauthenticator (that is, you still need a callback URL, a client ID, and a client secret).

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

sqre-ghowlauth-0.0.2.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.2-py2.py3-none-any.whl (5.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sqre-ghowlauth-0.0.2.tar.gz.

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2cdd524ecfacf199c02c6d1a8ce0b9ff842d25310ad33fb4267d0bab6357141d
MD5 d97fcfd8a0583c7171f88d004ef6366a
BLAKE2b-256 9b16bf4741b846aa5ab66366ceab1ac5f88a2342c10c94897e09ad4312d8edd9

See more details on using hashes here.

File details

Details for the file sqre_ghowlauth-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5547a021e19511654e62fcbd0a9f5c1bae2a183cce75e003399347de2333f78e
MD5 21657e14f2c3fe308fbd43e4b2f54d85
BLAKE2b-256 402baaabbea902cea584b9265500d06736788af2f128f6d8db21f55d9fa60391

See more details on using hashes here.

Supported by

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