synapse-product/synapse/config/jwt.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

58 lines
1.9 KiB
Python
Raw Normal View History

2016-03-28 15:33:40 -04: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 09:30:15 -04:00
from ._base import Config, ConfigError
MISSING_JWT = """Missing jwt library. This is required for jwt login.
Install by running:
pip install pyjwt
"""
2016-03-28 15:33:40 -04:00
class JWTConfig(Config):
section = "jwt"
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
2016-03-28 15:33:40 -04: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 09:30:15 -04: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 09:30:15 -04:00
try:
import jwt
2019-06-20 05:32:02 -04:00
2016-04-25 09:30:15 -04:00
jwt # To stop unused lint.
except ImportError:
raise ConfigError(MISSING_JWT)
2016-03-28 15:33:40 -04: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