Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(security): strengthen log redaction for API keys and propagated child logger records (#14174)

OpenHands Bot61e3dc2cadbe
diff --git a/openhands/app_server/app_conversation/live_status_app_conversation_service.py b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
index d552a984de..0fd378bf15 100644
--- a/openhands/app_server/app_conversation/live_status_app_conversation_service.py
+++ b/openhands/app_server/app_conversation/live_status_app_conversation_service.py
@@ -103,7 +103,11 @@ from openhands.sdk.plugin import PluginSource
from openhands.sdk.secret import LookupSecret, StaticSecret
from openhands.sdk.settings import ACPAgentSettings
from openhands.sdk.utils.paging import page_iterator
-from openhands.sdk.utils.redact import sanitize_config
+from openhands.sdk.utils.redact import (
+ redact_api_key_literals,
+ redact_text_secrets,
+ sanitize_config,
+)
from openhands.sdk.workspace.remote.async_remote_workspace import AsyncRemoteWorkspace
from openhands.tools.preset.default import (
get_default_tools,
@@ -434,7 +438,7 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
except Exception as exc:
_logger.exception('Error starting conversation', stack_info=True)
task.status = AppConversationStartTaskStatus.ERROR
- task.detail = str(exc)
+ task.detail = redact_text_secrets(redact_api_key_literals(str(exc)))
yield task
async def _build_app_conversations(
@@ -1411,7 +1415,7 @@ class LiveStatusAppConversationService(AppConversationServiceBase):
)
if hook_config:
_logger.debug(
- f'Successfully loaded hooks: {hook_config.model_dump()}'
+ f'Successfully loaded hooks: {sanitize_config(hook_config.model_dump())}'
)
else:
_logger.debug('No hooks found in workspace')
diff --git a/openhands/app_server/utils/logger.py b/openhands/app_server/utils/logger.py
index b67b028789..ee02cb8d98 100644
--- a/openhands/app_server/utils/logger.py
+++ b/openhands/app_server/utils/logger.py
@@ -14,6 +14,12 @@ import litellm
from pythonjsonlogger.json import JsonFormatter
from termcolor import colored
+from openhands.sdk.utils.redact import (
+ redact_api_key_literals,
+ redact_text_secrets,
+ redact_url_params,
+)
+
# Suppress deprecation warnings from dependencies before they're imported
# aifc was removed in Python 3.13 but speech_recognition still references it
with warnings.catch_warnings():
@@ -290,6 +296,12 @@ class SensitiveDataFilter(logging.Filter):
pattern = rf"{attr}='?([\w-]+)'?"
msg = re.sub(pattern, f"{attr}='******'", msg)
+ # Apply SDK redaction utils to catch API key literals (e.g. sk_live_,
+ # sk-proj-, ghp_, etc.) and secret dict patterns (e.g. 'GITHUB_TOKEN':
+ # '...') that the pattern-based filter above does not cover.
+ msg = redact_api_key_literals(msg)
+ msg = redact_text_secrets(msg)
+
# Update the record
record.msg = msg
record.args = ()
@@ -386,16 +398,26 @@ if DEBUG:
if current_log_level == logging.DEBUG:
openhands_logger.debug('DEBUG mode enabled.')
+_sensitive_data_filter = SensitiveDataFilter(openhands_logger.name)
+
if LOG_JSON:
- openhands_logger.addHandler(json_log_handler(current_log_level))
+ _json_handler = json_log_handler(current_log_level)
+ _json_handler.addFilter(_sensitive_data_filter)
+ openhands_logger.addHandler(_json_handler)
# Configure concurrent.futures logger to use JSON formatting as well
cf_logger = logging.getLogger('concurrent.futures')
cf_logger.setLevel(current_log_level)
cf_logger.addHandler(json_log_handler(current_log_level))
else:
- openhands_logger.addHandler(get_console_handler(current_log_level))
-
-openhands_logger.addFilter(SensitiveDataFilter(openhands_logger.name))
+ _console_handler = get_console_handler(current_log_level)
+ _console_handler.addFilter(_sensitive_data_filter)
+ openhands_logger.addHandler(_console_handler)
+
+# Keep the filter on the logger for records logged directly to openhands_logger,
+# and on the handlers for records propagated from child loggers (e.g.
+# openhands.app_server.*) β€” Python only checks the originating logger's
+# filters, not ancestor filters, during propagation.
+openhands_logger.addFilter(_sensitive_data_filter)
openhands_logger.propagate = False
openhands_logger.debug('Logging initialized')
@@ -521,7 +543,8 @@ class OpenHandsLoggerAdapter(logging.LoggerAdapter):
def process(
self, msg: str, kwargs: MutableMapping[str, Any]
) -> tuple[str, MutableMapping[str, Any]]:
- """If 'extra' is supplied in kwargs, merge it with the adapters 'extra' dict
+ """Merge 'extra' kwargs with the adapter's 'extra' dict.
+
Starting in Python 3.13, LoggerAdapter's merge_extra option will do this.
"""
if 'extra' in kwargs and isinstance(kwargs['extra'], dict):
@@ -542,8 +565,6 @@ class RedactURLParamsFilter(logging.Filter):
_URL_WITH_QS_RE = re.compile(r'\S+\?\S+')
def filter(self, record: logging.LogRecord) -> bool:
- from openhands.sdk.utils.redact import redact_url_params
-
if record.args:
if isinstance(record.args, (tuple, list)):
record.args = tuple(
diff --git a/tests/unit/app_server/utils/logger/test_logger.py b/tests/unit/app_server/utils/logger/test_logger.py
index 73acd45de8..05db5467f8 100644
--- a/tests/unit/app_server/utils/logger/test_logger.py
+++ b/tests/unit/app_server/utils/logger/test_logger.py
@@ -309,8 +309,10 @@ def test_redact_url_params_filter_msg_embedded_url():
def test_uvicorn_default_config_default_handler_has_redact_filter():
- """The 'default' handler (used by uvicorn.error) must have the redact filter
- so that WebSocket [accepted] logs don't leak session_api_key."""
+ """The 'default' handler (used by uvicorn.error) must have the redact filter.
+
+ Ensures WebSocket [accepted] logs don't leak session_api_key.
+ """
config = _uvicorn_default_log_config()
assert 'redact_url_params' in config['handlers']['default']['filters']
@@ -330,3 +332,67 @@ def test_uvicorn_configs_all_handlers_have_redact_filter():
f"Handler '{handler_name}' in {config_fn.__name__} is missing "
f"the 'redact_url_params' filter"
)
+
+
[email protected]('os.environ', {}, clear=True)
+def test_sensitive_data_filter_redacts_api_key_literals():
+ """SensitiveDataFilter must redact common API key prefixes via SDK utils."""
+ sensitive_filter = SensitiveDataFilter()
+
+ # Use values that match the SDK's actual patterns (20+ chars after prefix)
+ cases = [
+ 'sk-proj-' + 'a' * 25,
+ 'ghp_' + 'A' * 25,
+ "api_key='should-be-hidden'",
+ "{'GITHUB_TOKEN': 'mytoken'}",
+ ]
+ for secret in cases:
+ record = logging.LogRecord(
+ name='test',
+ level=logging.INFO,
+ pathname='test.py',
+ lineno=1,
+ msg=f'Value: {secret}',
+ args=(),
+ exc_info=None,
+ )
+ sensitive_filter.filter(record)
+ assert secret not in record.msg, f'Secret {secret!r} was not redacted'
+ assert '<redacted>' in record.msg
+
+
[email protected]('os.environ', {}, clear=True)
+def test_sensitive_filter_applied_to_handler_catches_child_logger_records():
+ """Filter on the handler must catch records propagated from child loggers.
+
+ Python only checks the originating logger's filters during propagation,
+ not ancestor logger filters. The filter must therefore be attached to
+ the handler as well as to openhands_logger so that child-logger records
+ (e.g. openhands.app_server.*) are still redacted.
+ """
+ import io
+
+ sensitive_filter = SensitiveDataFilter()
+
+ stream = io.StringIO()
+ handler = logging.StreamHandler(stream)
+ handler.setLevel(logging.DEBUG)
+ handler.addFilter(sensitive_filter)
+
+ parent = logging.getLogger('openhands.test_parent')
+ parent.addHandler(handler)
+ parent.setLevel(logging.DEBUG)
+ parent.propagate = False
+
+ child = logging.getLogger('openhands.test_parent.child')
+ child.setLevel(logging.DEBUG)
+
+ # Use a value that matches the SDK's actual redaction patterns (20+ chars)
+ secret = 'sk-proj-' + 'x' * 25
+ child.info(f'Token: {secret}')
+
+ output = stream.getvalue()
+ assert secret not in output, (
+ 'Child logger record was not redacted by handler filter'
+ )
+ assert '<redacted>' in output