@onekeyfe/hwk-desktop-noble-ble 1.2.8-alpha.13 → 1.2.8-alpha.52

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ElectronBleScanOptions, ElectronBleConnectOptions } from '@onekeyfe/hwk-adapter-core';
+import { ElectronBleConnectOptions, ElectronBleScanOptions } from '@onekeyfe/hwk-adapter-core';
 export { THIRD_PARTY_BLE_CHANNELS, THIRD_PARTY_BLE_DEVICE_TTL_MS, THIRD_PARTY_BLE_POWER_ON_TIMEOUT_MS, THIRD_PARTY_BLE_SCAN_DURATION_MS, THIRD_PARTY_BLE_SCAN_IDLE_STOP_MS, ThirdPartyBleChannel } from './constants.mjs';
 
 type BleDebugLogLevel = 'debug' | 'info' | 'warn' | 'error';
@@ -12,6 +12,26 @@ type BleDebugLogger = (entry: BleDebugLogEntry) => void;
 /** Replace sensitive values at any depth; everything else is forwarded verbatim. */
 declare function redactBleDebugLogData(data?: Record<string, unknown>): Record<string, unknown> | undefined;
 
+/**
+ * Main-process allowlist entry for one vendor key. The renderer only names the vendor; which
+ * peripherals it may see and which GATT profile and framing it may use are decided here, so an
+ * IPC caller cannot turn the service into a generic BLE proxy. UUID arguments may arrive in any
+ * case, with or without dashes.
+ */
+interface ThirdPartyBleVendorProfile {
+    /** Whether an advertised service UUID belongs to this vendor. */
+    isServiceUuid(uuid: string): boolean;
+    /** Whether a local name belongs to this vendor; the handler passes a length-capped name. */
+    isName?(name: string): boolean;
+    /** Whether this GATT profile and write framing is one the vendor's firmware uses. */
+    acceptsConnect(options: ElectronBleConnectOptions): boolean;
+}
+/**
+ * Vendors the desktop BLE service serves by default, keyed by the vendor string the connectors
+ * send. A host passing `vendors` replaces this map, so spread it to add a vendor.
+ */
+declare const DEFAULT_THIRD_PARTY_BLE_VENDORS: Readonly<Record<string, ThirdPartyBleVendorProfile>>;
+
 /** Device info the main process returns to the renderer over IPC. */
 interface ThirdPartyBleDeviceInfo {
     /** Stable id (noble peripheral.id) used as connectId. */
@@ -139,6 +159,11 @@ interface NobleBleHandlerOptions {
     /** Override the overall connect timeout (tests only; defaults to 31s). */
     connectTimeoutMs?: number;
     logger?: BleDebugLogger;
+    /**
+     * Vendors served over IPC, keyed by the `vendor` the renderer sends. Replaces the default map
+     * (spread `DEFAULT_THIRD_PARTY_BLE_VENDORS` to add one); unknown vendors are rejected.
+     */
+    vendors?: Record<string, ThirdPartyBleVendorProfile>;
 }
 /** Noble BLE logic decoupled from Electron IPC, so tests can use a fake noble. */
 declare class NobleBleHandler {
@@ -146,6 +171,7 @@ declare class NobleBleHandler {
     private readonly _factory;
     private readonly _connectTimeoutMs;
     private readonly _logger?;
+    private readonly _vendors;
     private readonly _discovered;
     private readonly _lastSeen;
     private readonly _connected;
@@ -167,6 +193,7 @@ declare class NobleBleHandler {
     private _nativeReleased;
     private _lastNobleRecoverAt?;
     constructor(options?: NobleBleHandlerOptions);
+    private _resolveVendor;
     setNotificationListener(handler: (id: string, hexData: string) => void): void;
     setDisconnectedListener(handler: (id: string) => void): void;
     init(): Promise<void>;
@@ -274,4 +301,4 @@ interface ThirdPartyBleSupportHandle {
  */
 declare function initThirdPartyBleSupport(webContents: WebContentsLike, options?: InitThirdPartyBleSupportOptions): ThirdPartyBleSupportHandle;
 
-export { type BleDebugLogEntry, type BleDebugLogLevel, type BleDebugLogger, type InitThirdPartyBleSupportOptions, type IpcMainLike, NobleBleHandler, type NobleBleHandlerOptions, type ThirdPartyBleApi, type ThirdPartyBleAvailability, type ThirdPartyBleDeviceInfo, type ThirdPartyBleSupportHandle, initThirdPartyBleSupport, redactBleDebugLogData };
+export { type BleDebugLogEntry, type BleDebugLogLevel, type BleDebugLogger, DEFAULT_THIRD_PARTY_BLE_VENDORS, type InitThirdPartyBleSupportOptions, type IpcMainLike, NobleBleHandler, type NobleBleHandlerOptions, type ThirdPartyBleApi, type ThirdPartyBleAvailability, type ThirdPartyBleDeviceInfo, type ThirdPartyBleSupportHandle, type ThirdPartyBleVendorProfile, initThirdPartyBleSupport, redactBleDebugLogData };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ElectronBleScanOptions, ElectronBleConnectOptions } from '@onekeyfe/hwk-adapter-core';
+import { ElectronBleConnectOptions, ElectronBleScanOptions } from '@onekeyfe/hwk-adapter-core';
 export { THIRD_PARTY_BLE_CHANNELS, THIRD_PARTY_BLE_DEVICE_TTL_MS, THIRD_PARTY_BLE_POWER_ON_TIMEOUT_MS, THIRD_PARTY_BLE_SCAN_DURATION_MS, THIRD_PARTY_BLE_SCAN_IDLE_STOP_MS, ThirdPartyBleChannel } from './constants.js';
 
 type BleDebugLogLevel = 'debug' | 'info' | 'warn' | 'error';
@@ -12,6 +12,26 @@ type BleDebugLogger = (entry: BleDebugLogEntry) => void;
 /** Replace sensitive values at any depth; everything else is forwarded verbatim. */
 declare function redactBleDebugLogData(data?: Record<string, unknown>): Record<string, unknown> | undefined;
 
+/**
+ * Main-process allowlist entry for one vendor key. The renderer only names the vendor; which
+ * peripherals it may see and which GATT profile and framing it may use are decided here, so an
+ * IPC caller cannot turn the service into a generic BLE proxy. UUID arguments may arrive in any
+ * case, with or without dashes.
+ */
+interface ThirdPartyBleVendorProfile {
+    /** Whether an advertised service UUID belongs to this vendor. */
+    isServiceUuid(uuid: string): boolean;
+    /** Whether a local name belongs to this vendor; the handler passes a length-capped name. */
+    isName?(name: string): boolean;
+    /** Whether this GATT profile and write framing is one the vendor's firmware uses. */
+    acceptsConnect(options: ElectronBleConnectOptions): boolean;
+}
+/**
+ * Vendors the desktop BLE service serves by default, keyed by the vendor string the connectors
+ * send. A host passing `vendors` replaces this map, so spread it to add a vendor.
+ */
+declare const DEFAULT_THIRD_PARTY_BLE_VENDORS: Readonly<Record<string, ThirdPartyBleVendorProfile>>;
+
 /** Device info the main process returns to the renderer over IPC. */
 interface ThirdPartyBleDeviceInfo {
     /** Stable id (noble peripheral.id) used as connectId. */
@@ -139,6 +159,11 @@ interface NobleBleHandlerOptions {
     /** Override the overall connect timeout (tests only; defaults to 31s). */
     connectTimeoutMs?: number;
     logger?: BleDebugLogger;
+    /**
+     * Vendors served over IPC, keyed by the `vendor` the renderer sends. Replaces the default map
+     * (spread `DEFAULT_THIRD_PARTY_BLE_VENDORS` to add one); unknown vendors are rejected.
+     */
+    vendors?: Record<string, ThirdPartyBleVendorProfile>;
 }
 /** Noble BLE logic decoupled from Electron IPC, so tests can use a fake noble. */
 declare class NobleBleHandler {
@@ -146,6 +171,7 @@ declare class NobleBleHandler {
     private readonly _factory;
     private readonly _connectTimeoutMs;
     private readonly _logger?;
+    private readonly _vendors;
     private readonly _discovered;
     private readonly _lastSeen;
     private readonly _connected;
@@ -167,6 +193,7 @@ declare class NobleBleHandler {
     private _nativeReleased;
     private _lastNobleRecoverAt?;
     constructor(options?: NobleBleHandlerOptions);
+    private _resolveVendor;
     setNotificationListener(handler: (id: string, hexData: string) => void): void;
     setDisconnectedListener(handler: (id: string) => void): void;
     init(): Promise<void>;
@@ -274,4 +301,4 @@ interface ThirdPartyBleSupportHandle {
  */
 declare function initThirdPartyBleSupport(webContents: WebContentsLike, options?: InitThirdPartyBleSupportOptions): ThirdPartyBleSupportHandle;
 
-export { type BleDebugLogEntry, type BleDebugLogLevel, type BleDebugLogger, type InitThirdPartyBleSupportOptions, type IpcMainLike, NobleBleHandler, type NobleBleHandlerOptions, type ThirdPartyBleApi, type ThirdPartyBleAvailability, type ThirdPartyBleDeviceInfo, type ThirdPartyBleSupportHandle, initThirdPartyBleSupport, redactBleDebugLogData };
+export { type BleDebugLogEntry, type BleDebugLogLevel, type BleDebugLogger, DEFAULT_THIRD_PARTY_BLE_VENDORS, type InitThirdPartyBleSupportOptions, type IpcMainLike, NobleBleHandler, type NobleBleHandlerOptions, type ThirdPartyBleApi, type ThirdPartyBleAvailability, type ThirdPartyBleDeviceInfo, type ThirdPartyBleSupportHandle, type ThirdPartyBleVendorProfile, initThirdPartyBleSupport, redactBleDebugLogData };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  DEFAULT_THIRD_PARTY_BLE_VENDORS: () => DEFAULT_THIRD_PARTY_BLE_VENDORS,
   NobleBleHandler: () => NobleBleHandler,
   THIRD_PARTY_BLE_CHANNELS: () => THIRD_PARTY_BLE_CHANNELS,
   THIRD_PARTY_BLE_DEVICE_TTL_MS: () => THIRD_PARTY_BLE_DEVICE_TTL_MS,
@@ -114,24 +115,74 @@ var THIRD_PARTY_BLE_SCAN_IDLE_STOP_MS = 1e4;
 var THIRD_PARTY_BLE_DEVICE_TTL_MS = 5e3;
 var THIRD_PARTY_BLE_POWER_ON_TIMEOUT_MS = 1e4;
 
+// src/vendorProfiles.ts
+var normalizeBleUuid = (uuid) => uuid.replace(/-/g, "").toLowerCase();
+var isUuidString = (value) => typeof value === "string";
+var isIntegerInRange = (value, min, max) => typeof value === "number" && Number.isInteger(value) && value >= min && value <= max;
+var TREZOR_SERVICE_UUID = normalizeBleUuid("8c000001-a59b-4d58-a9ad-073df69fa1b1");
+var TREZOR_WRITE_UUID = normalizeBleUuid("8c000002-a59b-4d58-a9ad-073df69fa1b1");
+var TREZOR_NOTIFY_UUID = normalizeBleUuid("8c000003-a59b-4d58-a9ad-073df69fa1b1");
+var TREZOR_PACKET_SIZE = 244;
+var TREZOR_MAX_CHUNK_DELAY_MS = 50;
+var TREZOR_NAME_BRAND = /\bTrezor\b/i;
+var TREZOR_NAME_MODEL = /\bSafe\s*7\b|\bT3W1\b/i;
+var trezorProfile = {
+  isServiceUuid: (uuid) => isUuidString(uuid) && normalizeBleUuid(uuid) === TREZOR_SERVICE_UUID,
+  isName: (name) => TREZOR_NAME_BRAND.test(name) && TREZOR_NAME_MODEL.test(name),
+  acceptsConnect: (options) => {
+    const { write } = options;
+    return isUuidString(options.serviceUuid) && isUuidString(options.writeUuid) && isUuidString(options.notifyUuid) && normalizeBleUuid(options.serviceUuid) === TREZOR_SERVICE_UUID && normalizeBleUuid(options.writeUuid) === TREZOR_WRITE_UUID && normalizeBleUuid(options.notifyUuid) === TREZOR_NOTIFY_UUID && typeof write === "object" && write !== null && write.mode === "padded" && write.chunkSize === TREZOR_PACKET_SIZE && (write.chunkDelayMs === void 0 || isIntegerInRange(write.chunkDelayMs, 0, TREZOR_MAX_CHUNK_DELAY_MS)) && write.maxLength === void 0;
+  }
+};
+var LEDGER_UUID = /^13d634002c97([0-9a-f]{4})000([0-3])4c6564676572$/;
+var LEDGER_ROLE_SERVICE = "0";
+var LEDGER_ROLE_NOTIFY = "1";
+var LEDGER_ROLE_WRITE = "2";
+var LEDGER_ROLE_WRITE_CMD = "3";
+var LEDGER_MAX_FRAME_SIZE = 255;
+var parseLedgerUuid = (uuid) => {
+  if (!isUuidString(uuid)) return void 0;
+  const parsed = LEDGER_UUID.exec(normalizeBleUuid(uuid));
+  return parsed ? { model: parsed[1], role: parsed[2] } : void 0;
+};
+var ledgerProfile = {
+  isServiceUuid: (uuid) => parseLedgerUuid(uuid)?.role === LEDGER_ROLE_SERVICE,
+  acceptsConnect: (options) => {
+    const service = parseLedgerUuid(options.serviceUuid);
+    const notify = parseLedgerUuid(options.notifyUuid);
+    const write = parseLedgerUuid(options.writeUuid);
+    const framing = options.write;
+    return service?.role === LEDGER_ROLE_SERVICE && notify?.role === LEDGER_ROLE_NOTIFY && (write?.role === LEDGER_ROLE_WRITE || write?.role === LEDGER_ROLE_WRITE_CMD) && notify.model === service.model && write.model === service.model && typeof framing === "object" && framing !== null && framing.mode === "raw" && isIntegerInRange(framing.maxLength, 1, LEDGER_MAX_FRAME_SIZE) && framing.chunkSize === void 0 && framing.chunkDelayMs === void 0;
+  }
+};
+var DEFAULT_THIRD_PARTY_BLE_VENDORS = Object.freeze({
+  ledger: ledgerProfile,
+  trezor: trezorProfile
+});
+
 // src/NobleBleHandler.ts
 var DEFAULT_NOBLE_FACTORY = () => {
   const noble = require("@stoprocent/noble");
   return noble;
 };
-var normalizeUuid = (uuid) => uuid.replace(/-/g, "").toLowerCase();
-var matchesPeripheral = (p, match) => {
-  if (!match) return false;
+var BLE_NAME_MATCH_MAX_LENGTH = 64;
+var matchesPeripheral = (p, profile, narrowTo) => {
   const adv = p.advertisement ?? {};
   const advertised = adv.serviceUuids ?? [];
-  if (match.serviceUuids?.length && advertised.some(
-    (uuid) => match.serviceUuids?.some((wanted) => normalizeUuid(wanted) === normalizeUuid(uuid))
+  if (advertised.some(
+    (uuid) => typeof uuid === "string" && profile.isServiceUuid(uuid) && (!narrowTo || narrowTo.has(normalizeBleUuid(uuid)))
   )) {
     return true;
   }
   const name = adv.localName;
-  if (!match.namePatterns?.length || !name) return false;
-  return match.namePatterns.every((pattern) => new RegExp(pattern, "i").test(name));
+  if (!profile.isName || typeof name !== "string" || !name) return false;
+  return profile.isName(name.slice(0, BLE_NAME_MATCH_MAX_LENGTH));
+};
+var requestedServiceUuids = (options) => {
+  const requested = options?.match ? options.match.serviceUuids : options?.serviceUuids;
+  if (!Array.isArray(requested)) return void 0;
+  const uuids = requested.filter((uuid) => typeof uuid === "string");
+  return uuids.length ? new Set(uuids.map(normalizeBleUuid)) : void 0;
 };
 var peripheralToInfo = (p) => {
   const adv = p.advertisement ?? {};
@@ -193,6 +244,12 @@ var NobleBleHandler = class {
     this._factory = options.nobleFactory ?? DEFAULT_NOBLE_FACTORY;
     this._connectTimeoutMs = options.connectTimeoutMs ?? BLE_CONNECT_TIMEOUT_MS;
     this._logger = options.logger;
+    this._vendors = new Map(Object.entries(options.vendors ?? DEFAULT_THIRD_PARTY_BLE_VENDORS));
+  }
+  _resolveVendor(vendor) {
+    const profile = typeof vendor === "string" ? this._vendors.get(vendor) : void 0;
+    if (typeof vendor !== "string" || !profile) throw new Error("Unsupported BLE vendor");
+    return { vendor, profile };
   }
   setNotificationListener(handler) {
     this._onNotification = handler;
@@ -245,14 +302,15 @@ var NobleBleHandler = class {
    * packet, and a Safe 7 ADV carries only its name (UUID is in the scan response).
    */
   async scan(options) {
-    this._scanOwners.add(options?.vendor);
+    const { vendor, profile } = this._resolveVendor(options?.vendor);
+    this._scanOwners.add(vendor);
     try {
       await this.init();
     } catch (error) {
-      this._scanOwners.delete(options?.vendor);
+      this._scanOwners.delete(vendor);
       throw error;
     }
-    if (!this._scanOwners.has(options?.vendor)) return [];
+    if (!this._scanOwners.has(vendor)) return [];
     try {
       await this._setScanning(true);
     } catch (error) {
@@ -261,7 +319,7 @@ var NobleBleHandler = class {
     }
     this._assertActive();
     this._armIdleStop();
-    const devices = this._snapshot(options);
+    const devices = this._snapshot(vendor, profile, requestedServiceUuids(options));
     if (devices.length === 0) {
       this._log("warn", "scan.empty", {
         raw: this._discovered.size,
@@ -275,9 +333,8 @@ var NobleBleHandler = class {
    * In-range devices matching the caller, minus TTL-expired ones. `_discovered`
    * is only a cache; a missing device can still be reached by `_directConnect`.
    */
-  _snapshot(options) {
+  _snapshot(vendor, profile, narrowTo) {
     const now = Date.now();
-    const match = options?.match ?? { serviceUuids: options?.serviceUuids };
     const result = [];
     for (const [id, peripheral] of this._discovered) {
       if (now - (this._lastSeen.get(id) ?? 0) > THIRD_PARTY_BLE_DEVICE_TTL_MS) {
@@ -285,11 +342,11 @@ var NobleBleHandler = class {
         this._lastSeen.delete(id);
         continue;
       }
-      if (!matchesPeripheral(peripheral, match)) continue;
+      if (!matchesPeripheral(peripheral, profile, narrowTo)) continue;
       result.push(peripheralToInfo(peripheral));
     }
     for (const [id, entry] of this._connected) {
-      if (entry.vendor !== options?.vendor) continue;
+      if (entry.vendor !== vendor) continue;
       if (result.some((info) => info.id === id)) continue;
       result.push(peripheralToInfo(entry.peripheral));
     }
@@ -406,7 +463,9 @@ var NobleBleHandler = class {
    */
   getDevice(id) {
     const p = this._discovered.get(id);
-    if (!p) return null;
+    if (!p || ![...this._vendors.values()].some((profile) => matchesPeripheral(p, profile))) {
+      return null;
+    }
     return peripheralToInfo(p);
   }
   /** Live RSSI (dBm) of a connected peripheral, else the cached scan-time value. */
@@ -523,10 +582,13 @@ var NobleBleHandler = class {
   // `timed out` (unreachable) and `connection failed` (stale bond) differently.
   async connect(id, options) {
     if (!options || !options.vendor || ![options.serviceUuid, options.writeUuid, options.notifyUuid].every(
-      (uuid) => typeof uuid === "string" && /^[0-9a-f]{32}$/i.test(normalizeUuid(uuid))
+      (uuid) => typeof uuid === "string" && /^[0-9a-f]{32}$/i.test(normalizeBleUuid(uuid))
     )) {
       throw new Error("Invalid BLE GATT profile");
     }
+    if (!this._resolveVendor(options.vendor).profile.acceptsConnect(options)) {
+      throw new Error(`BLE GATT profile not allowed for ${options.vendor}`);
+    }
     this._assertActive();
     const claim = { abandoned: false };
     let abandon;
@@ -634,10 +696,10 @@ var NobleBleHandler = class {
         [options.serviceUuid],
         [options.writeUuid, options.notifyUuid]
       );
-      const writeUuid = normalizeUuid(options.writeUuid);
-      const notifyUuid = normalizeUuid(options.notifyUuid);
-      const writeChar = characteristics.find((c) => normalizeUuid(c.uuid) === writeUuid);
-      const notifyChar = characteristics.find((c) => normalizeUuid(c.uuid) === notifyUuid);
+      const writeUuid = normalizeBleUuid(options.writeUuid);
+      const notifyUuid = normalizeBleUuid(options.notifyUuid);
+      const writeChar = characteristics.find((c) => normalizeBleUuid(c.uuid) === writeUuid);
+      const notifyChar = characteristics.find((c) => normalizeBleUuid(c.uuid) === notifyUuid);
       if (!writeChar || !notifyChar) {
         throw new Error(`BLE characteristics not found on device ${id}`);
       }
@@ -948,6 +1010,7 @@ function initThirdPartyBleSupport(webContents, options = {}) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DEFAULT_THIRD_PARTY_BLE_VENDORS,
   NobleBleHandler,
   THIRD_PARTY_BLE_CHANNELS,
   THIRD_PARTY_BLE_DEVICE_TTL_MS,