MatrixSynapse/synapse/config/jwt.py

122 lines
4.2 KiB
Python
Raw Normal View History

2016-03-28 21:33:40 +02:00
# Copyright 2015 Niklas Riekenbrauck
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Any
from synapse.types import JsonDict
2016-04-25 15:30:15 +02:00
from ._base import Config, ConfigError
2019-06-20 11:32:02 +02:00
MISSING_JWT = """Missing jwt library. This is required for jwt login.
2016-04-25 15:30:15 +02:00
Install by running:
pip install pyjwt
"""
2016-03-28 21:33:40 +02:00
class JWTConfig(Config):
section = "jwt"
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
2016-03-28 21:33:40 +02:00
jwt_config = config.get("jwt_config", None)
if jwt_config:
self.jwt_enabled = jwt_config.get("enabled", False)
self.jwt_secret = jwt_config["secret"]
self.jwt_algorithm = jwt_config["algorithm"]
2016-04-25 15:30:15 +02:00
self.jwt_subject_claim = jwt_config.get("subject_claim", "sub")
# The issuer and audiences are optional, if provided, it is asserted
# that the claims exist on the JWT.
self.jwt_issuer = jwt_config.get("issuer")
self.jwt_audiences = jwt_config.get("audiences")
2016-04-25 15:30:15 +02:00
try:
import jwt
2019-06-20 11:32:02 +02:00
2016-04-25 15:30:15 +02:00
jwt # To stop unused lint.
except ImportError:
raise ConfigError(MISSING_JWT)
2016-03-28 21:33:40 +02:00
else:
self.jwt_enabled = False
self.jwt_secret = None
self.jwt_algorithm = None
self.jwt_subject_claim = None
self.jwt_issuer = None
self.jwt_audiences = None
2016-03-28 21:33:40 +02:00
def generate_config_section(self, **kwargs: Any) -> str:
2016-03-28 21:33:40 +02:00
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
2020-10-23 18:38:40 +02:00
# expected to be non-existent.
#
# See https://matrix-org.github.io/synapse/latest/jwt.html.
2016-04-01 19:04:28 +02:00
#
#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"
2016-03-28 21:33:40 +02:00
"""