OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
fix: remove hardcoded index name in acl utils (#2201)
Lucas Oliveira5b565bb60e68
diff --git a/securityconfig/roles.yml b/securityconfig/roles.ymlindex d19c76dc1..01f697787 100644--- a/securityconfig/roles.yml+++ b/securityconfig/roles.yml@@ -10,7 +10,7 @@ openrag_user_role:- "cluster:monitor/*"index_permissions:- - index_patterns: ["documents", "documents*", "knowledge_filters", "knowledge_filters*"]+ - index_patterns: ["documents", "*documents*", "knowledge_filters", "knowledge_filters*"]allowed_actions:- readdls: >@@ -22,7 +22,7 @@ openrag_user_role:{"terms":{"allowed_principals":{"index":"openrag_dls_principals","id":"${user.name}","path":"principals"}}},{"bool":{"must_not":{"exists":{"field":"owner"}}}}],"minimum_should_match":1}}- - index_patterns: ["documents", "documents*", "knowledge_filters", "knowledge_filters*"]+ - index_patterns: ["documents", "*documents*", "knowledge_filters", "knowledge_filters*"]allowed_actions:- indices:admin/mappings/get- indices:admin/existsdiff --git a/src/api/settings/endpoints.py b/src/api/settings/endpoints.pyindex ab3f09a7a..f6ebe7c6c 100644--- a/src/api/settings/endpoints.py+++ b/src/api/settings/endpoints.py@@ -56,7 +56,7 @@ from api.settings.models import (SettingsUpdateResponse,WatsonXProviderConfig,)-from config.config_manager import ALLOWED_INDEX_NAME_PREFIXES, is_permitted_index_name+from config.config_manager import ALLOWED_INDEX_NAME_PATTERNS, is_permitted_index_namefrom config.settings import (DEFAULT_DOCS_URL,ENVIRONMENT,@@ -632,8 +632,8 @@ async def update_settings(status_code=422,detail=(f"Index name '{new_index_name}' is not permitted. The OpenSearch "- "security role only grants search access to indices starting "- f"with {' or '.join(ALLOWED_INDEX_NAME_PREFIXES)}."+ "security role only grants search access to indices matching "+ f"{' or '.join(ALLOWED_INDEX_NAME_PATTERNS)}."),)working_config.knowledge.index_name = new_index_namediff --git a/src/config/config_manager.py b/src/config/config_manager.pyindex 4000f6052..935559400 100644--- a/src/config/config_manager.py+++ b/src/config/config_manager.py@@ -61,13 +61,15 @@ _SAFE_CONFIG_PATH = re.compile(r"^/?(?:[A-Za-z0-9_.\-]+/)*[A-Za-z0-9_.\-]+\.ya?m# ---------------------------------------------------------------------------# The OpenSearch security role `openrag_user_role` (securityconfig/roles.yml)# only grants indices:data/read/search on the index_patterns "documents",-# "documents*", "knowledge_filters", "knowledge_filters*". Nothing re-templates+# "*documents*", "knowledge_filters", "knowledge_filters*". Nothing re-templates# that static role config from OPENSEARCH_INDEX_NAME, so an index name outside# those patterns causes ingestion/search to fail with a 403# AuthorizationException. Keep this allowlist in sync with securityconfig/roles.yml.# ----------------------------------------------------------------------------ALLOWED_INDEX_NAME_PREFIXES = ("documents", "knowledge_filters")-_PERMITTED_INDEX_NAME = re.compile(r"^(documents|knowledge_filters)[a-z0-9._-]*$")+ALLOWED_INDEX_NAME_PATTERNS = ("*documents*", "knowledge_filters*")+_PERMITTED_INDEX_NAME = re.compile(+ r"^[a-z0-9._-]*documents[a-z0-9._-]*$|^knowledge_filters[a-z0-9._-]*$"+)def is_permitted_index_name(index_name: str) -> bool:@@ -421,8 +423,8 @@ class ConfigManager:else:logger.error(f"OPENSEARCH_INDEX_NAME={env_index_name!r} is not permitted by the "- f"OpenSearch security role (must start with one of "- f"{ALLOWED_INDEX_NAME_PREFIXES}); ignoring and keeping "+ f"OpenSearch security role (must match one of "+ f"{ALLOWED_INDEX_NAME_PATTERNS}); ignoring and keeping "f"{config_data['knowledge'].get('index_name', 'documents')!r}. ""See securityconfig/roles.yml.")diff --git a/src/connectors/service.py b/src/connectors/service.pyindex c91f4c95d..535e8ebac 100644--- a/src/connectors/service.py+++ b/src/connectors/service.py@@ -1,5 +1,6 @@from typing import Any+from config.settings import get_index_namefrom utils.file_utils import clean_connector_filenamefrom utils.logging_config import get_logger@@ -126,7 +127,7 @@ class ConnectorService:# used for DLS visibility/ACL-change checks.try:await write_client.update_by_query(- index=self.index_name,+ index=get_index_name(),body={# Match both fields: both ingestion paths carry the raw# connector id in connector_file_id (document_id is adiff --git a/src/services/monitor_service.py b/src/services/monitor_service.pyindex 331c02c66..828ba627d 100644--- a/src/services/monitor_service.py+++ b/src/services/monitor_service.py@@ -2,7 +2,7 @@ import jsonimport uuidfrom typing import Any-from config.settings import OPENRAG_BACKEND_INTERNAL_URL, clients+from config.settings import OPENRAG_BACKEND_INTERNAL_URL, clients, get_index_namefrom utils.logging_config import get_loggerlogger = get_logger(__name__)@@ -65,7 +65,7 @@ class MonitorService:{"doc_level_input": {"description": f"Monitor for knowledge filter: {filter_name}",- "indices": ["documents"],+ "indices": [get_index_name()],"queries": [{"id": f"kf_query_{filter_id}",diff --git a/src/utils/acl_utils.py b/src/utils/acl_utils.pyindex 9def041b0..07f76095c 100644--- a/src/utils/acl_utils.py+++ b/src/utils/acl_utils.py@@ -10,6 +10,7 @@ import hashlibimport jsonfrom typing import Any+from config.settings import get_index_namefrom src.connectors.base import DocumentACLfrom utils.logging_config import get_logger@@ -76,7 +77,7 @@ async def should_update_acl("""try:response = await opensearch_client.search(- index="documents",+ index=get_index_name(),body={"query": _build_id_query(document_id, id_fields),"size": 1,@@ -136,7 +137,7 @@ async def update_document_acl(try:response = await write_client.update_by_query(- index="documents",+ index=get_index_name(),body={"query": _build_id_query(document_id, id_fields),"script": {@@ -199,7 +200,7 @@ async def batch_update_acls(update_tasks = [write_client.update_by_query(- index="documents",+ index=get_index_name(),body={"query": _build_id_query(doc_id, id_fields),"script": {