Redact sensitive data in Plugwise diagnostics

homeassistant/components/plugwise/const.py

@@ -13,14 +13,21 @@
 LOGGER = logging.getLogger(__package__)
 
 API: Final = "api"
+AVAILABLE_SCHEDULES: Final = "available_schedules"
+DEVICES: Final = "devices"
 FLOW_SMILE: Final = "smile (Adam/Anna/P1)"
 FLOW_STRETCH: Final = "stretch (Stretch)"
 FLOW_TYPE: Final = "flow_type"
 GATEWAY: Final = "gateway"
+MAC_ADDRESS: Final = "mac_address"
+NONE: Final = "None"
+OFF: Final = "off"
 PW_TYPE: Final = "plugwise_type"
+SELECT_SCHEDULE: Final = "select_schedule"
 SMILE: Final = "smile"
 STRETCH: Final = "stretch"
 STRETCH_USERNAME: Final = "stretch"
+ZIGBEE_MAC_ADDRESS: Final = "zigbee_mac_address"
 
 PLATFORMS: Final[list[str]] = [
     Platform.BINARY_SENSOR,

homeassistant/components/plugwise/diagnostics.py

@@ -5,18 +5,49 @@
 from typing import Any
 
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import ATTR_NAME
 from homeassistant.core import HomeAssistant
+from homeassistant.helpers.redact import async_redact_data
 
-from .const import DOMAIN
+from .const import (
+    AVAILABLE_SCHEDULES,
+    DEVICES,
+    DOMAIN,
+    GATEWAY,
+    MAC_ADDRESS,
+    NONE,
+    OFF,
+    SELECT_SCHEDULE,
+    ZIGBEE_MAC_ADDRESS,
+)
 from .coordinator import PlugwiseDataUpdateCoordinator
 
+KEYS_TO_REDACT = {
+    ATTR_NAME,
+    MAC_ADDRESS,
+    ZIGBEE_MAC_ADDRESS,
+}
+
 
 async def async_get_config_entry_diagnostics(
     hass: HomeAssistant, entry: ConfigEntry
 ) -> dict[str, Any]:
     """Return diagnostics for a config entry."""
     coordinator: PlugwiseDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
-    return {
-        "gateway": coordinator.data.gateway,
-        "devices": coordinator.data.devices,
-    }
+
+    data = async_redact_data(coordinator.data.devices, KEYS_TO_REDACT)
+
+    for device in data:
+        if (key := SELECT_SCHEDULE) in data[device]:
+            if (value := data[device][key]) not in (OFF, NONE):
+                i = data[device][AVAILABLE_SCHEDULES].index(value)
+                data[device][key] = f"**REDACTED_{i}**"
+
+            value = data[device][AVAILABLE_SCHEDULES]
+            for j, item in enumerate(value):
+                if item not in (OFF, NONE):
+                    value[j] = f"**REDACTED_{j}**"
+
+            data[device][AVAILABLE_SCHEDULES] = value
+
+    return {GATEWAY: coordinator.data.gateway, DEVICES: data}