Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

3.2 KB
Raw Blame
import glob
import logging
import os
from email.headerregistry import Address
from typing import Any

from django.conf import settings

from zerver.lib.storage import static_path

# See https://jackstromberg.com/2013/01/useraccountcontrol-attributeflag-values/
# for docs on what these values mean.
LDAP_USER_ACCOUNT_CONTROL_NORMAL = "512"
LDAP_USER_ACCOUNT_CONTROL_DISABLED = "514"


def generate_dev_ldap_dir(mode: str, num_users: int = 8) -> dict[str, dict[str, Any]]:
    mode = mode.lower()
    ldap_data = []
    for i in range(1, num_users + 1):
        name = f"LDAP User {i}"
        email = f"ldapuser{i}@zulip.com"
        phone_number = f"999999999{i}"
        birthdate = f"19{i:02}-{i:02}-{i:02}"
        ldap_data.append((name, email, phone_number, birthdate))

    profile_images = []
    for path in glob.glob(os.path.join(static_path("images/test-images/avatars"), "*")):
        with open(path, "rb") as f:
            profile_images.append(f.read())
    ldap_dir = {}
    for i, user_data in enumerate(ldap_data):
        email = user_data[1].lower()
        email_username = Address(addr_spec=email).username
        common_data = {
            "cn": [user_data[0]],
            "userPassword": [email_username],
            "phoneNumber": [user_data[2]],
            "birthDate": [user_data[3]],
        }
        if mode == "a":
            ldap_dir[f"uid={email},ou=users,dc=zulip,dc=com"] = dict(
                uid=[email],
                thumbnailPhoto=[profile_images[i % len(profile_images)]],
                userAccountControl=[LDAP_USER_ACCOUNT_CONTROL_NORMAL],
                **common_data,
            )
        elif mode == "b":
            ldap_dir[f"uid={email_username},ou=users,dc=zulip,dc=com"] = dict(
                uid=[email_username],
                jpegPhoto=[profile_images[i % len(profile_images)]],
                **common_data,
            )
        elif mode == "c":
            ldap_dir[f"uid={email_username},ou=users,dc=zulip,dc=com"] = dict(
                uid=[email_username], email=[email], **common_data
            )

    return ldap_dir


def init_fakeldap(
    directory: dict[str, dict[str, list[str]]] | None = None,
) -> None:  # nocoverage
    # We only use this in development.  Importing mock inside
    # this function is an import time optimization, which
    # avoids the expensive import of the mock module (slow
    # because its dependency pbr uses pkgresources, which is
    # really slow to import.)
    from unittest import mock

    from fakeldap import MockLDAP

    # Silent `django_auth_ldap` logger in dev mode to avoid
    # spammy user not found log messages.
    ldap_auth_logger = logging.getLogger("django_auth_ldap")
    ldap_auth_logger.setLevel(logging.CRITICAL)

    fakeldap_logger = logging.getLogger("fakeldap")
    fakeldap_logger.setLevel(logging.CRITICAL)

    ldap_patcher = mock.patch("django_auth_ldap.config.ldap.initialize")
    mock_initialize = ldap_patcher.start()
    mock_ldap = MockLDAP()
    mock_initialize.return_value = mock_ldap

    assert settings.FAKE_LDAP_MODE is not None
    mock_ldap.directory = directory or generate_dev_ldap_dir(
        settings.FAKE_LDAP_MODE, settings.FAKE_LDAP_NUM_USERS
    )