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, 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, 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.0.3.tar.gz (53.0 kB view details)

Uploaded Source

Built Distribution

oauthenticator-16.0.3-py3-none-any.whl (73.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-16.0.3.tar.gz
  • Upload date:
  • Size: 53.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for oauthenticator-16.0.3.tar.gz
Algorithm Hash digest
SHA256 e0a9f53f29240f75dbc3bbc476f0125470a6b4e3f8d31fcf318c7798490b1528
MD5 4505f47ffa1f064589a87cb9b759ecac
BLAKE2b-256 27a18024cd6dddc7df9926ffefc42b17fcd6fd003728cb2633d1e60dfa2c75d0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b02ecfe9d33c879e572ba0859bed123b3cdd6264e3eeaca57ffaa5538fb8376e
MD5 cc96c055d1b4d213382bca94cbe4cdad
BLAKE2b-256 2f819fb7a1dc4c735c9de03c9f17fe7168c1d03a1a06c9354363942844f5ba4f

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