Redact privacy sensitive fields from device specification

* functon which can redact device log fields * reverted dubble quotes to single quotes. * another double quote to single quote. IDE automatically changes this when save.. :-( * set default Redacted fields, and append redacted fields when needed. added same redacted function for other driver. * Ensure filter implementation does not crash --------- Co-authored-by: Eelco <[email protected]> Co-authored-by: Bob van de Vijver <[email protected]>
athombv · Jul 29, 2024 · 307aeff · 307aeff
1 parent 5767e19
commit 307aeff
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/drivers/other/driver.js b/drivers/other/driver.js
@@ -1,6 +1,7 @@
 "use strict";
 
 const TuyaOAuth2Driver = require("../../lib/TuyaOAuth2Driver");
+const TuyaOAuth2Util = require("../../lib/TuyaOAuth2Util");
 
 module.exports = class TuyaOAuth2DriverOther extends TuyaOAuth2Driver {
   onTuyaPairListDeviceFilter() {
@@ -11,7 +12,7 @@ module.exports = class TuyaOAuth2DriverOther extends TuyaOAuth2Driver {
     const props = super.onTuyaPairListDeviceProperties(device);
 
     const combinedSpecification = {
-      device: device,
+      device: TuyaOAuth2Util.redactFields(device),
       specifications: specifications,
     };
 

diff --git a/lib/TuyaOAuth2Driver.js b/lib/TuyaOAuth2Driver.js
@@ -1,6 +1,7 @@
 'use strict';
 
 const { OAuth2Driver } = require('homey-oauth2app');
+const TuyaOAuth2Util = require('./TuyaOAuth2Util');
 
 /**
  * @extends OAuth2Driver
@@ -14,7 +15,7 @@ class TuyaOAuth2Driver extends OAuth2Driver {
     const devices = await oAuth2Client.getDevices();
     const filteredDevices = devices
       .filter(device => {
-        this.log('Device:', JSON.stringify(device));
+        this.log('Device:', JSON.stringify(TuyaOAuth2Util.redactFields(device)));
         return this.onTuyaPairListDeviceFilter(device);
       });
     const listDevices = [];

diff --git a/lib/TuyaOAuth2Util.js b/lib/TuyaOAuth2Util.js
@@ -79,6 +79,23 @@ class TuyaOAuth2Util {
     return headers;
   }
 
+  /*
+   * Redact sensitive fields when logging Device information
+   */
+  static redactFields(device, additionalFields = []) {
+    const defaultFields = ['ip', 'lat', 'lon', 'owner_id', 'uid', 'uuid', 'local_key'];
+    const combinedFields = [...new Set([...defaultFields, ...additionalFields])];
+
+    const newObj = JSON.parse(JSON.stringify(device));
+    combinedFields.forEach((field) => {
+      if (newObj.hasOwnProperty(field)) {
+        newObj[field] = "<redacted>";
+      }
+    });
+
+    return newObj;
+  }
+
 }
 
 module.exports = TuyaOAuth2Util;