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 - Test 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, 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, first setup a development environment as described in CONTRIBUTING.md, and then do:

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

Uploaded Source

Built Distribution

oauthenticator-16.3.1-py3-none-any.whl (78.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-16.3.1.tar.gz
  • Upload date:
  • Size: 60.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for oauthenticator-16.3.1.tar.gz
Algorithm Hash digest
SHA256 805861382726a2b92b2f1aeea7d7c80a1e6e782adceb87f17ee6574d01b5b4c9
MD5 46d16c845b9689ea2d4b0d5b112e01fd
BLAKE2b-256 47a2e4cbf59d224a4fb455de7c4402f4e3b52d5087e9898c4fc78861cd5300cf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 312a05d5a7eef851403ab64dd9a04833c36dce2b7d8d78806cb64e522a1232ed
MD5 8748e05f93ff06520d0ada4b7b81ba44
BLAKE2b-256 02ad5a8d0af6759f07dc6fd08639ec11d4cb61c229cfe44743dea0e4f0fb60be

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