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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oauthenticator-17.4.0-py3-none-any.whl (86.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-17.4.0.tar.gz
  • Upload date:
  • Size: 208.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for oauthenticator-17.4.0.tar.gz
Algorithm Hash digest
SHA256 b1025d725dc406977299c87fedea2006fcabac3bea9d4e17f690d4dad044923e
MD5 f90917f4ed843669f9988b1639c6209a
BLAKE2b-256 b255d0d2c37985c3272dd016b753296bb33d7b8e748ea009fdf0d85e3c1a867a

See more details on using hashes here.

Provenance

The following attestation bundles were made for oauthenticator-17.4.0.tar.gz:

Publisher: release.yaml on jupyterhub/oauthenticator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for oauthenticator-17.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b59a8d71f0e2822fad243837eb325b4d12b365c6aedfd3cc88f73e9f00486e8
MD5 4a852162b85be75592bf7b3aaed34f69
BLAKE2b-256 adfbdc63bbec406e4dd7eecf1def43348ae27d94f9444e8a86d55af46e284080

See more details on using hashes here.

Provenance

The following attestation bundles were made for oauthenticator-17.4.0-py3-none-any.whl:

Publisher: release.yaml on jupyterhub/oauthenticator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page