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

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.10-py2.py3-none-any.whl (7.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.10.tar.gz
Algorithm Hash digest
SHA256 5b956a733e2179515f7181e82e803ad879408e909b980ec6a6d0c8c7b138b33f
MD5 f112afebacdbe0b7f67f6cc189dc2368
BLAKE2b-256 e1559146e1cf417471b1d712e01ee4caa3f3a5d514e58b93a99ef6ee8d6ba741

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e446f6b95cbe923bcde1a9967d611a69d4637361fb0c32cbdd8af897f7edd72e
MD5 e35896780f82e87b7805460764e22583
BLAKE2b-256 e483aef6f6129b5be63504367dba4173e880d88364c3cc6c29b08d4825314f69

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