ha-mcp-dev 7.6.0.dev640__tar.gz → 7.6.0.dev641__tar.gz

{ha_mcp_dev-7.6.0.dev640/src/ha_mcp_dev.egg-info → ha_mcp_dev-7.6.0.dev641}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ha-mcp-dev
-Version: 7.6.0.dev640
+Version: 7.6.0.dev641
 Summary: Home Assistant MCP Server - Complete control of Home Assistant through MCP
 Author-email: Julien <github@qc-h.net>
 License: MIT

{ha_mcp_dev-7.6.0.dev640 → ha_mcp_dev-7.6.0.dev641}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ha-mcp-dev"
-version = "7.6.0.dev640"
+version = "7.6.0.dev641"
 description = "Home Assistant MCP Server - Complete control of Home Assistant through MCP"
 readme = "README.md"
 requires-python = ">=3.13,<3.14"

{ha_mcp_dev-7.6.0.dev640 → ha_mcp_dev-7.6.0.dev641}/src/ha_mcp/tools/tools_bug_report.py

@@ -508,7 +508,8 @@ class BugReportTools:
         **OUTPUT:**
         Returns both templates plus diagnostic data. Key fields:
         - `runtime_bug_template`, `agent_behavior_template` — pick based on context
-        - `recent_logs`, `startup_logs` — captured ha-mcp tool/server log entries
+        - `recent_logs` — recent ha-mcp tool calls (secret parameters redacted);
+          startup log entries are summarised in `formatted_report`, not returned raw
         - `addon_logs` — addon container stdout/stderr (HA add-on installs only;
           empty string otherwise)
         - `suggested_title`, `duplicate_check_urls`, `anonymization_guide`
@@ -622,8 +623,13 @@ class BugReportTools:
         return {
             "success": True,
             "diagnostic_info": diagnostic_info,
+            # ``recent_logs`` entries are redacted at the logging chokepoint
+            # (UsageLogger.log_tool_usage), so the tool parameters here carry no
+            # secrets. ``startup_logs`` come from a separate StartupLogCollector
+            # that is NOT redacted at source, so the raw entries are
+            # intentionally omitted — the sanitized view lives in
+            # ``formatted_report`` (via ``_format_startup_logs``).
             "recent_logs": recent_logs,
-            "startup_logs": startup_logs,
             "addon_logs": addon_logs,
             "log_count": len(recent_logs),
             "startup_log_count": len(startup_logs),

{ha_mcp_dev-7.6.0.dev640 → ha_mcp_dev-7.6.0.dev641}/src/ha_mcp/utils/usage_logger.py

@@ -94,6 +94,72 @@ def get_startup_logs() -> list[dict[str, Any]]:
     return _startup_collector.get_logs()
 
 
+# Parameter keys whose values are masked before a tool call is recorded to the
+# in-memory ring buffer or persisted to disk. Tool kwargs can carry secrets
+# (alarm/lock ``code``, tokens, passwords); these must never reach the usage
+# log, which ``ha_report_issue`` surfaces and which is written verbatim to
+# plaintext ``mcp_usage.jsonl``. Matching is by key name (case-insensitive) and
+# recursive, so a secret nested under a non-sensitive key — e.g.
+# ``ha_call_service(data={"code": ...})`` — is caught while ``data`` siblings
+# like ``entity_id``/``brightness`` survive for debugging.
+_SENSITIVE_PARAM_KEYS = frozenset(
+    {
+        "code",
+        "pin",
+        "password",
+        "passwd",
+        "secret",
+        "token",
+        "access_token",
+        "refresh_token",
+        "api_key",
+        "apikey",
+        "client_secret",
+        "authorization",
+    }
+)
+# Suffix match only for families with a low false-positive rate. Deliberately
+# excludes ``_code``/``_key`` so ``status_code``/``cache_key`` stay readable;
+# the exact ``code``/``pin``/``api_key`` entries above already cover the real
+# Home Assistant service-call surface.
+_SENSITIVE_KEY_SUFFIXES = ("_token", "_secret", "_password", "_passwd")
+_REDACTED_VALUE = "[REDACTED]"
+_MAX_REDACT_DEPTH = 6
+
+
+def _is_sensitive_key(key: Any) -> bool:
+    """Return True if a parameter key's value should be masked."""
+    if not isinstance(key, str):
+        return False
+    lowered = key.lower()
+    return lowered in _SENSITIVE_PARAM_KEYS or lowered.endswith(_SENSITIVE_KEY_SUFFIXES)
+
+
+def _redact_parameters(value: Any, _depth: int = 0) -> Any:
+    """Return a copy of ``value`` with sensitive values masked by key name.
+
+    Never mutates the input: it is the live tool ``kwargs`` dict, still
+    referenced by the caller after this returns. Recurses through nested
+    dicts/lists/tuples so secrets nested under non-sensitive keys are caught
+    (a tuple is returned as a list). Fails closed past ``_MAX_REDACT_DEPTH`` —
+    a subtree too deep to walk is masked wholesale rather than returned verbatim.
+    """
+    if _depth > _MAX_REDACT_DEPTH:
+        return _REDACTED_VALUE
+    if isinstance(value, dict):
+        return {
+            key: (
+                _REDACTED_VALUE
+                if _is_sensitive_key(key)
+                else _redact_parameters(item, _depth + 1)
+            )
+            for key, item in value.items()
+        }
+    if isinstance(value, (list, tuple)):
+        return [_redact_parameters(item, _depth + 1) for item in value]
+    return value
+
+
 @dataclass
 class ToolUsageLog:
     """Single tool usage log entry."""
@@ -201,10 +267,14 @@ class UsageLogger:
         if not self._enabled:
             return
         try:
+            # Mask secrets (alarm/lock codes, tokens, passwords) before the entry
+            # reaches the ring buffer or disk. Returns a copy — never mutates the
+            # caller's live kwargs dict.
+            redacted_parameters = _redact_parameters(parameters)
             log_entry = ToolUsageLog(
                 timestamp=datetime.now(UTC).isoformat(),
                 tool_name=tool_name,
-                parameters=parameters,
+                parameters=redacted_parameters,
                 execution_time_ms=execution_time_ms,
                 success=success,
                 error_message=error_message,

{ha_mcp_dev-7.6.0.dev640 → ha_mcp_dev-7.6.0.dev641/src/ha_mcp_dev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ha-mcp-dev
-Version: 7.6.0.dev640
+Version: 7.6.0.dev641
 Summary: Home Assistant MCP Server - Complete control of Home Assistant through MCP
 Author-email: Julien <github@qc-h.net>
 License: MIT