Compare commits

..

5 Commits

13 changed files with 184 additions and 101 deletions
+33
View File
@@ -107,3 +107,36 @@ iconPath: Resources/AppIcon.png
> Tip:
>
> Your app icon must be a png, and it should ideally have a resolution of 1024x1024px.
## Add entitlements
You may need to add special [entitlements](https://developer.apple.com/documentation/bundleresources/entitlements) to your app, for example you need the `com.apple.developer.homekit` entitlement in order to connect to HomeKit devices.
First create an `App.entitlements` file with the necessary entitlements:
```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>com.apple.developer.homekit</key>
<true/>
</dict>
</plist>
```
Then, tell xtool about it via `xtool.yml`:
```yaml
entitlementsPath: App.entitlements
```
> Troubleshooting:
>
> There are a number of situations in which xtool may not be able to successfully apply an entitlement to your app.
>
> - Some entitlements, such as [Network Extension](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.networking.networkextension), don't work with free developer accounts. You might need to enrol in one of the Apple Developer Programs to use these.
> - Other entitlements, like [User Notifications Filtering](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.usernotifications.filtering), require special permission from Apple. If you do have the appropriate permission, these may or may not work with xtool.
> - Many entitlements require specific "Capabilities" to be enabled on your app in the Developer Services portal. xtool handles this for you, but we need to add code to xtool for each Entitlement-Capability mapping. If you run into a Capability that we don't handle yet, please let us know.
>
> Entitlements are a large surface area. If you find any bugs or missing functionality, please [create a GitHub Issue](https://github.com/xtool-org/xtool/issues/new/choose).
+3 -3
View File
@@ -1,5 +1,5 @@
{
"originHash" : "6980154be7e8da0aace058cc72033471d7d9573fa77fdbf53972129e4cd1d0a2",
"originHash" : "d08ba8535e09303ac5be5621b8aea1a2409ebcb2ab566d661a63ec8ab5825189",
"pins" : [
{
"identity" : "aexml",
@@ -420,8 +420,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/zsign",
"state" : {
"revision" : "e9853fd3be36ea1a61fa9d4b7f71f4b4d8244369",
"version" : "1.4.0"
"revision" : "7c669ed2423c53076d511b875a914f01ba7de062",
"version" : "1.5.2"
}
}
],
+1 -1
View File
@@ -42,7 +42,7 @@ let package = Package(
dependencies: [
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.3.0")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.5.2")),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
.package(url: "https://github.com/apple/swift-http-types", from: "1.3.1"),
+72 -43
View File
@@ -2,58 +2,87 @@
import fs from 'fs';
function makeOpen(enumSchema) {
const copy = structuredClone(enumSchema);
Object.keys(enumSchema).forEach(k => delete enumSchema[k]);
Object.assign(enumSchema, {
anyOf: [
copy,
{ type: 'string' },
]
})
function update(schema, value) {
for (const key in value) {
const val = value[key];
if (val === null) {
delete schema[key];
} else if (Array.isArray(val)) {
schema[key] = (schema[key] ?? []).concat(val);
} else if (typeof val === 'object') {
if (schema[key] === undefined) {
schema[key] = {};
}
update(schema[key], val);
} else {
schema[key] = val;
}
}
}
function format(schema) {
const schemas = schema.components.schemas;
// in-place update
function replace(schema, value) {
Object.keys(schema).forEach(k => delete schema[k]);
Object.assign(schema, value);
}
// this field is required when using the private Xcode API
const capabilityCreateRelationships = schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships;
capabilityCreateRelationships.properties.capability = {
function clone(schema) {
return JSON.parse(JSON.stringify(schema));
}
function makeOpen(enumSchema) {
replace(enumSchema, {
anyOf: [
clone(enumSchema),
{ type: 'string' },
]
});
}
function patch(schema) {
const schemas = schema.components.schemas;
// this field is required when using the private Xcode API
update(schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships, {
properties: {
capability: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
type: {
type: 'string',
enum: ['capabilities'],
},
id: { $ref: '#/components/schemas/CapabilityType' },
},
required: ['id', 'type'],
data: {
type: 'object',
properties: {
type: {
type: 'string',
enum: ['capabilities'],
},
id: { $ref: '#/components/schemas/CapabilityType' },
},
required: ['id', 'type'],
},
},
required: ['data'],
}
capabilityCreateRelationships.required.push('capability');
// we don't use this but it triggers a deprecation warning. see:
// https://github.com/apple/swift-openapi-generator/issues/715
schemas.App.properties.relationships.properties.inAppPurchases.deprecated = false;
// openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
// misses some cases that they do, actually, return.
// https://swiftpackageindex.com/apple/swift-openapi-generator/1.7.2/documentation/swift-openapi-generator/useful-openapi-patterns#Open-enums-and-oneOfs
makeOpen(schemas.BundleIdPlatform);
makeOpen(schemas.CapabilityType);
makeOpen(schemas.CertificateType);
makeOpen(schemas.Device.properties.attributes.properties.deviceClass);
return schema;
}
},
required: ['capability'],
})
// we don't use this but it triggers a deprecation warning. see:
// https://github.com/apple/swift-openapi-generator/issues/715
schemas.App.properties.relationships.properties.inAppPurchases.deprecated = false;
// openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
// misses some cases that they do, actually, return.
// https://swiftpackageindex.com/apple/swift-openapi-generator/1.7.2/documentation/swift-openapi-generator/useful-openapi-patterns#Open-enums-and-oneOfs
makeOpen(schemas.BundleIdPlatform);
makeOpen(schemas.CapabilityType);
makeOpen(schemas.CertificateType);
makeOpen(schemas.Device.properties.attributes.properties.deviceClass);
return schema;
}
const text = fs.readFileSync(process.stdin.fd, 'utf8');
const json = JSON.parse(text);
const formatted = format(json);
const formattedText = JSON.stringify(formatted);
console.log(formattedText);
const patched = patch(json);
const patchedText = JSON.stringify(patched);
console.log(patchedText);
+2
View File
@@ -14,6 +14,8 @@ public struct PackSchemaBase: Codable, Sendable {
public var product: String?
public var infoPath: String?
public var entitlementsPath: String?
public var iconPath: String?
public var resources: [String]?
}
@@ -165,7 +165,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
var entitlements: Entitlements
// if the executable doesn't already have entitlements, that's
// okay. We don't have to throw an error.
if let entitlementsData = try? await context.signerImpl.analyze(executable: executableURL),
if let entitlementsData = try? await context.signer.analyze(executable: executableURL),
let decodedEntitlements = try? PropertyListDecoder().decode(Entitlements.self, from: entitlementsData) {
entitlements = decodedEntitlements
@@ -71,6 +71,7 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
let allDevices = try await context.developerAPIClient.devicesGetCollection()
.ok.body.json.data
.filter { $0.attributes?.deviceClass?.value1?.supportsIOSApps == true }
let response = try await context.developerAPIClient.profilesCreateInstance(
body: .json(
@@ -106,3 +107,12 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
}
}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload.Value1Payload {
fileprivate var supportsIOSApps: Bool {
switch self {
case .ipad, .iphone, .ipod: true
default: false
}
}
}
@@ -75,11 +75,6 @@ public actor AppInstaller {
}
}
// serial queue
private let installQueue = DispatchQueue(
label: "com.kabiroberai.xtool.install-queue"
)
public let ipa: URL
public let udid: String
public let connectionPreferences: Connection.Preferences
@@ -275,7 +275,7 @@ public actor IntegratedInstaller {
auth: auth
)
let signer = Signer(context: context) { certs in
let signer = AutoSigner(context: context) { certs in
await self.delegate?.confirmRevocation(of: certs) ?? false
}
let bundleID = try await signer.sign(
@@ -1,14 +1,7 @@
//
// Signer.swift
// XKit
//
// Created by Kabir Oberai on 13/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
public struct Signer {
/// Provisions and codesigns.
public struct AutoSigner {
public enum Error: LocalizedError {
case noSigners
@@ -92,10 +85,9 @@ public struct Signer {
let entitlements = provisioningDict.mapValues(\.entitlements)
status(NSLocalizedString("signer.signing", value: "Signing", comment: ""))
try await context.signerImpl.sign(
try await context.signer.sign(
app: app,
certificate: signingInfo.certificate,
privateKey: signingInfo.privateKey,
identity: .real(signingInfo.certificate, signingInfo.privateKey),
entitlementMapping: entitlements,
progress: progress
)
+38 -31
View File
@@ -1,23 +1,10 @@
//
// SignerImpl.swift
// XKit
//
// Created by Kabir Oberai on 10/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import CXKit
import SignerSupport
import ConcurrencyExtras
/// a wrapper around signer_t
public actor SignerImpl {
private static let signingQueue = DispatchQueue(
label: "com.kabiroberai.xtool.signing-queue",
attributes: .concurrent
)
/// a wrapper around `signer_t`
public actor Signer {
public enum Error: LocalizedError {
case notFound
@@ -44,6 +31,11 @@ public actor SignerImpl {
}
}
public enum Identity {
case real(Certificate, PrivateKey)
case adhoc
}
private let signer: UnsafePointer<signer_t>
public var name: String {
String(cString: signer.pointee.name)
@@ -53,24 +45,23 @@ public actor SignerImpl {
self.signer = signer.value
}
public static func all() -> some Collection<SignerImpl> {
public static func all() -> some Collection<Signer> {
var list = get_signers()
var arr: [SignerImpl] = []
var arr: [Signer] = []
while let curr = list {
arr.append(SignerImpl(signer: UncheckedSendable(curr)))
arr.append(Signer(signer: UncheckedSendable(curr)))
list = curr.pointee.next
}
return arr
}
public static func first() throws -> SignerImpl {
public static func first() throws -> Signer {
try all().first.orThrow(Error.notFound)
}
private func _sign(
app: URL,
certificate: Certificate,
privateKey: PrivateKey,
identity: Identity,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) throws {
@@ -99,14 +90,32 @@ public actor SignerImpl {
}
let sendableProgress = UncheckedSendable(progress)
let sendableEntsArray = UncheckedSendable(entsArray)
try certificate.data().withUnsafeBytes { cert in
let sendableCert = UncheckedSendable(cert)
try privateKey.data.withUnsafeBytes { priv in
let certificateData: Data
let privateKeyData: Data
let lengthOverride: Int?
switch identity {
case .real(let certificate, let privateKey):
certificateData = try certificate.data()
privateKeyData = privateKey.data
lengthOverride = nil
case .adhoc:
// we can't use empty data here because withUnsafeBytes
// might return a bufferpointer with a nil base address,
// but signer.h expects non-null values. The real fix is
// updating xtool-core/SignerSupport/signer.h to annotate
// the pointers as nullable, but alas that requires effort.
certificateData = Data([0])
privateKeyData = Data([0])
lengthOverride = 0
}
try certificateData.withUnsafeBytes { cert in
try privateKeyData.withUnsafeBytes { priv in
var exception: UnsafeMutablePointer<Int8>?
defer { exception.map { free($0) } }
let progress = sendableProgress.value
let cert = sendableCert.value
let entsArray = sendableEntsArray.value
guard let certBase = cert.baseAddress,
@@ -117,8 +126,8 @@ public actor SignerImpl {
defer { box.release() }
guard signer.pointee.sign(
app.path,
certBase, cert.count,
privBase, priv.count,
certBase, lengthOverride ?? cert.count,
privBase, lengthOverride ?? priv.count,
entsArray, entsArray.count,
{
// swiftlint:disable:previous opening_brace
@@ -140,15 +149,13 @@ public actor SignerImpl {
public func sign(
app: URL,
certificate: Certificate,
privateKey: PrivateKey,
identity: Identity,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) async throws {
try self._sign(
app: app,
certificate: certificate,
privateKey: privateKey,
identity: identity,
entitlementMapping: entitlementMapping,
progress: progress
)
+3 -3
View File
@@ -14,7 +14,7 @@ public struct SigningContext: Sendable {
public let udid: String
public let deviceName: String
public let auth: DeveloperAPIAuthData
public let signerImpl: SignerImpl
public let signer: Signer
public var developerAPIClient: DeveloperAPIClient {
DeveloperAPIClient(auth: auth)
@@ -24,12 +24,12 @@ public struct SigningContext: Sendable {
udid: String,
deviceName: String,
auth: DeveloperAPIAuthData,
signerImpl: SignerImpl? = nil
signer: Signer? = nil
) throws {
self.udid = udid
self.deviceName = deviceName
self.auth = auth
self.signerImpl = try signerImpl ?? .first()
self.signer = try signer ?? .first()
}
}
+16 -1
View File
@@ -62,7 +62,22 @@ struct PackOperation {
buildSettings: buildSettings,
plan: plan
)
return try await packer.pack()
let bundle = try await packer.pack()
if let entitlementsPath = schema.base.entitlementsPath {
let data = try await Data(reading: URL(fileURLWithPath: entitlementsPath))
let decoder = PropertyListDecoder()
let entitlements = try decoder.decode(Entitlements.self, from: data)
print("Pseudo-signing...")
try await Signer.first().sign(
app: bundle,
identity: .adhoc,
entitlementMapping: [bundle: entitlements],
progress: { _ in }
)
}
return bundle
}
}