ContextQMD
Back to Authelia

Headscale

docs/content/integration/openid-connect/clients/headscale/index.md

4.39.193.3 KB
Original Source

Tested Versions

{{% oidc-common bugs="claims-hydration" %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://headscale.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: headscale
  • Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

{{< sitevar-preferences >}}

Configuration

Authelia

The following YAML configuration is an example Authelia client configuration for use with Headscale which will operate with the application example:

yaml
identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'headscale'
        client_name: 'Headscale'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - 'https://headscale.{{< sitevar name="domain" nojs="example.com" >}}/oidc/callback'
        scopes:
          - 'openid'
          - 'email'
          - 'profile'
          - 'groups'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Configuration Escape Hatch

{{% oidc-escape-hatch-claims-hydration client_id="headscale" claims="email,groups" %}}

Note this additional configuration of a claims_policy is only necessary if you are authorizing users based on domain, groups or email (oidc.allowed_domains, oidc.allowed_groups and oidc.allowed_users in the Headscale configuration file). See Headscale#2655 for details.

Application

To configure Headscale to utilize Authelia as an OpenID Connect 1.0 provider, configure the oidc: section in the config.yaml

yaml
oidc:
  only_start_if_oidc_is_available: true
  issuer: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'
  client_id: 'headscale'
  client_secret: 'insecure_secret'
  # client_secret_path: '/path/to/client_secret.txt' # Alternative to client_secret
  scope: ['openid', 'profile', 'email', 'groups']
  pkce:
    enabled: true
    method: 'S256'

See Also