Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: redact session_api_key from uvicorn WebSocket access logs (#13839)

OpenHands Bot2c2e37902f53
diff --git a/openhands/core/logger.py b/openhands/core/logger.py
index 75ffde4d05..25da5f1e81 100644
--- a/openhands/core/logger.py
+++ b/openhands/core/logger.py
@@ -537,6 +537,42 @@ class OpenHandsLoggerAdapter(logging.LoggerAdapter):
return msg, kwargs
+class RedactURLParamsFilter(logging.Filter):
+ """Logging filter that redacts sensitive query parameters from URLs.
+
+ Intercepts log records and applies ``redact_url_params`` to any string
+ argument that contains a query string, preventing secrets such as
+ ``session_api_key`` from appearing in uvicorn access logs.
+ """
+
+ def filter(self, record: logging.LogRecord) -> bool:
+ from openhands.utils._redact_compat import redact_url_params
+
+ if record.args and isinstance(record.args, (tuple, list)):
+ record.args = tuple(
+ redact_url_params(arg) if isinstance(arg, str) and '?' in arg else arg
+ for arg in record.args
+ )
+ return True
+
+
+def get_uvicorn_log_config() -> dict:
+ """Returns a uvicorn log config dict with URL-param redaction.
+
+ When ``LOG_JSON`` is enabled the config uses JSON formatters; otherwise it
+ uses uvicorn's default plain-text formatters. In both cases a
+ :class:`RedactURLParamsFilter` is attached to the access-log handler so
+ that sensitive query parameters (e.g. ``session_api_key``) are never
+ written to logs.
+
+ Returns:
+ A dict suitable for passing to ``uvicorn.run(..., log_config=...)``.
+ """
+ if LOG_JSON:
+ return _uvicorn_json_log_config()
+ return _uvicorn_default_log_config()
+
+
def get_uvicorn_json_log_config() -> dict:
"""Returns a uvicorn log config dict for JSON structured logging.
@@ -547,9 +583,18 @@ def get_uvicorn_json_log_config() -> dict:
Returns:
A dict suitable for passing to uvicorn.run(..., log_config=...).
"""
+ return _uvicorn_json_log_config()
+
+
+def _uvicorn_json_log_config() -> dict:
return {
'version': 1,
'disable_existing_loggers': False,
+ 'filters': {
+ 'redact_url_params': {
+ '()': 'openhands.core.logger.RedactURLParamsFilter',
+ },
+ },
'formatters': {
# Uvicorn mutates 'default' and 'access' to set use_colors;
# keep them present using Uvicorn formatters
@@ -584,6 +629,7 @@ def get_uvicorn_json_log_config() -> dict:
'class': 'logging.StreamHandler',
'level': 'INFO',
'formatter': 'json_access',
+ 'filters': ['redact_url_params'],
'stream': 'ext://sys.stdout',
},
},
@@ -623,3 +669,55 @@ def get_uvicorn_json_log_config() -> dict:
},
'root': {'level': 'INFO', 'handlers': ['default']},
}
+
+
+def _uvicorn_default_log_config() -> dict:
+ """Replicates uvicorn's default LOGGING_CONFIG with URL-param redaction."""
+ return {
+ 'version': 1,
+ 'disable_existing_loggers': False,
+ 'filters': {
+ 'redact_url_params': {
+ '()': 'openhands.core.logger.RedactURLParamsFilter',
+ },
+ },
+ 'formatters': {
+ 'default': {
+ '()': 'uvicorn.logging.DefaultFormatter',
+ 'fmt': '%(levelprefix)s %(message)s',
+ 'use_colors': None,
+ },
+ 'access': {
+ '()': 'uvicorn.logging.AccessFormatter',
+ 'fmt': '%(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s',
+ },
+ },
+ 'handlers': {
+ 'default': {
+ 'formatter': 'default',
+ 'class': 'logging.StreamHandler',
+ 'stream': 'ext://sys.stderr',
+ },
+ 'access': {
+ 'formatter': 'access',
+ 'class': 'logging.StreamHandler',
+ 'filters': ['redact_url_params'],
+ 'stream': 'ext://sys.stdout',
+ },
+ },
+ 'loggers': {
+ 'uvicorn': {
+ 'handlers': ['default'],
+ 'level': 'INFO',
+ 'propagate': False,
+ },
+ 'uvicorn.error': {
+ 'level': 'INFO',
+ },
+ 'uvicorn.access': {
+ 'handlers': ['access'],
+ 'level': 'INFO',
+ 'propagate': False,
+ },
+ },
+ }
diff --git a/openhands/runtime/action_execution_server.py b/openhands/runtime/action_execution_server.py
index afab4abf66..9696e061b7 100644
--- a/openhands/runtime/action_execution_server.py
+++ b/openhands/runtime/action_execution_server.py
@@ -46,7 +46,7 @@ from openhands.app_server.status.system_stats import (
)
from openhands.core.config.mcp_config import MCPStdioServerConfig
from openhands.core.exceptions import BrowserUnavailableException
-from openhands.core.logger import get_uvicorn_json_log_config
+from openhands.core.logger import get_uvicorn_log_config
from openhands.core.logger import openhands_logger as logger
from openhands.events.action import (
Action,
@@ -1078,8 +1078,5 @@ if __name__ == '__main__':
return JSONResponse(content=[])
logger.debug(f'Starting action execution API on port {args.port}')
- # When LOG_JSON=1, provide a JSON log config to Uvicorn so error/access logs are structured
- log_config = None
- if os.getenv('LOG_JSON', '0') in ('1', 'true', 'True'):
- log_config = get_uvicorn_json_log_config()
+ log_config = get_uvicorn_log_config()
run(app, host='0.0.0.0', port=args.port, log_config=log_config, use_colors=False)
diff --git a/openhands/server/__main__.py b/openhands/server/__main__.py
index c9fb341094..9b3e7b6790 100644
--- a/openhands/server/__main__.py
+++ b/openhands/server/__main__.py
@@ -10,14 +10,11 @@ import os
import uvicorn
-from openhands.core.logger import get_uvicorn_json_log_config
+from openhands.core.logger import LOG_JSON, get_uvicorn_log_config
def main():
- # When LOG_JSON=1, configure Uvicorn to emit JSON logs for error/access
- log_config = None
- if os.getenv('LOG_JSON', '0') in ('1', 'true', 'True'):
- log_config = get_uvicorn_json_log_config()
+ log_config = get_uvicorn_log_config()
uvicorn.run(
'openhands.server.listen:app',
@@ -25,8 +22,7 @@ def main():
port=int(os.environ.get('port') or '3000'),
log_level='debug' if os.environ.get('DEBUG') else 'info',
log_config=log_config,
- # If LOG_JSON enabled, force colors off; otherwise let uvicorn default
- use_colors=False if log_config else None,
+ use_colors=False if LOG_JSON else None,
)
diff --git a/tests/unit/core/logger/test_logger.py b/tests/unit/core/logger/test_logger.py
index 78c5661bc8..18677e645f 100644
--- a/tests/unit/core/logger/test_logger.py
+++ b/tests/unit/core/logger/test_logger.py
@@ -1,7 +1,7 @@
import logging
from unittest.mock import patch
-from openhands.core.logger import SensitiveDataFilter
+from openhands.core.logger import RedactURLParamsFilter, SensitiveDataFilter
@patch.dict(
@@ -115,3 +115,164 @@ def test_sensitive_data_filter_case_sensitivity():
assert 'secret-value-2' not in record.msg
assert 'secret-value-3' not in record.msg
assert record.msg.count('******') == 3
+
+
+# --------------------------------------------------------------------------
+# RedactURLParamsFilter tests
+# --------------------------------------------------------------------------
+
+
+def test_redact_url_params_filter_websocket_log():
+ """Test that session_api_key is redacted from WebSocket access logs."""
+ log_filter = RedactURLParamsFilter()
+
+ # Simulate uvicorn WebSocket access log format
+ record = logging.LogRecord(
+ name='uvicorn.access',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='%s - "%s" [%s]',
+ args=(
+ '127.0.0.1:8000',
+ 'GET /ws/abc123?resend_all=true&session_api_key=secret-token-12345',
+ 'accepted',
+ ),
+ exc_info=None,
+ )
+
+ # Apply the filter
+ result = log_filter.filter(record)
+
+ # Filter should always return True (never drop records)
+ assert result is True
+
+ # Check that secret is redacted but other params preserved
+ args_str = str(record.args)
+ assert 'secret-token-12345' not in args_str
+ # URL-encoded <redacted> is %3Credacted%3E
+ assert '<redacted>' in args_str or '%3Credacted%3E' in args_str
+ assert 'resend_all=true' in args_str
+
+
+def test_redact_url_params_filter_multiple_sensitive_params():
+ """Test that multiple sensitive parameters are redacted."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='uvicorn.access',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='Request: %s',
+ args=('GET /api?api_key=secret1&token=secret2&user_id=123',),
+ exc_info=None,
+ )
+
+ log_filter.filter(record)
+
+ args_str = str(record.args)
+ assert 'secret1' not in args_str
+ assert 'secret2' not in args_str
+ assert 'user_id=123' in args_str
+
+
+def test_redact_url_params_filter_non_url_passthrough():
+ """Test that messages without URLs pass through unchanged."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='Normal log: %s %s',
+ args=('hello', 'world'),
+ exc_info=None,
+ )
+
+ log_filter.filter(record)
+
+ # Message should remain unchanged
+ assert record.args == ('hello', 'world')
+
+
+def test_redact_url_params_filter_no_query_string():
+ """Test that URLs without query strings pass through unchanged."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='Request: %s',
+ args=('GET /api/v1/users',),
+ exc_info=None,
+ )
+
+ log_filter.filter(record)
+
+ # URL without query string should remain unchanged
+ assert record.args == ('GET /api/v1/users',)
+
+
+def test_redact_url_params_filter_empty_args():
+ """Test that records with no args are handled gracefully."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='Simple message',
+ args=(),
+ exc_info=None,
+ )
+
+ result = log_filter.filter(record)
+
+ assert result is True
+ assert record.args == ()
+
+
+def test_redact_url_params_filter_none_args():
+ """Test that records with None args are handled gracefully."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='Simple message',
+ args=None,
+ exc_info=None,
+ )
+
+ result = log_filter.filter(record)
+
+ assert result is True
+ assert record.args is None
+
+
+def test_redact_url_params_filter_dict_args():
+ """Test that records with dict args (used by some formatters) pass through."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='%(method)s %(path)s',
+ args={'method': 'GET', 'path': '/api?secret=test'},
+ exc_info=None,
+ )
+
+ result = log_filter.filter(record)
+
+ # Dict args should pass through (filter only handles tuple/list)
+ assert result is True
+ assert record.args == {'method': 'GET', 'path': '/api?secret=test'}