Skip to main content

OAuthenticator: Authenticate JupyterHub users with common OAuth providers

Project description

OAuth + JupyterHub Authenticator = OAuthenticator :heart:

Documentation build status GitHub Workflow Status Latest PyPI version Latest conda-forge version GitHub Discourse Gitter

OAuth is a token based login mechanism that doesn't rely on a username and password mapping. In order to use this login mechanism with JupyerHub the login handlers need to be overridden. OAuthenticator overrides these handlers for the common OAuth2 identity providers allowing them to be plugged in and used with JupyterHub.

The following authentication services are supported through their own authenticator: Auth0, Azure AD, Bitbucket, CILogon, GitHub, GitLab, Globus, Google, MediaWiki, Okpy, OpenShift.

There is also a GenericAuthenticator that can be configured with any OAuth 2.0 identity provider or can be used to create a new authenticator class when additional customization is needed.

Installation

The installation guide can be found in the docs.

The docs also provide example setups for different OAuth2 identity providers:

Running tests

To run the tests locally:

$ pip install --upgrade --pre -r test-requirements.txt
$ pytest -v ./oauthenticator/tests/

Or you run a specific test file with:

$ pytest -v ./oauthenticator/tests/<test-file-name>

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

oauthenticator-0.12.3.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

oauthenticator-0.12.3-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file oauthenticator-0.12.3.tar.gz.

File metadata

  • Download URL: oauthenticator-0.12.3.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.3.tar.gz
Algorithm Hash digest
SHA256 f86e18e954ae37796ee149fe01ab0be0707d9e0415d62336ba3447e7b4383461
MD5 1a113546900f9f0dd4c0badfa2297d61
BLAKE2b-256 d64da79cfffa0fc5e6b0c06747d0bdce9c28a38ec789ada231b4c329cd132c5f

See more details on using hashes here.

Provenance

File details

Details for the file oauthenticator-0.12.3-py3-none-any.whl.

File metadata

  • Download URL: oauthenticator-0.12.3-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0a6c5b64312c53231ba160b35a95cb30fecef8e488184acdf570a6564c5a247d
MD5 14fa68e6061f2b645d587c091d220842
BLAKE2b-256 895e5531624b6d4490b6b2bb53ce7fb514a4e840f8bd6dc9046b3e2eaa324afc

See more details on using hashes here.

Provenance

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