PluginBench
Skill
Review
Audit score 70

browserenginekit

dpearson2699/swift-ios-skills

Build alternative browser engines for iOS/iPadOS with process isolation, XPC communication, and system integration.

What is browserenginekit?

BrowserEngineKit is a framework for developing non-WebKit browser engines on iOS and iPadOS in supported regions (EU on iOS 17.4+, Japan on iOS 26.2+). Use it when you need to implement a custom HTML/CSS/JavaScript rendering engine with proper process isolation, capability management, and Apple entitlements.

  • Manage separate processes for web content, networking, and rendering with XPC inter-process communication
  • Check device eligibility for alternative browser engines via BEAvailability API
  • Configure entitlements and sandbox capabilities for host app and extension targets
  • Handle process lifecycle including launch, interruption, and graceful shutdown
  • Support GPU and memory attribution between rendering and web content processes
  • Implement text interaction and layer hosting for browser UI coordination

How to install browserenginekit

npx skills add https://github.com/dpearson2699/swift-ios-skills --skill browserenginekit
Prerequisites
  • Apple-approved entitlements (com.apple.developer.web-browser-engine.host and type-specific extension entitlements)
  • Xcode with current Apple SDKs and Swift 6.3+
  • Device eligibility verification via BEAvailability (iOS/iPadOS 18.4+)
  • Separate extension targets for web content, networking, and rendering processes
Claude Code
Cursor
Windsurf
Cline

How to use browserenginekit

  1. 1.Request required entitlements from Apple (com.apple.developer.web-browser and com.apple.developer.web-browser-engine.host for host; type-specific entitlements for extensions)
  2. 2.Check device eligibility using BEAvailability.isEligible(for: .webBrowser) before launching extensions
  3. 3.Create process instances (WebContentProcess, NetworkingProcess, RenderingProcess) with interruption handlers
  4. 4.Establish XPC connections using makeLibXPCConnection() on each process
  5. 5.Bootstrap the web content extension with anonymous XPC endpoints from networking and rendering processes
  6. 6.Implement extension conformance (WebContentExtension, NetworkingExtension, RenderingExtension) in each extension target
  7. 7.Configure extension capabilities and sandbox restrictions via entitlements and Info.plist
  8. 8.Call invalidate() on processes when shutting down or handling crashes

Use cases

Good for
  • Developing a Firefox, Chrome, or other non-WebKit browser for iOS/iPadOS
  • Building an embedded alternative browser engine for in-app web browsing
  • Managing web content rendering in isolated processes for security and stability
  • Implementing custom networking stacks separate from system URLSession defaults
  • Coordinating GPU resources and media playback across extension processes
Who it's for
  • Browser app developers targeting iOS 17.4+ and iPadOS 18+
  • Teams building alternative rendering engines with custom JavaScript interpreters
  • Apps embedding third-party or first-party web engines for in-app browsing
  • Developers in EU and Japan regions subject to alternative-engine eligibility rules

browserenginekit FAQ

What regions support alternative browser engines?

EU support is available on iOS 17.4+ and iPadOS 18+. Japan support starts with iOS 26.2+ and requires additional security mitigations (PAC, memory integrity enforcement). Development and testing can occur anywhere.

Do I need separate processes for each browser tab?

The web content extension typically runs one process per tab or iframe. Networking and rendering extensions are usually single instances shared across all tabs.

Can extensions communicate directly with each other?

No. Extensions communicate only through anonymous XPC endpoints brokered by the host app. The web content extension receives endpoints to networking and rendering during bootstrap.

What entitlements do I need for an embedded (non-browser) app?

Use com.apple.developer.embedded-web-browser-engine and com.apple.developer.embedded-web-browser-engine.engine-association (set to 'first-party' or 'third-party'). Embedded engines cannot use JIT, browser extensions, or arm64e.

What should I do if an extension crashes?

The onInterruption handler fires when an extension crashes or is terminated by the OS. Implement recovery logic such as restarting the process or notifying the user.

Full instructions (SKILL.md)

Source of truth, from dpearson2699/swift-ios-skills.


name: browserenginekit description: "Build alternative browser engines using BrowserEngineKit. Use when developing a non-WebKit browser engine for iOS/iPadOS in supported regions, managing web content/rendering/networking extension processes, configuring GPU and networking process capabilities, checking alternative-engine device eligibility, or reviewing BrowserEngineKit entitlements and Info.plist setup."

BrowserEngineKit

Framework for building web browsers with alternative (non-WebKit) rendering engines on iOS and iPadOS. Provides process isolation, XPC communication, capability management, and system integration for browser apps that implement their own HTML/CSS/JavaScript engine. Examples target Swift 6.3 and current Apple SDKs.

BrowserEngineKit is a specialized framework. Alternative browser engines are available only through Apple-approved entitlement profiles and supported-region device eligibility. EU support applies to eligible users on iOS 17.4+ and iPadOS 18+; Japan support starts with iOS 26.2 and adds explicit PAC/MIE security requirements for browser apps. Development and testing can occur anywhere. The companion frameworks BrowserEngineCore (low-level primitives) and BrowserKit (eligibility checks, data transfer) support the overall workflow.

Contents

Overview and Eligibility

Eligibility Checking

Use BEAvailability from the BrowserKit framework to check whether the device is eligible for alternative browser engines. BEAvailability is available on iOS/iPadOS 18.4+:

import BrowserKit

do {
    let eligible = try await BEAvailability.isEligible(for: .webBrowser)
    guard eligible else { return /* fall back or explain */ }
    // Device supports alternative browser engines
} catch {
    // Handle eligibility lookup failure
}

Eligibility depends on the device region and OS version. Do not hard-code region checks; rely on the system API.

Availability anchors: process APIs are iOS/iPadOS 17.4+, BEDownloadMonitor is iOS 18.2+, .revision2 restricted sandbox is iOS 26+, and RenderingExtensionFeature.coreML is iOS 26.2+.

Entitlements

Browser App (Host)

The host app requires two entitlements:

EntitlementPurpose
com.apple.developer.web-browserEnables default-browser candidacy
com.apple.developer.web-browser-engine.hostEnables alternative engine extensions

Both must be requested from Apple. The request process varies by region.

Extension Entitlements

Each extension target requires its type-specific entitlement set to true:

Extension TypeEntitlement
Web contentcom.apple.developer.web-browser-engine.webcontent
Networkingcom.apple.developer.web-browser-engine.networking
Renderingcom.apple.developer.web-browser-engine.rendering

Optional Entitlements

EntitlementExtensionPurpose
com.apple.security.cs.allow-jitWeb contentJIT compilation of scripts
com.apple.developer.kernel.extended-virtual-addressingWeb contentRequired alongside JIT
com.apple.developer.memory.transfer_sendRenderingSend memory attribution; value is host app bundle ID
com.apple.developer.memory.transfer_acceptWeb contentAccept memory attribution; value is host app bundle ID
com.apple.developer.web-browser-engine.restrict.notifydWeb contentRestrict notification daemon access

Embedded Browser Engine (Non-Browser Apps)

Apps that are not browsers but embed an alternative engine for in-app browsing use different entitlements:

EntitlementPurpose
com.apple.developer.embedded-web-browser-engineEnable embedded engine
com.apple.developer.embedded-web-browser-engine.engine-associationDeclare engine ownership

engine-association is available starting iOS/iPadOS/Mac Catalyst 26.2 and is set to first-party when you own the engine or third-party when another developer owns it. Embedded engines use arm64 only (not arm64e), cannot include browser extensions, and cannot use JIT compilation.

Japan-Specific Requirements

Browser apps distributed in Japan are supported on iOS 26.2+ and must adopt the current security mitigations Apple lists for Japan, including Pointer Authentication Codes and Memory Integrity Enforcement for relevant allocators and extension processes. Enable hardware memory tagging with com.apple.security.hardened-process.checked-allocations; Apple strongly recommends enabling it in the EU as well.

Architecture

A browser built with BrowserEngineKit consists of four components running in separate processes:

Host App (UI, coordination)
  |
  |-- XPC --> Web Content Extension (HTML parsing, JS, DOM)
  |-- XPC --> Networking Extension (URLSession, sockets)
  |-- XPC --> Rendering Extension (Metal, GPU, media)

The host app launches and manages all extensions. Extensions cannot launch other extensions. Extensions communicate with each other through anonymous XPC endpoints brokered by the host app.

Bootstrap Sequence

  1. Host launches web content, networking, and rendering extensions
  2. Host creates XPC connections to each extension
  3. Host requests anonymous XPC endpoints from networking and rendering
  4. Host sends both endpoints to the web content extension via a bootstrap message
  5. Web content extension connects directly to networking and rendering

This architecture follows the principle of least privilege: the web content extension works with untrusted data but has no direct OS resource access.

Process Management

Launching Extensions

Each extension type has a corresponding process class in the host app:

import BrowserEngineKit

// Web content (one per tab or iframe)
let contentProcess = try await WebContentProcess(
    bundleIdentifier: nil,
    onInterruption: {
        // Handle crash or OS interruption
    }
)

// Networking (typically one instance)
let networkProcess = try await NetworkingProcess(
    bundleIdentifier: nil,
    onInterruption: {
        // Handle interruption
    }
)

// Rendering / GPU (typically one instance)
let renderingProcess = try await RenderingProcess(
    bundleIdentifier: nil,
    onInterruption: {
        // Handle interruption
    }
)

Pass nil for bundleIdentifier to use the default extension target. The interruption handler fires if the extension crashes or is terminated by the OS.

Creating XPC Connections

let connection = try contentProcess.makeLibXPCConnection()
// Use connection for inter-process messaging

Each process type provides makeLibXPCConnection() to create an xpc_connection_t for communication.

Stopping Extensions

contentProcess.invalidate()

After calling invalidate(), no further method calls on the process object are valid.

Extension Types

Web Content Extension

Hosts the browser engine's HTML parser, CSS engine, JavaScript interpreter, and DOM. Conform to WebContentExtension to handle incoming XPC connections:

import BrowserEngineKit

@main
struct MyWebContentExtension: WebContentExtension {
    func handle(xpcConnection: xpc_connection_t) {
        // Set up message handlers on the connection
    }
}

Configure via WebContentExtensionConfiguration in the extension's EXAppExtensionAttributes.

Networking Extension

Handles all network requests using URLSession or socket APIs. One instance serves all tabs:

import BrowserEngineKit

@main
struct MyNetworkingExtension: NetworkingExtension {
    func handle(xpcConnection: xpc_connection_t) {
        // Handle network request messages
    }
}

Configure via NetworkingExtensionConfiguration.

Rendering Extension

Accesses the GPU via Metal for video decoding, compositing, and complex rendering. One instance typically serves the entire browser:

import BrowserEngineKit

@main
struct MyRenderingExtension: RenderingExtension {
    init() {
        if #available(iOS 26.2, macOS 26.2, *) {
            enableFeature(.coreML)
        }
    }

    func handle(xpcConnection: xpc_connection_t) {
        // Handle rendering commands
    }
}

Configure via RenderingExtensionConfiguration.

Capabilities

Grant capabilities to extensions so the OS schedules them appropriately:

// Grant foreground priority to an extension
let grant = try contentProcess.grantCapability(.foreground)

// ... extension does foreground work ...

// Relinquish when done
grant.invalidate()

Available Capabilities

CapabilityUse Case
.foregroundActive tab rendering, visible content
.backgroundBackground tasks, prefetching
.suspendedMinimal activity, pending cleanup
.mediaPlaybackAndCapture(environment:)Audio/video playback, camera/mic capture

Media Environment

For media capabilities, create a MediaEnvironment tied to a page URL. The environment supports AVCaptureSession for camera/mic access and is XPC-serializable for cross-process transport:

let mediaEnv = MediaEnvironment(webPage: pageURL)
let grant = try contentProcess.grantCapability(
    .mediaPlaybackAndCapture(environment: mediaEnv)
)
try mediaEnv.activate()
let captureSession = try mediaEnv.makeCaptureSession()

Visibility Propagation

Attach a visibility propagation interaction to browser views so extensions know when content is on screen. Both WebContentProcess and RenderingProcess provide createVisibilityPropagationInteraction().

Layer Hosting and View Coordination

The rendering extension draws into a LayerHierarchy, whose content the host app displays via LayerHierarchyHostingView. Handles are passed over XPC. Use LayerHierarchyHostingTransactionCoordinator to synchronize layer updates atomically across processes.

See references/browserenginekit-patterns.md for detailed layer hosting examples and transaction coordination.

Text Interaction

Adopt BETextInput on custom text views to integrate with UIKit's text system. This enables standard text selection, autocorrect, dictation, and keyboard interactions.

Key integration points:

  • asyncInputDelegate for communicating text changes to the system
  • handleKeyEntry(_:completionHandler:) for keyboard events
  • BETextInteraction for selection gestures, edit menus, and context menus
  • BEScrollView and BEScrollViewDelegate for custom scroll handling

See references/browserenginekit-patterns.md for detailed text interaction implementation.

Sandbox and Security

Restricted Sandbox

After initialization, lock down content extensions using the restricted sandbox:

// In the web content extension, after setup:
if #available(iOS 26.0, macOS 26.0, *) {
    applyRestrictedSandbox(revision: .revision2)
} else {
    applyRestrictedSandbox(revision: .revision1)
}

This removes access to resources the extension used during startup but no longer needs. Use the latest available revision for the strongest restrictions.

JIT Compilation

Web content extensions that JIT-compile JavaScript toggle memory between writable and executable states. Use the BE_JIT_WRITE_PROTECT_TAG from BrowserEngineCore:

import BrowserEngineCore

// BE_JIT_WRITE_PROTECT_TAG is used with pthread_jit_write_protect_np
// to control JIT memory page permissions

Requires the com.apple.security.cs.allow-jit and com.apple.developer.kernel.extended-virtual-addressing entitlements on the web content extension only.

arm64e Requirement

All executables (host app and extensions) must be built with the arm64e instruction set for distribution. Build as a universal binary to also support arm64 iPads.

In Xcode build settings or xcconfig:

ARCHS[sdk=iphoneos*]=arm64e

Do not use arm64e for Simulator targets.

Downloads

Report download progress to the system using BEDownloadMonitor. Create an access token, initialize the monitor with source/destination URLs and a Progress object, then call beginMonitoring() to show the system download UI. Use resumeMonitoring(placeholderURL:) to resume interrupted downloads. BEDownloadMonitor is available on iOS 18.2+.

See references/browserenginekit-patterns.md for full download management examples.

Common Mistakes

DON'T: Skip the bootstrap sequence

// WRONG - content extension has no path to other extensions
let contentProcess = try await WebContentProcess(
    bundleIdentifier: nil, onInterruption: {}
)
// Immediately start sending work without connecting to networking/rendering

// CORRECT - broker connections through the host app
let networkEndpoint = try await networkProxy.getEndpoint()
let renderEndpoint = try await renderProxy.getEndpoint()
try await contentProxy.bootstrap(
    renderingExtension: renderEndpoint,
    networkExtension: networkEndpoint
)

DON'T: Launch extensions from other extensions

// WRONG - extensions cannot launch other extensions
// (inside a WebContentExtension)
let network = try await NetworkingProcess(...)

// CORRECT - only the host app launches extensions
// Host app creates all processes, then brokers connections

DON'T: Use extension process objects after invalidation

// WRONG
contentProcess.invalidate()
let conn = try contentProcess.makeLibXPCConnection()  // Error

// CORRECT - create a new process if needed
let newProcess = try await WebContentProcess(
    bundleIdentifier: nil, onInterruption: {}
)

DON'T: Apply JIT entitlements to non-content extensions

JIT compilation entitlements (com.apple.security.cs.allow-jit) are valid only on web content extensions. Adding them to the host app, rendering extension, or networking extension causes App Store rejection.

DON'T: Hard-code region eligibility

// WRONG
if Locale.current.region?.identifier == "DE" {
    useAlternativeEngine()
}

// CORRECT - use the system eligibility API
let eligible = try await BEAvailability.isEligible(for: .webBrowser)
if eligible {
    useAlternativeEngine()
}

DON'T: Forget to set UIRequiredDeviceCapabilities

Without web-browser-engine in UIRequiredDeviceCapabilities, users on unsupported devices can download the app and hit runtime failures.

Review Checklist

  • com.apple.developer.web-browser-engine.host entitlement on host app
  • Each extension has its type-specific entitlement
  • UIRequiredDeviceCapabilities includes web-browser-engine
  • arm64e instruction set configured for all iOS device targets
  • arm64e is not set for Simulator targets
  • Swift packages built with iOSPackagesShouldBuildARM64e workspace setting
  • Extension point identifiers set correctly in each extension's Info.plist
  • Interruption handlers implemented for all process types
  • Bootstrap sequence connects content extension to networking and rendering
  • Capabilities granted before work begins and invalidated when done
  • Visibility propagation interaction added to browser content views
  • Restricted sandbox applied to content extensions after initialization
  • BEAvailability used for eligibility checks instead of manual region logic
  • Memory attribution entitlements use the host app bundle ID as their value
  • Download progress reported via BEDownloadMonitor for active downloads on iOS 18.2+
  • Memory tagging enabled for Japan distribution on iOS 26.2+ (recommended for EU)

References

Related skills

More from dpearson2699/swift-ios-skills and the wider catalog.

CAcallkit logo

callkit

dpearson2699/swift-ios-skills

Implement native iOS VoIP calling with CallKit and PushKit integration.

1.6k installsAudited
CAcarplay logo

carplay

dpearson2699/swift-ios-skills

Build CarPlay-enabled apps for vehicle displays using Apple's template-based UI framework.

1.6k installsAudited
CLcloudkit logo

cloudkit

dpearson2699/swift-ios-skills

Implement CloudKit and iCloud sync for iOS/macOS apps with record CRUD, queries, subscriptions, and SwiftData integration.

1.7k installs
COcontacts-framework logo

contacts-framework

dpearson2699/swift-ios-skills

Read, create, update, and pick contacts using Contacts and ContactsUI frameworks.

2.1k installsAudited
COcore-bluetooth logo

core-bluetooth

dpearson2699/swift-ios-skills

Build Bluetooth Low Energy central and peripheral workflows with Core Bluetooth scanning, connecting, GATT communication, and background modes.

2.2k installsAudited
COcore-data logo

core-data

dpearson2699/swift-ios-skills

Build, review, or improve Core Data persistence in apps that have not adopted SwiftData. Use when working with NSManagedObject subclasses, NSFetchedResultsController for list-driven UI, NSBatchInsertRequest / NSBatchDeleteRequest / NSBatchUpdateRequest for bulk operations, NSPersistentHistoryChangeRequest for persistent history tracking and multi-target sync, NSStagedMigrationManager for staged schema migrations (iOS 17+), NSCompositeAttributeDescription for composite attributes (iOS 17+), or when integrating Core Data threading with Swift Concurrency. For Core Data + SwiftData coexistence or migration, see the swiftdata skill instead.

1.1k installsAudited