conf.py

"""
Settings used by django-python3.
"""
from ssl import PROTOCOL_TLS

from django.conf import settings


class LazySetting(object):

    """
    A proxy to a named Django setting.
    """

    def __init__(self, name, default=None):
        self.name = name
        self.default = default

    def __get__(self, obj, cls):
        if obj is None:
            return self

        property_name = self.name

        if hasattr(obj._settings, (name_with_prefix := obj._prefix + self.name)):
            property_name = name_with_prefix

        return getattr(obj._settings, property_name, self.default)


class LazySettings(object):

    """
    A proxy to ldap-specific django settings.

    Settings are resolved at runtime, allowing tests
    to change settings at runtime.
    """

    def __init__(self, settings, prefix=''):
        self._settings = settings
        self._prefix = prefix

    def set_or_clear_prefix(self, new_prefix=''):
        """
        Setter method for the _prefix property, is called before each authentication.
        This allows users to use multiple LDAP configs at the same time.

        Args:
            new_prefix (str, optional): The string that should be appended to the default constant names. Defaults to an empty string.
        """
        self._prefix = new_prefix

    LDAP_AUTH_URL = LazySetting(
        name="LDAP_AUTH_URL",
        default=["ldap://localhost:389"],
    )

    LDAP_AUTH_USE_TLS = LazySetting(
        name="LDAP_AUTH_USE_TLS",
        default=False,
    )

    LDAP_AUTH_TLS_CIPHERS = LazySetting(
        name="LDAP_AUTH_TLS_CIPHERS",
        default="ALL",
    )

    LDAP_AUTH_TLS_VERSION = LazySetting(
        name="LDAP_AUTH_TLS_VERSION",
        default=PROTOCOL_TLS,
    )

    LDAP_AUTH_TLS_ARGS = LazySetting(
        name="LDAP_AUTH_TLS_ARGS",
        default={},
    )

    LDAP_AUTH_SEARCH_BASE = LazySetting(
        name="LDAP_AUTH_SEARCH_BASE",
        default="ou=people,dc=example,dc=com",
    )

    LDAP_AUTH_OBJECT_CLASS = LazySetting(
        name="LDAP_AUTH_OBJECT_CLASS",
        default="inetOrgPerson",
    )

    LDAP_AUTH_USER_FIELDS = LazySetting(
        name="LDAP_AUTH_USER_FIELDS",
        default={
            "username": "uid",
            "first_name": "givenName",
            "last_name": "sn",
            "email": "mail",
        },
    )

    LDAP_AUTH_USER_LOOKUP_FIELDS = LazySetting(
        name="LDAP_AUTH_USER_LOOKUP_FIELDS",
        default=(
            "username",
        ),
    )

    LDAP_AUTH_CLEAN_USER_DATA = LazySetting(
        name="LDAP_AUTH_CLEAN_USER_DATA",
        default="django_python3_ldap.utils.clean_user_data",
    )

    LDAP_AUTH_FORMAT_SEARCH_FILTERS = LazySetting(
        name="LDAP_AUTH_FORMAT_SEARCH_FILTERS",
        default="django_python3_ldap.utils.format_search_filters",
    )

    LDAP_AUTH_SYNC_USER_RELATIONS = LazySetting(
        name="LDAP_AUTH_SYNC_USER_RELATIONS",
        default="django_python3_ldap.utils.sync_user_relations",
    )

    LDAP_AUTH_FORMAT_USERNAME = LazySetting(
        name="LDAP_AUTH_FORMAT_USERNAME",
        default="django_python3_ldap.utils.format_username_openldap",
    )

    LDAP_AUTH_ACTIVE_DIRECTORY_DOMAIN = LazySetting(
        name="LDAP_AUTH_ACTIVE_DIRECTORY_DOMAIN",
        default=None,
    )

    LDAP_AUTH_TEST_USER_USERNAME = LazySetting(
        name="LDAP_AUTH_TEST_USER_USERNAME",
        default="",
    )

    LDAP_AUTH_TEST_USER_EMAIL = LazySetting(
        name="LDAP_AUTH_TEST_USER_EMAIL",
        default=""
    )

    LDAP_AUTH_TEST_USER_PASSWORD = LazySetting(
        name="LDAP_AUTH_TEST_USER_PASSWORD",
        default="",
    )

    LDAP_AUTH_CONNECTION_USERNAME = LazySetting(
        name="LDAP_AUTH_CONNECTION_USERNAME",
        default=None,
    )

    LDAP_AUTH_CONNECTION_PASSWORD = LazySetting(
        name="LDAP_AUTH_CONNECTION_PASSWORD",
        default=None,
    )

    LDAP_AUTH_CONNECT_ARGS = LazySetting(
        name="LDAP_AUTH_CONNECT_ARGS",
        default={},
    )

    LDAP_AUTH_CONNECT_USE_SSL = LazySetting(
        name="LDAP_AUTH_CONNECT_USE_SSL",
        default=False,
    )

    LDAP_AUTH_CONNECT_TIMEOUT = LazySetting(
        name="LDAP_AUTH_CONNECT_TIMEOUT",
        default=None
    )

    LDAP_AUTH_RECEIVE_TIMEOUT = LazySetting(
        name="LDAP_AUTH_RECEIVE_TIMEOUT",
        default=None
    )

    LDAP_AUTH_POOL_ACTIVE = LazySetting(
        name="LDAP_AUTH_POOL_ACTIVE",
        default=True
    )


settings = LazySettings(settings)