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, FeiShu, 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-14.1.0.tar.gz (44.4 kB view details)

Uploaded Source

Built Distribution

oauthenticator-14.1.0-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-14.1.0.tar.gz
  • Upload date:
  • Size: 44.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11

File hashes

Hashes for oauthenticator-14.1.0.tar.gz
Algorithm Hash digest
SHA256 ad0346d5d250fa6a684281459a88c2c2c3b83426697581ba732487f4421815cc
MD5 c60ec60c6ffbce31e9376cab26f0362d
BLAKE2b-256 5cca5ab2a8dcc3e5904c21c1507387e38ca99c47f623c5487b94770ea7036afc

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oauthenticator-14.1.0-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11

File hashes

Hashes for oauthenticator-14.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45dd3f2332e13117d871da92350bfbdaef75ca397563bc85bb47f0dad397084d
MD5 bd89ac986766450b35b876b5e361b95b
BLAKE2b-256 765fc3ae5e89372d4452cce99c8607c089b16bef37467ce9e1a4a018f8e6e993

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