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.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
fix(api): tighten RAGFlow external knowledge endpoint validation (#40065)
Sourav Rajvid65a57b7c700
diff --git a/api/services/knowledge/external/service.py b/api/services/knowledge/external/service.pyindex 29dbf449dda..8291b9c4ab4 100644--- a/api/services/knowledge/external/service.py+++ b/api/services/knowledge/external/service.py@@ -82,12 +82,19 @@ class ExternalDatasetService:@staticmethoddef check_endpoint_and_api_key(settings: dict[str, Any]):+ """Probe a configured endpoint and API key without changing the settings.++ Require nonempty endpoint and API key values. Append ``/retrieval``+ after removing trailing slashes, and raise ``ValueError`` for invalid+ URLs, connection failures, or HTTP 401, 403, 404, and 502 responses.+ Other responses, including provider argument errors, pass validation.+ """if "endpoint" not in settings or not settings["endpoint"]:raise ValueError("endpoint is required")if "api_key" not in settings or not settings["api_key"]:raise ValueError("api_key is required")- endpoint = f"{settings['endpoint']}/retrieval"+ endpoint = f"{settings['endpoint'].rstrip('/')}/retrieval"api_key = settings["api_key"]parsed_url = urlparse(endpoint)@@ -116,7 +123,7 @@ class ExternalDatasetService:raise ValueError(f"Bad Gateway: failed to connect to the endpoint: {endpoint}")if response.status_code == 404:raise ValueError(f"Not Found: failed to connect to the endpoint: {endpoint}")- if response.status_code == 403:+ if response.status_code in {401, 403}:raise ValueError("Forbidden: Authorization failed with the provided api_key")@staticmethod@@ -371,7 +378,12 @@ class ExternalDatasetService:*,session: Session,) -> ExternalKnowledgeApiSetting:- """Resolve owned configuration into a request that outlives the read session."""+ """Resolve tenant-owned configuration using the caller's read session.++ Return a request with one slash before ``retrieval`` that outlives the+ session, without making an HTTP call. Missing owned configuration+ raises ``ExternalKnowledgeRetrievalError``.+ """external_knowledge_binding = session.scalar(select(ExternalKnowledgeBindings).where(ExternalKnowledgeBindings.dataset_id == dataset_id, ExternalKnowledgeBindings.tenant_id == tenant_id)@@ -408,7 +420,7 @@ class ExternalDatasetService:}return ExternalKnowledgeApiSetting(- url=f"{settings.get('endpoint')}/retrieval",+ url=f"{settings.get('endpoint', '').rstrip('/')}/retrieval",request_method="post",headers=headers,params=request_params,diff --git a/api/tests/unit_tests/services/knowledge/external/test_service.py b/api/tests/unit_tests/services/knowledge/external/test_service.pyindex 2d540963c9a..38fdc3737c0 100644--- a/api/tests/unit_tests/services/knowledge/external/test_service.py+++ b/api/tests/unit_tests/services/knowledge/external/test_service.py@@ -11,6 +11,7 @@ from datetime import datetimefrom typing import Anyfrom unittest.mock import MagicMock, patch+import httpximport pytestfrom sqlalchemy import selectfrom sqlalchemy.orm import Session@@ -789,13 +790,66 @@ class TestExternalDatasetServiceCheckEndpoint:assert "sk-abcdef" not in messageassert "CDEF" not in message+ @patch("services.knowledge.external.service.ssrf_proxy")+ def test_check_endpoint_strips_trailing_slash_before_retrieval(+ self, mock_proxy, factory: ExternalDatasetServiceTestDataFactory+ ):+ """Regression for #40028: trailing slashes must not produce a double-slash retrieval URL."""+ settings = {"endpoint": "http://ragflow.example.com/api/v1/dify/", "api_key": "ragflow-test-key"}++ mock_proxy.post.return_value = httpx.Response(200)++ ExternalDatasetService.check_endpoint_and_api_key(settings)++ assert mock_proxy.post.call_args[0][0] == "http://ragflow.example.com/api/v1/dify/retrieval"++ @patch("services.knowledge.external.service.ssrf_proxy")+ def test_check_endpoint_ragflow_wrong_base_returns_401(+ self, mock_proxy, factory: ExternalDatasetServiceTestDataFactory+ ):+ """Regression for #40028: a generic /api/v1 base must not pass when it only returns 401."""+ settings = {"endpoint": "http://ragflow.example.com/api/v1", "api_key": "ragflow-test-key"}++ mock_proxy.post.return_value = httpx.Response(401)++ with pytest.raises(ValueError, match="Forbidden.*Authorization failed"):+ ExternalDatasetService.check_endpoint_and_api_key(settings)++ call_args = mock_proxy.post.call_args+ assert call_args[0][0] == "http://ragflow.example.com/api/v1/retrieval"++ @patch("services.knowledge.external.service.ssrf_proxy")+ def test_check_endpoint_ragflow_dify_base_accepts_argument_error(+ self, mock_proxy, factory: ExternalDatasetServiceTestDataFactory+ ):+ """Regression for #40028: the documented /api/v1/dify base should pass when the provider+ rejects the probe payload with a 400 argument error instead of dropping the connection."""+ settings = {"endpoint": "http://ragflow.example.com/api/v1/dify", "api_key": "ragflow-test-key"}++ mock_proxy.post.return_value = httpx.Response(400)++ ExternalDatasetService.check_endpoint_and_api_key(settings)++ call_args = mock_proxy.post.call_args+ assert call_args[0][0] == "http://ragflow.example.com/api/v1/dify/retrieval"++ @patch("services.knowledge.external.service.ssrf_proxy")+ def test_check_endpoint_401_unauthorized(self, mock_proxy, factory: ExternalDatasetServiceTestDataFactory):+ """Test validation fails with 401 Unauthorized (auth failure)."""+ settings = {"endpoint": "https://api.example.com", "api_key": "wrong-key"}++ mock_proxy.post.return_value = httpx.Response(401)++ with pytest.raises(ValueError, match="Forbidden.*Authorization failed"):+ ExternalDatasetService.check_endpoint_and_api_key(settings)+@patch("services.knowledge.external.service.ssrf_proxy")def test_check_endpoint_other_4xx_codes_pass(self, mock_proxy, factory: ExternalDatasetServiceTestDataFactory):"""Test that other 4xx codes don't raise exceptions."""# Arrangesettings = {"endpoint": "https://api.example.com", "api_key": "test-key"}- for status_code in [400, 401, 405, 429]:+ for status_code in [400, 405, 429]:mock_response = MagicMock()mock_response.status_code = status_codemock_proxy.post.return_value = mock_response@@ -1663,17 +1717,26 @@ class TestExternalDatasetServiceCreateDataset:class TestExternalDatasetServiceFetchRetrieval:"""Test fetch_external_knowledge_retrieval operations."""+ @pytest.mark.parametrize("trailing_slashes", ["", "/", "///"])@patch("services.knowledge.external.service.ExternalDatasetService.process_external_api")def test_fetch_external_knowledge_retrieval_success_with_results(- self, mock_process, factory: ExternalDatasetServiceTestDataFactory, sqlite_session: Session+ self,+ mock_process,+ factory: ExternalDatasetServiceTestDataFactory,+ sqlite_session: Session,+ trailing_slashes: str,):- """Test successful external knowledge retrieval with results."""+ """Given endpoint slash variants, retrieve records from the same normalized URL."""# Arrangetenant_id = "tenant-123"dataset_id = "dataset-123"query = "test query for retrieval"- _seed_external_retrieval_dependencies(sqlite_session, tenant_id=tenant_id, dataset_id=dataset_id)+ _, api = _seed_external_retrieval_dependencies(sqlite_session, tenant_id=tenant_id, dataset_id=dataset_id)+ api.settings = json.dumps(+ {"endpoint": f"http://ragflow.example.com/api/v1/dify{trailing_slashes}", "api_key": "ragflow-test-key"}+ )+ sqlite_session.commit()mock_response = MagicMock()mock_response.status_code = 200@@ -1696,6 +1759,7 @@ class TestExternalDatasetServiceFetchRetrieval:assert len(result) == 2assert result[0]["content"] == "result 1"assert result[1]["score"] == 0.8+ assert mock_process.call_args[0][0].url == "http://ragflow.example.com/api/v1/dify/retrieval"def test_fetch_external_knowledge_retrieval_binding_not_found_error(self, factory: ExternalDatasetServiceTestDataFactory, sqlite_session: Session