@onekeyfe/hd-transport 1.2.0-alpha.34 → 1.2.0-alpha.35

package/__tests__/messages.test.js

@@ -101,10 +101,10 @@ describe('messages', () => {
     expect(v2Messages.nested.MessageType.values).toMatchObject({
       MessageType_DeviceStatusGet: 60602,
       MessageType_DeviceStatus: 60603,
-      MessageType_DeviceSessionGet: 60606,
-      MessageType_DeviceSession: 60607,
-      MessageType_DeviceSessionAskPin: 60608,
-      MessageType_DeviceSessionAskPassphrase: 60609,
+      MessageType_DeviceSessionGet: 61200,
+      MessageType_DeviceSession: 61201,
+      MessageType_DeviceSessionAskPin: 61202,
+      MessageType_DeviceSessionAskPassphrase: 61203,
     });
     expect(v2Messages.nested.DeviceStatusGet).toEqual({ fields: {} });
     expect(v2Messages.nested.ProtocolInfoRequest.fields.eventless_wallet_session).toMatchObject({
@@ -112,6 +112,11 @@ describe('messages', () => {
       type: 'bool',
       options: { default: false },
     });
+    expect(v2Messages.nested.ProtocolInfo.fields).toMatchObject({
+      version: { id: 1, type: 'uint32', rule: 'required' },
+      build_fingerprint: { id: 2, type: 'string', rule: 'required' },
+      supported_messages: { id: 3, type: 'uint32', rule: 'repeated' },
+    });
     expect(v2Messages.nested.DeviceSessionGet.fields.session_id).toMatchObject({
       id: 1,
       type: 'bytes',
@@ -147,6 +152,7 @@ describe('messages', () => {
           id: 1,
         },
         on_device: {
+          rule: 'required',
           type: 'bool',
           id: 2,
         },
@@ -163,52 +169,54 @@ describe('messages', () => {
     );
   });
 
-  test('Protocol V2 passphrase selection keeps the explicit input source on wire', () => {
+  test('Protocol V2 passphrase selection explicitly selects host or device input on wire', () => {
     const messages = parseConfigure(v2Messages);
     const { Message } = createMessageFromName(messages, 'DeviceSessionAskPassphrase');
 
-    const onDevice = Message.encode(Message.create({ on_device: true })).finish();
     const onHost = Message.encode(
-      Message.create({
-        passphrase: 'host hidden wallet',
-        on_device: false,
-      })
+      Message.create({ passphrase: 'host hidden wallet', on_device: false })
     ).finish();
+    const onDevice = Message.encode(Message.create({ on_device: true })).finish();
 
-    expect(Buffer.from(onDevice).toString('hex')).toBe('1001');
     expect(Buffer.from(onHost).toString('hex')).toBe(
       '0a12686f73742068696464656e2077616c6c65741000'
     );
+    expect(Buffer.from(onDevice).toString('hex')).toBe('1001');
     expect(Message.decode(onHost)).toMatchObject({
       passphrase: 'host hidden wallet',
       on_device: false,
     });
+    expect(Message.decode(onDevice)).toMatchObject({ on_device: true });
   });
 
   test('Protocol V2 onboarding status matches the current firmware-pro2 schema', () => {
-    expect(v2Messages.nested.DevOnboardingStep.values).toMatchObject({
-      DEV_ONBOARDING_STEP_UNKNOWN: 0,
-      DEV_ONBOARDING_STEP_CHECKING: 1,
-      DEV_ONBOARDING_STEP_PERSONALIZATION: 2,
-      DEV_ONBOARDING_STEP_PIN: 3,
-      DEV_ONBOARDING_STEP_SETUP: 4,
-      DEV_ONBOARDING_STEP_DONE: 5,
+    expect(v2Messages.nested.MessageType.values).toMatchObject({
+      MessageType_OnboardingStatusGet: 61600,
+      MessageType_OnboardingStatus: 61601,
+    });
+    expect(v2Messages.nested.OnboardingStep.values).toMatchObject({
+      ONBOARDING_STEP_UNKNOWN: 0,
+      ONBOARDING_STEP_CHECKING: 1,
+      ONBOARDING_STEP_PERSONALIZATION: 2,
+      ONBOARDING_STEP_PIN: 3,
+      ONBOARDING_STEP_SETUP: 4,
+      ONBOARDING_STEP_DONE: 5,
     });
-    expect(v2Messages.nested.DevOnboardingPhase.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupKind.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupMethod.values).toBeDefined();
-    expect(v2Messages.nested.DevOnboardingSetupStatus.fields).toMatchObject({
-      kind: { id: 1, type: 'DevOnboardingSetupKind' },
-      method: { id: 2, type: 'DevOnboardingSetupMethod' },
+    expect(v2Messages.nested.OnboardingPhase.values).toBeDefined();
+    expect(v2Messages.nested.OnboardingSetupKind.values).toBeDefined();
+    expect(v2Messages.nested.OnboardingSetupMethod.values).toBeDefined();
+    expect(v2Messages.nested.OnboardingSetupStatus.fields).toMatchObject({
+      kind: { id: 1, type: 'OnboardingSetupKind' },
+      method: { id: 2, type: 'OnboardingSetupMethod' },
     });
-    expect(v2Messages.nested.DevOnboardingStatus.fields).toMatchObject({
-      step: { id: 1, type: 'DevOnboardingStep' },
-      phase: { id: 2, type: 'DevOnboardingPhase' },
-      setup: { id: 3, type: 'DevOnboardingSetupStatus' },
+    expect(v2Messages.nested.OnboardingStatus.fields).toMatchObject({
+      step: { id: 1, type: 'OnboardingStep' },
+      phase: { id: 2, type: 'OnboardingPhase' },
+      setup: { id: 3, type: 'OnboardingSetupStatus' },
       pin_set: { id: 4, type: 'bool' },
       wallet_initialized: { id: 5, type: 'bool' },
     });
-    expect(v2Messages.nested).not.toHaveProperty('DevOnboardingStage');
+    expect(v2Messages.nested).not.toHaveProperty('DevOnboardingStatus');
   });
 
   test('Protocol V2 does not restore retired unlock or passphrase ids', () => {

package/__tests__/protocol-v2.test.js

@@ -73,14 +73,14 @@ const protocolV2Messages = parseConfigure({
           type: 'uint32',
           id: 1,
         },
-        supported_messages: {
-          type: 'uint32',
+        build_fingerprint: {
+          type: 'string',
           id: 2,
-          rule: 'repeated',
         },
-        protobuf_definition: {
-          type: 'string',
+        supported_messages: {
+          type: 'uint32',
           id: 3,
+          rule: 'repeated',
         },
       },
     },
@@ -211,7 +211,7 @@ const protocolV2Messages = parseConfigure({
         MessageType_FileWrite: 60805,
         MessageType_DeviceFirmwareUpdateRequest: 61000,
         MessageType_DeviceFirmwareUpdateStatus: 61002,
-        MessageType_DeviceSession: 60607,
+        MessageType_DeviceSession: 61201,
         MessageType_PartialNested: 62000,
       },
     },
@@ -235,8 +235,8 @@ describe('Protocol V2 framing and session', () => {
   test('encodes and decodes Protocol V2 protobuf frames', () => {
     const frame = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
       version: 1,
+      build_fingerprint: 'application__1.0.0__abc__DEV__DEBUG',
       supported_messages: [60200, 60201],
-      protobuf_definition: 'proto',
     });
 
     const parsed = protocolV2.decodeFrame(frame);
@@ -251,8 +251,8 @@ describe('Protocol V2 framing and session', () => {
       seq: parsed.seq,
       message: {
         version: 1,
+        build_fingerprint: 'application__1.0.0__abc__DEV__DEBUG',
         supported_messages: [60200, 60201],
-        protobuf_definition: 'proto',
       },
     });
   });
@@ -297,10 +297,10 @@ describe('Protocol V2 framing and session', () => {
     const malformedPayload = new Uint8Array(32);
     malformedPayload[0] = 0x0a;
     malformedPayload[1] = 101;
-    const frame = protocolV2.encodeProtobufFrame(60607, malformedPayload);
+    const frame = protocolV2.encodeProtobufFrame(61201, malformedPayload);
 
     expect(() => ProtocolV2.decodeFrame(schemas, frame)).toThrow(
-      'Protocol V2 protobuf decode failed for "DeviceSession" (60607, 32-byte payload); ' +
+      'Protocol V2 protobuf decode failed for "DeviceSession" (61201, 32-byte payload); ' +
         'the payload is malformed or incompatible with the active SDK schema.'
     );
   });
@@ -397,8 +397,8 @@ describe('Protocol V2 framing and session', () => {
       type: 'ProtocolInfo',
       message: {
         version: 2,
+        build_fingerprint: null,
         supported_messages: [60206],
-        protobuf_definition: null,
       },
     });
   });
@@ -408,8 +408,8 @@ describe('Protocol V2 framing and session', () => {
     const logger = { debug: jest.fn() };
     const response = ProtocolV2.encodeFrame(schemas, 'ProtocolInfo', {
       version: 2,
+      build_fingerprint: 'application__1.0.0__sensitive__DEV__DEBUG',
       supported_messages: [60206],
-      protobuf_definition: 'sensitive-schema',
     });
     const session = new ProtocolV2Session({
       schemas,
@@ -648,8 +648,8 @@ describe('Protocol V2 framing and session', () => {
       type: 'ProtocolInfo',
       message: {
         version: 2,
+        build_fingerprint: null,
         supported_messages: [],
-        protobuf_definition: null,
       },
     });
     expect(logger.debug).not.toHaveBeenCalled();
@@ -770,8 +770,8 @@ describe('Protocol V2 framing and session', () => {
       type: 'ProtocolInfo',
       message: {
         version: 2,
+        build_fingerprint: null,
         supported_messages: [],
-        protobuf_definition: null,
       },
     });
 

package/__tests__/transport-log.test.js

@@ -0,0 +1,79 @@
+const { createTransportCallLog, getSafeTransportLogPayload } = require('../src/utils/transportLog');
+
+describe('transport log sanitization', () => {
+  test('logs non-sensitive request fields and redacts passphrases recursively', () => {
+    expect(
+      createTransportCallLog('DeviceSessionAskPassphrase', 'V2', {
+        passphrase: 'hidden-wallet-secret',
+        on_device: false,
+        metadata: {
+          retry: 1,
+          session_id: 'wallet-session-secret',
+        },
+      })
+    ).toEqual({
+      name: 'DeviceSessionAskPassphrase',
+      protocol: 'V2',
+      request: {
+        passphrase: '[REDACTED]',
+        on_device: false,
+        metadata: {
+          retry: 1,
+          session_id: '[REDACTED]',
+        },
+      },
+    });
+  });
+
+  test('logs response fields while redacting device and wallet identifiers', () => {
+    expect(
+      getSafeTransportLogPayload({
+        message: 'Passphrase accepted',
+        device_id: 'device-secret',
+        nested: {
+          btc_test_address: 'wallet-address',
+          unlocked: true,
+        },
+      })
+    ).toEqual({
+      message: 'Passphrase accepted',
+      device_id: '[REDACTED]',
+      nested: {
+        btc_test_address: '[REDACTED]',
+        unlocked: true,
+      },
+    });
+  });
+
+  test('does not log raw signing request or response payloads', () => {
+    expect(
+      getSafeTransportLogPayload(
+        {
+          transaction: 'raw-transaction',
+          path: "m/44'/60'/0'/0/0",
+        },
+        'EthereumSignTx'
+      )
+    ).toBe('[REDACTED]');
+    expect(
+      getSafeTransportLogPayload(
+        {
+          signature: 'raw-signature',
+        },
+        'EthereumSignedTx'
+      )
+    ).toBe('[REDACTED]');
+  });
+
+  test('replaces binary content with its byte length', () => {
+    expect(
+      getSafeTransportLogPayload({
+        file_name: 'resource.bin',
+        data: new Uint8Array(128),
+      })
+    ).toEqual({
+      file_name: 'resource.bin',
+      data: '[BINARY:128]',
+    });
+  });
+});