OAuthenticator: Authenticate JupyterHub users with common OAuth providers
Project description
OAuth + JupyterHub Authenticator = OAuthenticator :heart:
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>
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file oauthenticator-17.0.0.tar.gz.
File metadata
- Download URL: oauthenticator-17.0.0.tar.gz
- Upload date:
- Size: 61.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d1e45f72e23e1ae8601749b264fcbc65c2f890108bbfa3dc18493ef7627e199d |
|
| MD5 | 2c44ba624a05e86dbcd23d3c6e58b734 |
|
| BLAKE2b-256 | 8b56c77cb87aa09f9a9aaf6540760810391efe5b72e8f73dfb252f27401d8f43 |
Provenance
File details
Details for the file oauthenticator-17.0.0-py3-none-any.whl.
File metadata
- Download URL: oauthenticator-17.0.0-py3-none-any.whl
- Upload date:
- Size: 81.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 85bc830dfcfbce2f220567f298101e6f4a0d4da3382cef41b198bd1563723feb |
|
| MD5 | aca9b4afa7f1eb4d6baf62c11f8b3e9f |
|
| BLAKE2b-256 | 84de0fd3a469d374c79aa9447ef134ad434edbf28adc5dd2af888816c263269b |
