Skip to content

Commit

Permalink
add documentation for pkce config
Browse files Browse the repository at this point in the history
  • Loading branch information
Rorical committed Nov 29, 2024
1 parent 618c1ef commit 6784519
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
5 changes: 5 additions & 0 deletions config-example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,11 @@ unix_socket_permission: "0770"
# allowed_users:
# - [email protected]
#
# # Optional: Enable PKCE (Proof Key for Code Exchange) support for enhanced security
# # and prevent CSRF attacks.
# # See https://datatracker.ietf.org/doc/html/rfc7636
# enable_pkce: false
#
# # Map legacy users from pre-0.24.0 versions of headscale to the new OIDC users
# # by taking the username from the legacy user and matching it with the username
# # provided by the OIDC. This is useful when migrating from legacy users to OIDC
Expand Down
6 changes: 6 additions & 0 deletions docs/ref/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ oidc:
allowed_users:
- [email protected]

# Optional: Enable PKCE (Proof Key for Code Exchange) support for enhanced security and prevent CSRF attacks
# PKCE adds an additional layer of security to the OAuth 2.0 authorization code flow
# by preventing authorization code interception attacks
# See https://datatracker.ietf.org/doc/html/rfc7636
enable_pkce: false

# If `strip_email_domain` is set to `true`, the domain part of the username email address will be removed.
# This will transform `[email protected]` to the user `first-name.last-name`
# If `strip_email_domain` is set to `false` the domain part will NOT be removed resulting to the following
Expand Down

0 comments on commit 6784519

Please sign in to comment.