MatrixSynapse/synapse/config/cas.py

54 lines
1.8 KiB
Python
Raw Normal View History

2015-10-07 15:45:57 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
2015-10-07 15:45:57 +02:00
#
# 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 ._base import Config
class CasConfig(Config):
"""Cas Configuration
cas_server_url: URL of CAS server
"""
section = "cas"
def read_config(self, config, **kwargs):
2015-10-07 15:45:57 +02:00
cas_config = config.get("cas_config", None)
if cas_config:
self.cas_enabled = cas_config.get("enabled", True)
2015-10-07 15:45:57 +02:00
self.cas_server_url = cas_config["server_url"]
2015-11-05 00:32:30 +01:00
self.cas_service_url = cas_config["service_url"]
self.cas_displayname_attribute = cas_config.get("displayname_attribute")
self.cas_required_attributes = cas_config.get("required_attributes", {})
2015-10-07 15:45:57 +02:00
else:
self.cas_enabled = False
self.cas_server_url = None
2015-11-05 00:32:30 +01:00
self.cas_service_url = None
self.cas_displayname_attribute = None
self.cas_required_attributes = {}
2015-10-07 15:45:57 +02:00
def generate_config_section(self, config_dir_path, server_name, **kwargs):
2015-10-07 15:45:57 +02:00
return """
# Enable CAS for registration and login.
#
2015-10-07 15:45:57 +02:00
#cas_config:
# enabled: true
2015-10-07 15:45:57 +02:00
# server_url: "https://cas-server.com"
2017-10-29 21:54:20 +01:00
# service_url: "https://homeserver.domain.com:8448"
# #displayname_attribute: name
# #required_attributes:
# # name: value
2015-10-07 15:45:57 +02:00
"""