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

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.7-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.7.tar.gz.

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.7.tar.gz
Algorithm Hash digest
SHA256 32c0784b7c9e4802a2fd9ea8900356a8b5818890bcb664d99da2b76412d3dd64
MD5 08568d6755c8a6ec4f3fa7aab5f304af
BLAKE2b-256 03f8f9bb930ba7079c6ebe30384a49193b96d70935a869c8a37bc153387874b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1523f6221a43d39e9bfe1f37dc08895fe31424622dc17bbe32c33089c29d3ac8
MD5 b614ddc37ef2f937fca9a3397e2bd186
BLAKE2b-256 42fab3006f541f507c63c6115af6280717710b4fe2c28ecb8dcf01d6b0567574

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