Compare commits

..

4 Commits

33 changed files with 246 additions and 738 deletions
-33
View File
@@ -107,36 +107,3 @@ 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).
+2 -2
View File
@@ -144,8 +144,8 @@ api: openapi/openapi.json
update-api:
@+$(MAKE) -B api
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/patch.js
node Sources/DeveloperAPI/patch.js < openapi/base.json > openapi/openapi.json
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml
npx --yes bump-cli overlay openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml > openapi/openapi.json
openapi/base.json:
@mkdir -p openapi
+3 -3
View File
@@ -1,5 +1,5 @@
{
"originHash" : "d08ba8535e09303ac5be5621b8aea1a2409ebcb2ab566d661a63ec8ab5825189",
"originHash" : "6980154be7e8da0aace058cc72033471d7d9573fa77fdbf53972129e4cd1d0a2",
"pins" : [
{
"identity" : "aexml",
@@ -420,8 +420,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/zsign",
"state" : {
"revision" : "7c669ed2423c53076d511b875a914f01ba7de062",
"version" : "1.5.2"
"revision" : "e9853fd3be36ea1a61fa9d4b7f71f4b4d8244369",
"version" : "1.4.0"
}
}
],
+2 -2
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.5.2")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.4.0")),
.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"),
@@ -88,7 +88,7 @@ let package = Package(
dependencies: [
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
],
exclude: ["openapi-generator-config.yaml", "patch.js"]
exclude: ["openapi-generator-config.yaml", "openapi-overlay.yaml"]
),
.target(
name: "XKit",
+62 -247
View File
@@ -3464,60 +3464,14 @@ public enum Components {
/// - Remark: Generated from `#/components/schemas/Device/attributes/udid`.
public var udid: Swift.String?
/// - Remark: Generated from `#/components/schemas/Device/attributes/deviceClass`.
public struct DeviceClassPayload: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/Device/attributes/deviceClass/value1`.
@frozen public enum Value1Payload: String, Codable, Hashable, Sendable, CaseIterable {
case appleWatch = "APPLE_WATCH"
case ipad = "IPAD"
case iphone = "IPHONE"
case ipod = "IPOD"
case appleTv = "APPLE_TV"
case mac = "MAC"
}
/// - Remark: Generated from `#/components/schemas/Device/attributes/deviceClass/value1`.
public var value1: Components.Schemas.Device.AttributesPayload.DeviceClassPayload.Value1Payload?
/// - Remark: Generated from `#/components/schemas/Device/attributes/deviceClass/value2`.
public var value2: Swift.String?
/// Creates a new `DeviceClassPayload`.
///
/// - Parameters:
/// - value1:
/// - value2:
public init(
value1: Components.Schemas.Device.AttributesPayload.DeviceClassPayload.Value1Payload? = nil,
value2: Swift.String? = nil
) {
self.value1 = value1
self.value2 = value2
}
public init(from decoder: any Decoder) throws {
var errors: [any Error] = []
do {
self.value1 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
do {
self.value2 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
try Swift.DecodingError.verifyAtLeastOneSchemaIsNotNil(
[
self.value1,
self.value2
],
type: Self.self,
codingPath: decoder.codingPath,
errors: errors
)
}
public func encode(to encoder: any Encoder) throws {
try encoder.encodeFirstNonNilValueToSingleValueContainer([
self.value1,
self.value2
])
}
@frozen public enum DeviceClassPayload: String, Codable, Hashable, Sendable, CaseIterable {
case appleWatch = "APPLE_WATCH"
case ipad = "IPAD"
case iphone = "IPHONE"
case ipod = "IPOD"
case appleTv = "APPLE_TV"
case mac = "MAC"
case appleVisionPro = "APPLE_VISION_PRO"
}
/// - Remark: Generated from `#/components/schemas/Device/attributes/deviceClass`.
public var deviceClass: Components.Schemas.Device.AttributesPayload.DeviceClassPayload?
@@ -5061,57 +5015,12 @@ public enum Components {
}
}
/// - Remark: Generated from `#/components/schemas/BundleIdPlatform`.
public struct BundleIdPlatform: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/BundleIdPlatform/value1`.
@frozen public enum Value1Payload: String, Codable, Hashable, Sendable, CaseIterable {
case ios = "IOS"
case macOs = "MAC_OS"
case universal = "UNIVERSAL"
}
/// - Remark: Generated from `#/components/schemas/BundleIdPlatform/value1`.
public var value1: Components.Schemas.BundleIdPlatform.Value1Payload?
/// - Remark: Generated from `#/components/schemas/BundleIdPlatform/value2`.
public var value2: Swift.String?
/// Creates a new `BundleIdPlatform`.
///
/// - Parameters:
/// - value1:
/// - value2:
public init(
value1: Components.Schemas.BundleIdPlatform.Value1Payload? = nil,
value2: Swift.String? = nil
) {
self.value1 = value1
self.value2 = value2
}
public init(from decoder: any Decoder) throws {
var errors: [any Error] = []
do {
self.value1 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
do {
self.value2 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
try Swift.DecodingError.verifyAtLeastOneSchemaIsNotNil(
[
self.value1,
self.value2
],
type: Self.self,
codingPath: decoder.codingPath,
errors: errors
)
}
public func encode(to encoder: any Encoder) throws {
try encoder.encodeFirstNonNilValueToSingleValueContainer([
self.value1,
self.value2
])
}
@frozen public enum BundleIdPlatform: String, Codable, Hashable, Sendable, CaseIterable {
case ios = "IOS"
case macOs = "MAC_OS"
case universal = "UNIVERSAL"
case services = "SERVICES"
case macos = "MACOS"
}
/// - Remark: Generated from `#/components/schemas/CapabilityOption`.
public struct CapabilityOption: Codable, Hashable, Sendable {
@@ -5241,150 +5150,56 @@ public enum Components {
}
}
/// - Remark: Generated from `#/components/schemas/CapabilityType`.
public struct CapabilityType: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/CapabilityType/value1`.
@frozen public enum Value1Payload: String, Codable, Hashable, Sendable, CaseIterable {
case icloud = "ICLOUD"
case inAppPurchase = "IN_APP_PURCHASE"
case gameCenter = "GAME_CENTER"
case pushNotifications = "PUSH_NOTIFICATIONS"
case wallet = "WALLET"
case interAppAudio = "INTER_APP_AUDIO"
case maps = "MAPS"
case associatedDomains = "ASSOCIATED_DOMAINS"
case personalVpn = "PERSONAL_VPN"
case appGroups = "APP_GROUPS"
case healthkit = "HEALTHKIT"
case homekit = "HOMEKIT"
case wirelessAccessoryConfiguration = "WIRELESS_ACCESSORY_CONFIGURATION"
case applePay = "APPLE_PAY"
case dataProtection = "DATA_PROTECTION"
case sirikit = "SIRIKIT"
case networkExtensions = "NETWORK_EXTENSIONS"
case multipath = "MULTIPATH"
case hotSpot = "HOT_SPOT"
case nfcTagReading = "NFC_TAG_READING"
case classkit = "CLASSKIT"
case autofillCredentialProvider = "AUTOFILL_CREDENTIAL_PROVIDER"
case accessWifiInformation = "ACCESS_WIFI_INFORMATION"
case networkCustomProtocol = "NETWORK_CUSTOM_PROTOCOL"
case coremediaHlsLowLatency = "COREMEDIA_HLS_LOW_LATENCY"
case systemExtensionInstall = "SYSTEM_EXTENSION_INSTALL"
case userManagement = "USER_MANAGEMENT"
case appleIdAuth = "APPLE_ID_AUTH"
}
/// - Remark: Generated from `#/components/schemas/CapabilityType/value1`.
public var value1: Components.Schemas.CapabilityType.Value1Payload?
/// - Remark: Generated from `#/components/schemas/CapabilityType/value2`.
public var value2: Swift.String?
/// Creates a new `CapabilityType`.
///
/// - Parameters:
/// - value1:
/// - value2:
public init(
value1: Components.Schemas.CapabilityType.Value1Payload? = nil,
value2: Swift.String? = nil
) {
self.value1 = value1
self.value2 = value2
}
public init(from decoder: any Decoder) throws {
var errors: [any Error] = []
do {
self.value1 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
do {
self.value2 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
try Swift.DecodingError.verifyAtLeastOneSchemaIsNotNil(
[
self.value1,
self.value2
],
type: Self.self,
codingPath: decoder.codingPath,
errors: errors
)
}
public func encode(to encoder: any Encoder) throws {
try encoder.encodeFirstNonNilValueToSingleValueContainer([
self.value1,
self.value2
])
}
@frozen public enum CapabilityType: String, Codable, Hashable, Sendable, CaseIterable {
case icloud = "ICLOUD"
case inAppPurchase = "IN_APP_PURCHASE"
case gameCenter = "GAME_CENTER"
case pushNotifications = "PUSH_NOTIFICATIONS"
case wallet = "WALLET"
case interAppAudio = "INTER_APP_AUDIO"
case maps = "MAPS"
case associatedDomains = "ASSOCIATED_DOMAINS"
case personalVpn = "PERSONAL_VPN"
case appGroups = "APP_GROUPS"
case healthkit = "HEALTHKIT"
case homekit = "HOMEKIT"
case wirelessAccessoryConfiguration = "WIRELESS_ACCESSORY_CONFIGURATION"
case applePay = "APPLE_PAY"
case dataProtection = "DATA_PROTECTION"
case sirikit = "SIRIKIT"
case networkExtensions = "NETWORK_EXTENSIONS"
case multipath = "MULTIPATH"
case hotSpot = "HOT_SPOT"
case nfcTagReading = "NFC_TAG_READING"
case classkit = "CLASSKIT"
case autofillCredentialProvider = "AUTOFILL_CREDENTIAL_PROVIDER"
case accessWifiInformation = "ACCESS_WIFI_INFORMATION"
case networkCustomProtocol = "NETWORK_CUSTOM_PROTOCOL"
case coremediaHlsLowLatency = "COREMEDIA_HLS_LOW_LATENCY"
case systemExtensionInstall = "SYSTEM_EXTENSION_INSTALL"
case userManagement = "USER_MANAGEMENT"
case appleIdAuth = "APPLE_ID_AUTH"
}
/// - Remark: Generated from `#/components/schemas/CertificateType`.
public struct CertificateType: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/CertificateType/value1`.
@frozen public enum Value1Payload: String, Codable, Hashable, Sendable, CaseIterable {
case applePay = "APPLE_PAY"
case applePayMerchantIdentity = "APPLE_PAY_MERCHANT_IDENTITY"
case applePayPspIdentity = "APPLE_PAY_PSP_IDENTITY"
case applePayRsa = "APPLE_PAY_RSA"
case developerIdKext = "DEVELOPER_ID_KEXT"
case developerIdKextG2 = "DEVELOPER_ID_KEXT_G2"
case developerIdApplication = "DEVELOPER_ID_APPLICATION"
case developerIdApplicationG2 = "DEVELOPER_ID_APPLICATION_G2"
case development = "DEVELOPMENT"
case distribution = "DISTRIBUTION"
case identityAccess = "IDENTITY_ACCESS"
case iosDevelopment = "IOS_DEVELOPMENT"
case iosDistribution = "IOS_DISTRIBUTION"
case macAppDistribution = "MAC_APP_DISTRIBUTION"
case macInstallerDistribution = "MAC_INSTALLER_DISTRIBUTION"
case macAppDevelopment = "MAC_APP_DEVELOPMENT"
case passTypeId = "PASS_TYPE_ID"
case passTypeIdWithNfc = "PASS_TYPE_ID_WITH_NFC"
}
/// - Remark: Generated from `#/components/schemas/CertificateType/value1`.
public var value1: Components.Schemas.CertificateType.Value1Payload?
/// - Remark: Generated from `#/components/schemas/CertificateType/value2`.
public var value2: Swift.String?
/// Creates a new `CertificateType`.
///
/// - Parameters:
/// - value1:
/// - value2:
public init(
value1: Components.Schemas.CertificateType.Value1Payload? = nil,
value2: Swift.String? = nil
) {
self.value1 = value1
self.value2 = value2
}
public init(from decoder: any Decoder) throws {
var errors: [any Error] = []
do {
self.value1 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
do {
self.value2 = try decoder.decodeFromSingleValueContainer()
} catch {
errors.append(error)
}
try Swift.DecodingError.verifyAtLeastOneSchemaIsNotNil(
[
self.value1,
self.value2
],
type: Self.self,
codingPath: decoder.codingPath,
errors: errors
)
}
public func encode(to encoder: any Encoder) throws {
try encoder.encodeFirstNonNilValueToSingleValueContainer([
self.value1,
self.value2
])
}
@frozen public enum CertificateType: String, Codable, Hashable, Sendable, CaseIterable {
case applePay = "APPLE_PAY"
case applePayMerchantIdentity = "APPLE_PAY_MERCHANT_IDENTITY"
case applePayPspIdentity = "APPLE_PAY_PSP_IDENTITY"
case applePayRsa = "APPLE_PAY_RSA"
case developerIdKext = "DEVELOPER_ID_KEXT"
case developerIdKextG2 = "DEVELOPER_ID_KEXT_G2"
case developerIdApplication = "DEVELOPER_ID_APPLICATION"
case developerIdApplicationG2 = "DEVELOPER_ID_APPLICATION_G2"
case development = "DEVELOPMENT"
case distribution = "DISTRIBUTION"
case identityAccess = "IDENTITY_ACCESS"
case iosDevelopment = "IOS_DEVELOPMENT"
case iosDistribution = "IOS_DISTRIBUTION"
case macAppDistribution = "MAC_APP_DISTRIBUTION"
case macInstallerDistribution = "MAC_INSTALLER_DISTRIBUTION"
case macAppDevelopment = "MAC_APP_DEVELOPMENT"
case passTypeId = "PASS_TYPE_ID"
case passTypeIdWithNfc = "PASS_TYPE_ID_WITH_NFC"
}
/// - Remark: Generated from `#/components/schemas/SubscriptionStatusUrlVersion`.
@frozen public enum SubscriptionStatusUrlVersion: String, Codable, Hashable, Sendable, CaseIterable {
+42
View File
@@ -0,0 +1,42 @@
overlay: 1.0.0
info:
title: Overlay for App Store Connect API
version: 1.0.0
actions:
# this field is required when using the private Xcode API
- target: '$.components.schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships'
update:
properties:
capability:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum: [capabilities]
id:
"$ref": "#/components/schemas/CapabilityType"
required: [id, type]
required: [data]
required: [capability]
# we don't use this but it triggers a deprecation warning. see:
# https://github.com/apple/swift-openapi-generator/issues/715
- target: '$.components.schemas.App.properties.relationships.properties.inAppPurchases'
update:
deprecated: false
# openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
# misses some cases that they do, actually, return.
- target: '$.components.schemas.Device.properties.attributes.properties.deviceClass'
update:
enum:
- APPLE_VISION_PRO
- target: '$.components.schemas.BundleIdPlatform'
update:
enum:
- SERVICES
# the spec already declares MAC_OS but ASC sometimes seems to
# spell this as MACOS instead. see:
# https://github.com/xtool-org/xtool/issues/64
- MACOS
-88
View File
@@ -1,88 +0,0 @@
#!/usr/bin/env node
import fs from 'fs';
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;
}
}
}
// in-place update
function replace(schema, value) {
Object.keys(schema).forEach(k => delete schema[k]);
Object.assign(schema, value);
}
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'],
},
},
required: ['data'],
}
},
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 patched = patch(json);
const patchedText = JSON.stringify(patched);
console.log(patchedText);
-2
View File
@@ -14,8 +14,6 @@ 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]?
}
+1 -3
View File
@@ -153,8 +153,7 @@ public struct Planner: Sendable {
bundleID: bundleID,
infoPlist: infoPlist,
resources: resources,
iconPath: self.schema.base.iconPath,
entitlementsPath: self.schema.base.entitlementsPath
iconPath: self.schema.base.iconPath
)
}
@@ -218,7 +217,6 @@ public struct Plan: Sendable {
public var infoPlist: [String: any Sendable]
public var resources: [Resource]
public var iconPath: String?
public var entitlementsPath: String?
}
public enum Resource: Codable, Sendable {
+4 -10
View File
@@ -42,15 +42,6 @@ public struct XcodePacker {
throw StringError("Could not parse deployment target '\(plan.deploymentTarget)'")
}
var buildSettings: [String: Any] = [
"PRODUCT_BUNDLE_IDENTIFIER": plan.bundleID,
"TARGETED_DEVICE_FAMILY": families.map { "\($0)" }.joined(separator: ","),
]
if let entitlementsPath = plan.entitlementsPath {
buildSettings["CODE_SIGN_ENTITLEMENTS"] = fromProjectToRoot + Path(entitlementsPath)
}
let project = Project(
name: plan.product,
targets: [
@@ -59,7 +50,10 @@ public struct XcodePacker {
type: .application,
platform: .iOS,
deploymentTarget: deploymentTarget,
settings: Settings(buildSettings: buildSettings),
settings: Settings(buildSettings: [
"PRODUCT_BUNDLE_IDENTIFIER": plan.bundleID,
"TARGETED_DEVICE_FAMILY": families.map { "\($0)" }.joined(separator: ","),
]),
sources: [
TargetSource(path: (fromProjectToRoot + emptyFile).string),
],
@@ -41,22 +41,14 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
private func upsertApp(
bundleID: String,
entitlements: Entitlements,
isFreeTeam: Bool
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
) async throws -> Components.Schemas.BundleId {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let existing = try await context.developerAPIClient
.bundleIdsGetCollection(query: .init(
filter_lbrack_identifier_rbrack_: [bundleID]
))
.ok.body.json.data
// filter[identifier] is a prefix filter so we need to manually upgrade to equality
.first(where: { $0.attributes?.identifier == newBundleID })
let appID: Components.Schemas.BundleId
if let existing {
if let existing = appIDs[bundleID] {
appID = existing
} else {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let name = ProvisioningIdentifiers.appName(fromSanitized: bundleID)
let createResponse = try await context.developerAPIClient.bundleIdsCreateInstance(
body: .json(
@@ -65,7 +57,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
_type: .bundleIds,
attributes: .init(
name: name,
platform: .init(.ios),
platform: .ios,
identifier: newBundleID
)
)
@@ -113,8 +105,8 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
}
} else {
// DeveloperServices doesn't allow deleting these capabilities
let requiredCapabilities: Set<Components.Schemas.CapabilityType.Value1Payload> = [.inAppPurchase]
if let capType = cap.attributes?.capabilityType?.value1, !requiredCapabilities.contains(capType) {
let requiredCapabilities: Set<Components.Schemas.CapabilityType> = [.inAppPurchase]
if let capType = cap.attributes?.capabilityType, !requiredCapabilities.contains(capType) {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
@@ -158,7 +150,8 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
/// that the app has).
private func addApp(
_ app: URL,
isFreeTeam: Bool
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
) async throws -> ProvisioningInfo {
let infoURL = app.appendingPathComponent("Info.plist")
guard let data = try? Data(contentsOf: infoURL),
@@ -172,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.signer.analyze(executable: executableURL),
if let entitlementsData = try? await context.signerImpl.analyze(executable: executableURL),
let decodedEntitlements = try? PropertyListDecoder().decode(Entitlements.self, from: entitlementsData) {
entitlements = decodedEntitlements
@@ -186,7 +179,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
entitlements = try Entitlements(entitlements: [])
}
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam)
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam, appIDs: appIDs)
let newBundleID = appID.attributes!.identifier!
let teamID = try signingInfo.certificate.teamID()
@@ -232,6 +225,17 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
)
}
// keyed by sanitized bundle ID
private func getCurrentAppIDs() async throws -> [String: Components.Schemas.BundleId] {
let bundleIDs = try await context.developerAPIClient.bundleIdsGetCollection().ok.body.json.data
let keyedIDs = bundleIDs
.compactMap { id -> (String, Components.Schemas.BundleId)? in
guard let bundleID = id.attributes?.identifier else { return nil }
return (ProvisioningIdentifiers.sanitize(identifier: bundleID), id)
}
return Dictionary(keyedIDs, uniquingKeysWith: { $1 })
}
/// Registers the app + its extensions, returning the profile and entitlements of each
public func perform() async throws -> [URL: ProvisioningInfo] {
var apps: [URL] = [root]
@@ -240,7 +244,9 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
apps += plugins.implicitContents.filter { $0.pathExtension.lowercased() == "appex" }
}
let isFreeTeam = try await context.auth.team()?.isFree == true
async let isFreeTeamTask = context.auth.team()?.isFree == true
async let appIDsTask = getCurrentAppIDs()
let (isFreeTeam, appIDs) = try await (isFreeTeamTask, appIDsTask)
return try await withThrowingTaskGroup(
of: (URL, ProvisioningInfo).self,
@@ -248,7 +254,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
) { group in
for app in apps {
group.addTask {
let info = try await addApp(app, isFreeTeam: isFreeTeam)
let info = try await addApp(app, isFreeTeam: isFreeTeam, appIDs: appIDs)
return (app, info)
}
}
@@ -15,11 +15,11 @@ public struct DeveloperServicesCapability: Sendable, Hashable {
public var settings: [Components.Schemas.CapabilitySetting]?
public init(
_ capabilityType: Components.Schemas.CapabilityType.Value1Payload,
_ capabilityType: Components.Schemas.CapabilityType,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = .init(capabilityType)
self.capabilityType = capabilityType
self.isFree = isFree
self.settings = settings
}
@@ -54,7 +54,7 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_type: .certificates,
attributes: .init(
csrContent: csr.pemString,
certificateType: .init(.development)
certificateType: .development
)
)))
)
@@ -6,8 +6,6 @@ import OpenAPIURLSession
import Dependencies
extension DeveloperAPIClient {
@TaskLocal fileprivate static var cursor: [URLQueryItem] = []
public init(
auth: DeveloperAPIAuthData
) {
@@ -24,39 +22,6 @@ extension DeveloperAPIClient {
]
)
}
/// Perform a paginated request, starting at the page given by `link`.
///
/// `link` should be a URL that contains a `cursor` query parameter. The
/// cursor will be applied to any requests made inside the closure.
public static func withNextLink<T>(
_ link: String?,
isolation: isolated (any Actor)? = #isolation,
perform action: () async throws -> T
) async throws -> T {
let cursor: [URLQueryItem]
if let link {
guard let components = URLComponents(string: link),
let newOffset = components.queryItems?.first(where: { $0.name == "cursor" }),
let newLimit = components.queryItems?.first(where: { $0.name == "limit" })
else { throw Errors.badNextLink(link) }
// the next value will contain a cursor (offset) *and* a limit even if we didn't
// provide a limit in our initial request. we need to include the limit in subsequent
// requests, otherwise the cursor isn't respected.
cursor = [newOffset, newLimit]
} else {
cursor = []
}
return try await $cursor.withValue(cursor) {
try await action()
}
}
public enum Errors: Error {
case badNextLink(String)
}
}
public enum DeveloperAPIAuthData: Sendable {
@@ -161,13 +126,9 @@ public struct DeveloperAPIXcodeAuthMiddleware: ClientMiddleware {
let path = request.path ?? "/"
var components = URLComponents(string: path) ?? .init()
var items = components.queryItems ?? []
items.upsertQueryItems(DeveloperAPIClient.cursor + [
components.queryItems = (components.queryItems ?? []) + [
URLQueryItem(name: "teamId", value: authData.teamID.rawValue)
])
components.queryItems = items
]
let query = components.percentEncodedQuery ?? ""
components.query = nil
@@ -253,28 +214,45 @@ public struct DeveloperAPIASCAuthMiddleware: ClientMiddleware {
_ baseURL: URL
) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var request = request
let jwt = try await generator.generate()
var request = request
request.headerFields[.authorization] = "Bearer \(jwt)"
let cursor = DeveloperAPIClient.cursor
if !cursor.isEmpty {
var components = URLComponents(string: request.path ?? "") ?? .init()
var items = components.queryItems ?? []
items.upsertQueryItems(cursor)
components.queryItems = items
request.path = components.string
}
return try await next(request, body, baseURL)
}
}
extension [URLQueryItem] {
fileprivate mutating func upsertQueryItems(_ items: [URLQueryItem]) {
let newNames = Set(items.map(\.name))
removeAll { newNames.contains($0.name) }
append(contentsOf: items)
struct LoggingMiddleware: ClientMiddleware {
static let regex: NSRegularExpression? = {
guard let pat = ProcessInfo.processInfo.environment["XTL_DEV_LOG"] else { return nil }
return try? NSRegularExpression(pattern: pat)
}()
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
baseURL: URL,
operationID: String,
next: (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, body) = try await next(request, body, baseURL)
guard Self.regex?.firstMatch(
in: operationID,
range: NSRange(operationID.startIndex..., in: operationID)
) != nil
else { return (response, body) }
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
// body may only be consumable once, replace it with the collected data
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
print("\(operationID) response body -> \(text)")
}
return (response, body)
}
}
@@ -27,7 +27,7 @@ public struct DeveloperServicesFetchDeviceOperation: DeveloperServicesOperation
_type: .devices,
attributes: .init(
name: self.context.deviceName,
platform: .init(.ios),
platform: .ios,
udid: self.context.udid
)
)))
@@ -1,78 +0,0 @@
import DeveloperAPI
/// An `AsyncSequence` that unfolds a paginated DeveloperAPI request.
///
/// Some Developer API GET requests are paginated. Each response contains
/// a `links.next` field that points to the next page. This API allows you to
/// consume all pages as an `AsyncSequence`. For example, you can
/// enumerate all devices with
///
/// ```swift
/// let pages = DeveloperAPIPages {
/// try await client.devicesGetCollection().ok.body.json
/// } next: {
/// $0.links.next
/// }
/// for try await page in pages {
/// print(page.data)
/// }
/// ```
public struct DeveloperAPIPages<Page>: AsyncSequence {
// inspired by PagedRequest from
// https://github.com/AvdLee/appstoreconnect-swift-sdk
public var request: @Sendable () async throws -> Page
public var getNext: @Sendable (Page) -> String?
public init(
request: @escaping @Sendable () async throws -> Page,
next getNext: @escaping @Sendable (Page) -> String?
) {
self.request = request
self.getNext = getNext
}
public func makeAsyncIterator() -> AsyncIterator {
AsyncIterator(request: request, getNext: getNext)
}
public struct AsyncIterator: AsyncIteratorProtocol {
fileprivate enum State {
case initial
case hasNext(String)
case end
}
fileprivate let request: @Sendable () async throws -> Page
fileprivate let getNext: @Sendable (Page) -> String?
fileprivate var state: State = .initial
public mutating func next() async throws -> Page? {
guard !Task.isCancelled else { return nil }
let cursor: String?
switch state {
case .initial:
cursor = nil
case .hasNext(let next):
cursor = next
case .end:
return nil
}
let page = try await DeveloperAPIClient.withNextLink(cursor) {
try await request()
}
if let next = getNext(page), next != cursor {
state = .hasNext(next)
} else {
state = .end
}
return page
}
}
}
@@ -1,39 +0,0 @@
import Foundation
import OpenAPIRuntime
import HTTPTypes
struct LoggingMiddleware: ClientMiddleware {
static let regex: NSRegularExpression? = {
guard let pat = ProcessInfo.processInfo.environment["XTL_DEV_LOG"] else { return nil }
return try? NSRegularExpression(pattern: pat)
}()
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
baseURL: URL,
operationID: String,
next: (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, body) = try await next(request, body, baseURL)
guard Self.regex?.firstMatch(
in: operationID,
range: NSRange(operationID.startIndex..., in: operationID)
) != nil
else { return (response, body) }
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
// body may only be consumable once, replace it with the collected data
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
print("\(operationID) response body -> \(text)")
}
return (response, body)
}
}
@@ -1,25 +0,0 @@
import DeveloperAPI
// syntactic sugar to make it nicer to work with `anyOf:` types
public protocol OpenAPIExtensibleEnum {
associatedtype Value1Payload: RawRepresentable<String>, Codable, Hashable, Sendable, CaseIterable
var value1: Value1Payload? { get set }
var value2: String? { get set }
init(value1: Value1Payload?, value2: String?)
}
extension OpenAPIExtensibleEnum {
public var rawValue: String {
value2!
}
public init(_ value: Value1Payload) {
self.init(value1: value, value2: nil)
}
}
extension Components.Schemas.BundleIdPlatform: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityType: OpenAPIExtensibleEnum {}
extension Components.Schemas.CertificateType: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload: OpenAPIExtensibleEnum {}
@@ -71,7 +71,6 @@ 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(
@@ -107,12 +106,3 @@ 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,6 +75,11 @@ 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 = AutoSigner(context: context) { certs in
let signer = Signer(context: context) { certs in
await self.delegate?.confirmRevocation(of: certs) ?? false
}
let bundleID = try await signer.sign(
@@ -1,7 +1,14 @@
//
// Signer.swift
// XKit
//
// Created by Kabir Oberai on 13/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
/// Provisions and codesigns.
public struct AutoSigner {
public struct Signer {
public enum Error: LocalizedError {
case noSigners
@@ -85,9 +92,10 @@ public struct AutoSigner {
let entitlements = provisioningDict.mapValues(\.entitlements)
status(NSLocalizedString("signer.signing", value: "Signing", comment: ""))
try await context.signer.sign(
try await context.signerImpl.sign(
app: app,
identity: .real(signingInfo.certificate, signingInfo.privateKey),
certificate: signingInfo.certificate,
privateKey: signingInfo.privateKey,
entitlementMapping: entitlements,
progress: progress
)
+31 -38
View File
@@ -1,10 +1,23 @@
//
// 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 Signer {
/// a wrapper around signer_t
public actor SignerImpl {
private static let signingQueue = DispatchQueue(
label: "com.kabiroberai.xtool.signing-queue",
attributes: .concurrent
)
public enum Error: LocalizedError {
case notFound
@@ -31,11 +44,6 @@ public actor Signer {
}
}
public enum Identity {
case real(Certificate, PrivateKey)
case adhoc
}
private let signer: UnsafePointer<signer_t>
public var name: String {
String(cString: signer.pointee.name)
@@ -45,23 +53,24 @@ public actor Signer {
self.signer = signer.value
}
public static func all() -> some Collection<Signer> {
public static func all() -> some Collection<SignerImpl> {
var list = get_signers()
var arr: [Signer] = []
var arr: [SignerImpl] = []
while let curr = list {
arr.append(Signer(signer: UncheckedSendable(curr)))
arr.append(SignerImpl(signer: UncheckedSendable(curr)))
list = curr.pointee.next
}
return arr
}
public static func first() throws -> Signer {
public static func first() throws -> SignerImpl {
try all().first.orThrow(Error.notFound)
}
private func _sign(
app: URL,
identity: Identity,
certificate: Certificate,
privateKey: PrivateKey,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) throws {
@@ -90,32 +99,14 @@ public actor Signer {
}
let sendableProgress = UncheckedSendable(progress)
let sendableEntsArray = UncheckedSendable(entsArray)
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
try certificate.data().withUnsafeBytes { cert in
let sendableCert = UncheckedSendable(cert)
try privateKey.data.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,
@@ -126,8 +117,8 @@ public actor Signer {
defer { box.release() }
guard signer.pointee.sign(
app.path,
certBase, lengthOverride ?? cert.count,
privBase, lengthOverride ?? priv.count,
certBase, cert.count,
privBase, priv.count,
entsArray, entsArray.count,
{
// swiftlint:disable:previous opening_brace
@@ -149,13 +140,15 @@ public actor Signer {
public func sign(
app: URL,
identity: Identity,
certificate: Certificate,
privateKey: PrivateKey,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) async throws {
try self._sign(
app: app,
identity: identity,
certificate: certificate,
privateKey: privateKey,
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 signer: Signer
public let signerImpl: SignerImpl
public var developerAPIClient: DeveloperAPIClient {
DeveloperAPIClient(auth: auth)
@@ -24,12 +24,12 @@ public struct SigningContext: Sendable {
udid: String,
deviceName: String,
auth: DeveloperAPIAuthData,
signer: Signer? = nil
signerImpl: SignerImpl? = nil
) throws {
self.udid = udid
self.deviceName = deviceName
self.auth = auth
self.signer = try signer ?? .first()
self.signerImpl = try signerImpl ?? .first()
}
}
@@ -21,8 +21,8 @@ extension ProvisioningIdentifiers {
return identifier.split(separator: ".").dropFirst().joined(separator: ".")
}
static func identifier(fromSanitized sanitized: String, context: SigningContext) -> String {
let uuid = context.auth.identityID.split(separator: "-")[0].uppercased()
static func identifier(fromSanitized sanitized: String, context: SigningContext? = nil) -> String {
let uuid = (context?.auth.identityID ?? UUID().uuidString).split(separator: "-")[0].uppercased()
return "\(Self.idPrefix)\(uuid).\(sanitized)"
}
@@ -36,7 +36,7 @@ extension ProvisioningIdentifiers {
return sanitize(identifier: id)
}
static func groupID(fromSanitized sanitized: String, context: SigningContext) -> DeveloperServicesAppGroup.GroupID {
static func groupID(fromSanitized sanitized: String, context: SigningContext? = nil) -> DeveloperServicesAppGroup.GroupID {
.init(rawValue: "\(Self.groupPrefix)\(identifier(fromSanitized: sanitized, context: context))")
}
@@ -22,15 +22,7 @@ struct DSCertificatesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let certificates = try await DeveloperAPIPages {
try await client.certificatesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let certificates = try await client.certificatesGetCollection().ok.body.json.data
for certificate in certificates {
print("- id: \(certificate.id)")
guard let attributes = certificate.attributes else {
@@ -22,15 +22,7 @@ struct DSDevicesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let devices = try await DeveloperAPIPages {
try await client.devicesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let devices = try await client.devicesGetCollection().ok.body.json.data
for device in devices {
print("- id: \(device.id)")
guard let attributes = device.attributes else {
@@ -22,15 +22,7 @@ struct DSIdentifiersListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let bundleIDs = try await DeveloperAPIPages {
try await client.bundleIdsGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let bundleIDs = try await client.bundleIdsGetCollection().ok.body.json.data
for bundleID in bundleIDs {
print("- id: \(bundleID.id)")
guard let attributes = bundleID.attributes else {
@@ -24,15 +24,7 @@ struct DSProfilesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let profiles = try await DeveloperAPIPages {
try await client.profilesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let profiles = try await client.profilesGetCollection().ok.body.json.data
for profile in profiles {
print("- id: \(profile.id)")
guard let attributes = profile.attributes else {
+2 -24
View File
@@ -62,22 +62,7 @@ struct PackOperation {
buildSettings: buildSettings,
plan: plan
)
let bundle = try await packer.pack()
if let entitlementsPath = plan.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
return try await packer.pack()
}
}
@@ -213,14 +198,7 @@ struct DevRunCommand: AsyncParsableCommand {
defer { print() }
do {
try await installer.install(app: output)
} catch let error as CancellationError {
throw error
} catch {
print("\nError: \(error)")
throw ExitCode.failure
}
try await installer.install(app: output)
}
}
+2 -4
View File
@@ -34,11 +34,9 @@ struct InstallCommand: AsyncParsableCommand {
do {
try await installer.install(app: URL(fileURLWithPath: path))
print("\nSuccessfully installed!")
} catch let error as CancellationError {
throw error
} catch {
print("\nError: \(error)")
throw ExitCode.failure
print("\nFailed :(")
print("Error: \(error)")
}
}
}
+1 -1
View File
@@ -330,7 +330,7 @@ struct SDKBuilder {
guard FileManager.default.changeCurrentDirectoryPath(outDir) else {
throw Console.Error("Could not change directory to '\(outDir)'")
}
defer { _ = FileManager.default.changeCurrentDirectoryPath(oldDirectory) }
defer { FileManager.default.changeCurrentDirectoryPath(oldDirectory) }
let inputStream = DataReader.data(readingFrom: fd.rawValue)