ContextQMD
Back to Authelia

pgAdmin

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

4.39.193.9 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://pgadmin.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: pgadmin
  • 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 pgAdmin 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: 'pgadmin'
        client_name: 'pgAdmin'
        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://pgadmin.{{< sitevar name="domain" nojs="example.com" >}}/oauth2/authorize'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
        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'

Application

To configure pgAdmin there is one method, using the Configuration File.

Configuration File

{{< callout context="tip" title="Did you know?" icon="outline/rocket" >}} Generally the configuration file is named config_local.py and in the official container is mounted at /pgadmin4/. {{< /callout >}}

To configure pgAdmin to utilize Authelia as an OpenID Connect 1.0 Provider, use the following configuration:

python
AUTHENTICATION_SOURCES = ['oauth2', 'internal']
OAUTH2_AUTO_CREATE_USER = True
OAUTH2_CONFIG = [{
	'OAUTH2_NAME': 'Authelia',
	'OAUTH2_DISPLAY_NAME': 'Authelia',
	'OAUTH2_CLIENT_ID': 'pgadmin',
	'OAUTH2_CLIENT_SECRET': 'insecure_secret',
	'OAUTH2_API_BASE_URL': 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}',
	'OAUTH2_AUTHORIZATION_URL': 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization',
	'OAUTH2_TOKEN_URL': 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token',
	'OAUTH2_USERINFO_ENDPOINT': 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo',
	'OAUTH2_SERVER_METADATA_URL': 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/.well-known/openid-configuration',
	'OAUTH2_SCOPE': 'openid email profile',
	'OAUTH2_USERNAME_CLAIM': 'email',
	'OAUTH2_ICON': 'fa-openid',
	'OAUTH2_BUTTON_COLOR': '<button-color>',
	'OAUTH2_CHALLENGE_METHOD': 'S256',
	'OAUTH2_RESPONSE_TYPE': 'code'
}]

See Also