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.

fix(api): align dataset RBAC permission checks (#42392)

XiaoBa039bf03a31d7
diff --git a/api/controllers/console/datasets/data_source.py b/api/controllers/console/datasets/data_source.py
index 39b1d454f13..e4ad4b3b819 100644
--- a/api/controllers/console/datasets/data_source.py
+++ b/api/controllers/console/datasets/data_source.py
@@ -420,7 +420,7 @@ class DataSourceNotionDatasetSyncApi(Resource):
@login_required
@account_initialization_required
@console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_EDIT, DatasetId()))
@with_session(write=False)
def get(self, session: Session, dataset_id: UUID) -> tuple[dict[str, str], int]:
dataset_id_str = str(dataset_id)
@@ -440,7 +440,7 @@ class DataSourceNotionDocumentSyncApi(Resource):
@login_required
@account_initialization_required
@console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_EDIT, DatasetId()))
@with_session(write=False)
def get(self, session: Session, dataset_id: UUID, document_id: UUID) -> tuple[dict[str, str], int]:
dataset_id_str = str(dataset_id)
diff --git a/api/controllers/console/datasets/datasets.py b/api/controllers/console/datasets/datasets.py
index 5ce10105c0b..2f39d249896 100644
--- a/api/controllers/console/datasets/datasets.py
+++ b/api/controllers/console/datasets/datasets.py
@@ -13,7 +13,7 @@ from werkzeug.exceptions import Forbidden, NotFound
import services
from configs import dify_config
from controllers.common.fields import ApiBaseUrlResponse, SimpleResultResponse, UsageCheckResponse
-from controllers.common.rbac import DatasetId, RBACCheck, Workspace
+from controllers.common.rbac import DatasetId, RBACCheck, Workspace, enforce_rbac_checks
from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models
from controllers.common.session import with_session
from controllers.console import console_ns
@@ -906,11 +906,31 @@ class DatasetIndexingEstimateApi(Resource):
@login_required
@account_initialization_required
@console_ns.expect(console_ns.models[IndexingEstimatePayload.__name__])
+ @with_current_user
@with_current_tenant_id
@with_session
@model_validate(IndexingEstimatePayload)
- def post(self, req_data: IndexingEstimatePayload, session: Session, current_tenant_id: str):
+ def post(
+ self,
+ req_data: IndexingEstimatePayload,
+ session: Session,
+ current_tenant_id: str,
+ current_user: Account,
+ ):
args = req_data.model_dump()
+ dataset_id = req_data.dataset_id
+ if dataset_id:
+ checks = [RBACCheck(RBACPermission.DATASET_USE, DatasetId())]
+ path_args = {"dataset_id": dataset_id}
+ else:
+ checks = [RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, Workspace())]
+ path_args = None
+ enforce_rbac_checks(
+ tenant_id=current_tenant_id,
+ account_id=current_user.id,
+ checks=checks,
+ path_args=path_args,
+ )
# validate args
DocumentService.estimate_args_validate(args)
extract_settings = []
diff --git a/api/controllers/console/datasets/datasets_document.py b/api/controllers/console/datasets/datasets_document.py
index a4d54053800..8b793459c0f 100644
--- a/api/controllers/console/datasets/datasets_document.py
+++ b/api/controllers/console/datasets/datasets_document.py
@@ -19,7 +19,7 @@ import services
from configs import dify_config
from controllers.common.controller_schemas import DocumentBatchDownloadZipPayload
from controllers.common.fields import SimpleResultMessageResponse, SimpleResultResponse, UrlResponse
-from controllers.common.rbac import DatasetId, RBACCheck
+from controllers.common.rbac import DatasetId, RBACCheck, enforce_rbac_checks
from controllers.common.schema import register_response_schema_models, register_schema_models
from controllers.common.session import with_session
from controllers.console import console_ns
@@ -367,6 +367,13 @@ class GetProcessRuleApi(Resource):
if not dataset:
raise NotFound("Dataset not found.")
+ enforce_rbac_checks(
+ tenant_id=dataset.tenant_id,
+ account_id=current_user.id,
+ checks=[RBACCheck(RBACPermission.DATASET_READONLY, DatasetId())],
+ path_args={"dataset_id": dataset.id},
+ )
+
try:
DatasetService.check_dataset_permission(dataset, current_user, session)
except services.errors.account.NoPermissionError as e:
@@ -405,7 +412,7 @@ class DatasetDocumentListApi(Resource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID):
dataset_id_str = str(dataset_id)
@@ -721,7 +728,7 @@ class DocumentIndexingEstimateApi(DocumentResource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_USE, DatasetId()))
@with_session
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID, document_id: UUID):
dataset_id_str = str(dataset_id)
@@ -813,7 +820,7 @@ class DocumentBatchIndexingEstimateApi(DocumentResource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_USE, DatasetId()))
@with_session
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID, batch: str):
dataset_id_str = str(dataset_id)
@@ -935,7 +942,7 @@ class DocumentBatchIndexingStatusApi(DocumentResource):
@login_required
@account_initialization_required
@with_current_user
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_user: Account, dataset_id: UUID, batch: str):
dataset_id_str = str(dataset_id)
@@ -978,7 +985,7 @@ class DocumentIndexingStatusApi(DocumentResource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID, document_id: UUID):
dataset_id_str = str(dataset_id)
@@ -1044,7 +1051,7 @@ class DocumentApi(DocumentResource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID, document_id: UUID):
dataset_id_str = str(dataset_id)
@@ -1614,7 +1621,7 @@ class DocumentPipelineExecutionLogApi(DocumentResource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(
self,
@@ -1767,7 +1774,7 @@ class DocumentSummaryStatusApi(DocumentResource):
@login_required
@account_initialization_required
@with_current_user
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_user: Account, dataset_id: UUID, document_id: UUID):
"""
diff --git a/api/controllers/console/datasets/metadata.py b/api/controllers/console/datasets/metadata.py
index f0cec5c014d..c749be64f06 100644
--- a/api/controllers/console/datasets/metadata.py
+++ b/api/controllers/console/datasets/metadata.py
@@ -92,7 +92,7 @@ class DatasetMetadataCreateApi(Resource):
)
@with_current_user
@with_current_tenant_id
- @rbac_permission_required(RBACCheck(RBACPermission.DATASET_CREATE_AND_MANAGEMENT, DatasetId()))
+ @rbac_permission_required(RBACCheck(RBACPermission.DATASET_READONLY, DatasetId()))
@with_session(write=False)
def get(self, session: Session, current_tenant_id: str, current_user: Account, dataset_id: UUID):
dataset_id_str = str(dataset_id)
diff --git a/api/tests/unit_tests/controllers/console/datasets/test_data_source_notion_apis.py b/api/tests/unit_tests/controllers/console/datasets/test_data_source_notion_apis.py
index a0a7e37b3e3..8bbea58ba8e 100644
--- a/api/tests/unit_tests/controllers/console/datasets/test_data_source_notion_apis.py
+++ b/api/tests/unit_tests/controllers/console/datasets/test_data_source_notion_apis.py
@@ -10,6 +10,7 @@ from flask import Flask
from sqlalchemy.orm import Session
from werkzeug.exceptions import NotFound
+from controllers.common.rbac import DatasetId
from controllers.console.datasets.data_source import (
DataSourceNotionDatasetSyncApi,
DataSourceNotionDocumentSyncApi,
@@ -18,9 +19,11 @@ from controllers.console.datasets.data_source import (
DataSourceNotionPreviewQuery,
NotionEstimatePayload,
)
+from controllers.console.wraps import RBACPermission
from core.rag.index_processor.constant.index_type import IndexStructureType
from models import Account, Dataset, Document
from models.dataset import DataSourceType
+from tests.unit_tests.controllers.rbac_introspection import rbac_checks
from tests.unit_tests.model_factories import make_dataset, make_document
@@ -104,6 +107,12 @@ class TestDataSourceNotionIndexingEstimateApi:
class TestDataSourceNotionDatasetSyncApi:
+ def test_get_requires_dataset_edit_permission(self) -> None:
+ [check] = rbac_checks(DataSourceNotionDatasetSyncApi.get)
+
+ assert check.scene is RBACPermission.DATASET_EDIT
+ assert isinstance(check.locator, DatasetId)
+
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_get_success(self, app: Flask, sqlite_session: Session) -> None:
api = DataSourceNotionDatasetSyncApi()
@@ -145,6 +154,12 @@ class TestDataSourceNotionDatasetSyncApi:
class TestDataSourceNotionDocumentSyncApi:
+ def test_get_requires_dataset_edit_permission(self) -> None:
+ [check] = rbac_checks(DataSourceNotionDocumentSyncApi.get)
+
+ assert check.scene is RBACPermission.DATASET_EDIT
+ assert isinstance(check.locator, DatasetId)
+
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_get_success(self, app: Flask, sqlite_session: Session) -> None:
api = DataSourceNotionDocumentSyncApi()
diff --git a/api/tests/unit_tests/controllers/console/datasets/test_datasets.py b/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
index 238e551eeef..277572fa2d4 100644
--- a/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
+++ b/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
@@ -13,6 +13,7 @@ from sqlalchemy.orm import Session
from werkzeug.exceptions import BadRequest, Forbidden, NotFound
import services
+from controllers.common.rbac import DatasetId, Workspace
from controllers.console import console_ns
from controllers.console.app.error import ProviderNotInitializeError
from controllers.console.datasets.datasets import (
@@ -38,6 +39,7 @@ from controllers.console.datasets.datasets import (
_get_retrieval_methods_by_vector_type,
)
from controllers.console.datasets.error import DatasetInUseError, DatasetNameDuplicateError, IndexingEstimateError
+from controllers.console.wraps import RBACPermission
from core.entities.knowledge_entities import IndexingEstimate
from core.errors.error import LLMBadRequestError, ProviderTokenNotInitError
from core.provider_manager import ProviderManager
@@ -1117,6 +1119,49 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
"dataset_id": None,
}
+ @pytest.mark.parametrize(
+ ("dataset_id", "expected_scene", "expected_locator_type", "expected_path_args"),
+ [
+ ("dataset-1", RBACPermission.DATASET_USE, DatasetId, {"dataset_id": "dataset-1"}),
+ (None, RBACPermission.DATASET_CREATE_AND_MANAGEMENT, Workspace, None),
+ ],
+ )
+ def test_post_authorizes_existing_and_new_dataset_workflows(
+ self,
+ app: Flask,
+ dataset_id: str | None,
+ expected_scene: RBACPermission,
+ expected_locator_type: type[DatasetId] | type[Workspace],
+ expected_path_args: dict[str, str] | None,
+ ) -> None:
+ api = DatasetIndexingEstimateApi()
+ method = unwrap(api.post)
+ payload = {**self._base_payload(), "dataset_id": dataset_id}
+ session = self.session
+ session.add(self._upload_file())
+ session.flush()
+ current_user = make_account()
+
+ with (
+ app.test_request_context("/"),
+ patch("controllers.console.datasets.datasets.DocumentService.estimate_args_validate", return_value=None),
+ patch(
+ "controllers.console.datasets.datasets.IndexingRunner.indexing_estimate",
+ return_value=IndexingEstimate(total_segments=1, preview=[]),
+ ),
+ patch("controllers.console.datasets.datasets.enforce_rbac_checks", create=True) as enforce_checks,
+ ):
+ method(api, IndexingEstimatePayload(**payload), session, "tenant-1", current_user)
+
+ enforce_checks.assert_called_once()
+ kwargs = enforce_checks.call_args.kwargs
+ assert kwargs["tenant_id"] == "tenant-1"
+ assert kwargs["account_id"] == current_user.id
+ assert kwargs.get("path_args") == expected_path_args
+ [check] = kwargs["checks"]
+ assert check.scene is expected_scene
+ assert isinstance(check.locator, expected_locator_type)
+
def test_post_success_upload_file(self, app: Flask):
api = DatasetIndexingEstimateApi()
method = unwrap(api.post)
@@ -1139,6 +1184,7 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
IndexingEstimatePayload(**payload),
session,
"tenant-1",
+ make_account(),
)
assert status == 200
assert response == {
@@ -1165,6 +1211,7 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
IndexingEstimatePayload(**payload),
session,
"tenant-1",
+ make_account(),
)
def test_post_llm_bad_request_error(self, app: Flask):
@@ -1190,6 +1237,7 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
IndexingEstimatePayload(**payload),
session,
"tenant-1",
+ make_account(),
)
def test_post_provider_token_not_init(self, app: Flask):
@@ -1215,6 +1263,7 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
IndexingEstimatePayload(**payload),
session,
"tenant-1",
+ make_account(),
)
def test_post_generic_exception(self, app: Flask):
@@ -1239,6 +1288,7 @@ class TestDatasetIndexingEstimateApi(_UsesSQLiteSession):
IndexingEstimatePayload(**payload),
session,
"tenant-1",
+ make_account(),
)
diff --git a/api/tests/unit_tests/controllers/console/datasets/test_datasets_document.py b/api/tests/unit_tests/controllers/console/datasets/test_datasets_document.py
index c56a65b193a..e636a4634e1 100644
--- a/api/tests/unit_tests/controllers/console/datasets/test_datasets_document.py
+++ b/api/tests/unit_tests/controllers/console/datasets/test_datasets_document.py
@@ -10,6 +10,7 @@ from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden, NotFound
import services
+from controllers.common.rbac import DatasetId
from controllers.console import console_ns
from controllers.console.datasets.datasets_document import (
DatasetDocumentListApi,
@@ -46,6 +47,7 @@ from controllers.console.datasets.error import (
InvalidActionError,
InvalidMetadataError,
)
+from controllers.console.wraps import RBACPermission
from core.entities.knowledge_entities import IndexingEstimate
from core.rag.index_processor.constant.index_type import IndexStructureType
from extensions.storage.storage_type import StorageType
@@ -66,6 +68,7 @@ from services.vector_space_admission_service import (
format_vector_space_admission_error,
)
from tests.unit_tests.config_override import config_overrides_context
+from tests.unit_tests.controllers.rbac_introspection import rbac_checks
def make_serializable_document(**overrides):
@@ -224,6 +227,35 @@ class _UsesSQLiteSession:
self.session = sqlite_session
+ "method",
+ [
+ DatasetDocumentListApi.get,
+ DocumentBatchIndexingStatusApi.get,
+ DocumentIndexingStatusApi.get,
+ DocumentApi.get,
+ DocumentPipelineExecutionLogApi.get,
+ DocumentSummaryStatusApi.get,
+ ],
+)
+def test_document_read_routes_require_dataset_readonly_permission(method) -> None:
+ [check] = rbac_checks(method)
+
+ assert check.scene is RBACPermission.DATASET_READONLY
+ assert isinstance(check.locator, DatasetId)
+
+
+ "method",
+ [DocumentIndexingEstimateApi.get, DocumentBatchIndexingEstimateApi.get],
+)
+def test_document_indexing_estimates_require_dataset_use_permission(method) -> None:
+ [check] = rbac_checks(method)
+
+ assert check.scene is RBACPermission.DATASET_USE
+ assert isinstance(check.locator, DatasetId)
+
+
class TestGetProcessRuleApi(_UsesSQLiteSession):
def test_get_default_success(self, app: Flask, patch_tenant):
api = GetProcessRuleApi()
@@ -301,6 +333,40 @@ class TestGetProcessRuleApi(_UsesSQLiteSession):
assert response["mode"] == "custom"
assert response["rules"] is None
+ def test_get_with_document_requires_dataset_readonly_permission(self, app: Flask, patch_tenant):
+ api = GetProcessRuleApi()
+ method = unwrap(api.get)
+ user, tenant_id = patch_tenant
+ document = make_document()
+ dataset = make_dataset(tenant_id=tenant_id)
+
+ with (
+ app.test_request_context("/?document_id=doc-1"),
+ patch(
+ "controllers.console.datasets.datasets_document.DocumentService.get_document_by_id",
+ return_value=document,
+ ),
+ patch(
+ "controllers.console.datasets.datasets_document.DatasetService.get_dataset",
+ return_value=dataset,
+ ),
+ patch(
+ "controllers.console.datasets.datasets_document.DatasetService.check_dataset_permission",
+ return_value=None,
+ ),
+ patch("controllers.console.datasets.datasets_document.enforce_rbac_checks", create=True) as enforce_checks,
+ ):
+ method(api, self.session, user)
+
+ enforce_checks.assert_called_once()
+ kwargs = enforce_checks.call_args.kwargs
+ assert kwargs["tenant_id"] == tenant_id
+ assert kwargs["account_id"] == user.id
+ assert kwargs["path_args"] == {"dataset_id": dataset.id}
+ [check] = kwargs["checks"]
+ assert check.scene is RBACPermission.DATASET_READONLY
+ assert isinstance(check.locator, DatasetId)
+
def test_get_with_document_dataset_not_found(self, app: Flask, patch_tenant):
api = GetProcessRuleApi()
method = unwrap(api.get)
diff --git a/api/tests/unit_tests/controllers/console/datasets/test_metadata.py b/api/tests/unit_tests/controllers/console/datasets/test_metadata.py
index 3c154ffd2ff..55c708d0253 100644
--- a/api/tests/unit_tests/controllers/console/datasets/test_metadata.py
+++ b/api/tests/unit_tests/controllers/console/datasets/test_metadata.py
@@ -9,6 +9,7 @@ from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden, NotFound
from controllers.common.controller_schemas import MetadataUpdatePayload
+from controllers.common.rbac import DatasetId
from controllers.console import console_ns
from controllers.console.datasets.metadata import (
DatasetMetadataApi,
@@ -17,6 +18,7 @@ from controllers.console.datasets.metadata import (
DatasetMetadataCreateApi,
DocumentMetadataEditApi,
)
+from controllers.console.wraps import RBACPermission
from models.account import Account
from models.dataset import Dataset
from services.dataset_service import DatasetService
@@ -25,6 +27,7 @@ from services.errors.account import NoPermissionError
from services.errors.metadata import MetadataResourceNotFoundError
from services.metadata_service import MetadataService
from tests.unit_tests.config_override import config_overrides_context
+from tests.unit_tests.controllers.rbac_introspection import rbac_checks
@pytest.fixture
@@ -67,6 +70,12 @@ def bypass_decorators(mocker: MockerFixture):
class TestDatasetMetadataCreateApi:
+ def test_get_requires_dataset_readonly_permission(self):
+ [check] = rbac_checks(DatasetMetadataCreateApi.get)
+
+ assert check.scene is RBACPermission.DATASET_READONLY
+ assert isinstance(check.locator, DatasetId)
+
def test_create_metadata_success(self, app: Flask, current_user, dataset, dataset_id, sqlite_session: Session):
api = DatasetMetadataCreateApi()
method = unwrap(api.post)