Synapse

Tested Versions

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 demonstration purposes and you can theoretically use nearly any alphanumeric string.
  2. The OpenID Connect 1.0 secret parameter:
    1. The value used in this guide is merely for demonstration purposes and you should absolutely not use this in production and should instead utilize the How Do I Generate Client Secrets 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. The Configuration example for Authelia is only a portion of the required configuration and it should be used as a guide in conjunction with the standard OpenID Connect 1.0 Configuration guide.

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://matrix.example.com/
  • Authelia Root URL: https://auth.example.com
  • Client ID: synapse
  • Client Secret: insecure_secret

Configuration

Application

To configure Synapse to utilize Authelia as an OpenID Connect 1.0 Provider:

  1. Edit your Synapse homeserver.yaml configuration file and add configure the following:
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"]
    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 }}"

Authelia

The following YAML configuration is an example Authelia client configuration for use with Synapse which will operate with the above 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:
    - id: synapse
      description: Synapse
      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
      userinfo_signing_algorithm: none

See Also