Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

4.4 KB
Raw Blame
"""Manage workspace knowledge API keys and keys restricted to one knowledge base."""

from collections.abc import Callable
from dataclasses import replace
from datetime import datetime
from typing import Protocol

from machinery.context import RequestContext
from services.auth.api_key_contracts import ApiKeyCache, ApiKeyRecord, ApiKeyResourceNotFoundError
from services.errors.base import NoPermissionError
from services.knowledge.dataset_access import (
    DatasetAccess,
    DatasetAccessDeniedError,
    DatasetNotFoundError,
)


class DatasetApiKeyStore(Protocol):
    def list_keys(self, workspace_id: str, dataset_id: str) -> tuple[ApiKeyRecord, ...]: ...

    def create_key(self, workspace_id: str, dataset_id: str, *, max_keys: int, prefix: str) -> ApiKeyRecord: ...

    def delete_key(self, workspace_id: str, dataset_id: str, key_id: str) -> ApiKeyRecord: ...

    def list_workspace_keys(self, workspace_id: str) -> tuple[ApiKeyRecord, ...]: ...

    def create_workspace_key(
        self,
        workspace_id: str,
        dataset_ids: tuple[str, ...],
        *,
        knowledge_space_ids: tuple[str, ...] = (),
        max_keys: int,
        prefix: str,
    ) -> ApiKeyRecord: ...

    def delete_workspace_key(self, workspace_id: str, key_id: str) -> ApiKeyRecord: ...


class UnknownDatasetIdsError(Exception):
    def __init__(self, dataset_ids: list[str]) -> None:
        super().__init__(f"Unknown knowledge base id(s): {', '.join(dataset_ids)}")


class UnknownKnowledgeSpaceIdsError(Exception):
    def __init__(self, space_ids: list[str]) -> None:
        super().__init__(f"Unknown knowledge space id(s): {', '.join(space_ids)}")


class DatasetApiKeyService:
    MAX_KEYS = 10

    def __init__(
        self,
        *,
        keys: DatasetApiKeyStore,
        cache: ApiKeyCache,
        access: DatasetAccess,
        rbac_enabled: Callable[[], bool],
        last_used_at: Callable[[str, str | None, datetime | None], datetime | None],
    ) -> None:
        self._keys = keys
        self._cache = cache
        self._access = access
        self._rbac_enabled = rbac_enabled
        self._last_used_at = last_used_at

    def list_keys(self, context: RequestContext, dataset_id: str) -> tuple[ApiKeyRecord, ...]:
        self._check_access(context, dataset_id)
        return self._keys.list_keys(context.active_workspace_id, dataset_id)

    def create_key(self, context: RequestContext, dataset_id: str) -> ApiKeyRecord:
        self._check_access(context, dataset_id)
        return self._keys.create_key(context.active_workspace_id, dataset_id, max_keys=self.MAX_KEYS, prefix="ds-")

    def delete_key(self, context: RequestContext, dataset_id: str, key_id: str) -> None:
        self._check_access(context, dataset_id)
        key = self._keys.delete_key(context.active_workspace_id, dataset_id, key_id)
        self._cache.delete(key.token, key.type)

    def _check_access(self, context: RequestContext, dataset_id: str) -> None:
        # Enterprise RBAC is enforced at admission; community deployments use the dataset ACL.
        if not self._rbac_enabled():
            try:
                self._access.require_accessible(context, dataset_id)
            except DatasetNotFoundError as error:
                raise ApiKeyResourceNotFoundError("Dataset not found.") from error
            except DatasetAccessDeniedError as error:
                raise NoPermissionError("You do not have permission to access this dataset.") from error

    def list_workspace_keys(self, context: RequestContext) -> tuple[ApiKeyRecord, ...]:
        return tuple(
            replace(key, last_used_at=self._last_used_at(key.token, key.type, key.last_used_at))
            for key in self._keys.list_workspace_keys(context.active_workspace_id)
        )

    def create_workspace_key(
        self, context: RequestContext, dataset_ids: tuple[str, ...], *, knowledge_space_ids: tuple[str, ...] = ()
    ) -> ApiKeyRecord:
        return self._keys.create_workspace_key(
            context.active_workspace_id,
            tuple(dict.fromkeys(dataset_ids)),
            knowledge_space_ids=tuple(dict.fromkeys(knowledge_space_ids)),
            max_keys=self.MAX_KEYS,
            prefix="dataset-",
        )

    def delete_workspace_key(self, context: RequestContext, key_id: str) -> None:
        key = self._keys.delete_workspace_key(context.active_workspace_id, key_id)
        self._cache.delete(key.token, key.type)