Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
3f7a0dd
Refactor: use get_services_container_dn for service container DN retr…
Jan 13, 2026
fd408db
Refactor: improve attribute update queries in alembic migration
Jan 13, 2026
c07fe6d
Refactor: simplify directory selection queries in alembic migration f…
Jan 13, 2026
61b0d80
Enhance entrypoint script: add config fix function and periodic updat…
Jan 13, 2026
a7cadbd
Update Kerberos configuration handling: add shared volume for KDC fil…
Jan 13, 2026
1f4697d
Remove outdated comment regarding services container name in Kerberos…
Jan 13, 2026
b45356a
Update test case in kadmin.py to reflect new expected hash value for …
Jan 13, 2026
08cd05c
Refactor alembic migration to rename 'services' to 'System' and updat…
Jan 16, 2026
53854a7
Refactor alembic migration to improve session handling and streamline…
Jan 16, 2026
b15fbde
Update down_revision in alembic migration to reflect the latest migra…
Jan 16, 2026
a6abcd0
Refactor: rename get_services_container_dn to get_system_container_dn…
Jan 16, 2026
f076c03
Add shared volume for KDC files in development and package docker-com…
Jan 19, 2026
a6d5882
Remove unused downgrade function for updating descendant paths in ale…
Jan 19, 2026
4601e4c
Refactor alembic migration to consolidate attribute update logic for …
Jan 19, 2026
91a143f
Fix comment formatting in downgrade function of alembic migration for…
Jan 19, 2026
25c1749
Enhance alembic migration for renaming 'services' to 'System' by cons…
Jan 19, 2026
e2f9114
Remove redundant existence check for 'System' directory in alembic mi…
Jan 19, 2026
7b01fe1
Remove unused base directory checks in alembic migration for renaming…
Jan 19, 2026
87d07d6
Update down_revision in alembic migration for renaming 'services' to …
Jan 19, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .kerberos/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ set -e

sed -i 's/ou=users/cn=users/g' /etc/kdc/krb5.d/stash.keyfile || true
sed -i 's/ou=users/cn=users/g' /etc/kdc/krb5.conf || true

cd /server

uvicorn --factory config_server:create_app \
Expand Down
1 change: 1 addition & 0 deletions .package/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ services:
- ./certs:/certs
- psync_queue:/var/spool/krb5-sync
- ldap_keytab:/LDAP_keytab/
- kdc:/etc/krb5kdc/
env_file:
.env
command: python multidirectory.py --scheduler
Expand Down
143 changes: 143 additions & 0 deletions app/alembic/versions/a1b2c3d4e5f6_rename_services_to_system.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
"""Rename services container to System for AD compatibility.

Revision ID: a1b2c3d4e5f6
Revises: 6c858cc05da7
Create Date: 2026-01-13 12:00:00.000000

"""

from alembic import op
from dishka import AsyncContainer, Scope
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncConnection, AsyncSession

from entities import Attribute, Directory
from repo.pg.tables import queryable_attr as qa

# revision identifiers, used by Alembic.
revision: None | str = "a1b2c3d4e5f6"
down_revision: None | str = "c5a9b3f2e8d7"
branch_labels: None | list[str] = None
depends_on: None | list[str] = None


async def _update_descendants(
session: AsyncSession,
parent_id: int,
ou_from: str,
ou_to: str,
) -> None:
"""Recursively update paths of all descendants."""
child_dirs = await session.scalars(
select(Directory)
.where(qa(Directory.parent_id) == parent_id),
) # fmt: skip

for child_dir in child_dirs:
child_dir.path = [ou_from if p == ou_to else p for p in child_dir.path]
await session.flush()
await _update_descendants(
session,
child_dir.id,
ou_from=ou_from,
ou_to=ou_to,
)


async def _update_attributes(
session: AsyncSession,
old_value: str,
new_value: str,
) -> None:
"""Update attribute values during downgrade."""
result = await session.execute(
select(Attribute)
.where(
Attribute.value.ilike(f"%{old_value}%"), # type: ignore
),
) # fmt: skip
attributes = result.scalars().all()

for attr in attributes:
if attr.value and old_value in attr.value:
attr.value = attr.value.replace(old_value, new_value)

await session.flush()


def upgrade(container: AsyncContainer) -> None:
"""Upgrade: Rename 'services' container to 'System'."""

async def _rename_services_to_system(connection: AsyncConnection) -> None: # noqa: ARG001
async with container(scope=Scope.REQUEST) as cnt:
session = await cnt.get(AsyncSession)

service_dir = await session.scalar(
select(Directory).where(
qa(Directory.name) == "services",
qa(Directory.is_system).is_(True),
),
)
if not service_dir:
return
ou_to = "ou=System"
ou_from = "ou=services"

service_dir.name = "System"
service_dir.path = [
ou_to if p == ou_from else p for p in service_dir.path
]

await session.flush()
await _update_descendants(
session,
service_dir.id,
ou_from=ou_from,
ou_to=ou_to,
)

await _update_attributes(session, ou_from, ou_to)
await session.commit()

op.run_async(_rename_services_to_system)


def downgrade(container: AsyncContainer) -> None:
"""Downgrade: Rename 'System' container back to 'services'."""

async def _rename_system_to_services(connection: AsyncConnection) -> None: # noqa: ARG001
async with container(scope=Scope.REQUEST) as cnt:
session = await cnt.get(AsyncSession)

system_dir = await session.scalar(
select(Directory).where(
qa(Directory.name) == "System",
qa(Directory.is_system).is_(True),
),
)
if not system_dir:
return
ou_to = "ou=services"
ou_from = "ou=System"

system_dir.name = "services"
system_dir.path = [
ou_to if p == ou_from else p for p in system_dir.path
]

await session.flush()
await _update_descendants(
session,
system_dir.id,
ou_from=ou_from,
ou_to=ou_to,
)

await _update_attributes(
session,
ou_from,
ou_to,
)
await session.commit()

op.run_async(_rename_system_to_services)
77 changes: 60 additions & 17 deletions app/extra/scripts/update_krb5_config.py
Original file line number Diff line number Diff line change
@@ -1,46 +1,89 @@
"""Kerberos update config.
"""Kerberos configuration update script.

Copyright (c) 2025 MultiFactor
License: https://github.com/MultiDirectoryLab/MultiDirectory/blob/main/LICENSE
"""

from pathlib import Path

from loguru import logger
from sqlalchemy.ext.asyncio import AsyncSession

from config import Settings
from ldap_protocol.kerberos import AbstractKadmin
from ldap_protocol.kerberos.utils import get_system_container_dn
from ldap_protocol.utils.queries import get_base_directories

KRB5_CONF_PATH = Path("/etc/krb5kdc/krb5.conf")
KDC_CONF_PATH = Path("/etc/krb5kdc/kdc.conf")
STASH_FILE_PATH = Path("/etc/krb5kdc/krb5.d/stash.keyfile")


def _migrate_legacy_dns(content: str) -> str:
"""Replace legacy DN formats with current ones.

:param content: File content to migrate.
:return: Migrated content.
"""
return content.replace("ou=services", "ou=System").replace(
"ou=users",
"cn=users",
)


async def update_krb5_config(
kadmin: AbstractKadmin,
session: AsyncSession,
settings: Settings,
) -> None:
"""Update kerberos config."""
if not (await kadmin.get_status(wait_for_positive=True)):
logger.error("kadmin_api is not running")
return
"""Update Kerberos configuration files via direct write to shared volume.

base_dn_list = await get_base_directories(session)
base_dn = base_dn_list[0].path_dn
domain: str = base_dn_list[0].name
Renders krb5.conf and kdc.conf from templates and writes them directly
to the shared volume. Also migrates legacy DN formats in stash.keyfile
if present (ou=services -> ou=System, ou=users -> cn=users).

krbadmin = "cn=krbadmin,cn=users," + base_dn
services_container = "ou=services," + base_dn
:param session: Database session for fetching base directories.
:param settings: Application settings with template environment.
:raises Exception: If config rendering or writing fails.
"""
if not KRB5_CONF_PATH.parent.exists():
logger.error(
f"Config directory {KRB5_CONF_PATH.parent} not found, "
"kerberos volume not mounted",
)
return

krb5_template = settings.TEMPLATES.get_template("krb5.conf")
kdc_template = settings.TEMPLATES.get_template("kdc.conf")
base_dn_list = await get_base_directories(session)
if not base_dn_list:
logger.error("No base directories found")
return

kdc_config = await kdc_template.render_async(domain=domain)
base_dn = base_dn_list[0].path_dn
domain = base_dn_list[0].name
krbadmin = f"cn=krbadmin,cn=users,{base_dn}"
services_container = get_system_container_dn(base_dn)

krb5_config = await krb5_template.render_async(
krb5_config = await settings.TEMPLATES.get_template(
"krb5.conf",
).render_async(
domain=domain,
krbadmin=krbadmin,
services_container=services_container,
ldap_uri=settings.KRB5_LDAP_URI,
mfa_push_url=settings.KRB5_MFA_PUSH_URL,
sync_password_url=settings.KRB5_SYNC_PASSWORD_URL,
)
kdc_config = await settings.TEMPLATES.get_template(
"kdc.conf",
).render_async(
domain=domain,
)

KRB5_CONF_PATH.write_text(krb5_config, encoding="utf-8")
KDC_CONF_PATH.write_text(kdc_config, encoding="utf-8")

await kadmin.setup_configs(krb5_config, kdc_config)
if STASH_FILE_PATH.exists():
stash_content = STASH_FILE_PATH.read_text(encoding="utf-8")
if "ou=services" in stash_content or "ou=users" in stash_content:
STASH_FILE_PATH.write_text(
_migrate_legacy_dns(stash_content),
encoding="utf-8",
)
11 changes: 8 additions & 3 deletions app/ldap_protocol/kerberos/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@
from .ldap_structure import KRBLDAPStructureManager
from .schemas import AddRequests, KDCContext, KerberosAdminDnGroup, TaskStruct
from .template_render import KRBTemplateRenderer
from .utils import KerberosState, get_krb_server_state, set_state
from .utils import (
KerberosState,
get_krb_server_state,
get_system_container_dn,
set_state,
)


class KerberosService(AbstractService):
Expand Down Expand Up @@ -141,7 +146,7 @@ def _build_kerberos_admin_dns(self, base_dn: str) -> KerberosAdminDnGroup:
dataclass with DN for krbadmin, services_container, krbadmin_group.
"""
krbadmin = f"cn=krbadmin,cn=users,{base_dn}"
services_container = f"ou=services,{base_dn}"
services_container = get_system_container_dn(base_dn)
krbgroup = f"cn=krbadmin,cn=groups,{base_dn}"
return KerberosAdminDnGroup(
krbadmin_dn=krbadmin,
Expand Down Expand Up @@ -293,7 +298,7 @@ async def _get_kdc_context(self) -> KDCContext:
base_dn, domain = await self._get_base_dn()
krbadmin = f"cn=krbadmin,cn=users,{base_dn}"
krbgroup = f"cn=krbadmin,cn=groups,{base_dn}"
services_container = f"ou=services,{base_dn}"
services_container = get_system_container_dn(base_dn)
return KDCContext(
base_dn=base_dn,
domain=domain,
Expand Down
5 changes: 5 additions & 0 deletions app/ldap_protocol/kerberos/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,8 @@ async def unlock_principal(name: str, session: AsyncSession) -> None:
.filter_by(directory_id=subquery, name="krbprincipalexpiration")
.execution_options(synchronize_session=False),
)


def get_system_container_dn(base_dn: str) -> str:
"""Get System container DN for services."""
return f"ou=System,{base_dn}"
3 changes: 2 additions & 1 deletion app/ldap_protocol/roles/role_use_case.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

from entities import AccessControlEntry, AceType, Directory, Role
from enums import AuthorizationRules, RoleConstants, RoleScope
from ldap_protocol.kerberos.utils import get_system_container_dn
from ldap_protocol.utils.queries import get_base_directories
from repo.pg.tables import (
access_control_entries_table,
Expand Down Expand Up @@ -211,7 +212,7 @@ async def create_kerberos_system_role(self) -> None:

aces = self._get_full_access_aces(
role_id=self._role_dao.get_last_id(),
base_dn="ou=services," + base_dn_list[0].path_dn,
base_dn=get_system_container_dn(base_dn_list[0].path_dn),
)
await self._access_control_entry_dao.create_bulk(aces)

Expand Down
1 change: 1 addition & 0 deletions docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ services:
- ./certs:/certs
- ./app:/app
- ldap_keytab:/LDAP_keytab/
- kdc:/etc/krb5kdc/
env_file:
local.env
command: python multidirectory.py --scheduler
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ services:
- ./certs:/certs
- ./app:/app
- ldap_keytab:/LDAP_keytab/
- kdc:/etc/krb5kdc/
env_file: local.env
command: python multidirectory.py --scheduler
tty: true
Expand Down
8 changes: 4 additions & 4 deletions tests/test_api/test_main/test_kadmin.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ async def test_tree_creation(
response = await http_client.post(
"entry/search",
json={
"base_object": "ou=services,dc=md,dc=test",
"base_object": "ou=System,dc=md,dc=test",
"scope": 0,
"deref_aliases": 0,
"size_limit": 1000,
Expand All @@ -90,7 +90,7 @@ async def test_tree_creation(
)
assert (
response.json()["search_result"][0]["object_name"]
== "ou=services,dc=md,dc=test"
== "ou=System,dc=md,dc=test"
)

bind = MutePolicyBindRequest(
Expand Down Expand Up @@ -157,13 +157,13 @@ async def test_setup_call(
kdc_doc = kadmin.setup.call_args.kwargs.pop("kdc_config").encode()

# NOTE: Asserting documents integrity, tests template rendering
assert blake2b(krb_doc, digest_size=8).hexdigest() == "f433bbc7df5a236b"
assert blake2b(krb_doc, digest_size=8).hexdigest() == "0567ec28b8ccca51"
assert blake2b(kdc_doc, digest_size=8).hexdigest() == "79e43649d34fe577"

assert kadmin.setup.call_args.kwargs == {
"domain": "md.test",
"admin_dn": "cn=user0,cn=users,dc=md,dc=test",
"services_dn": "ou=services,dc=md,dc=test",
"services_dn": "ou=System,dc=md,dc=test",
"krbadmin_dn": "cn=krbadmin,cn=users,dc=md,dc=test",
"krbadmin_password": "Password123",
"ldap_keytab_path": "/LDAP_keytab/ldap.keytab",
Expand Down
2 changes: 0 additions & 2 deletions tests/test_shedule.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,9 @@ async def test_check_ldap_principal(
async def test_update_krb5_config(
session: AsyncSession,
settings: Settings,
kadmin: AbstractKadmin,
) -> None:
"""Test update_krb5_config."""
await update_krb5_config(
session=session,
kadmin=kadmin,
settings=settings,
)