Skip to content

Entitlements outside supportedTypes stay in the binary but their capability is never enabled on the App ID → late install failure #352

Open

Description

@rahul05ranjan

If the project's entitlements file contains an entitlement whose type is not registered in EntitlementContainer.supportedTypes — today that's at least com.apple.developer.networking.networkextension and com.apple.developer.default-data-protection — xtool dev (device install) keeps the entitlement in the signed binary but never enables the matching capability on the App ID it registers. The device then rejects the install late, with an error that doesn't point at the cause. On free teams the entitlement is instead silently dropped and the feature just doesn't work.

Code trace

  • Sources/XKit/Model/Entitlements/EntitlementTypes.swift:15-30 — supportedTypes is the parse registry. NetworkExtensionEntitlement.self is commented out at line 23, AssociatedDomainsEntitlement.self at line 20; DataProtectionEntitlement (defined at line 109) is missing from the list entirely.
  • Entitlements.entitlements() decodes through ProtoCodableKeyValueContainer, which explicitly skips unknown keys (guard T.protoCodableType(for: key.stringValue) != nil else { continue } in xtool-core, ProtoCodableKeyValueContainer.swift:58-59). Unregistered entitlements never come back from entitlements().
  • Capability registration is computed only from parsed entitlements: Sources/XKit/DeveloperServices/App IDs/DeveloperServicesAddAppOperation.swift:88 — wantedCapabilitiesList = try entitlements.entitlements().compactMap(\.anyCapability). So the App ID never gets the network-extension / data-protection capability enabled, and DeveloperServicesFetchProfileOperation returns a profile that doesn't grant those entitlements.
  • Meanwhile the raw dictionary inside Entitlements retains unknown keys by design (the type's doc comment says so), and AutoSigner signs with that full mapping (Sources/XKit/Signer/AutoSigner.swift:85-92), so the binary does embed the entitlement.
  • Result for a paid team: binary entitlements ⊃ profile entitlements → install fails at device verification (the classic "entitlements not granted by the provisioning profile" class of error), long after configure/build succeeded with no warning.
  • Result for a free team: DeveloperServicesAddAppOperation.swift:182 filters to free capabilities and rebuilds Entitlements from the filtered list, silently discarding the entitlement from the binary.

The capability mappings for these entitlements already exist and are complete — Sources/XKit/DeveloperServices/App IDs/Entitlements/DeveloperServicesCapability.swift maps NetworkExtensionEntitlement → .networkExtensions and DataProtectionEntitlement → .dataProtection (with settings) — they're just unreachable because the types aren't registered.

Repro / expectations

A VPN or network-extension app with a paid team:

  1. xtool.yml with entitlementsPath pointing at a plist containing com.apple.developer.networking.networkextension.
  2. xtool dev builds and provisions with no warnings.
  3. The install on the device fails with an entitlement/profile mismatch error.

(I verified the code path statically; I haven't reproduced the device-side rejection on hardware.)

Suggested direction

  • Register the remaining entitlement types so their capabilities get provisioned. One caveat: the real-world value of com.apple.developer.networking.networkextension is often an array of extension kinds (e.g. ["packet-tunnel-provider"]) or a bool, so the current rawValue: Bool modeling would need adjusting.
  • PR Provision associated domains entitlement #334 does this for AssociatedDomainsEntitlement only.
  • Independently of how many types get registered, a warning when an entitlements file contains keys xtool won't provision would turn this into a configure-time error instead of a late install failure — the set of entitlements Apple supports grows faster than this registry.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions