appium-ios-remotexpc 0.11.0 → 0.13.0

package/build/src/lib/apple-tv/pairing/user-input-service.d.ts

@@ -0,0 +1,8 @@
+import type { UserInputInterface } from '../pairing-protocol/types.js';
+/** Handles user interaction for PIN input during pairing */
+export declare class UserInputService implements UserInputInterface {
+    private readonly log;
+    promptForPIN(): Promise<string>;
+    promptForInput(prompt: string): Promise<string>;
+}
+//# sourceMappingURL=user-input-service.d.ts.map

package/build/src/lib/apple-tv/pairing/user-input-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input-service.d.ts","sourceRoot":"","sources":["../../../../../src/lib/apple-tv/pairing/user-input-service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,4DAA4D;AAC5D,qBAAa,gBAAiB,YAAW,kBAAkB;IACzD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAwC;IAEtD,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAyC/B,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAkBtD"}

package/build/src/lib/apple-tv/pairing/user-input-service.js

@@ -0,0 +1,61 @@
+import { logger } from '@appium/support';
+import { createInterface } from 'node:readline';
+import { PairingError } from '../errors.js';
+import { NETWORK_CONSTANTS } from '../network/constants.js';
+/** Handles user interaction for PIN input during pairing */
+export class UserInputService {
+    log = logger.getLogger('UserInputService');
+    async promptForPIN() {
+        const rl = createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        let timeoutId = null;
+        try {
+            const pin = await new Promise((resolve, reject) => {
+                timeoutId = setTimeout(() => {
+                    reject(new PairingError('PIN input timeout', 'INPUT_TIMEOUT'));
+                }, NETWORK_CONSTANTS.PIN_INPUT_TIMEOUT_MS);
+                rl.question('Enter PIN from Apple TV screen: ', (answer) => {
+                    // Clear timeout since we got the PIN
+                    if (timeoutId) {
+                        clearTimeout(timeoutId);
+                        timeoutId = null;
+                    }
+                    resolve(answer);
+                });
+            });
+            const cleanPin = pin.trim();
+            if (!/^\d+$/.test(cleanPin)) {
+                this.log.error('Invalid PIN format');
+                throw new PairingError('PIN must contain only digits', 'INVALID_PIN');
+            }
+            this.log.debug('PIN received successfully');
+            return cleanPin;
+        }
+        finally {
+            // Clean up timeout if error occurred before clearing
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+            rl.close();
+        }
+    }
+    async promptForInput(prompt) {
+        const rl = createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        try {
+            const input = await new Promise((resolve) => {
+                rl.question(prompt, (answer) => {
+                    resolve(answer);
+                });
+            });
+            return input.trim();
+        }
+        finally {
+            rl.close();
+        }
+    }
+}

package/build/src/lib/apple-tv/pairing-protocol/constants.d.ts

@@ -0,0 +1,18 @@
+/** Constants for pairing protocol states */
+export declare const PAIRING_STATES: {
+    readonly M3: 3;
+    readonly M5: 5;
+    readonly M6: 6;
+};
+/** Constants for pairing protocol messages */
+export declare const PAIRING_MESSAGES: {
+    readonly ENCRYPT_SALT: "Pair-Setup-Encrypt-Salt";
+    readonly ENCRYPT_INFO: "Pair-Setup-Encrypt-Info";
+    readonly SIGN_SALT: "Pair-Setup-Controller-Sign-Salt";
+    readonly SIGN_INFO: "Pair-Setup-Controller-Sign-Info";
+    readonly M5_NONCE: "PS-Msg05";
+    readonly M6_NONCE: "PS-Msg06";
+};
+/** TLV type for device info */
+export declare const INFO_TYPE = 17;
+//# sourceMappingURL=constants.d.ts.map

package/build/src/lib/apple-tv/pairing-protocol/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/lib/apple-tv/pairing-protocol/constants.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,eAAO,MAAM,cAAc;;;;CAIjB,CAAC;AAEX,8CAA8C;AAC9C,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AAEX,+BAA+B;AAC/B,eAAO,MAAM,SAAS,KAAO,CAAC"}

package/build/src/lib/apple-tv/pairing-protocol/constants.js

@@ -0,0 +1,17 @@
+/** Constants for pairing protocol states */
+export const PAIRING_STATES = {
+    M3: 0x03,
+    M5: 0x05,
+    M6: 0x06,
+};
+/** Constants for pairing protocol messages */
+export const PAIRING_MESSAGES = {
+    ENCRYPT_SALT: 'Pair-Setup-Encrypt-Salt',
+    ENCRYPT_INFO: 'Pair-Setup-Encrypt-Info',
+    SIGN_SALT: 'Pair-Setup-Controller-Sign-Salt',
+    SIGN_INFO: 'Pair-Setup-Controller-Sign-Info',
+    M5_NONCE: 'PS-Msg05',
+    M6_NONCE: 'PS-Msg06',
+};
+/** TLV type for device info */
+export const INFO_TYPE = 0x11;

package/build/src/lib/apple-tv/pairing-protocol/index.d.ts

@@ -0,0 +1,4 @@
+export { PairingProtocol } from './pairing-protocol.js';
+export { PAIRING_STATES, PAIRING_MESSAGES, INFO_TYPE } from './constants.js';
+export type { EncryptionKeys, PairingRequest, UserInputInterface, PairingProtocolInterface, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/build/src/lib/apple-tv/pairing-protocol/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/apple-tv/pairing-protocol/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7E,YAAY,EACV,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,YAAY,CAAC"}

package/build/src/lib/apple-tv/pairing-protocol/index.js

@@ -0,0 +1,2 @@
+export { PairingProtocol } from './pairing-protocol.js';
+export { PAIRING_STATES, PAIRING_MESSAGES, INFO_TYPE } from './constants.js';

package/build/src/lib/apple-tv/pairing-protocol/pairing-protocol.d.ts

@@ -0,0 +1,159 @@
+import type { AppleTVDevice } from '../../bonjour/bonjour-discovery.js';
+import type { NetworkClientInterface } from '../network/types.js';
+import type { PairingProtocolInterface, UserInputInterface } from './types.js';
+/** Implements the Apple TV pairing protocol including SRP authentication and key exchange */
+export declare class PairingProtocol implements PairingProtocolInterface {
+    private readonly networkClient;
+    private readonly userInput;
+    private static readonly log;
+    private _sequenceNumber;
+    constructor(networkClient: NetworkClientInterface, userInput: UserInputInterface);
+    executePairingFlow(device: AppleTVDevice): Promise<string>;
+    private createRequest;
+    /**
+     * Fragments a buffer into TLV8 items of maximum fragment size
+     * @param buffer Buffer to fragment
+     * @param type TLV8 type identifier
+     * @returns Array of TLV8 items
+     */
+    private fragmentBuffer;
+    /**
+     * Creates a nonce buffer with prefix padding
+     * @param nonceString The nonce string identifier
+     * @returns Padded nonce buffer
+     */
+    private createNonce;
+    /**
+     * Performs initial handshake with Apple TV to establish connection
+     * Sends handshake request with host options and wire protocol version
+     */
+    private performHandshake;
+    /**
+     * Attempts to verify existing pairing credentials with Apple TV
+     * Creates pair verification request and handles expected failure for new pairing flow
+     */
+    private attemptPairVerification;
+    /**
+     * Initiates manual pairing setup process with Apple TV
+     * Sends setup request and receives SRP challenge data
+     * @returns Response containing SRP salt and server public key
+     */
+    private setupManualPairing;
+    /**
+     * Extracts and validates SRP pairing data from Apple TV response
+     * @param response Network response containing pairing data
+     * @returns Parsed TLV8 dictionary with SRP challenge components
+     * @throws PairingError if pairing data is missing or invalid
+     */
+    private extractAndValidatePairingData;
+    /**
+     * Performs SRP authentication using user-provided PIN
+     * Prompts for PIN, creates SRP client, sends proof, and validates response
+     * @param parsedSRP SRP challenge data from Apple TV
+     * @returns Authenticated SRP client with session key
+     * @throws PairingError if PIN is incorrect or authentication fails
+     */
+    private performSRPAuthentication;
+    /**
+     * Receives and processes M6 pairing completion message from Apple TV
+     * Attempts to decrypt and validate final pairing state
+     * @param decryptKey Decryption key for M6 encrypted data
+     */
+    private receiveM6Completion;
+    /**
+     * Constructs initial handshake request packet
+     * Includes host options and wire protocol version for pairing session
+     * @returns Handshake request with sequence number 0
+     */
+    private createHandshakeRequest;
+    /**
+     * Creates pair verification request with X25519 public key
+     * Used to attempt verification of existing pairing credentials
+     * @returns Pair verification request with random X25519 key
+     */
+    private createPairVerificationRequest;
+    /**
+     * Creates pair verification failed event request
+     * Sent after verification attempt to proceed with manual pairing setup
+     * @returns Pair verify failed event packet
+     */
+    private createPairVerifyFailedRequest;
+    /**
+     * Constructs manual pairing setup request packet
+     * Initiates M1/M2 exchange with setup pairing data
+     * @returns Setup manual pairing request with host information
+     */
+    private createSetupManualPairingRequest;
+    /**
+     * Parses base64-encoded TLV8 response into dictionary
+     * Decodes base64 string and converts TLV8 format to key-value pairs
+     * @param data Base64-encoded TLV8 data
+     * @returns Dictionary mapping TLV8 type numbers to buffer values
+     * @throws PairingError if TLV8 parsing fails
+     */
+    private parseTLV8Response;
+    /**
+     * Validates SRP response for errors and required challenge data
+     * Checks for error codes and verifies presence of salt and public key
+     * @param parsedSRP Parsed SRP response dictionary
+     * @throws PairingError if response contains errors or missing required data
+     */
+    private validateSRPResponse;
+    /**
+     * Initializes SRP client with PIN and server challenge data
+     * Sets up identity, salt, and server public key for proof computation
+     * @param pin User-provided pairing PIN
+     * @param parsedSRP SRP challenge data containing salt and server public key
+     * @returns Configured SRP client ready for proof generation
+     * @throws PairingError if required SRP data is missing
+     */
+    private createSRPClient;
+    /**
+     * Sends M3 message containing SRP proof to Apple TV
+     * Includes client public key and computed proof for authentication
+     * @param srpClient Configured SRP client with computed proof
+     */
+    private sendSRPProof;
+    /**
+     * Validates M4 SRP proof response from Apple TV
+     * Checks for authentication errors indicating incorrect PIN
+     * @param response Network response containing SRP proof validation result
+     * @throws PairingError if PIN authentication failed
+     */
+    private validateSRPProofResponse;
+    /**
+     * Sends M5 exchange message with encrypted pairing credentials
+     * Includes long-term public key, signature, and device information encrypted with session key
+     * @param encryptKey Encryption key derived from session key
+     * @param devicePairingID Host device pairing identifier
+     * @param ltpk Long-term public key (Ed25519)
+     * @param ltsk Long-term secret key (Ed25519)
+     * @param sessionKey SRP session key for signature derivation
+     * @throws PairingError if M5 message creation fails
+     */
+    private sendM5Message;
+    /**
+     * Processes and decrypts M6 completion response from Apple TV
+     * Validates pairing completion state and decrypts final exchange data
+     * @param m6Response Network response containing M6 completion message
+     * @param decryptKey Decryption key for M6 encrypted data
+     */
+    private processM6Response;
+    /**
+     * Derives encryption and decryption keys from SRP session key
+     * Uses HKDF with pairing-specific salt and info strings
+     * @param sessionKey SRP session key from authentication
+     * @returns Encryption keys for M5/M6 message exchange
+     */
+    private deriveEncryptionKeys;
+    /**
+     * Saves pairing credentials to storage and returns credential path
+     * Persists long-term public and private keys for future connections
+     * @param device Apple TV device information
+     * @param ltpk Long-term public key to save
+     * @param ltsk Long-term secret key to save
+     * @returns Path to saved pairing credentials file
+     */
+    private createPairingResult;
+}
+//# sourceMappingURL=pairing-protocol.d.ts.map

package/build/src/lib/apple-tv/pairing-protocol/pairing-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pairing-protocol.d.ts","sourceRoot":"","sources":["../../../../../src/lib/apple-tv/pairing-protocol/pairing-protocol.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAexE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAYlE,OAAO,KAAK,EAEV,wBAAwB,EAExB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,6FAA6F;AAC7F,qBAAa,eAAgB,YAAW,wBAAwB;IAK5D,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAL5B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAuC;IAClE,OAAO,CAAC,eAAe,CAAK;gBAGT,aAAa,EAAE,sBAAsB,EACrC,SAAS,EAAE,kBAAkB;IAG1C,kBAAkB,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAwChE,OAAO,CAAC,aAAa;IAYrB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAetB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAInB;;;OAGG;YACW,gBAAgB;IAO9B;;;OAGG;YACW,uBAAuB;IAUrC;;;;OAIG;YACW,kBAAkB;IAQhC;;;;;OAKG;IACH,OAAO,CAAC,6BAA6B;IAYrC;;;;;;OAMG;YACW,wBAAwB;IActC;;;;OAIG;YACW,mBAAmB;IAcjC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuB9B;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAmBrC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAUrC;;;;OAIG;IACH,OAAO,CAAC,+BAA+B;IAmBvC;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAqBzB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAyB3B;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAsBvB;;;;OAIG;YACW,YAAY;IAmC1B;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAiBhC;;;;;;;;;OASG;YACW,aAAa;IA2E3B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAsCzB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAe5B;;;;;;;OAOG;YACW,mBAAmB;CAQlC"}