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

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.4-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.4.tar.gz
Algorithm Hash digest
SHA256 fd22702a3bc0a74a4988cc2dd01a0aafae277cb649033419ab41e9d9962de79f
MD5 635f6ef0615a24d2003813cba08ef255
BLAKE2b-256 5ad756ce2fe1059e94c57c628d325d8af6194c5c4cbff0112df3af253f0ed047

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8739afff45a07e994589979749c7c67cf64d4d4f82119ab7ebd17e7b0a94a57c
MD5 057e699c5d5d81adde1fae48d290e371
BLAKE2b-256 c7122ac7134f8b6bca1ff4d45ac865c9cfb33a477af80887cea567b95aaabb3d

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