Remove code generating comments in configuration file (#12941)

1 files changed, 0 insertions, 183 deletions

diff --git a/synapse/config/saml2.py b/synapse/config/saml2.py
index 19b2f1b215..bd7c234d31 100644
--- a/synapse/config/saml2.py
+++ b/synapse/config/saml2.py
@@ -223,189 +223,6 @@ class SAML2Config(Config):
             },
         }
 
-    def generate_config_section(self, config_dir_path: str, **kwargs: Any) -> str:
-        return """\
-        ## Single sign-on integration ##
-
-        # The following settings can be used to make Synapse use a single sign-on
-        # provider for authentication, instead of its internal password database.
-        #
-        # You will probably also want to set the following options to `false` to
-        # disable the regular login/registration flows:
-        #   * enable_registration
-        #   * password_config.enabled
-        #
-        # You will also want to investigate the settings under the "sso" configuration
-        # section below.
-
-        # Enable SAML2 for registration and login. Uses pysaml2.
-        #
-        # At least one of `sp_config` or `config_path` must be set in this section to
-        # enable SAML login.
-        #
-        # Once SAML support is enabled, a metadata file will be exposed at
-        # https://<server>:<port>/_synapse/client/saml2/metadata.xml, which you may be able to
-        # use to configure your SAML IdP with. Alternatively, you can manually configure
-        # the IdP to use an ACS location of
-        # https://<server>:<port>/_synapse/client/saml2/authn_response.
-        #
-        saml2_config:
-          # `sp_config` is the configuration for the pysaml2 Service Provider.
-          # See pysaml2 docs for format of config.
-          #
-          # Default values will be used for the 'entityid' and 'service' settings,
-          # so it is not normally necessary to specify them unless you need to
-          # override them.
-          #
-          sp_config:
-            # Point this to the IdP's metadata. You must provide either a local
-            # file via the `local` attribute or (preferably) a URL via the
-            # `remote` attribute.
-            #
-            #metadata:
-            #  local: ["saml2/idp.xml"]
-            #  remote:
-            #    - url: https://our_idp/metadata.xml
-
-            # Allowed clock difference in seconds between the homeserver and IdP.
-            #
-            # Uncomment the below to increase the accepted time difference from 0 to 3 seconds.
-            #
-            #accepted_time_diff: 3
-
-            # By default, the user has to go to our login page first. If you'd like
-            # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
-            # 'service.sp' section:
-            #
-            #service:
-            #  sp:
-            #    allow_unsolicited: true
-
-            # The examples below are just used to generate our metadata xml, and you
-            # may well not need them, depending on your setup. Alternatively you
-            # may need a whole lot more detail - see the pysaml2 docs!
-
-            #description: ["My awesome SP", "en"]
-            #name: ["Test SP", "en"]
-
-            #ui_info:
-            #  display_name:
-            #    - lang: en
-            #      text: "Display Name is the descriptive name of your service."
-            #  description:
-            #    - lang: en
-            #      text: "Description should be a short paragraph explaining the purpose of the service."
-            #  information_url:
-            #    - lang: en
-            #      text: "https://example.com/terms-of-service"
-            #  privacy_statement_url:
-            #    - lang: en
-            #      text: "https://example.com/privacy-policy"
-            #  keywords:
-            #    - lang: en
-            #      text: ["Matrix", "Element"]
-            #  logo:
-            #    - lang: en
-            #      text: "https://example.com/logo.svg"
-            #      width: "200"
-            #      height: "80"
-
-            #organization:
-            #  name: Example com
-            #  display_name:
-            #    - ["Example co", "en"]
-            #  url: "http://example.com"
-
-            #contact_person:
-            #  - given_name: Bob
-            #    sur_name: "the Sysadmin"
-            #    email_address": ["admin@example.com"]
-            #    contact_type": technical
-
-          # Instead of putting the config inline as above, you can specify a
-          # separate pysaml2 configuration file:
-          #
-          #config_path: "%(config_dir_path)s/sp_conf.py"
-
-          # The lifetime of a SAML session. This defines how long a user has to
-          # complete the authentication process, if allow_unsolicited is unset.
-          # The default is 15 minutes.
-          #
-          #saml_session_lifetime: 5m
-
-          # An external module can be provided here as a custom solution to
-          # mapping attributes returned from a saml provider onto a matrix user.
-          #
-          user_mapping_provider:
-            # The custom module's class. Uncomment to use a custom module.
-            #
-            #module: mapping_provider.SamlMappingProvider
-
-            # Custom configuration values for the module. Below options are
-            # intended for the built-in provider, they should be changed if
-            # using a custom module. This section will be passed as a Python
-            # dictionary to the module's `parse_config` method.
-            #
-            config:
-              # The SAML attribute (after mapping via the attribute maps) to use
-              # to derive the Matrix ID from. 'uid' by default.
-              #
-              # Note: This used to be configured by the
-              # saml2_config.mxid_source_attribute option. If that is still
-              # defined, its value will be used instead.
-              #
-              #mxid_source_attribute: displayName
-
-              # The mapping system to use for mapping the saml attribute onto a
-              # matrix ID.
-              #
-              # Options include:
-              #  * 'hexencode' (which maps unpermitted characters to '=xx')
-              #  * 'dotreplace' (which replaces unpermitted characters with
-              #     '.').
-              # The default is 'hexencode'.
-              #
-              # Note: This used to be configured by the
-              # saml2_config.mxid_mapping option. If that is still defined, its
-              # value will be used instead.
-              #
-              #mxid_mapping: dotreplace
-
-          # In previous versions of synapse, the mapping from SAML attribute to
-          # MXID was always calculated dynamically rather than stored in a
-          # table. For backwards- compatibility, we will look for user_ids
-          # matching such a pattern before creating a new account.
-          #
-          # This setting controls the SAML attribute which will be used for this
-          # backwards-compatibility lookup. Typically it should be 'uid', but if
-          # the attribute maps are changed, it may be necessary to change it.
-          #
-          # The default is 'uid'.
-          #
-          #grandfathered_mxid_source_attribute: upn
-
-          # It is possible to configure Synapse to only allow logins if SAML attributes
-          # match particular values. The requirements can be listed under
-          # `attribute_requirements` as shown below. All of the listed attributes must
-          # match for the login to be permitted.
-          #
-          #attribute_requirements:
-          #  - attribute: userGroup
-          #    value: "staff"
-          #  - attribute: department
-          #    value: "sales"
-
-          # If the metadata XML contains multiple IdP entities then the `idp_entityid`
-          # option must be set to the entity to redirect users to.
-          #
-          # Most deployments only have a single IdP entity and so should omit this
-          # option.
-          #
-          #idp_entityid: 'https://our_idp/entityid'
-        """ % {
-            "config_dir_path": config_dir_path
-        }
-
 
 ATTRIBUTE_REQUIREMENTS_SCHEMA = {
     "type": "array",