appium-ios-remotexpc 0.10.2 → 0.12.0

package/src/lib/plist/plist-decoder.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { Transform, type TransformCallback } from 'stream';
 
+import { getLogger } from '../logger.js';
 import { UTF8_ENCODING } from './constants.js';
 import { parsePlist } from './unified-plist-parser.js';
 import {
@@ -10,7 +10,7 @@ import {
   hasUnicodeReplacementCharacter,
 } from './utils.js';
 
-const log = logger.getLogger('Plist');
+const log = getLogger('Plist');
 
 /**
  * Decodes plist format data with length prefix to JavaScript objects

package/src/lib/plist/plist-parser.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { DOMParser, Element, Node } from '@xmldom/xmldom';
 
+import { getLogger } from '../logger.js';
 import type { PlistArray, PlistDictionary, PlistValue } from '../types.js';
 import { PlistService } from './plist-service.js';
 import {
@@ -14,7 +14,7 @@ import {
   trimBeforeXmlDeclaration,
 } from './utils.js';
 
-const errorLog = logger.getLogger('PlistError');
+const errorLog = getLogger('PlistError');
 
 /**
  * Parses an XML plist string into a JavaScript object

package/src/lib/plist/plist-service.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import { Socket } from 'net';
 import { TLSSocket } from 'tls';
 
+import { getLogger } from '../logger.js';
 import type { PlistDictionary } from '../types.js';
 import { LengthBasedSplitter } from './length-based-splitter.js';
 import { PlistServiceDecoder } from './plist-decoder.js';
 import { PlistServiceEncoder } from './plist-encoder.js';
 
-const log = logger.getLogger('Plist');
-const errorLog = logger.getLogger('PlistError');
+const log = getLogger('Plist');
+const errorLog = getLogger('PlistError');
 
 const config = {
   verboseErrorLogging: false,

package/src/lib/remote-xpc/remote-xpc-connection.ts

@@ -1,9 +1,9 @@
-import { logger } from '@appium/support';
 import net from 'node:net';
 
+import { getLogger } from '../logger.js';
 import Handshake from './handshake.js';
 
-const log = logger.getLogger('RemoteXpcConnection');
+const log = getLogger('RemoteXpcConnection');
 
 // Timeout constants
 const CONNECTION_TIMEOUT_MS = 30000; // 30 seconds

package/src/lib/tss/index.ts

@@ -1,11 +1,11 @@
-import { logger } from '@appium/support';
 import axios from 'axios';
 import { randomUUID } from 'node:crypto';
 
+import { getLogger } from '../logger.js';
 import { createPlist, parsePlist } from '../plist/index.js';
 import type { PlistDictionary } from '../types.js';
 
-const log = logger.getLogger('TSSRequestor');
+const log = getLogger('TSSRequestor');
 
 // TSS Constants
 const TSS_CONTROLLER_ACTION_URL = 'http://gs.apple.com/TSS/controller?action=2';

package/src/lib/tunnel/index.ts

@@ -1,13 +1,13 @@
-import { logger } from '@appium/support';
 import {
   type TunnelConnection,
   connectToTunnelLockdown,
 } from 'appium-ios-tuntap';
 import type { TLSSocket } from 'tls';
 
+import { getLogger } from '../logger.js';
 import { RemoteXpcConnection } from '../remote-xpc/remote-xpc-connection.js';
 
-const log = logger.getLogger('TunnelManager');
+const log = getLogger('TunnelManager');
 
 /**
  * Interface for tunnel registry entry

package/src/lib/tunnel/packet-stream-client.ts

@@ -1,9 +1,10 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 import { type Socket, createConnection } from 'net';
 
-const log = logger.getLogger('PacketStreamClient');
+import { getLogger } from '../logger.js';
+
+const log = getLogger('PacketStreamClient');
 
 /**
  * Constants for packet stream protocol

package/src/lib/tunnel/packet-stream-server.ts

@@ -1,9 +1,10 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 import { type Server, type Socket, createServer } from 'net';
 
-const log = logger.getLogger('PacketStreamServer');
+import { getLogger } from '../logger.js';
+
+const log = getLogger('PacketStreamServer');
 
 /**
  * Interface for serialized packet message

package/src/lib/tunnel/tunnel-api-client.ts

@@ -1,8 +1,7 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../logger.js';
 import type { TunnelRegistry, TunnelRegistryEntry } from '../types.js';
 
-const log = logger.getLogger('TunnelApiClient');
+const log = getLogger('TunnelApiClient');
 
 /**
  * API client for tunnel registry operations

package/src/lib/tunnel/tunnel-registry-server.ts

@@ -1,7 +1,7 @@
-import { logger } from '@appium/support';
 import * as http from 'node:http';
 import { URL } from 'node:url';
 
+import { getLogger } from '../logger.js';
 import type { TunnelRegistry, TunnelRegistryEntry } from '../types.js';
 
 // Constants
@@ -9,7 +9,7 @@ const DEFAULT_TUNNEL_REGISTRY_PORT = 42314;
 const API_BASE_PATH = '/remotexpc/tunnels';
 
 // Logger instance
-const log = logger.getLogger('TunnelRegistryServer');
+const log = getLogger('TunnelRegistryServer');
 
 // Helper functions
 /**

package/src/lib/types.ts

@@ -6,6 +6,7 @@ import { EventEmitter } from 'events';
 
 import type { ServiceConnection } from '../service-connection.js';
 import type { BaseService, Service } from '../services/ios/base-service.js';
+import { ProvisioningProfile } from '../services/ios/misagent/provisioning-profile.js';
 import type { PowerAssertionOptions } from '../services/ios/power-assertion/index.js';
 import { PowerAssertionType } from '../services/ios/power-assertion/index.js';
 import type { InterfaceOrientation } from '../services/ios/springboard-service/index.js';
@@ -768,3 +769,74 @@ export interface SpringboardServiceWithConnection {
   /** The RemoteXPC connection for service management */
   remoteXPC: RemoteXpcConnection;
 }
+
+/**
+ * Represents the instance side of MisagentService where provisioning profiles can be managed
+ * @remarks
+ * Provisioning profiles are Apple configuration files (.mobileprovision) that contain:
+ * - Certificates, identifiers, and device information
+ * - App entitlements and permissions
+ * - Expiration dates and platform restrictions
+ */
+export interface MisagentService extends BaseService {
+  /**
+   * Installs a provisioning profile from a file path
+   * @param path The file path of the provisioning profile (.mobileprovision file)
+   */
+  installProfileFromPath(path: string): Promise<void>;
+  /**
+   * Installs a provisioning profile from a buffer
+   * @param payload The buffer containing the provisioning profile data
+   */
+  installProfile(payload: Buffer): Promise<void>;
+  /**
+   * Removes a provisioning profile by its UUID
+   * @param uuid The uuid of the provisioning profile to remove
+   */
+  removeProfile(uuid: string): Promise<void>;
+
+  /**
+   * Fetching all provisioning profiles from the device
+   * This can be used for listing installed provisioning profiles and backing them up
+   * @returns {Promise<ProvisioningProfile[]>}
+   * e.g.
+   *  [
+   *  {
+   *    "AppIDName": "Apple Development: John Doe (ABCDE12345)",
+   *    "ApplicationIdentifierPrefix": [
+   *       "ABCDE12345"
+   *     ],
+   *  "CreationDate": "2023-10-01T12:34:56Z",
+   *   "Platform": [
+   *    "iOS",
+   *    "xrOS",
+   *  ],
+   * IsXcodeManaged": false,
+   * "DeveloperCertificates": [ <Buffer ...> ],
+   * "Entitlements": {
+   *    "application-identifier": "ABCDE12345.com.example.app",
+   *    "get-task-allow": true,
+   *    ...
+   *  },
+   *  "ExpirationDate": "2024-10-01T12:34:56Z",
+   *  "Name": "Apple Development: John Doe (ABCDE12345)",
+   *  "UUID": "12345678-90AB-CDEF-1234-567890ABCDEF",
+   *  "Version": 1,
+   *  ...
+   * },
+   * ]
+   * @example
+   * const profiles = await misagentService.fetchAll();
+   * profiles.forEach(profile => {
+   *   console.log(`Profile: ${profile.plist.Name}`);
+   *   console.log(`UUID: ${profile.plist.UUID}`);
+   *   console.log(`Expires: ${profile.plist.ExpirationDate}`);
+   * });
+   */
+  fetchAll(): Promise<ProvisioningProfile[]>;
+}
+
+export interface MisagentServiceWithConnection {
+  misagentService: MisagentService;
+  remoteXPC: RemoteXpcConnection;
+}

package/src/lib/usbmux/index.ts

@@ -1,8 +1,8 @@
-import { logger } from '@appium/support';
 import { Server, Socket, createConnection, createServer } from 'node:net';
 import { release } from 'node:os';
 
 import { BaseSocketService } from '../../base-socket-service.js';
+import { getLogger } from '../logger.js';
 import { type PairRecord, processPlistResponse } from '../pair-record/index.js';
 import { type RawPairRecordResponse } from '../pair-record/pair-record.js';
 import { LengthBasedSplitter, parsePlist } from '../plist/index.js';
@@ -32,7 +32,7 @@ export interface Device {
   Properties: DeviceProperties;
 }
 
-const log = logger.getLogger('Usbmux');
+const log = getLogger('Usbmux');
 
 export const USBMUXD_PORT = 27015;
 export const DEFAULT_USBMUXD_SOCKET = '/var/run/usbmuxd';

package/src/services/ios/afc/index.ts

@@ -1,10 +1,10 @@
-import { logger } from '@appium/support';
 import fs from 'node:fs';
 import net from 'node:net';
 import path from 'node:path';
 import { Readable, Writable } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 
+import { getLogger } from '../../../lib/logger.js';
 import {
   buildClosePayload,
   buildFopenPayload,
@@ -25,7 +25,7 @@ import { AFC_FOPEN_TEXTUAL_MODES, AFC_WRITE_THIS_LENGTH } from './constants.js';
 import { AfcError, AfcFileMode, AfcOpcode } from './enums.js';
 import { createAfcReadStream, createAfcWriteStream } from './stream-utils.js';
 
-const log = logger.getLogger('AfcService');
+const log = getLogger('AfcService');
 
 const NON_LISTABLE_ENTRIES = ['', '.', '..'];
 

package/src/services/ios/base-service.ts

@@ -1,8 +1,7 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../lib/logger.js';
 import { ServiceConnection } from '../../service-connection.js';
 
-const log = logger.getLogger('BaseService');
+const log = getLogger('BaseService');
 
 /**
  * Interface for service information

package/src/services/ios/diagnostic-service/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import { PlistServiceDecoder } from '../../../lib/plist/plist-decoder.js';
 import type {
   DiagnosticsService as DiagnosticsServiceInterface,
@@ -7,7 +6,7 @@ import type {
 } from '../../../lib/types.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('DiagnosticService');
+const log = getLogger('DiagnosticService');
 
 /**
  * DiagnosticsService provides an API to:

package/src/services/ios/misagent/index.ts

@@ -0,0 +1,110 @@
+import { fs } from '@appium/support';
+import path from 'path';
+
+import {
+  type MisagentService as MisagentServiceInterface,
+  type PlistDictionary,
+} from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+import { ProvisioningProfile } from './provisioning-profile.js';
+
+class MisagentService extends BaseService implements MisagentServiceInterface {
+  static readonly RSD_SERVICE_NAME = 'com.apple.misagent.shim.remote';
+  private _conn: ServiceConnection | null = null;
+
+  async connectToMisagentService(): Promise<ServiceConnection> {
+    if (this._conn) {
+      return this._conn;
+    }
+
+    const service = this.getServiceConfig();
+    this._conn = await this.startLockdownService(service);
+    return this._conn;
+  }
+
+  async installProfileFromPath(filePath: string): Promise<void> {
+    // Check if file exists
+    if (!(await fs.exists(filePath))) {
+      throw new Error(`Profile filepath does not exist: ${filePath}`);
+    }
+    const fileExtension = path.extname(filePath).toLowerCase();
+    if (fileExtension !== '.mobileprovision') {
+      throw new Error(
+        `Invalid file extension: ${fileExtension}. Only .mobileprovision files are supported.`,
+      );
+    }
+    const payload = await fs.readFile(filePath);
+    await this.installProfile(payload);
+  }
+
+  async installProfile(payload: Buffer): Promise<void> {
+    await this.sendRequest(
+      {
+        MessageType: 'Install',
+        Profile: payload,
+        ProfileType: 'Provisioning',
+      },
+      'Failed to install profile',
+    );
+  }
+
+  async removeProfile(uuid: string): Promise<void> {
+    await this.sendRequest(
+      {
+        MessageType: 'Remove',
+        ProfileID: uuid,
+        ProfileType: 'Provisioning',
+      },
+      'Failed to remove profile',
+    );
+  }
+
+  async fetchAll(): Promise<ProvisioningProfile[]> {
+    const response = await this.sendRequest(
+      {
+        MessageType: 'CopyAll',
+        ProfileType: 'Provisioning',
+      },
+      'Failed to copy all profiles',
+    );
+
+    if (!response.Payload || !Array.isArray(response.Payload)) {
+      return [];
+    }
+
+    return response.Payload.filter((profileData): profileData is Buffer =>
+      Buffer.isBuffer(profileData),
+    ).map((profileData) => new ProvisioningProfile(profileData));
+  }
+
+  private async sendRequest(
+    request: any,
+    errorMessage: string,
+  ): Promise<PlistDictionary> {
+    const conn = await this.connectToMisagentService();
+    try {
+      // Skip StartService response
+      await conn.sendPlistRequest(request);
+      const res = await conn.sendPlistRequest(request);
+      if (res.Status) {
+        throw new Error(`Invalid response: ${JSON.stringify(res)}`);
+      }
+      return res;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`${errorMessage}: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  private getServiceConfig(): { serviceName: string; port: string } {
+    return {
+      serviceName: MisagentService.RSD_SERVICE_NAME,
+      port: this.address[1].toString(),
+    };
+  }
+}
+
+export { MisagentService };

package/src/services/ios/misagent/provisioning-profile.ts

@@ -0,0 +1,44 @@
+import { parsePlist } from '../../../lib/plist/index.js';
+import { type PlistDictionary } from '../../../lib/types.js';
+
+class ProvisioningProfile {
+  buf: Buffer;
+  public plist: PlistDictionary;
+
+  constructor(buf: Buffer) {
+    this.buf = buf;
+
+    // Find '<?xml' marker and extract everything after it
+    const xmlMarker = Buffer.from('<?xml');
+    const xmlIndex = buf.indexOf(xmlMarker);
+
+    if (xmlIndex === -1) {
+      throw new Error('No XML content found in provisioning profile');
+    }
+
+    // Get XML content starting from '<?xml'
+    let xml = buf.subarray(buf.indexOf(xmlMarker));
+
+    // Find '</plist>' and extract up to and including it
+    const plistEnd = Buffer.from('</plist>');
+    const plistIndex = xml.indexOf(plistEnd);
+
+    if (plistIndex === -1) {
+      throw new Error('No closing </plist> tag found');
+    }
+
+    xml = xml.subarray(0, plistIndex + plistEnd.length);
+    this.plist = parsePlist(xml) as PlistDictionary;
+  }
+
+  toString(): string {
+    return JSON.stringify(this.plist);
+  }
+
+  toJSON(): PlistDictionary {
+    // Only display the plist content
+    return this.plist;
+  }
+}
+
+export { ProvisioningProfile };

package/src/services/ios/mobile-config/index.ts

@@ -1,6 +1,7 @@
-import { fs, logger } from '@appium/support';
+import { fs } from '@appium/support';
 import path from 'node:path';
 
+import { getLogger } from '../../../lib/logger.js';
 import { SUPPORTED_EXTENSIONS } from '../../../lib/plist/constants.js';
 import { createPlist, parsePlist } from '../../../lib/plist/index.js';
 import {
@@ -11,7 +12,7 @@ import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
 const ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT = 14002;
-const log = logger.getLogger('MobileConfigService');
+const log = getLogger('MobileConfigService');
 
 /**
  * MobileConfigService provides an API to:

package/src/services/ios/mobile-image-mounter/index.ts

@@ -1,9 +1,9 @@
-import { logger } from '@appium/support';
 import { createHash } from 'crypto';
 import { Stats, promises as fs } from 'fs';
 import { performance } from 'perf_hooks';
 import { Readable } from 'stream';
 
+import { getLogger } from '../../../lib/logger.js';
 import { parseXmlPlist } from '../../../lib/plist/index.js';
 import { getManifestFromTSS } from '../../../lib/tss/index.js';
 import type {
@@ -13,7 +13,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('MobileImageMounterService');
+const log = getLogger('MobileImageMounterService');
 
 /**
  * Base interface for service responses

package/src/services/ios/notification-proxy/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import type {
   NotificationProxyService as NotificationProxyServiceInterface,
   PlistDictionary,
@@ -8,7 +7,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('NotificationProxyService');
+const log = getLogger('NotificationProxyService');
 
 export interface ObserveNotificationRequest extends PlistDictionary {
   Command: 'ObserveNotification';

package/src/services/ios/power-assertion/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import type {
   PlistDictionary,
   PowerAssertionService as PowerAssertionServiceInterface,
@@ -7,7 +6,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('PowerAssertionService');
+const log = getLogger('PowerAssertionService');
 
 /**
  * Power assertion types that can be used to prevent system sleep

package/src/services/ios/syslog-service/index.ts

@@ -1,7 +1,7 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 
+import { getLogger } from '../../../lib/logger.js';
 import { isBinaryPlist } from '../../../lib/plist/binary-plist-parser.js';
 import { parsePlist } from '../../../lib/plist/unified-plist-parser.js';
 import type {
@@ -12,8 +12,8 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService, type Service } from '../base-service.js';
 
-const syslogLog = logger.getLogger('SyslogMessages');
-const log = logger.getLogger('Syslog');
+const syslogLog = getLogger('SyslogMessages');
+const log = getLogger('Syslog');
 
 const MIN_PRINTABLE_RATIO = 0.5;
 const ASCII_PRINTABLE_MIN = 32;

package/src/services/ios/tunnel-service/index.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import { TLSSocket } from 'tls';
 
 import {
   LockdownService,
   upgradeSocketToTLS,
 } from '../../../lib/lockdown/index.js';
+import { getLogger } from '../../../lib/logger.js';
 import { PlistService } from '../../../lib/plist/plist-service.js';
 import { createUsbmux } from '../../../lib/usbmux/index.js';
 
-const log = logger.getLogger('TunnelService');
+const log = getLogger('TunnelService');
 const LABEL = 'appium-internal';
 
 /**

package/src/services/ios/webinspector/index.ts

@@ -1,12 +1,12 @@
-import { logger } from '@appium/support';
 import { randomUUID } from 'crypto';
 import { EventEmitter } from 'events';
 
+import { getLogger } from '../../../lib/logger.js';
 import type { PlistDictionary, PlistMessage } from '../../../lib/types.js';
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('WebInspectorService');
+const log = getLogger('WebInspectorService');
 
 /**
  * Interface for WebInspector message structure

package/src/services.ts

@@ -5,6 +5,7 @@ import { TunnelManager } from './lib/tunnel/index.js';
 import { TunnelApiClient } from './lib/tunnel/tunnel-api-client.js';
 import type {
   DiagnosticsServiceWithConnection,
+  MisagentServiceWithConnection,
   MobileConfigServiceWithConnection,
   MobileImageMounterServiceWithConnection,
   NotificationProxyServiceWithConnection,
@@ -15,6 +16,7 @@ import type {
 } from './lib/types.js';
 import AfcService from './services/ios/afc/index.js';
 import DiagnosticsService from './services/ios/diagnostic-service/index.js';
+import { MisagentService } from './services/ios/misagent/index.js';
 import { MobileConfigService } from './services/ios/mobile-config/index.js';
 import MobileImageMounterService from './services/ios/mobile-image-mounter/index.js';
 import { NotificationProxyService } from './services/ios/notification-proxy/index.js';
@@ -106,6 +108,22 @@ export async function startSpringboardService(
   };
 }
 
+export async function startMisagentService(
+  udid: string,
+): Promise<MisagentServiceWithConnection> {
+  const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+  const misagentService = remoteXPC.findService(
+    MisagentService.RSD_SERVICE_NAME,
+  );
+  return {
+    remoteXPC: remoteXPC as RemoteXpcConnection,
+    misagentService: new MisagentService([
+      tunnelConnection.host,
+      parseInt(misagentService.port, 10),
+    ]),
+  };
+}
+
 export async function startPowerAssertionService(
   udid: string,
 ): Promise<PowerAssertionServiceWithConnection> {