ContextQMD
Back to Authelia

Claper

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

4.39.194.0 KB
Original Source

Tested Versions

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

Assumptions

This example makes the following assumptions:

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

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

{{< sitevar-preferences >}}

Configuration

Authelia

{{< callout context="note" title="Security Note" icon="outline/info-circle" >}} This client uses a plaintext client secret. While this is generally discouraged, in this context it is required. This is because the client signs a request object using the client secret rather than a regular request. This helps ensure the request can't be tampered with in any way even using a Man-in-the-Middle attack.

In addition due to the enforcement of both PKCE using SHA256 and Pushed Authorization Requests this client is incredibly secure. {{< /callout >}}

The following YAML configuration is an example Authelia client configuration for use with Claper 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: 'claper'
        client_name: 'Claper'
        client_secret: '$plaintext$insecure_secret'
        public: false
        authorization_policy: 'two_factor'
        require_pushed_authorization_requests: true
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - 'https://claper.{{< sitevar name="domain" nojs="example.com" >}}/users/oidc/callback'
        scopes:
          - 'openid'
          - 'email'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        request_object_signing_alg: 'HS256'
        token_endpoint_auth_method: 'client_secret_basic'

Configuration Escape Hatch

{{% oidc-escape-hatch-claims-hydration client_id="claper" claims="email" %}}

Application

To configure Claper there is one method, using the Environment Variables.

Environment Variables

To configure Claper to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables:

Standard
shell
OIDC_PROVIDER_NAME=Authelia
OIDC_ISSUER=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
OIDC_CLIENT_ID=claper
OIDC_CLIENT_SECRET=insecure_secret
OIDC_SCOPES=openid email
OIDC_LOGO_URL=https://www.authelia.com/images/branding/logo-cropped.png
OIDC_AUTO_REDIRECT_LOGIN=false
Docker Compose
yaml
services:
  claper:
    environment:
      OIDC_PROVIDER_NAME: 'Authelia'
      OIDC_ISSUER: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'
      OIDC_CLIENT_ID: 'claper'
      OIDC_CLIENT_SECRET: 'insecure_secret'
      OIDC_SCOPES: 'openid email profile'
      OIDC_LOGO_URL: 'https://www.authelia.com/images/branding/logo-cropped.png'
      OIDC_AUTO_REDIRECT_LOGIN: 'false'

See Also