Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

Inject IBM OpenSearch creds into Langflow vars

Edwin Josebd8bef722cd3
diff --git a/src/auth/ibm_auth.py b/src/auth/ibm_auth.py
index e61f1f2aa..1ee903b19 100644
--- a/src/auth/ibm_auth.py
+++ b/src/auth/ibm_auth.py
@@ -49,6 +49,22 @@ async def fetch_ibm_public_key(url: str):
return _cached_public_key
+def extract_ibm_credentials(basic_credentials: str) -> tuple[str, str]:
+ """Decode a 'Basic <base64>' string and return (username, password).
+
+ Returns ("unknown", "") if the string is not a valid Basic credential.
+ """
+ import base64
+ if not basic_credentials.startswith("Basic "):
+ return ("unknown", "")
+ try:
+ decoded = base64.b64decode(basic_credentials[6:]).decode("utf-8")
+ username, _, password = decoded.partition(":")
+ return (username, password)
+ except Exception:
+ return ("unknown", "")
+
+
def validate_ibm_jwt(token: str, public_key) -> dict | None:
"""Validate *token* with *public_key* (full RS256 + expiry check).
diff --git a/src/dependencies.py b/src/dependencies.py
index 15468dadf..2d8284043 100644
--- a/src/dependencies.py
+++ b/src/dependencies.py
@@ -103,18 +103,14 @@ async def _get_ibm_user(request: Request, required: bool) -> Optional["User"]:
If *required* is True, raises HTTP 401 when none is present.
If *required* is False, returns None instead of raising.
"""
- import base64
import auth.ibm_auth as ibm_auth
+ from auth.ibm_auth import extract_ibm_credentials
from config.settings import IBM_SESSION_COOKIE_NAME, IBM_CREDENTIALS_HEADER
# ── Option 0: Configurable credentials header (Traefik production) ───
lh_credentials = request.headers.get(IBM_CREDENTIALS_HEADER, "")
if lh_credentials.startswith("Basic "):
- try:
- decoded = base64.b64decode(lh_credentials[6:]).decode("utf-8")
- username = decoded.split(":", 1)[0]
- except Exception:
- username = "unknown"
+ username, _ = extract_ibm_credentials(lh_credentials)
# Persist credentials to connections.json for reuse by background processes
connector_service = request.app.state.services.get("connector_service")
@@ -157,11 +153,7 @@ async def _get_ibm_user(request: Request, required: bool) -> Optional["User"]:
# ── Option 2: ibm-auth-basic cookie (local dev, no Traefik) ─────────
auth_header = request.cookies.get("ibm-auth-basic", "")
if auth_header.startswith("Basic "):
- try:
- decoded = base64.b64decode(auth_header[6:]).decode("utf-8")
- username = decoded.split(":", 1)[0]
- except Exception:
- username = "unknown"
+ username, _ = extract_ibm_credentials(auth_header)
user = User(
user_id=username,
@@ -170,6 +162,8 @@ async def _get_ibm_user(request: Request, required: bool) -> Optional["User"]:
picture=None,
provider="ibm_ams_basic",
jwt_token=auth_header,
+ opensearch_username=username,
+ opensearch_credentials=auth_header,
)
request.state.user = user
return user
diff --git a/src/services/chat_service.py b/src/services/chat_service.py
index 7c5fb5302..f9178e9c2 100644
--- a/src/services/chat_service.py
+++ b/src/services/chat_service.py
@@ -81,7 +81,7 @@ class ChatService:
extra_headers["X-LANGFLOW-GLOBAL-VAR-SELECTED_EMBEDDING_MODEL"] = embedding_model
# Add provider credentials to headers
- await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service)
+ await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service, jwt_token=jwt_token)
logger.debug(f"[LF] Extra headers {extra_headers}")
# Get context variables for filters, limit, and threshold
from auth_context import (
@@ -206,7 +206,7 @@ class ChatService:
extra_headers["X-LANGFLOW-GLOBAL-VAR-SELECTED_EMBEDDING_MODEL"] = embedding_model
# Add provider credentials to headers
- await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service)
+ await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service, jwt_token=jwt_token)
# Build the complete filter expression like the chat service does
filter_expression = {}
@@ -336,7 +336,7 @@ class ChatService:
extra_headers["X-LANGFLOW-GLOBAL-VAR-SELECTED_EMBEDDING_MODEL"] = embedding_model
# Add provider credentials to headers
- await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service)
+ await add_provider_credentials_to_headers(extra_headers, config, flows_service=self.flows_service, jwt_token=jwt_token)
# Ensure the Langflow client exists; try lazy init if needed
langflow_client = await clients.ensure_langflow_client()
diff --git a/src/services/langflow_file_service.py b/src/services/langflow_file_service.py
index 4f08968c6..21e946d2d 100644
--- a/src/services/langflow_file_service.py
+++ b/src/services/langflow_file_service.py
@@ -183,7 +183,7 @@ class LangflowFileService:
)
# Add provider credentials as global variables for ingestion
- await add_provider_credentials_to_headers(headers, config, flows_service=self.flows_service)
+ await add_provider_credentials_to_headers(headers, config, flows_service=self.flows_service, jwt_token=jwt_token)
logger.info(f"[LF] Headers {headers}")
logger.info(f"[LF] Payload {payload}")
resp = await clients.langflow_request(
@@ -296,7 +296,7 @@ class LangflowFileService:
"X-Langflow-Global-Var-ALLOWED_USERS": json.dumps( []),
"X-Langflow-Global-Var-ALLOWED_GROUPS": json.dumps( []),
}
- await add_provider_credentials_to_headers(headers, config, flows_service=self.flows_service)
+ await add_provider_credentials_to_headers(headers, config, flows_service=self.flows_service, jwt_token=jwt_token)
logger.info(
diff --git a/src/utils/langflow_headers.py b/src/utils/langflow_headers.py
index df7ced01f..25c0bef7a 100644
--- a/src/utils/langflow_headers.py
+++ b/src/utils/langflow_headers.py
@@ -4,29 +4,60 @@ from typing import Dict
from utils.container_utils import transform_localhost_url
-async def add_provider_credentials_to_headers(headers: Dict[str, str], config, flows_service=None) -> None:
+def build_ibm_opensearch_vars(
+ basic_credentials: str,
+ prefix: str = "X-LANGFLOW-GLOBAL-VAR-",
+) -> Dict[str, str]:
+ """Build IBM OpenSearch auth vars from a Basic credential string.
+
+ Returns a dict with three keys (using the given prefix):
+ - {prefix}OPENSEARCH_USERNAME — decoded username
+ - {prefix}OPENSEARCH_PASSWORD — decoded password
+ - {prefix}JWT — the full "Basic <b64>" string, used by Langflow
+ components that authenticate OpenSearch via JWT header
+
+ Pass prefix="X-LANGFLOW-GLOBAL-VAR-" for HTTP headers, or prefix="" for MCP global vars.
+ """
+ from auth.ibm_auth import extract_ibm_credentials
+ username, password = extract_ibm_credentials(basic_credentials)
+ return {
+ f"{prefix}OPENSEARCH_USERNAME": username,
+ f"{prefix}OPENSEARCH_PASSWORD": password,
+ f"{prefix}JWT": basic_credentials,
+ }
+
+
+async def add_provider_credentials_to_headers(
+ headers: Dict[str, str],
+ config,
+ flows_service=None,
+ jwt_token: str = None,
+) -> None:
"""Add provider credentials to headers as Langflow global variables.
-
+
Args:
headers: Dictionary of headers to add credentials to
config: OpenRAGConfig object containing provider configurations
flows_service: Optional FlowsService instance to resolve Ollama URLs.
+ jwt_token: Optional JWT / Basic credential string. When IBM_AUTH_ENABLED and this
+ is a "Basic ..." string, OPENSEARCH_USERNAME, OPENSEARCH_PASSWORD, and
+ JWT are injected as Langflow global variables.
"""
# Add OpenAI credentials
if config.providers.openai.api_key:
headers["X-LANGFLOW-GLOBAL-VAR-OPENAI_API_KEY"] = str(config.providers.openai.api_key)
-
+
# Add Anthropic credentials
if config.providers.anthropic.api_key:
headers["X-LANGFLOW-GLOBAL-VAR-ANTHROPIC_API_KEY"] = str(config.providers.anthropic.api_key)
-
+
# Add WatsonX credentials
if config.providers.watsonx.api_key:
headers["X-LANGFLOW-GLOBAL-VAR-WATSONX_APIKEY"] = str(config.providers.watsonx.api_key)
-
+
if config.providers.watsonx.project_id:
headers["X-LANGFLOW-GLOBAL-VAR-WATSONX_PROJECT_ID"] = str(config.providers.watsonx.project_id)
-
+
# Add Ollama endpoint (with localhost transformation)
if config.providers.ollama.endpoint:
if flows_service:
@@ -35,34 +66,46 @@ async def add_provider_credentials_to_headers(headers: Dict[str, str], config, f
ollama_endpoint = transform_localhost_url(config.providers.ollama.endpoint)
headers["X-LANGFLOW-GLOBAL-VAR-OLLAMA_BASE_URL"] = str(ollama_endpoint)
+ # IBM mode: inject OpenSearch Basic credentials as separate global vars
+ from config.settings import IBM_AUTH_ENABLED
+ if IBM_AUTH_ENABLED and jwt_token and jwt_token.startswith("Basic "):
+ headers.update(build_ibm_opensearch_vars(jwt_token, prefix="X-LANGFLOW-GLOBAL-VAR-"))
+
-async def build_mcp_global_vars_from_config(config, flows_service=None) -> Dict[str, str]:
+async def build_mcp_global_vars_from_config(
+ config,
+ flows_service=None,
+ jwt_token: str = None,
+) -> Dict[str, str]:
"""Build MCP global variables dictionary from OpenRAG configuration.
-
+
Args:
config: OpenRAGConfig object containing provider configurations
flows_service: Optional FlowsService instance to resolve Ollama URLs.
-
+ jwt_token: Optional JWT / Basic credential string. When IBM_AUTH_ENABLED and this
+ is a "Basic ..." string, OPENSEARCH_USERNAME, OPENSEARCH_PASSWORD, and
+ JWT are injected as global variables.
+
Returns:
Dictionary of global variables for MCP servers (without X-Langflow-Global-Var prefix)
"""
global_vars = {}
-
+
# Add OpenAI credentials
if config.providers.openai.api_key:
global_vars["OPENAI_API_KEY"] = config.providers.openai.api_key
-
+
# Add Anthropic credentials
if config.providers.anthropic.api_key:
global_vars["ANTHROPIC_API_KEY"] = config.providers.anthropic.api_key
-
+
# Add WatsonX credentials
if config.providers.watsonx.api_key:
global_vars["WATSONX_APIKEY"] = config.providers.watsonx.api_key
-
+
if config.providers.watsonx.project_id:
global_vars["WATSONX_PROJECT_ID"] = config.providers.watsonx.project_id
-
+
# Add Ollama endpoint (with localhost transformation)
if config.providers.ollama.endpoint:
if flows_service:
@@ -70,10 +113,14 @@ async def build_mcp_global_vars_from_config(config, flows_service=None) -> Dict[
else:
ollama_endpoint = transform_localhost_url(config.providers.ollama.endpoint)
global_vars["OLLAMA_BASE_URL"] = ollama_endpoint
-
+
# Add selected embedding model
if config.knowledge.embedding_model:
global_vars["SELECTED_EMBEDDING_MODEL"] = config.knowledge.embedding_model
-
- return global_vars
+ # IBM mode: inject OpenSearch Basic credentials as separate global vars
+ from config.settings import IBM_AUTH_ENABLED
+ if IBM_AUTH_ENABLED and jwt_token and jwt_token.startswith("Basic "):
+ global_vars.update(build_ibm_opensearch_vars(jwt_token, prefix=""))
+
+ return global_vars