From 2ab6e67ab73ff4ed0264116853a3eaf66a66d3ba Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Thu, 4 Feb 2021 09:06:20 -0500 Subject: [PATCH] Fix escaping of braces in OIDC sample config. (#9317) This fixes the Jinja2 templates for the mapping provider. --- changelog.d/9317.doc | 1 + docs/sample_config.yaml | 10 +++++----- synapse/config/oidc_config.py | 10 +++++----- 3 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 changelog.d/9317.doc diff --git a/changelog.d/9317.doc b/changelog.d/9317.doc new file mode 100644 index 000000000000..f4d508e0903a --- /dev/null +++ b/changelog.d/9317.doc @@ -0,0 +1 @@ +Fix the braces in the `oidc_providers` section of the sample config. diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 9dbba63bac24..fbbf71edd9fc 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1872,9 +1872,9 @@ oidc_providers: # user_mapping_provider: # config: # subject_claim: "id" - # localpart_template: "{ user.login }" - # display_name_template: "{ user.name }" - # email_template: "{ user.email }" + # localpart_template: "{{ user.login }}" + # display_name_template: "{{ user.name }}" + # email_template: "{{ user.email }}" # For use with Keycloak # @@ -1901,8 +1901,8 @@ oidc_providers: # user_mapping_provider: # config: # subject_claim: "id" - # localpart_template: "{ user.login }" - # display_name_template: "{ user.name }" + # localpart_template: "{{ user.login }}" + # display_name_template: "{{ user.name }}" # Enable Central Authentication Service (CAS) for registration and login. diff --git a/synapse/config/oidc_config.py b/synapse/config/oidc_config.py index 4c24c50629a5..9d8196d8c34f 100644 --- a/synapse/config/oidc_config.py +++ b/synapse/config/oidc_config.py @@ -198,9 +198,9 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs): # user_mapping_provider: # config: # subject_claim: "id" - # localpart_template: "{{ user.login }}" - # display_name_template: "{{ user.name }}" - # email_template: "{{ user.email }}" + # localpart_template: "{{{{ user.login }}}}" + # display_name_template: "{{{{ user.name }}}}" + # email_template: "{{{{ user.email }}}}" # For use with Keycloak # @@ -227,8 +227,8 @@ def generate_config_section(self, config_dir_path, server_name, **kwargs): # user_mapping_provider: # config: # subject_claim: "id" - # localpart_template: "{{ user.login }}" - # display_name_template: "{{ user.name }}" + # localpart_template: "{{{{ user.login }}}}" + # display_name_template: "{{{{ user.name }}}}" """.format( mapping_provider=DEFAULT_USER_MAPPING_PROVIDER )