appium-xcuitest-driver
Version:
Appium driver for iOS using XCUITest for backend
96 lines • 3.65 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.CertificateClient = void 0;
const remotexpc_utils_1 = require("./remotexpc-utils");
/**
* Certificate (MDM profile) operations on real devices using RemoteXPC.
*
* Requires **iOS/tvOS 18+**, the optional **`appium-ios-remotexpc`** package, and
* {@link CertificateClient.create} to be called with `useRemoteXPC: true` (typically from
* `isIos18OrNewer` after session startup).
*/
class CertificateClient {
mobileConfigService;
remoteXPCConnection;
log;
constructor(mobileConfigService, log, remoteXPCConnection) {
this.mobileConfigService = mobileConfigService;
this.log = log;
this.remoteXPCConnection = remoteXPCConnection;
}
/**
* Opens a RemoteXPC mobile config service for the given device.
*
* @param udid - Device UDID
* @param log - Appium logger instance
* @param useRemoteXPC - Must be `true` for this client; callers derive this from `isIos18OrNewer(opts)` after `start()`
* @throws {Error} If `useRemoteXPC` is false, or RemoteXPC/mobile config setup fails
*/
static async create(udid, log, useRemoteXPC) {
if (!useRemoteXPC) {
throw new Error('Real device SSL/certificate operations require iOS/tvOS 18 or newer with the optional ' +
'appium-ios-remotexpc package installed.');
}
let remoteXPCConnection;
let succeeded = false;
try {
const Services = await (0, remotexpc_utils_1.getRemoteXPCServices)();
const { mobileConfigService, remoteXPC } = await Services.startMobileConfigService(udid);
remoteXPCConnection = remoteXPC;
const client = new CertificateClient(mobileConfigService, log, remoteXPCConnection);
succeeded = true;
return client;
}
catch (err) {
throw new Error(`Failed to start RemoteXPC mobile config service for certificate operations: ${err.message}. ` +
'Ensure appium-ios-remotexpc is installed and the device is supported.', { cause: err });
}
finally {
if (remoteXPCConnection && !succeeded) {
try {
await remoteXPCConnection.close();
}
catch {
// ignore
}
}
}
}
/**
* Install a certificate / profile from a PEM payload buffer.
*/
async installCertificate(options) {
const { payload } = options;
await this.mobileConfigService.installProfileFromBuffer(payload);
}
/**
* Remove a profile by name.
*
* @param name - Profile identifier to remove
* @returns `'Acknowledged'` when the service accepts the removal request
*/
async removeCertificate(name) {
await this.mobileConfigService.removeProfile(name);
return 'Acknowledged';
}
/**
* @returns Installed profiles metadata from the device
*/
async listCertificates() {
return await this.mobileConfigService.getProfileList();
}
/**
* Closes the underlying RemoteXPC connection. Safe to call more than once (errors are logged at debug level).
*/
async close() {
try {
this.log.debug(`Closing remoteXPC connection`);
await this.remoteXPCConnection.close();
}
catch (err) {
this.log.debug(`Error closing remoteXPC connection: ${err.message}`);
}
}
}
exports.CertificateClient = CertificateClient;
//# sourceMappingURL=certificate-client.js.map