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

Uploaded Source

Built Distribution

oauthenticator-16.0.6-py3-none-any.whl (74.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for oauthenticator-16.0.6.tar.gz
Algorithm Hash digest
SHA256 f3623e66659151457e931bde1cd0d74ec6ce799713d10268fd224fde96b145c6
MD5 363ebeea0f052958adc16c0d791451ce
BLAKE2b-256 ebfebdf0a8b3516b1ad40f6afe72aaaea5ffed680eac7a2a972a35af1ce9edfb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 87461b023acfaaeded24dffe5a078a2171ee36fa15557501eb19c39e6b8f3eb4
MD5 a792019f12e8e2a99aabce155870209e
BLAKE2b-256 5e1e1936da1f4b314abf19752742fb39dcae8279a9ae5baedc3a6405fbe42ce2

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