diff --git a/backend/open_webui/env.py b/backend/open_webui/env.py index dea5d6787..4289475c0 100644 --- a/backend/open_webui/env.py +++ b/backend/open_webui/env.py @@ -195,10 +195,13 @@ ENABLE_FORWARD_USER_INFO_HEADERS = ( ) # Header names for user info forwarding (customizable via environment variables) -FORWARD_USER_INFO_HEADER_NAME = os.environ.get("FORWARD_USER_INFO_HEADER_NAME", "X-OpenWebUI-User-Name") -FORWARD_USER_INFO_HEADER_ID = os.environ.get("FORWARD_USER_INFO_HEADER_ID", "X-OpenWebUI-User-Id") -FORWARD_USER_INFO_HEADER_EMAIL = os.environ.get("FORWARD_USER_INFO_HEADER_EMAIL", "X-OpenWebUI-User-Email") -FORWARD_USER_INFO_HEADER_ROLE = os.environ.get("FORWARD_USER_INFO_HEADER_ROLE", "X-OpenWebUI-User-Role") +FORWARD_USER_INFO_HEADER_USER_NAME = os.environ.get("FORWARD_USER_INFO_HEADER_USER_NAME", "X-OpenWebUI-User-Name") +FORWARD_USER_INFO_HEADER_USER_ID = os.environ.get("FORWARD_USER_INFO_HEADER_USER_ID", "X-OpenWebUI-User-Id") +FORWARD_USER_INFO_HEADER_USER_EMAIL = os.environ.get("FORWARD_USER_INFO_HEADER_USER_EMAIL", "X-OpenWebUI-User-Email") +FORWARD_USER_INFO_HEADER_USER_ROLE = os.environ.get("FORWARD_USER_INFO_HEADER_USER_ROLE", "X-OpenWebUI-User-Role") + +# Header name for chat ID forwarding (customizable via environment variable) +FORWARD_SESSION_INFO_HEADER_CHAT_ID = os.environ.get("FORWARD_SESSION_INFO_HEADER_CHAT_ID", "X-OpenWebUI-Chat-Id") # Experimental feature, may be removed in future ENABLE_STAR_SESSIONS_MIDDLEWARE = ( diff --git a/backend/open_webui/retrieval/web/external.py b/backend/open_webui/retrieval/web/external.py index 527c918a4..1dd63273a 100644 --- a/backend/open_webui/retrieval/web/external.py +++ b/backend/open_webui/retrieval/web/external.py @@ -8,6 +8,7 @@ from fastapi import Request from open_webui.retrieval.web.main import SearchResult, get_filtered_results from open_webui.utils.headers import include_user_info_headers +from open_webui.env import FORWARD_SESSION_INFO_HEADER_CHAT_ID log = logging.getLogger(__name__) @@ -31,7 +32,7 @@ def search_external( chat_id = getattr(request.state, "chat_id", None) if chat_id: - headers["X-OpenWebUI-Chat-Id"] = str(chat_id) + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = str(chat_id) response = requests.post( external_url, diff --git a/backend/open_webui/retrieval/web/yandex.py b/backend/open_webui/retrieval/web/yandex.py index def134d99..fd1bc7274 100644 --- a/backend/open_webui/retrieval/web/yandex.py +++ b/backend/open_webui/retrieval/web/yandex.py @@ -11,6 +11,7 @@ from fastapi import Request from open_webui.retrieval.web.main import SearchResult, get_filtered_results from open_webui.utils.headers import include_user_info_headers +from open_webui.env import FORWARD_SESSION_INFO_HEADER_CHAT_ID from xml.etree import ElementTree as ET from xml.etree.ElementTree import Element @@ -50,7 +51,7 @@ def search_yandex( chat_id = getattr(request.state, "chat_id", None) if chat_id: - headers["X-OpenWebUI-Chat-Id"] = str(chat_id) + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = str(chat_id) payload = {} if yandex_search_config == "" else json.loads(yandex_search_config) diff --git a/backend/open_webui/routers/ollama.py b/backend/open_webui/routers/ollama.py index cfbdbcac0..ed231aabc 100644 --- a/backend/open_webui/routers/ollama.py +++ b/backend/open_webui/routers/ollama.py @@ -23,6 +23,7 @@ from open_webui.models.users import UserModel from open_webui.env import ( ENABLE_FORWARD_USER_INFO_HEADERS, + FORWARD_SESSION_INFO_HEADER_CHAT_ID, ) from fastapi import ( @@ -137,7 +138,7 @@ async def send_post_request( if ENABLE_FORWARD_USER_INFO_HEADERS and user: headers = include_user_info_headers(headers, user) if metadata and metadata.get("chat_id"): - headers["X-OpenWebUI-Chat-Id"] = metadata.get("chat_id") + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = metadata.get("chat_id") r = await session.post( url, diff --git a/backend/open_webui/routers/openai.py b/backend/open_webui/routers/openai.py index b1d31afb8..0b5433314 100644 --- a/backend/open_webui/routers/openai.py +++ b/backend/open_webui/routers/openai.py @@ -33,6 +33,7 @@ from open_webui.env import ( AIOHTTP_CLIENT_TIMEOUT, AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST, ENABLE_FORWARD_USER_INFO_HEADERS, + FORWARD_SESSION_INFO_HEADER_CHAT_ID, BYPASS_MODEL_ACCESS_CONTROL, ) from open_webui.models.users import UserModel @@ -142,7 +143,7 @@ async def get_headers_and_cookies( if ENABLE_FORWARD_USER_INFO_HEADERS and user: headers = include_user_info_headers(headers, user) if metadata and metadata.get("chat_id"): - headers["X-OpenWebUI-Chat-Id"] = metadata.get("chat_id") + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = metadata.get("chat_id") token = None auth_type = config.get("auth_type") diff --git a/backend/open_webui/utils/headers.py b/backend/open_webui/utils/headers.py index cdf5d2d85..f0b13c00d 100644 --- a/backend/open_webui/utils/headers.py +++ b/backend/open_webui/utils/headers.py @@ -1,18 +1,18 @@ from urllib.parse import quote from open_webui.env import ( - FORWARD_USER_INFO_HEADER_NAME, - FORWARD_USER_INFO_HEADER_ID, - FORWARD_USER_INFO_HEADER_EMAIL, - FORWARD_USER_INFO_HEADER_ROLE, + FORWARD_USER_INFO_HEADER_USER_NAME, + FORWARD_USER_INFO_HEADER_USER_ID, + FORWARD_USER_INFO_HEADER_USER_EMAIL, + FORWARD_USER_INFO_HEADER_USER_ROLE, ) def include_user_info_headers(headers, user): return { **headers, - FORWARD_USER_INFO_HEADER_NAME: quote(user.name, safe=" "), - FORWARD_USER_INFO_HEADER_ID: user.id, - FORWARD_USER_INFO_HEADER_EMAIL: user.email, - FORWARD_USER_INFO_HEADER_ROLE: user.role, + FORWARD_USER_INFO_HEADER_USER_NAME: quote(user.name, safe=" "), + FORWARD_USER_INFO_HEADER_USER_ID: user.id, + FORWARD_USER_INFO_HEADER_USER_EMAIL: user.email, + FORWARD_USER_INFO_HEADER_USER_ROLE: user.role, } diff --git a/backend/open_webui/utils/middleware.py b/backend/open_webui/utils/middleware.py index 3fcaf0fe9..5db562725 100644 --- a/backend/open_webui/utils/middleware.py +++ b/backend/open_webui/utils/middleware.py @@ -127,7 +127,10 @@ from open_webui.env import ( ENABLE_REALTIME_CHAT_SAVE, ENABLE_QUERIES_CACHE, RAG_SYSTEM_CONTEXT, + ENABLE_FORWARD_USER_INFO_HEADERS, + FORWARD_SESSION_INFO_HEADER_CHAT_ID, ) +from open_webui.utils.headers import include_user_info_headers from open_webui.constants import TASKS @@ -2207,6 +2210,12 @@ async def process_chat_payload(request, form_data, user, metadata, model): for key, value in connection_headers.items(): headers[key] = value + # Add user info headers if enabled + if ENABLE_FORWARD_USER_INFO_HEADERS and user: + headers = include_user_info_headers(headers, user) + if metadata and metadata.get("chat_id"): + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = metadata.get("chat_id") + mcp_clients[server_id] = MCPClient() await mcp_clients[server_id].connect( url=mcp_server_connection.get("url", ""), diff --git a/backend/open_webui/utils/tools.py b/backend/open_webui/utils/tools.py index 6a55a9536..ec281b43a 100644 --- a/backend/open_webui/utils/tools.py +++ b/backend/open_webui/utils/tools.py @@ -45,7 +45,10 @@ from open_webui.env import ( AIOHTTP_CLIENT_TIMEOUT, AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA, AIOHTTP_CLIENT_SESSION_TOOL_SERVER_SSL, + ENABLE_FORWARD_USER_INFO_HEADERS, + FORWARD_SESSION_INFO_HEADER_CHAT_ID, ) +from open_webui.utils.headers import include_user_info_headers from open_webui.tools.builtin import ( search_web, fetch_url, @@ -335,6 +338,13 @@ async def get_tools( for key, value in connection_headers.items(): headers[key] = value + # Add user info headers if enabled + if ENABLE_FORWARD_USER_INFO_HEADERS and user: + headers = include_user_info_headers(headers, user) + metadata = extra_params.get("__metadata__", {}) + if metadata and metadata.get("chat_id"): + headers[FORWARD_SESSION_INFO_HEADER_CHAT_ID] = metadata.get("chat_id") + def make_tool_function( function_name, tool_server_data, headers ):