hide passwords in debug

powermon/configmodel/config_model.py

@@ -22,7 +22,7 @@ class MQTTConfig(NoExtraBaseModel):
     name: str
     port: None | int = Field(default=None)
     username: None | str = Field(default=None)
-    password: None | str = Field(default=None)
+    password: None | str = Field(default=None, repr=False)
     adhoc_topic: None | str = Field(default=None)
     adhoc_result_topic: None | str = Field(default=None)
 

powermon/configmodel/port_config_model.py

@@ -12,7 +12,7 @@ class BlePortConfig(NoExtraBaseModel):
     type: Literal["ble"]
     mac: str
     protocol: None | str
-    victron_key: None | str = Field(default=None)
+    victron_key: None | str = Field(default=None, repr=False)
 
 
 class SerialPortConfig(NoExtraBaseModel):

powermon/runner.py

@@ -5,6 +5,7 @@
 import logging
 import time
 from argparse import ArgumentParser
+from copy import deepcopy
 from platform import python_version
 
 import yaml
@@ -63,6 +64,18 @@ def _process_command_line_overrides(args):
         _config["debuglevel"] = logging.DEBUG
     return _config
 
+def _safe_config(config):
+    """return a config dict that hides passwords etc"""
+    keys_to_hide = ['password', 'victron_key']
+    _config = deepcopy(config)
+    for key in _config.keys():
+        if isinstance(_config[key], dict):
+            _config[key] = _safe_config(_config[key])
+        if key in keys_to_hide:
+            _config[key] = "******"
+    return _config
+
+
 
 def main():
     """main entry point for powermon command"""
@@ -144,7 +157,7 @@ def main():
     log.setLevel(config.get("debuglevel", logging.WARNING))
 
     # debug config
-    log.info("config: %s", config)
+    log.info("config: %s", _safe_config(config))  # TODO: fix dumping of password and victron_key
 
     # build mqtt broker object (optional)
     mqtt_broker = MqttBroker.from_config(config=config.get("mqttbroker"))

tests/config/mqtt.yaml

@@ -25,8 +25,8 @@ commands:
 mqttbroker:
   name: localhost
   port: 1883
-  username: null
-  password: null
+  username: test
+  password: test_password
   adhoc_topic: powermon/adhoc_commands
   adhoc_result_topic: powermon/adhoc_results