synapse-old/synapse/config/jwt_config.py

55 lines
1.6 KiB
Python
Raw Normal View History

2016-03-28 13:33:40 -06:00
# -*- coding: utf-8 -*-
# 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.
2016-04-25 07:30:15 -06:00
from ._base import Config, ConfigError
2019-06-20 03:32:02 -06:00
MISSING_JWT = """Missing jwt library. This is required for jwt login.
2016-04-25 07:30:15 -06:00
Install by running:
pip install pyjwt
"""
2016-03-28 13:33:40 -06:00
class JWTConfig(Config):
section = "jwt"
def read_config(self, config, **kwargs):
2016-03-28 13:33:40 -06: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 07:30:15 -06:00
try:
import jwt
2019-06-20 03:32:02 -06:00
2016-04-25 07:30:15 -06:00
jwt # To stop unused lint.
except ImportError:
raise ConfigError(MISSING_JWT)
2016-03-28 13:33:40 -06:00
else:
self.jwt_enabled = False
self.jwt_secret = None
self.jwt_algorithm = None
def generate_config_section(self, **kwargs):
2016-03-28 13:33:40 -06:00
return """\
2016-04-01 11:04:28 -06:00
# The JWT needs to contain a globally unique "sub" (subject) claim.
#
#jwt_config:
# enabled: true
# secret: "a secret"
# algorithm: "HS256"
2016-03-28 13:33:40 -06:00
"""