appium-ios-remotexpc 0.12.0 → 0.13.0

package/src/lib/apple-tv/pairing-protocol/types.ts

@@ -0,0 +1,60 @@
+import type { AppleTVDevice } from '../../bonjour/bonjour-discovery.js';
+
+/** Encryption keys derived from SRP session key for secure communication */
+export interface EncryptionKeys {
+  encryptKey: Buffer;
+  decryptKey: Buffer;
+}
+
+/** Handshake message payload structure */
+export interface HandshakePayload {
+  request: {
+    _0: {
+      handshake: {
+        _0: {
+          hostOptions: { attemptPairVerify: boolean };
+          wireProtocolVersion: number;
+        };
+      };
+    };
+  };
+}
+
+/** Pairing event message payload structure */
+export interface PairingDataPayload {
+  event: {
+    _0: {
+      pairingData?: {
+        _0: {
+          data: string;
+          kind: 'verifyManualPairing' | 'setupManualPairing';
+          startNewSession?: boolean;
+          sendingHost?: string;
+        };
+      };
+      pairVerifyFailed?: Record<string, never>;
+    };
+  };
+}
+
+/** Structure of a pairing request message sent to Apple TV */
+export interface PairingRequest {
+  message: {
+    plain: {
+      _0: HandshakePayload | PairingDataPayload;
+    };
+  };
+  originatedBy: 'host' | 'accessory';
+  sequenceNumber: number;
+}
+
+/** Interface for handling user input during pairing process */
+export interface UserInputInterface {
+  promptForPIN(): Promise<string>;
+  promptForInput(prompt: string): Promise<string>;
+}
+
+/** Interface for executing the Apple TV pairing protocol flow */
+export interface PairingProtocolInterface {
+  executePairingFlow(device: AppleTVDevice): Promise<string>;
+}

package/src/lib/apple-tv/storage/index.ts

@@ -0,0 +1,2 @@
+export { PairingStorage } from './pairing-storage.js';
+export type { PairingStorageInterface } from './types.js';

package/src/lib/apple-tv/storage/pairing-storage.ts

@@ -0,0 +1,60 @@
+import { strongbox } from '@appium/strongbox';
+import { logger } from '@appium/support';
+
+import { STRONGBOX_CONTAINER_NAME } from '../../../constants.js';
+import { createXmlPlist } from '../../plist/index.js';
+import { PairingError } from '../errors.js';
+import type { PairingConfig } from '../types.js';
+import type { PairingStorageInterface } from './types.js';
+
+/** Manages persistent storage of pairing credentials as plist files */
+export class PairingStorage implements PairingStorageInterface {
+  private readonly log = logger.getLogger('PairingStorage');
+  private readonly box;
+
+  constructor(private readonly config: PairingConfig) {
+    this.box = strongbox(STRONGBOX_CONTAINER_NAME);
+  }
+
+  async save(
+    deviceId: string,
+    ltpk: Buffer,
+    ltsk: Buffer,
+    remoteUnlockHostKey = '',
+  ): Promise<string> {
+    try {
+      const itemName = `appletv_pairing_${deviceId}`;
+      const plistContent = this.createPlistContent(
+        ltpk,
+        ltsk,
+        remoteUnlockHostKey,
+      );
+
+      const item = await this.box.createItemWithValue(itemName, plistContent);
+      const itemPath = item.id;
+
+      this.log.info(`Pairing record saved to: ${itemPath}`);
+
+      return itemPath;
+    } catch (error) {
+      this.log.error('Save pairing record error:', error);
+      throw new PairingError(
+        'Failed to save pairing record',
+        'SAVE_ERROR',
+        error,
+      );
+    }
+  }
+
+  private createPlistContent(
+    publicKey: Buffer,
+    privateKey: Buffer,
+    remoteUnlockHostKey: string,
+  ): string {
+    return createXmlPlist({
+      private_key: privateKey,
+      public_key: publicKey,
+      remote_unlock_host_key: remoteUnlockHostKey,
+    });
+  }
+}

package/src/lib/apple-tv/storage/types.ts

@@ -0,0 +1,9 @@
+/** Interface for storing pairing credentials to disk */
+export interface PairingStorageInterface {
+  save(
+    deviceId: string,
+    ltpk: Buffer,
+    ltsk: Buffer,
+    remoteUnlockHostKey?: string,
+  ): Promise<string>;
+}

package/src/lib/apple-tv/types.ts

@@ -28,7 +28,6 @@ export interface PairingConfig {
   timeout: number;
   discoveryTimeout: number;
   maxRetries: number;
-  pairingDirectory: string;
 }
 
 // Represents a TLV8 data item with a type and binary data

package/src/lib/bonjour/bonjour-discovery.ts

@@ -522,6 +522,8 @@ export class BonjourDiscovery extends EventEmitter {
       return devices;
     } finally {
       this.stopBrowsing();
+      // Small delay to ensure cleanup logs are flushed before returning
+      await delay(100);
     }
   }