From 9917e3290a94e2e5228f2a506e8996490180e489 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Sun, 16 Apr 2023 07:48:03 +1000 Subject: [PATCH] docs: misc fixes (#5258) Signed-off-by: James Elliott --- .../en/blog/pre-release-notes-4.38/index.md | 2 -- .../openid-connect/frequently-asked-questions.md | 16 +++++++--------- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/content/en/blog/pre-release-notes-4.38/index.md b/docs/content/en/blog/pre-release-notes-4.38/index.md index 86f6b48a2..68ff6f6f2 100644 --- a/docs/content/en/blog/pre-release-notes-4.38/index.md +++ b/docs/content/en/blog/pre-release-notes-4.38/index.md @@ -75,7 +75,6 @@ Major Documentation Changes: - [Caddy](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/caddy/) - [Envoy](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/envoy/) - [HAProxy](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/haproxy/) - - [HAProxy](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/haproxy/) - [NGINX](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/nginx/) - [Traefik](https://deploy-preview-5250--authelia-staging.netlify.app/integration/proxies/traefik/) - [Kubernetes Integration](https://deploy-preview-5250--authelia-staging.netlify.app/integration/kubernetes/introduction/) @@ -120,7 +119,6 @@ Major Documentation Changes: - [Caddy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/caddy/) - [Envoy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/envoy/) - [HAProxy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/haproxy/) - - [HAProxy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/haproxy/) - [NGINX](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/nginx/) - [Traefik](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/traefik/) - [Kubernetes Integration](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/kubernetes/introduction/) diff --git a/docs/content/en/integration/openid-connect/frequently-asked-questions.md b/docs/content/en/integration/openid-connect/frequently-asked-questions.md index f7b8939df..ff95c8207 100644 --- a/docs/content/en/integration/openid-connect/frequently-asked-questions.md +++ b/docs/content/en/integration/openid-connect/frequently-asked-questions.md @@ -1,7 +1,7 @@ --- title: "Frequently Asked Questions" description: "Frequently Asked Questions regarding integrating the Authelia OpenID Connect Provider with an OpenID Connect relying party" -lead: "Frequently Asked Questionsregarding integrating the Authelia OpenID Connect Provider with an OpenID Connect relying party." +lead: "Frequently Asked Questions regarding integrating the Authelia OpenID Connect Provider with an OpenID Connect relying party." date: 2022-10-20T15:27:09+11:00 draft: false images: [] @@ -12,7 +12,7 @@ weight: 615 toc: true --- -## How Do I Generate Client Secrets +## How do I generate client secrets? We strongly recommend the following guidelines for generating client secrets: @@ -48,13 +48,11 @@ that is implemented by the authorization server which requires access to the sec which case the secret should be encrypted and not be stored in plaintext. The most likely long term outcome is that the client configurations will be stored in the database with the secret both salted and peppered. -Authelia currently does implement the `client_secret_jwt` assertion client authentication method. Warnings will be -generated for any client not explicitly configured to utilize this client authentication method. We do not support any -of the other the specifications or protocols which require secrets being accessible in the clear and currently we no -plans to implement any of these. We only officially support utilization of the plaintext digest types where it's backed -by specifications and as such we plan to make the use outside of the `client_secret_jwt` a fatal error in the future. -For these reasons we recommended that users remove this from their configuration entirely and use the -[How Do I Generate Client Secrets](#how-do-i-generate-client-secrets) FAQ. +Authelia currently does not implement any of the specifications or protocols which require secrets being accessible in +the clear such as most notably the `client_secret_jwt` grant, we will however likely soon implement `client_secret_jwt`. +We are however *__strongly discouraging__* and formally deprecating the use of plaintext client secrets for purposes +outside those required by specifications. We instead recommended that users remove this from their configuration +entirely and use the [How Do I Generate Client Secrets](#how-do-i-generate-client-secrets) FAQ. Plaintext is either denoted by the `$plaintext$` prefix where everything after the prefix is the secret. In addition if the secret does not start with the `$` character it's considered as a plaintext secret for the time being but is