import json from django.db import models from django.db.utils import ProgrammingError, OperationalError from django.utils.translation import ugettext_lazy as _ from django.conf import settings from common.utils import signer, get_logger logger = get_logger(__name__) class SettingQuerySet(models.QuerySet): def __getattr__(self, item): queryset = list(self) instances = [i for i in queryset if i.name == item] if len(instances) == 1: return instances[0] else: return Setting() class SettingManager(models.Manager): def get_queryset(self): return SettingQuerySet(self.model, using=self._db) class Setting(models.Model): name = models.CharField(max_length=128, unique=True, verbose_name=_("Name")) value = models.TextField(verbose_name=_("Value"), null=True, blank=True) category = models.CharField(max_length=128, default="default") encrypted = models.BooleanField(default=False) enabled = models.BooleanField(verbose_name=_("Enabled"), default=True) comment = models.TextField(verbose_name=_("Comment")) objects = SettingManager() cache_key_prefix = '_SETTING_' def __str__(self): return self.name @property def cleaned_value(self): try: value = self.value if self.encrypted: value = signer.unsign(value) if not value: return None value = json.loads(value) return value except json.JSONDecodeError: return None @cleaned_value.setter def cleaned_value(self, item): try: v = json.dumps(item) if self.encrypted: v = signer.sign(v) self.value = v except json.JSONDecodeError as e: raise ValueError("Json dump error: {}".format(str(e))) @classmethod def refresh_all_settings(cls): try: settings_list = cls.objects.all() for setting in settings_list: setting.refresh_setting() except (ProgrammingError, OperationalError): pass @classmethod def refresh_item(cls, name): item = cls.objects.filter(name=name).first() if not item: return item.refresh_setting() def refresh_setting(self): if hasattr(self.__class__, f'refresh_{self.name}'): getattr(self.__class__, f'refresh_{self.name}')() else: setattr(settings, self.name, self.cleaned_value) self.refresh_keycloak_to_openid_if_need() @classmethod def refresh_authentications(cls, name): setting = cls.objects.filter(name=name).first() if not setting: return backends_map = { 'AUTH_LDAP': [settings.AUTH_BACKEND_LDAP], 'AUTH_OPENID': [settings.AUTH_BACKEND_OIDC_CODE, settings.AUTH_BACKEND_OIDC_PASSWORD], 'AUTH_RADIUS': [settings.AUTH_BACKEND_RADIUS], 'AUTH_CAS': [settings.AUTH_BACKEND_CAS], 'AUTH_SAML2': [settings.AUTH_BACKEND_SAML2], } setting_backends = backends_map[name] auth_backends = settings.AUTHENTICATION_BACKENDS for backend in setting_backends: has = backend in auth_backends # 添加 if setting.cleaned_value and not has: logger.debug('Add auth backend: {}'.format(name)) settings.AUTHENTICATION_BACKENDS.insert(0, backend) # 去掉 if not setting.cleaned_value and has: index = auth_backends.index(backend) logger.debug('Pop auth backend: {}'.format(name)) auth_backends.pop(index) # 设置内存值 setattr(settings, name, setting.cleaned_value) @classmethod def refresh_AUTH_CAS(cls): cls.refresh_authentications('AUTH_CAS') @classmethod def refresh_AUTH_LDAP(cls): cls.refresh_authentications('AUTH_LDAP') @classmethod def refresh_AUTH_OPENID(cls): cls.refresh_authentications('AUTH_OPENID') @classmethod def refresh_AUTH_SAML2(cls): cls.refresh_authentications('AUTH_SAML2') def refresh_keycloak_to_openid_if_need(self): watch_config_names = [ 'AUTH_OPENID', 'AUTH_OPENID_REALM_NAME', 'AUTH_OPENID_SERVER_URL', 'AUTH_OPENID_PROVIDER_ENDPOINT', 'AUTH_OPENID_KEYCLOAK' ] if self.name not in watch_config_names: # 不在监听的配置中, 不需要刷新 return auth_keycloak = self.__class__.objects.filter(name='AUTH_OPENID_KEYCLOAK').first() if not auth_keycloak or not auth_keycloak.cleaned_value: # 关闭 Keycloak 方式的配置, 不需要刷新 return from jumpserver.conf import Config config_names = [ 'AUTH_OPENID', 'AUTH_OPENID_REALM_NAME', 'AUTH_OPENID_SERVER_URL', 'AUTH_OPENID_PROVIDER_ENDPOINT' ] # 获取当前 keycloak 配置 keycloak_config = {} for name in config_names: setting = self.__class__.objects.filter(name=name).first() if not setting: continue value = setting.cleaned_value keycloak_config[name] = value # 转化 keycloak 配置为 openid 配置 openid_config = Config.convert_keycloak_to_openid(keycloak_config) if not openid_config: return # 刷新 settings for key, value in openid_config.items(): setattr(settings, key, value) self.update_or_create(key, value, encrypted=False, category=self.category) @classmethod def refresh_AUTH_RADIUS(cls): cls.refresh_authentications('AUTH_RADIUS') @classmethod def update_or_create(cls, name='', value='', encrypted=False, category=''): """ 不能使用 Model 提供的,update_or_create 因为这里有 encrypted 和 cleaned_value :return: (changed, instance) """ setting = cls.objects.filter(name=name).first() changed = False if not setting: setting = Setting(name=name, encrypted=encrypted, category=category) if setting.cleaned_value != value: setting.encrypted = encrypted setting.cleaned_value = value setting.save() changed = True return changed, setting class Meta: db_table = "settings_setting" verbose_name = _("System setting")