# OAuth + JupyterHub Authenticator = OAuthenticator :heart:
[](https://oauthenticator.readthedocs.org/en/latest)
[](https://github.com/jupyterhub/oauthenticator/actions)
[](https://pypi.python.org/pypi/oauthenticator)
[](https://anaconda.org/conda-forge/oauthenticator)
[](https://github.com/jupyterhub/oauthenticator/issues)
[](https://discourse.jupyter.org/c/jupyterhub)
[](https://gitter.im/jupyterhub/jupyterhub)
[OAuth](https://en.wikipedia.org/wiki/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](oauthenticator/auth0.py),
[Azure AD](oauthenticator/azuread.py), [Bitbucket](oauthenticator/bitbucket.py), [CILogon](oauthenticator/cilogon.py), [FeiShu](https://github.com/tezignlab/jupyterhub_feishu_authenticator),
[GitHub](oauthenticator/github.py), [GitLab](oauthenticator/gitlab.py), [Globus](oauthenticator/globus.py),
[Google](oauthenticator/google.py), [MediaWiki](oauthenticator/mediawiki.py),
[OpenShift](oauthenticator/openshift.py).
There is also a [GenericAuthenticator](oauthenticator/generic.py)
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](https://oauthenticator.readthedocs.io/en/latest/tutorials/install.html).
The [docs](https://oauthenticator.readthedocs.io/en/latest/tutorials/provider-specific-setup/index.html) 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>
```
[contributing.md]: https://github.com/jupyterhub/oauthenticator/blob/main/CONTRIBUTING.md
Raw data
{
"_id": null,
"home_page": "https://jupyter.org",
"name": "oauthenticator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Interactive, Interpreter, Shell, Web",
"author": "Jupyter Development Team",
"author_email": "jupyter@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/96/80/92b1abbbf30067282ea38021ebcf8cde19b74bd4e93079b19fffe8278adc/oauthenticator-16.3.0.tar.gz",
"platform": "Linux",
"description": "# OAuth + JupyterHub Authenticator = OAuthenticator :heart:\n\n[](https://oauthenticator.readthedocs.org/en/latest)\n[](https://github.com/jupyterhub/oauthenticator/actions)\n[](https://pypi.python.org/pypi/oauthenticator)\n[](https://anaconda.org/conda-forge/oauthenticator)\n[](https://github.com/jupyterhub/oauthenticator/issues)\n[](https://discourse.jupyter.org/c/jupyterhub)\n[](https://gitter.im/jupyterhub/jupyterhub)\n\n[OAuth](https://en.wikipedia.org/wiki/OAuth) is a token based login mechanism that doesn't rely on a username and password mapping.\nIn order to use this login mechanism with JupyerHub the login handlers need to be overridden.\nOAuthenticator overrides these handlers for the common OAuth2 identity providers allowing them to be\nplugged in and used with JupyterHub.\n\nThe following authentication services are supported through their own authenticator: [Auth0](oauthenticator/auth0.py),\n[Azure AD](oauthenticator/azuread.py), [Bitbucket](oauthenticator/bitbucket.py), [CILogon](oauthenticator/cilogon.py), [FeiShu](https://github.com/tezignlab/jupyterhub_feishu_authenticator),\n[GitHub](oauthenticator/github.py), [GitLab](oauthenticator/gitlab.py), [Globus](oauthenticator/globus.py),\n[Google](oauthenticator/google.py), [MediaWiki](oauthenticator/mediawiki.py),\n[OpenShift](oauthenticator/openshift.py).\n\nThere is also a [GenericAuthenticator](oauthenticator/generic.py)\nthat can be configured with any OAuth 2.0 identity provider or can be used\nto create a new authenticator class when additional customization is needed.\n\n## Installation\n\nThe installation guide can be found in the [docs](https://oauthenticator.readthedocs.io/en/latest/tutorials/install.html).\n\nThe [docs](https://oauthenticator.readthedocs.io/en/latest/tutorials/provider-specific-setup/index.html) also provide example setups for different OAuth2 identity providers.\n\n## Running tests\n\nTo run the tests locally, first setup a development environment as described in\n[CONTRIBUTING.md], and then do:\n\n```\npytest -v ./oauthenticator/tests/\n```\n\nOr you run a specific test file with:\n\n```\npytest -v ./oauthenticator/tests/<test-file-name>\n```\n\n[contributing.md]: https://github.com/jupyterhub/oauthenticator/blob/main/CONTRIBUTING.md\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "OAuthenticator: Authenticate JupyterHub users with common OAuth providers",
"version": "16.3.0",
"project_urls": {
"Homepage": "https://jupyter.org"
},
"split_keywords": [
"interactive",
" interpreter",
" shell",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2ea506d90f2697e3fb2efe06f775a35cf7babbf4a3be3c3889227a6fccc5914",
"md5": "7966f13988e16d97931f507909ef219c",
"sha256": "8ae919d6d96a9f8147e46e15ee8127dc36661d36e4f9bce5132de726049c7574"
},
"downloads": -1,
"filename": "oauthenticator-16.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7966f13988e16d97931f507909ef219c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 77909,
"upload_time": "2024-03-20T13:45:23",
"upload_time_iso_8601": "2024-03-20T13:45:23.526446Z",
"url": "https://files.pythonhosted.org/packages/e2/ea/506d90f2697e3fb2efe06f775a35cf7babbf4a3be3c3889227a6fccc5914/oauthenticator-16.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "968092b1abbbf30067282ea38021ebcf8cde19b74bd4e93079b19fffe8278adc",
"md5": "b2a9fab2d46778efb1aad328012f3707",
"sha256": "40c75d18951f69f5e80713028e5c75947e396b805a6f700fe23f0fc7b27161a4"
},
"downloads": -1,
"filename": "oauthenticator-16.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b2a9fab2d46778efb1aad328012f3707",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 59182,
"upload_time": "2024-03-20T13:45:25",
"upload_time_iso_8601": "2024-03-20T13:45:25.479460Z",
"url": "https://files.pythonhosted.org/packages/96/80/92b1abbbf30067282ea38021ebcf8cde19b74bd4e93079b19fffe8278adc/oauthenticator-16.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 13:45:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oauthenticator"
}
JSON