feat(transport): add DebugLink support to NodeUsbTransport and UdpTra…

…nsport
trezor · Aug 19, 2024 · 8bd0e9b · 8bd0e9b
1 parent 2a1c8a4
commit 8bd0e9b
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 10 deletions.
diff --git a/packages/transport/src/api/udp.ts b/packages/transport/src/api/udp.ts
@@ -18,9 +18,11 @@ export class UdpApi extends AbstractApi {
 
     private enumerationTimeout: ReturnType<typeof setTimeout> | undefined;
     private enumerateAbortController = new AbortController();
+    private debugLink?: boolean;
 
-    constructor({ logger }: AbstractApiConstructorParams) {
+    constructor({ logger, debugLink }: AbstractApiConstructorParams & { debugLink?: boolean }) {
         super({ logger });
+        this.debugLink = debugLink;
     }
 
     listen() {
@@ -160,7 +162,7 @@ export class UdpApi extends AbstractApi {
 
     public async enumerate(signal?: AbortSignal) {
         // in theory we could support multiple devices, but we don't yet
-        const paths = ['127.0.0.1:21324'];
+        const paths = this.debugLink ? ['127.0.0.1:21325'] : ['127.0.0.1:21324'];
 
         try {
             const enumerateResult = await Promise.all(

diff --git a/packages/transport/src/api/usb.ts b/packages/transport/src/api/usb.ts
@@ -6,6 +6,8 @@ import {
     CONFIGURATION_ID,
     ENDPOINT_ID,
     INTERFACE_ID,
+    DEBUGLINK_ENDPOINT_ID,
+    DEBUGLINK_INTERFACE_ID,
     T1_HID_VENDOR,
     TREZOR_USB_DESCRIPTORS,
     WEBUSB_BOOTLOADER_PRODUCT,
@@ -16,6 +18,7 @@ import * as ERRORS from '../errors';
 interface ConstructorParams extends AbstractApiConstructorParams {
     usbInterface: USB;
     forceReadSerialOnConnect?: boolean;
+    debugLink?: boolean;
 }
 
 interface TransportInterfaceDevice {
@@ -36,12 +39,14 @@ export class UsbApi extends AbstractApi {
     protected usbInterface: ConstructorParams['usbInterface'];
     private forceReadSerialOnConnect?: boolean;
     private abortController = new AbortController();
+    private debugLink?: boolean;
 
-    constructor({ usbInterface, logger, forceReadSerialOnConnect }: ConstructorParams) {
+    constructor({ usbInterface, logger, forceReadSerialOnConnect, debugLink }: ConstructorParams) {
         super({ logger });
 
         this.usbInterface = usbInterface;
         this.forceReadSerialOnConnect = forceReadSerialOnConnect;
+        this.debugLink = debugLink;
     }
 
     public listen() {
@@ -183,7 +188,11 @@ export class UsbApi extends AbstractApi {
         try {
             this.logger?.debug('usb: device.transferIn');
             const res = await this.abortableMethod(
-                () => device.transferIn(ENDPOINT_ID, this.chunkSize),
+                () =>
+                    device.transferIn(
+                        this.debugLink ? DEBUGLINK_ENDPOINT_ID : ENDPOINT_ID,
+                        this.chunkSize,
+                    ),
                 { signal, onAbort: () => device.reset() },
             );
             this.logger?.debug(
@@ -220,7 +229,11 @@ export class UsbApi extends AbstractApi {
             // https://wicg.github.io/webusb/#ref-for-dom-usbdevice-transferout
             this.logger?.debug('usb: device.transferOut');
             const result = await this.abortableMethod(
-                () => device.transferOut(ENDPOINT_ID, newArray),
+                () =>
+                    device.transferOut(
+                        this.debugLink ? DEBUGLINK_ENDPOINT_ID : ENDPOINT_ID,
+                        newArray,
+                    ),
                 { signal, onAbort: () => device.reset() },
             );
             this.logger?.debug(
@@ -312,7 +325,10 @@ export class UsbApi extends AbstractApi {
         try {
             this.logger?.debug(`usb: device.claimInterface: ${INTERFACE_ID}`);
             // claim device for exclusive access by this app
-            await this.abortableMethod(() => device.claimInterface(INTERFACE_ID), { signal });
+            await this.abortableMethod(
+                () => device.claimInterface(this.debugLink ? DEBUGLINK_INTERFACE_ID : INTERFACE_ID),
+                { signal },
+            );
             this.logger?.debug(
                 `usb: device.claimInterface done: ${INTERFACE_ID}. device: ${this.formatDeviceForLog(device)}`,
             );
@@ -340,7 +356,7 @@ export class UsbApi extends AbstractApi {
 
         if (device.opened) {
             try {
-                const interfaceId = INTERFACE_ID;
+                const interfaceId = this.debugLink ? DEBUGLINK_INTERFACE_ID : INTERFACE_ID;
                 this.logger?.debug(`usb: device.releaseInterface: ${interfaceId}`);
                 await device.releaseInterface(interfaceId);
                 this.logger?.debug(

diff --git a/packages/transport/src/constants.ts b/packages/transport/src/constants.ts
@@ -2,6 +2,8 @@
 export const CONFIGURATION_ID = 1;
 export const INTERFACE_ID = 0;
 export const ENDPOINT_ID = 1;
+export const DEBUGLINK_INTERFACE_ID = 1;
+export const DEBUGLINK_ENDPOINT_ID = 2;
 export const T1_HID_VENDOR = 0x534c;
 
 const T1_HID_PRODUCT = 0x0001;

diff --git a/packages/transport/src/transports/abstract.ts b/packages/transport/src/transports/abstract.ts
@@ -58,6 +58,7 @@ export interface AbstractTransportParams {
     messages?: Record<string, any>;
     signal: AbortSignal;
     logger?: Logger;
+    debugLink?: boolean;
 }
 
 export const isTransportInstance = (transport?: AbstractTransport) => {

diff --git a/packages/transport/src/transports/nodeusb.ts b/packages/transport/src/transports/nodeusb.ts
@@ -13,7 +13,7 @@ export class NodeUsbTransport extends AbstractApiTransport {
     public name = 'NodeUsbTransport' as const;
 
     constructor(params: AbstractTransportParams) {
-        const { messages, logger, signal } = params;
+        const { messages, logger, signal, debugLink } = params;
         const sessionsBackground = new SessionsBackground({ signal });
 
         // in nodeusb there is no synchronization yet. this is a followup and needs to be decided
@@ -34,6 +34,7 @@ export class NodeUsbTransport extends AbstractApiTransport {
                     allowAllDevices: true, // return all devices, not only authorized
                 }),
                 logger,
+                debugLink,
             }),
             sessionsClient,
             signal,

diff --git a/packages/transport/src/transports/udp.ts b/packages/transport/src/transports/udp.ts
@@ -11,7 +11,7 @@ export class UdpTransport extends AbstractApiTransport {
     private enumerateTimeout: ReturnType<typeof setTimeout> | undefined;
 
     constructor(params: AbstractTransportParams) {
-        const { messages, logger, signal } = params;
+        const { messages, logger, signal, debugLink } = params;
         const sessionsBackground = new SessionsBackground({ signal });
 
         // in udp there is no synchronization yet. it depends where this transport runs (node or browser)
@@ -26,7 +26,7 @@ export class UdpTransport extends AbstractApiTransport {
 
         super({
             messages,
-            api: new UdpApi({ logger }),
+            api: new UdpApi({ logger, debugLink }),
             logger,
             sessionsClient,
             signal,