diff options
| author | Shay <hillerys@element.io> | 2022-06-14 07:53:42 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-14 07:53:42 -0700 |
| commit | 493c2fc44abcf3457953cc2f6f23509ff7855253 (patch) | |
| tree | f429a75b187fdd0449bc1a460ce730b6d2b2ccd2 /synapse/config/jwt.py | |
| parent | Rename delta to apply in the proper schema version. (#13050) (diff) | |
| download | synapse-493c2fc44abcf3457953cc2f6f23509ff7855253.tar.xz | |
Remove code generating comments in configuration file (#12941)
Diffstat (limited to 'synapse/config/jwt.py')
| -rw-r--r-- | synapse/config/jwt.py | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/synapse/config/jwt.py b/synapse/config/jwt.py index 2a756d1a7c..7e3c764b2c 100644 --- a/synapse/config/jwt.py +++ b/synapse/config/jwt.py @@ -55,67 +55,3 @@ class JWTConfig(Config): self.jwt_subject_claim = None self.jwt_issuer = None self.jwt_audiences = None - - def generate_config_section(self, **kwargs: Any) -> str: - return """\ - # JSON web token integration. The following settings can be used to make - # Synapse JSON web tokens for authentication, instead of its internal - # password database. - # - # Each JSON Web Token needs to contain a "sub" (subject) claim, which is - # used as the localpart of the mxid. - # - # Additionally, the expiration time ("exp"), not before time ("nbf"), - # and issued at ("iat") claims are validated if present. - # - # Note that this is a non-standard login type and client support is - # expected to be non-existent. - # - # See https://matrix-org.github.io/synapse/latest/jwt.html. - # - #jwt_config: - # Uncomment the following to enable authorization using JSON web - # tokens. Defaults to false. - # - #enabled: true - - # This is either the private shared secret or the public key used to - # decode the contents of the JSON web token. - # - # Required if 'enabled' is true. - # - #secret: "provided-by-your-issuer" - - # The algorithm used to sign the JSON web token. - # - # Supported algorithms are listed at - # https://pyjwt.readthedocs.io/en/latest/algorithms.html - # - # Required if 'enabled' is true. - # - #algorithm: "provided-by-your-issuer" - - # Name of the claim containing a unique identifier for the user. - # - # Optional, defaults to `sub`. - # - #subject_claim: "sub" - - # The issuer to validate the "iss" claim against. - # - # Optional, if provided the "iss" claim will be required and - # validated for all JSON web tokens. - # - #issuer: "provided-by-your-issuer" - - # A list of audiences to validate the "aud" claim against. - # - # Optional, if provided the "aud" claim will be required and - # validated for all JSON web tokens. - # - # Note that if the "aud" claim is included in a JSON web token then - # validation will fail without configuring audiences. - # - #audiences: - # - "provided-by-your-issuer" - """ |