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_LIST to be a comma-separated list of organizations whose members you want to permit, e.g. GITHUB_ORGANIZATION_LIST=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.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

sqre_ghowlauth-0.0.1-py2.py3-none-any.whl (5.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.1.tar.gz
Algorithm Hash digest
SHA256 afe24acecafe680f1c2d1f1a173c4fc422d728267e56b29eee8399b461b5a275
MD5 1da986d77794cbd83f89ef32c6e86bfb
BLAKE2b-256 539968b435614df64e5fd9c895f62e5d86642da52dcb16f0d9a7ab16c70f1b93

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a66876b306197f80a26f6acfbf3ff1db4cee6a0a84ec7371bf5979123325f5ac
MD5 b8dc330f066da3832bb332e1cce688ea
BLAKE2b-256 6a8eea25078cdd2563b6510374b3d7410479956a6a563fe965a07bd58483b361

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