1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Copyright (C) 2010-2012 Yaco Sistemas (http://www.yaco.es)
# Copyright (C) 2009 Lorenzo Gil Sanchez <lorenzo.gil.sanchez@gmail.com>
#
# 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.
import copy
from typing import Callable, Optional, Union
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from django.http import HttpRequest
from django.utils.module_loading import import_string
from saml2.config import SPConfig
from .utils import get_custom_setting
def get_config_loader(path: str) -> Callable:
"""Import the function at a given path and return it"""
try:
config_loader = import_string(path)
except ImportError as e:
raise ImproperlyConfigured(f'Error importing SAML config loader {path}: "{e}"')
if not callable(config_loader):
raise ImproperlyConfigured("SAML config loader must be a callable object.")
return config_loader
def config_settings_loader(request: Optional[HttpRequest] = None) -> SPConfig:
"""Utility function to load the pysaml2 configuration.
The configuration can be modified based on the request being passed.
This is the default config loader, which just loads the config from the settings.
"""
conf = SPConfig()
conf.load(copy.deepcopy(settings.SAML_CONFIG))
return conf
def get_config(
config_loader_path: Optional[Union[Callable, str]] = None,
request: Optional[HttpRequest] = None,
) -> SPConfig:
"""Load a config_loader function if necessary, and call that
function with the request as argument.
If the config_loader_path is a callable instead of a string,
no importing is necessary and it will be used directly.
Return the resulting SPConfig.
"""
config_loader_path = config_loader_path or get_custom_setting(
"SAML_CONFIG_LOADER", "djangosaml2.conf.config_settings_loader"
)
if callable(config_loader_path):
config_loader = config_loader_path
else:
config_loader = get_config_loader(config_loader_path)
return config_loader(request)
|
