split plugin dirs, created new cleaner import path for plugin config in settings.py

archivebox/auth_plugins/ldap/apps.py

@@ -0,0 +1,55 @@
+__package__ = 'archivebox.auth_plugins.ldap'
+
+import inspect
+
+from typing import List, Dict
+from pathlib import Path
+from pydantic import InstanceOf
+
+from django.conf import settings
+
+from pydantic_pkgr import BinProviderName, ProviderLookupDict, SemVer
+
+from plugantic.base_plugin import BasePlugin
+from plugantic.base_hook import BaseHook
+from plugantic.base_binary import BaseBinary, BaseBinProvider
+
+from pkg_plugins.pip.apps import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER
+from .settings import LDAP_CONFIG, LDAP_LIB
+
+
+###################### Config ##########################
+
+
+class LdapBinary(BaseBinary):
+    name: str = 'ldap'
+    description: str = 'LDAP Authentication'
+    binproviders_supported: List[InstanceOf[BaseBinProvider]] = [VENV_PIP_BINPROVIDER, SYS_PIP_BINPROVIDER]
+
+    provider_overrides: Dict[BinProviderName, ProviderLookupDict] = {
+        VENV_PIP_BINPROVIDER.name: {
+            "abspath": lambda: LDAP_LIB and Path(inspect.getfile(LDAP_LIB)),
+            "version": lambda: LDAP_LIB and SemVer(LDAP_LIB.__version__),
+        },
+        SYS_PIP_BINPROVIDER.name: {
+            "abspath": lambda: LDAP_LIB and Path(inspect.getfile(LDAP_LIB)),
+            "version": lambda: LDAP_LIB and SemVer(LDAP_LIB.__version__),
+        },
+    }
+
+LDAP_BINARY = LdapBinary()
+
+
+class LdapAuthPlugin(BasePlugin):
+    app_label: str = 'ldap'
+    verbose_name: str = 'LDAP Authentication'
+
+    hooks: List[InstanceOf[BaseHook]] = [
+        LDAP_CONFIG,
+        LDAP_BINARY,
+    ]
+
+
+PLUGIN = LdapAuthPlugin()
+PLUGIN.register(settings)
+DJANGO_APP = PLUGIN.AppConfig

archivebox/auth_plugins/ldap/settings.py

@@ -0,0 +1,85 @@
+__package__ = 'archivebox.auth_plugins.ldap'
+
+import sys
+
+from typing import Dict, List, ClassVar, Optional
+from pydantic import Field, model_validator
+
+from ...plugantic.base_configset import BaseConfigSet, ConfigSectionName
+
+LDAP_LIB = None
+try:
+    import ldap
+    from django_auth_ldap.config import LDAPSearch
+    LDAP_LIB = ldap
+except ImportError:
+    pass
+
+###################### Config ##########################
+
+
+class LdapConfig(BaseConfigSet):
+    """
+    LDAP Config gets imported by core/settings.py very early during startup, so it needs to be in a separate file from apps.py
+    so that it can be imported during settings.py initialization before the apps are loaded.
+    """
+    section: ClassVar[ConfigSectionName] = 'LDAP_CONFIG'
+
+    LDAP_ENABLED: bool                  = Field(default=False, alias='LDAP')
+    
+    LDAP_SERVER_URI: str                = Field(default=None)
+    LDAP_BIND_DN: str                   = Field(default=None)
+    LDAP_BIND_PASSWORD: str             = Field(default=None)
+    LDAP_USER_BASE: str                 = Field(default=None)
+    LDAP_USER_FILTER: str               = Field(default=None)
+    LDAP_CREATE_SUPERUSER: bool         = Field(default=False)
+
+    LDAP_USERNAME_ATTR: str             = Field(default=None)
+    LDAP_FIRSTNAME_ATTR: str            = Field(default=None)
+    LDAP_LASTNAME_ATTR: str             = Field(default=None)
+    LDAP_EMAIL_ATTR: str                = Field(default=None)
+    
+    @model_validator(mode='after')
+    def validate_ldap_config(self):
+        if self.LDAP_ENABLED and LDAP_LIB is None:
+            sys.stderr.write('[X] Error: Found LDAP=True config but LDAP packages not installed. You may need to run: pip install archivebox[ldap]\n\n')
+            # dont hard exit here. in case the user is just running "archivebox version" or "archivebox help", we still want those to work despite broken ldap
+            # sys.exit(1)
+            self.LDAP_ENABLED = False
+
+        if self.LDAP_ENABLED:
+            assert (
+                self.LDAP_SERVER_URI
+                and self.LDAP_BIND_DN
+                and self.LDAP_BIND_PASSWORD
+                and self.LDAP_USER_BASE
+                and self.LDAP_USER_FILTER
+            ), 'LDAP_* config options must all be set if LDAP_ENABLED=True'
+        return self
+
+    @property
+    def LDAP_USER_ATTR_MAP(self) -> Dict[str, str]:
+        return {
+            'username': self.LDAP_USERNAME_ATTR,
+            'first_name': self.LDAP_FIRSTNAME_ATTR,
+            'last_name': self.LDAP_LASTNAME_ATTR,
+            'email': self.LDAP_EMAIL_ATTR,
+        }
+
+    @property
+    def AUTHENTICATION_BACKENDS(self) -> List[str]:
+        return [
+            'django.contrib.auth.backends.ModelBackend',
+            'django_auth_ldap.backend.LDAPBackend',
+        ]
+
+    @property
+    def AUTH_LDAP_USER_SEARCH(self) -> Optional[object]:
+        return LDAP_LIB and LDAPSearch(
+            self.LDAP_USER_BASE,
+            LDAP_LIB.SCOPE_SUBTREE,                                                                         # type: ignore
+            '(&(' + self.LDAP_USERNAME_ATTR + '=%(user)s)' + self.LDAP_USER_FILTER + ')',
+        )
+
+
+LDAP_CONFIG = LdapConfig()