2.3.0

Updated the behavior so that sensitive data is not logged unless debugMode is enabled.

Author: tassy-h

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [2.3.0] - (2026.6.12)
+
+### Added
+ - Added an option to force communication over IPv4.
+ - Added contact sensor state option for garage doors
+
+### Changed
+ - Updated the behavior so that sensitive data is not logged unless debugMode is enabled.
+
+
 ## [2.2.3] - (2026.5.8)
 
 ### Changed

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@homebridge-plugins/homebridge-tuya",
   "displayName": "Homebridge Tuya",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "Forked from 0x5e/homebridge-tuya-platform, with a focus on fixing bugs and adding new device support.",
   "license": "MIT",
   "repository": {
@@ -47,6 +47,7 @@
     "debounce": "^1.2.1",
     "jsonschema": "^1.4.1",
     "kelvin-to-rgb": "^1.0.2",
+    "lodash": "^4.18.1",
     "lodash.isequal": "^4.5.0",
     "mqtt": "^4.2.6",
     "uuid": "^9.0.0"
@@ -56,6 +57,7 @@
     "@types/crypto-js": "^4.1.1",
     "@types/debounce": "^1.2.1",
     "@types/jest": "^29.1.2",
+    "@types/lodash": "^4.17.24",
     "@types/lodash.isequal": "^4.5.6",
     "@types/node": "^22.0.0",
     "@types/uuid": "^8.3.4",

package.json

@@ -7,7 +7,7 @@ import isEqual from 'lodash.isequal';
 import { TuyaDeviceSchema, TuyaDeviceSchemaIntegerProperty, TuyaDeviceSchemaMode, TuyaDeviceStatus } from '../device/TuyaDevice';
 import { TuyaPlatform } from '../platform';
 import { limit, sanitizeName } from '../util/util';
-import { PrefixLogger } from '../util/Logger';
+import { logger, PrefixLogger } from '../util/Logger';
 
 const MANUFACTURER = 'Tuya Inc.';
 
@@ -31,7 +31,7 @@ class BaseAccessory {
   public deviceManager = this.platform.deviceManager!;
   public device = this.deviceManager.getDevice(this.accessory.context.deviceID)!;
   public log = new PrefixLogger(
-    this.platform.log,
+    logger(),
     this.device.name.length > 0 ? this.device.name : this.device.id,
     this.platform.options.debug && ((this.platform.options.debugLevel ?? '').length > 0
       ? this.platform.options.debugLevel?.includes(this.device.id)

src/accessory/BaseAccessory.ts

@@ -11,7 +11,7 @@ import dns from 'dns';
 // @ts-ignore
 import { version } from '../../package.json';
 
-import Logger, { PrefixLogger } from '../util/Logger';
+import { ExLogger, logger, PrefixLogger } from '../util/Logger';
 
 enum Endpoints {
   AMERICA = 'https://openapi.tuyaus.com',
@@ -88,17 +88,17 @@ export default class TuyaOpenAPI {
   public deviceArr: Array<object> = [];
 
   public tokenInfo = { access_token: '', refresh_token: '', uid: '', expire: 0 };
+  private log: ExLogger;
 
   constructor(
     public endpoint: Endpoints | string,
     public accessId: string,
     public accessKey: string,
-    public log: Logger = console,
     public lang = 'en',
     public debug = false,
     public forceIPv4 = false,
   ) {
-    this.log = new PrefixLogger(log, TuyaOpenAPI.name, debug);
+    this.log = new PrefixLogger(logger(), TuyaOpenAPI.name, debug);
   }
 
   static getDefaultEndpoint(countryCode: number) {

src/core/TuyaOpenAPI.ts

@@ -4,7 +4,7 @@ import Crypto from 'crypto';
 import CryptoJS from 'crypto-js';
 
 import TuyaOpenAPI from './TuyaOpenAPI';
-import Logger, { PrefixLogger } from '../util/Logger';
+import { ExLogger, logger, PrefixLogger } from '../util/Logger';
 import dns from 'dns';
 
 const GCM_TAG_LENGTH = 16;
@@ -34,14 +34,14 @@ export default class TuyaOpenMQ {
   public linkId = uuid_v4();
 
   public timer?: NodeJS.Timeout;
+  private log: ExLogger;
 
   constructor(
     public api: TuyaOpenAPI,
-    public log: Logger = new PrefixLogger(console, 'console', false),
     public debug = false,
     public forceIPv4 = api.forceIPv4,
   ) {
-    this.log = new PrefixLogger(log, TuyaOpenMQ.name, debug);
+    this.log = new PrefixLogger(logger(), TuyaOpenMQ.name, debug);
   }
 
   start() {

src/core/TuyaOpenMQ.ts

@@ -1,7 +1,7 @@
 import EventEmitter from 'events';
 import TuyaOpenAPI from '../core/TuyaOpenAPI';
 import TuyaOpenMQ from '../core/TuyaOpenMQ';
-import { ExLogger, PrefixLogger } from '../util/Logger';
+import { ExLogger, logger, PrefixLogger } from '../util/Logger';
 import TuyaDevice, {
   TuyaDeviceSchema,
   TuyaDeviceSchemaMode,
@@ -37,10 +37,9 @@ export default class TuyaDeviceManager extends EventEmitter {
   ) {
     super();
 
-    const log = (this.api.log as PrefixLogger).log;
-    this.log = new PrefixLogger(log, TuyaDeviceManager.name, debug);
+    this.log = new PrefixLogger(logger(), TuyaDeviceManager.name, debug);
 
-    this.mq = new TuyaOpenMQ(api, log);
+    this.mq = new TuyaOpenMQ(api);
     this.mq.addMessageListener(this.onMQTTMessage.bind(this));
   }
 

src/device/TuyaDeviceManager.ts

@@ -14,6 +14,7 @@ import AccessoryFactory from './accessory/AccessoryFactory';
 import BaseAccessory from './accessory/BaseAccessory';
 import { sanitizeName } from './util/util';
 import TuyaOpenAPI, { LOGIN_ERROR_MESSAGES } from './core/TuyaOpenAPI';
+import { initLogger } from './util/Logger';
 
 
 /**
@@ -112,6 +113,7 @@ export class TuyaPlatform implements DynamicPlatformPlugin {
     public readonly config: PlatformConfig,
     public readonly api: API,
   ) {
+    initLogger(log);
 
     if (!this.validate()) {
       return;
@@ -262,7 +264,7 @@ export class TuyaPlatform implements DynamicPlatformPlugin {
     let res;
     const { endpoint, accessId, accessKey, debug, debugLevel } = this.options;
     const debugMode = debug && ((debugLevel ?? '').length > 0 ? debugLevel?.includes('api') : true);
-    const api = new TuyaOpenAPI(endpoint, accessId, accessKey, this.log, 'en', debugMode, this.options.forceIPv4);
+    const api = new TuyaOpenAPI(endpoint, accessId, accessKey, 'en', debugMode, this.options.forceIPv4);
     const deviceManager = new TuyaCustomDeviceManager(api, debugMode);
 
     this.log.info('Get token.');
@@ -355,7 +357,6 @@ export class TuyaPlatform implements DynamicPlatformPlugin {
       (endpoint && endpoint.length > 0) ? endpoint : TuyaOpenAPI.getDefaultEndpoint(countryCode),
       accessId,
       accessKey,
-      this.log,
       'en',
       debugMode,
       this.options.forceIPv4);

src/platform.ts

@@ -1,5 +1,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+import { EOL } from 'os';
+import util from 'util';
+import cloneDeep from 'lodash/cloneDeep';
+
 export default interface Logger {
   info(message?: any, ...args: any[]): void;
   warn(message?: any, ...args: any[]): void;
@@ -14,41 +18,94 @@ function isExLogger(obj: any): obj is ExLogger {
   return typeof obj.success === 'function';
 }
 
+let _logger: Logger;
+export const logger = () => _logger ?? console;
+export const initLogger = (logger: Logger) => _logger = logger;
+
 export class PrefixLogger implements ExLogger {
   constructor(
     public log: Logger,
-    public prefix: string,
+    public prefix: string = '',
     public debugMode = false,
+    private mask = !debugMode,
   ) {
     this.debugMode = this.debugMode || process.argv.includes('-D') || process.argv.includes('--debug');
   }
 
   debug(message?: any, ...args: any[]) {
+    message = typeof message === 'string' ? this.masking(message) : this.maskingValue(message);
+    args = args?.map(arg => typeof arg === 'string' ? this.masking(arg) : arg);
     if (this.debugMode) {
-      this.log.info((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+      this.log.info(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
     } else {
-      this.log.debug((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+      this.log.debug(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
     }
   }
 
   info(message?: any, ...args: any[]) {
-    this.log.info((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+    message = typeof message === 'string' ? this.masking(message) : this.maskingValue(message);
+    args = args?.map(arg => typeof arg === 'string' ? this.masking(arg) : arg);
+    this.log.info(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
   }
 
   warn(message?: any, ...args: any[]) {
-    this.log.warn((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+    message = typeof message === 'string' ? this.masking(message) : this.maskingValue(message);
+    args = args?.map(arg => typeof arg === 'string' ? this.masking(arg) : arg);
+    this.log.warn(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
   }
 
   error(message?: any, ...args: any[]) {
-    this.log.error((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+    message = typeof message === 'string' ? this.masking(message) : this.maskingValue(message);
+    args = args?.map(arg => typeof arg === 'string' ? this.masking(arg) : arg);
+    this.log.error(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
   }
 
   success(message?: any, ...args: any[]) {
+    message = typeof message === 'string' ? this.masking(message) : this.maskingValue(message);
+    args = args?.map(arg => typeof arg === 'string' ? this.masking(arg) : this.maskingValue(arg));
     if (isExLogger(this.log)) {
-      this.log.success((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+      this.log.success(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
     } else {
-      this.log.info((this.prefix ? `[${this.prefix}] ` : '') + message, ...args);
+      this.log.info(util.format(`[%s] ${typeof message === 'string' ? '%s' : '%O'}`, this.prefix, message), ...args);
     }
   }
 
-}
+  private masking(str: string) : string {
+    if (!this.mask || typeof str !== 'string') {
+      return str;
+    }
+    const regex_single = /'(password|token|access_?token|accessKey|tuyaKey|api_?key|secret)'\s*:\s*'[^']*'/gi;
+    const regex_double = /"(password|token|access_?token|accessKey|tuyaKey|api_?key|secret)"\s*:\s*"[^"]*"/gi;
+    const spilts = str.split(/\r\n|\n|\r/);
+    if (!spilts.some(s => regex_single.test(s)) && !spilts.some(s => regex_double.test(s))) {
+      return str;
+    }
+    const results = spilts
+      .map(a => a.replace(regex_single, '\'$1\': \'********\''))
+      .map(a => a.replace(regex_double, '"$1": "********"'));
+    return results.join(EOL);
+  }
+
+  private maskingValue(obj: any) {
+    if (!this.mask) {
+      return obj;
+    }
+    const cloneObj = cloneDeep(obj);
+    const regex = /(password|token|access_?token|accessKey|tuyakey|api_?key|secret)/i;
+    for (const key in cloneObj) {
+      const value = cloneObj[key];
+      if (typeof value === 'function') {
+        continue;
+      }
+      if (typeof value === 'string') {
+        if (!regex.test(key)) {
+          continue;
+        }
+        cloneObj[key] = '*'.repeat(value.length);
+      } else {
+        cloneObj[key] = this.maskingValue(value);
+      }
+    }
+    return cloneObj;
+  }
+}