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

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.9-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.9.tar.gz
Algorithm Hash digest
SHA256 8ee9ef4ccafe7a8a412a85e31c2bc906d7a35cb640e7cd6a56879c012375741f
MD5 1877c3d6ab692b68dbea90f6595e874f
BLAKE2b-256 70c38e132e1efcd2fdd9ffbead77063fca565ee015f57b0185f7be16731e0a3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 766d0f16329956c9cfac17dbca80c1b580a9baa6937e133ff35a8021eadd904b
MD5 34125c4f830e4c3adc416ee12c13ecc8
BLAKE2b-256 f73f74dc54ce975c26a73ea60823c64a3f6b3b3d74c78f9d4d2e2e340137b460

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