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.8.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.8-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.8.tar.gz
Algorithm Hash digest
SHA256 a9d2acb8a259271820bae6ebd071d8270511f5517d5085779b207ea45a93621b
MD5 a9dd1d020a67466dfd772946be12843a
BLAKE2b-256 44213e8f36d70893bf2849d7235d708c776ef46a381bb08ecfacc587f14bba80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4eecdb32dc14fe07a15ad6a97cca61ee07e1d7c3191a445a86db00978ae6263b
MD5 4e2a6e11d69daf9bd460819d6483958e
BLAKE2b-256 6f43127b32303f413a4c17eb32470d92df9265a7d410855661663c2af04dd796

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