STRUCT
WebAuthnRegistrationClientOperationStep
Contents
- Properties
actionModelactionsmetadatamessageslinkspropertiesrawJsonStringtypecontinueActioncontinueFormActionModelfallbackActions
- Methods
buildParameters(publicKey:clientDataJSON:attestationObject:type:rawId:)formattedParametersForRegistration(credentialOptions:attestationObject:rawClientDataJSON:credentialID:credentialParamType:)init(from:)encode(to:)==(_:_:)
public struct WebAuthnRegistrationClientOperationStep: ClientOperationStep
A step that instructs a client that it should use the device's platform Authentication Services API to perform a User Authentication Registration WebAuthn flow
After running the ceremony with one of actionModel's option sets, the client application should invoke
buildParameters(publicKey:clientDataJSON:attestationObject:type:rawId:) with the credential response, and submit the result with
continueFormActionModel to proceed with the flow.
Fallback actions are provided to assist on fallback if an error happens.
For more information, refer to the HAAPI Data Model documentation.
- Note: Starting on iOS 15,
WebAuthncan be used with the Authentication Services ASAuthorizationPublicKey APIs (native) but it is also possible to use the fallbackActions (web browser). Below iOS 15, fallbackActions (web browser) is the only way to handle WebAuthn.
Properties
actionModel
public let actionModel: WebAuthnRegistrationClientOperationActionModel
the WebAuthn client operation action model that contains the necessary details for the client to use the device's platform Authentication Services.
actions
public let actions: [any Action]
An array of Action that contains possible actions a user or the client may choose to take to continue the flow.
metadata
public let metadata: Metadata?
messages
public let messages: [UserMessage]
links
public let links: [Link]
properties
public let properties: (any Properties)?
rawJsonString
public let rawJsonString: String?
type
public let type: RepresentationType
continueAction
public let continueAction: FormAction
Returns the form action that has to be submitted alongside the result of buildParameters(publicKey:clientDataJSON:attestationObject:type:rawId:) after receiving the callback from the authenticator interaction.
continueFormActionModel
public var continueFormActionModel: FormActionModel
The form action model to submit the result of buildParameters(publicKey:clientDataJSON:attestationObject:type:rawId:) with.
fallbackActions
public var fallbackActions: [any Action]
Returns the actions that should be triggered when WebAuthnhandling fails or is impossible to use with the native APIs.
Methods
buildParameters(publicKey:clientDataJSON:attestationObject:type:rawId:)
public func buildParameters(
publicKey: WebAuthnRegistrationClientOperationActionModel.CredentialRequestOptions,
clientDataJSON: Data,
attestationObject: Data,
type: String,
rawId: Data
) throws -> [String: any Sendable]
Builds the parameters to submit with continueFormActionModel after a WebAuthn registration ceremony.
Pass the raw values of the credential returned by any WebAuthn driver; they are base64url-encoded here. The
authenticator attachment sent to the server is the one of publicKey, whatever the driver reports.
- Parameters:
- publicKey: The option set used for the ceremony:
actionModel.platformOptionsoractionModel.crossPlatformOptions. - clientDataJSON: The credential response's
clientDataJSON. - attestationObject: The credential response's
attestationObject. - type: The credential type,
public-keyfor WebAuthn. - rawId: The credential's raw id.
- publicKey: The option set used for the ceremony:
- Returns: The parameters to submit with
continueFormActionModel. - Throws: An
IdsvrErrorwhenpublicKeydid not come from a WebAuthn registration step, or the continue form has no context field for it.
Parameters
| Name | Description |
|---|---|
| publicKey | The option set used for the ceremony: actionModel.platformOptions or actionModel.crossPlatformOptions. |
| clientDataJSON | The credential response’s clientDataJSON. |
| attestationObject | The credential response’s attestationObject. |
| type | The credential type, public-key for WebAuthn. |
| rawId | The credential’s raw id. |
formattedParametersForRegistration(credentialOptions:attestationObject:rawClientDataJSON:credentialID:credentialParamType:)
public func formattedParametersForRegistration(
credentialOptions: WebAuthnRegistrationClientOperationActionModel.CredentialRequestOptions,
attestationObject: Data,
rawClientDataJSON: Data,
credentialID: Data,
credentialParamType: String = "public-key"
) -> [String: Any]
Builds the form parameters necessary to submit a WebAuthn Registration request.
- Parameters:
- publicKeyOptions: the selected
PublicKeyModelvalue used to create the authenticator request. - attestationObject: the attestation object's data provided by the device's platform Authorization Controller
ASAuthorization.credentialresponse. - rawClientDataJSON: the clientDataJSON's data provided by the device's platform Authorization Controller
ASAuthorization.credentialresponse. - credentialID:the credentialID's data provided by the device's platform Authorization Controller
ASAuthorization.credentialresponse. - credentialParamType: the credential type used to setup the authorization request. Defaults to "public-key".
- publicKeyOptions: the selected
- Returns: a
Dictionary<String: Any>containing the parameters to use when submiting the form action, or an empty dictionary when they cannot be built. - Note: ASAuthorizationPlatformPublicKeyCredentialRegistration is only available starting on iOS15 in AuthenticationServices framework.
Parameters
| Name | Description |
|---|---|
| publicKeyOptions | the selected PublicKeyModel value used to create the authenticator request. |
| attestationObject | the attestation object’s data provided by the device’s platform Authorization Controller ASAuthorization.credential response. |
| rawClientDataJSON | the clientDataJSON’s data provided by the device’s platform Authorization Controller ASAuthorization.credential response. |
| credentialID | the credentialID’s data provided by the device’s platform Authorization Controller ASAuthorization.credential response. |
| credentialParamType | the credential type used to setup the authorization request. Defaults to “public-key”. |
init(from:)
public init(from decoder: Decoder) throws
Parameters
| Name | Description |
|---|---|
| decoder | The decoder to read data from. |
encode(to:)
public func encode(to encoder: Encoder) throws
Parameters
| Name | Description |
|---|---|
| encoder | The encoder to write data to. |
==(::)
public static func == (lhs: WebAuthnRegistrationClientOperationStep,
rhs: WebAuthnRegistrationClientOperationStep) -> Bool
Parameters
| Name | Description |
|---|---|
| lhs | A value to compare. |
| rhs | Another value to compare. |