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

Uploaded Source

Built Distribution

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

File metadata

File hashes

Hashes for sqre-ghowlauth-0.0.6.tar.gz
Algorithm Hash digest
SHA256 f9fc32e67546fb105e966ac4a1ffa793bd8d1669cfcf5f56b0a32ef2cf4f64e1
MD5 574d780220e7e4d07b6c212c1ae30842
BLAKE2b-256 74058862a8b8c5db02af4cafd46e9432f7e841147e98c16bfb800dd63d8d7458

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_ghowlauth-0.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2129e3128e601999b3bb22f4b512b663f5a6d6110689e9b33adf83708744825
MD5 1454740f574f0442926b5fdc0f171a34
BLAKE2b-256 92b5bb3acc4e02e5a5def91e3cae3449fe6eaf9f259bf1225e2c7ffbcf354986

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