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

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.3-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ad356391f84d8bfd544a0546a5810111546499228731c28c7667796de8a20a5f
MD5 2100657fd846db33c40a6376017dd76f
BLAKE2b-256 7449dd6dbdb70421e9b9ebdba49ab834792782e134ff8ccd75849352cdf397f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5f85cd08a11923643e5e88d07c5de7bc134d68a990c8a3c13397dd1f3e226112
MD5 f7f235309fe7f6c3bcc6d52fa00260ef
BLAKE2b-256 ca776dfaf2a42129982cedea001db6c7cb52acbb7ee955638b92c602dc458ff5

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