AppleWebAuthnProvider

@available(iOS 16.0, macOS 13.0, *)
public final class AppleWebAuthnProvider : NSObject, WebAuthnProvider, @unchecked Sendable

Apple-platform WebAuthnProvider backed by ASAuthorizationPlatformPublicKeyCredentialProvider.

Provides passkey registration (secp256r1 key creation via Touch ID / Face ID) and assertion (passkey signing) for iOS 16+ and macOS 13+. Returns WebAuthnRegistrationResult and WebAuthnAuthenticationResult respectively.

On macOS set presentationContextProvider before calling register or authenticate; the system requires a host window reference. iOS handles presentation automatically.

The host application must declare an Associated Domains entitlement (webcredentials:<rpId>) and publish a matching AASA file. See docs/smart-accounts/webauthn-ios.md for setup details.

Example:

let provider = try AppleWebAuthnProvider(
    rpId: "wallet.example.com",
    rpName: "Example Smart Wallet"
)
let registration = try await provider.register(
    challenge: challenge32Bytes,
    userId: userIdBytes,
    userName: "user@example.com"
)

Show on GitHub

defaultTimeoutMs
Default operation timeout in milliseconds (60 seconds), used when no explicit timeout is supplied to the initializer or factory.
Declaration
Swift

public static let defaultTimeoutMs: Int64
Show on GitHub
rpId
WebAuthn Relying Party identifier. Must match an Associated Domains entitlement entry in the host application.
Declaration
Swift

public let rpId: String
Show on GitHub
rpName
Human-readable Relying Party name displayed during passkey prompts.
Declaration
Swift

public let rpName: String
Show on GitHub
timeout
Operation timeout in milliseconds. Applied to both register and authenticate; when exceeded, the call throws WebAuthnException.RegistrationFailed or WebAuthnException.AuthenticationFailed respectively.
Declaration
Swift

public let timeout: Int64
Show on GitHub
presentationContextProvider
Optional presentation context provider for the underlying ASAuthorizationController.

On macOS, ASAuthorizationController requires a context provider to supply the window in which to display the passkey UI. Without it the system fails the request with ASAuthorizationError code 1004. On iOS the system handles presentation automatically and this property may remain nil.

The provider holds a strong reference; assign before invoking register or authenticate. This property is not guarded by delegateLock, so mutating it concurrently with an in-flight call is undefined behavior.
Declaration
Swift

public var presentationContextProvider: ASAuthorizationControllerPresentationContextProviding?
Show on GitHub


                    
                    
                    init(rpId:rpName:timeout:)

Initializes a new AppleWebAuthnProvider.

Throws

SmartAccountConfigurationException.InvalidConfig when any input fails validation.

Declaration

Swift

public init(
    rpId: String,
    rpName: String,
    timeout: Int64 = AppleWebAuthnProvider.defaultTimeoutMs
) throws

Parameters

`rpId`	WebAuthn Relying Party identifier. Must be non-blank.
`rpName`	Human-readable RP name shown during passkey prompts. Must be non-blank.
`timeout`	Operation timeout in milliseconds. Must be strictly positive. Defaults to `defaultTimeoutMs` (60000).

Show on GitHub


                    
                    
                    create(rpId:rpName:timeout:)

Throwing convenience factory equivalent to init(rpId:rpName:timeout:).

Throws

SmartAccountConfigurationException.InvalidConfig for invalid inputs.

Declaration

Swift

public static func create(
    rpId: String,
    rpName: String,
    timeout: Int64 = AppleWebAuthnProvider.defaultTimeoutMs
) throws -> AppleWebAuthnProvider

Parameters

`rpId`	WebAuthn Relying Party identifier.
`rpName`	Human-readable RP name.
`timeout`	Operation timeout in milliseconds. Defaults to `defaultTimeoutMs`.

Return Value

A new configured AppleWebAuthnProvider.

Show on GitHub


                    
                    
                    register(challenge:userId:userName:)

Asynchronous

Declaration

Swift

public func register(
    challenge: Data,
    userId: Data,
    userName: String
) async throws -> WebAuthnRegistrationResult

Show on GitHub


                    
                    
                    authenticate(challenge:allowCredentials:)

Asynchronous

Declaration

Swift

public func authenticate(
    challenge: Data,
    allowCredentials: [WebAuthnAllowCredential]?
) async throws -> WebAuthnAuthenticationResult

Show on GitHub