Synapse

Tested Versions#

• Authelia
  • v4.39.1
• Synapse
  • v1.127.1

Before You Begin#

Common Notes#

1. The OpenID Connect 1.0 client_id parameter:
   1. This must be a unique value for every client.
   2. The value used in this guide is merely for readability and demonstration purposes and you should not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ. We recommend 64 random characters but you can use any arbitrary value that meets the other criteria.
   3. This must only contain RFC3986 Unreserved Characters.
   4. This must be no more than 100 characters in length.
2. The OpenID Connect 1.0 client_secret parameter:
   1. The value used in this guide is merely for demonstration purposes and you should absolutely not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ.
   2. This string may be stored as plaintext in the Authelia configuration but this behaviour is deprecated and is not guaranteed to be supported in the future. See the Plaintext guide for more information.
   3. When the secret is stored in hashed form in the Authelia configuration (heavily recommended), the cost of hashing can, if too great, cause timeouts for clients. See the Tuning the work factors guide for more information.
3. The configuration example for Authelia:
   1. Only contains an example configuration for the client registration and you MUST also configure the required elements from the OpenID Connect 1.0 Provider Configuration guide.
   2. Only contains a small portion of all of the available options for a registered client and users may wish to configure portions that are not part of this guide or configure them differently, as such it’s important to both familiarize yourself with the other options available and the effect of each of the options configured in this section by looking at the OpenID Connect 1.0 Clients Configuration guide.

Assumptions#

This example makes the following assumptions:

• Application Root URL: https://synapse.example.com/
• Authelia Root URL: https://auth.example.com/
• Client ID: synapse
• Client Secret: insecure_secret
• Groups: the synapse-users group exists and only members of this group are expected to be able to use Synapse.

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

Set Documentation Variables

Configuration#

Authelia#

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

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: 'synapse'
        client_name: 'Synapse'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        redirect_uris:
          - 'https://synapse.example.com/_synapse/client/oidc/callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'groups'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application#

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

Configuration File#

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

oidc_providers:
  - idp_id: authelia
    idp_name: 'Authelia'
    idp_icon: 'mxc://authelia.com/cKlrTPsGvlpKxAYeHWJsdVHI'
    discover: true
    issuer: 'https://auth.example.com'
    client_id: 'synapse'
    client_secret: 'insecure_secret'
    scopes:
     - 'openid'
     - 'profile'
     - 'email'
     - 'groups'
    allow_existing_users: true
    user_mapping_provider:
      config:
        subject_claim: 'sub'
        localpart_template: '{{ user.preferred_username }}'
        display_name_template: '{{ user.name }}'
        email_template: '{{ user.email }}'
    attribute_requirements:
     - attribute: 'groups'
       value: 'synapse-users'

See Also#

• Synapse OpenID Connect Authentication Documentation