Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(security): extend RedactURLParamsFilter to cover all uvicorn log formats (#13914)

OpenHands Botd58106b29b1b
diff --git a/openhands/core/logger.py b/openhands/core/logger.py
index 25da5f1e81..6c6102a17c 100644
--- a/openhands/core/logger.py
+++ b/openhands/core/logger.py
@@ -545,14 +545,30 @@ class RedactURLParamsFilter(logging.Filter):
``session_api_key`` from appearing in uvicorn access logs.
"""
+ _URL_WITH_QS_RE = re.compile(r'\S+\?\S+')
+
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
+ if record.args:
+ if 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
+ )
+ elif isinstance(record.args, dict):
+ record.args = {
+ k: redact_url_params(v) if isinstance(v, str) and '?' in v else v
+ for k, v in record.args.items()
+ }
+
+ if '?' in record.msg:
+ record.msg = self._URL_WITH_QS_RE.sub(
+ lambda m: redact_url_params(m.group(0)), record.msg
)
+
return True
diff --git a/tests/unit/core/logger/test_logger.py b/tests/unit/core/logger/test_logger.py
index 18677e645f..cec313ac6c 100644
--- a/tests/unit/core/logger/test_logger.py
+++ b/tests/unit/core/logger/test_logger.py
@@ -258,7 +258,7 @@ def test_redact_url_params_filter_none_args():
def test_redact_url_params_filter_dict_args():
- """Test that records with dict args (used by some formatters) pass through."""
+ """Test that records with dict args have URL params redacted."""
log_filter = RedactURLParamsFilter()
record = logging.LogRecord(
@@ -273,6 +273,31 @@ def test_redact_url_params_filter_dict_args():
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'}
+ assert record.args['method'] == 'GET'
+ assert 'test' not in record.args['path']
+ assert (
+ '<redacted>' in record.args['path'] or '%3Credacted%3E' in record.args['path']
+ )
+
+
+def test_redact_url_params_filter_msg_embedded_url():
+ """Test that URLs with query params embedded in record.msg are redacted."""
+ log_filter = RedactURLParamsFilter()
+
+ record = logging.LogRecord(
+ name='uvicorn.access',
+ level=logging.INFO,
+ pathname='',
+ lineno=0,
+ msg='10.0.0.1 - "GET /ws/abc?resend_all=true&session_api_key=secret-uuid-123" [accepted]',
+ args=None,
+ exc_info=None,
+ )
+
+ result = log_filter.filter(record)
+
+ assert result is True
+ assert 'secret-uuid-123' not in record.msg
+ assert 'resend_all=true' in record.msg
+ assert '<redacted>' in record.msg or '%3Credacted%3E' in record.msg