From ce012a0483067de94e61b4445a93398d6261e27a Mon Sep 17 00:00:00 2001 From: Charles Chan Date: Mon, 11 Mar 2024 13:30:31 -0700 Subject: [PATCH 1/2] Document OIDC_ENABLED in settings.rst --- docs/settings.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index f7ee76267..aa065e7e6 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -287,6 +287,12 @@ According to `OAuth 2.0 Security Best Current Practice `_ - For confidential clients, the use of PKCE `RFC7636 `_ is RECOMMENDED. +OIDC_ENABLED +~~~~~~~~~~~~ +Default: ``False`` + +Whether or not `OpenID Connect `_ auth flow is enabled. + OIDC_RSA_PRIVATE_KEY ~~~~~~~~~~~~~~~~~~~~ Default: ``""`` From 0d5fd0f8facd5fc523b781ed005dbd6bfa627199 Mon Sep 17 00:00:00 2001 From: Alan Crosswell Date: Tue, 7 May 2024 14:59:24 -0400 Subject: [PATCH 2/2] change settings to ref oidc.rst and from there ref the openid.net site. --- docs/oidc.rst | 4 ++-- docs/settings.rst | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/oidc.rst b/docs/oidc.rst index 37f5f90e2..bbb4651bd 100644 --- a/docs/oidc.rst +++ b/docs/oidc.rst @@ -4,8 +4,8 @@ OpenID Connect OpenID Connect support ====================== -``django-oauth-toolkit`` supports OpenID Connect (OIDC), which standardizes -authentication flows and provides a plug and play integration with other +``django-oauth-toolkit`` supports `OpenID Connect `_ +(OIDC), which standardizes authentication flows and provides a plug and play integration with other systems. OIDC is built on top of OAuth 2.0 to provide: * Generating ID tokens as part of the login process. These are JWT that diff --git a/docs/settings.rst b/docs/settings.rst index aa065e7e6..901fe8575 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -146,7 +146,7 @@ OAUTH2_SERVER_CLASS ~~~~~~~~~~~~~~~~~~~ The import string for the ``server_class`` (or ``oauthlib.oauth2.Server`` subclass) used in the ``OAuthLibMixin`` that implements OAuth2 grant types. It defaults -to ``oauthlib.oauth2.Server``, except when OIDC support is enabled, when the +to ``oauthlib.oauth2.Server``, except when :doc:`oidc` is enabled, when the default is ``oauthlib.openid.Server``. OAUTH2_VALIDATOR_CLASS @@ -291,7 +291,8 @@ OIDC_ENABLED ~~~~~~~~~~~~ Default: ``False`` -Whether or not `OpenID Connect `_ auth flow is enabled. +Whether or not :doc:`oidc` support is enabled. + OIDC_RSA_PRIVATE_KEY ~~~~~~~~~~~~~~~~~~~~