FidoConstants

public struct FidoConstants

Constants used throughout the FIDO module.

Actions

  • Action to register a new FIDO credential.

    Declaration

    Swift

    public static let ACTION_REGISTER: String

  • Action to authenticate with an existing FIDO credential.

    Declaration

    Swift

    public static let ACTION_AUTHENTICATE: String

Event Types

  • Event type for submitting a FIDO response.

    Declaration

    Swift

    public static let EVENT_TYPE_SUBMIT: String

JSON Fields

  • key

    Undocumented

    Declaration

    Swift

    public static let key: String

  • Undocumented

    Declaration

    Swift

    public static let type: String

  • Undocumented

    Declaration

    Swift

    public static let label: String

  • Undocumented

    Declaration

    Swift

    public static let required: String

  • The key for the main data payload in a callback.

    Declaration

    Swift

    public static let FIELD_DATA: String

  • The key for the action to be performed (e.g., “REGISTER” or “AUTHENTICATE”).

    Declaration

    Swift

    public static let FIELD_ACTION: String

  • The key for the response data from a FIDO operation.

    Declaration

    Swift

    public static let FIELD_RESPONSE: String

  • The key for the raw ID of a credential, typically Base64 encoded.

    Declaration

    Swift

    public static let FIELD_RAW_ID: String

  • The key for the client data JSON.

    Declaration

    Swift

    public static let FIELD_CLIENT_DATA_JSON: String

  • The key for the attestation object.

    Declaration

    Swift

    public static let FIELD_ATTESTATION_OBJECT: String

  • The key for the authenticator data.

    Declaration

    Swift

    public static let FIELD_AUTHENTICATOR_DATA: String

  • The key for the signature.

    Declaration

    Swift

    public static let FIELD_SIGNATURE: String

  • The key for the user handle.

    Declaration

    Swift

    public static let FIELD_USER_HANDLE: String

  • The key for the challenge.

    Declaration

    Swift

    public static let FIELD_CHALLENGE: String

  • The key for the timeout value.

    Declaration

    Swift

    public static let FIELD_TIMEOUT: String

  • The key for the user verification preference.

    Declaration

    Swift

    public static let FIELD_USER_VERIFICATION: String

  • The key for the relying party ID.

    Declaration

    Swift

    public static let FIELD_RP_ID: String

  • The key for the list of allowed credentials.

    Declaration

    Swift

    public static let FIELD_ALLOW_CREDENTIALS: String

  • The key for the attestation preference.

    Declaration

    Swift

    public static let FIELD_ATTESTATION: String

  • The key for the relying party information.

    Declaration

    Swift

    public static let FIELD_RP: String

  • The key for the user information.

    Declaration

    Swift

    public static let FIELD_USER: String

  • The key for the public key credential type.

    Declaration

    Swift

    public static let FIELD_PUB_KEY: String

  • The key for the public key credential parameters.

    Declaration

    Swift

    public static let FIELD_PUB_KEY_CRED_PARAMS: String

  • The key for the list of credentials to exclude.

    Declaration

    Swift

    public static let FIELD_EXCLUDE_CREDENTIALS: String

  • The key for the authenticator selection criteria.

    Declaration

    Swift

    public static let FIELD_AUTHENTICATOR_SELECTION: String

  • The key for the credential type.

    Declaration

    Swift

    public static let FIELD_TYPE: String

  • The key for the credential ID.

    Declaration

    Swift

    public static let FIELD_ID: String

  • The key for the algorithm.

    Declaration

    Swift

    public static let FIELD_ALG: String

  • The key for the name.

    Declaration

    Swift

    public static let FIELD_NAME: String

  • The key for the display name.

    Declaration

    Swift

    public static let FIELD_DISPLAY_NAME: String

  • The key for the authenticator attachment type.

    Declaration

    Swift

    public static let FIELD_AUTHENTICATOR_ATTACHMENT: String

  • The key for the authenticator attachment type platform.

    Declaration

    Swift

    public static let FIELD_AUTHENTICATOR_ATTACHMENT_PLATFORM: String

  • The key for the authenticator attachment type cross-platform.

    Declaration

    Swift

    public static let FIELD_AUTHENTICATOR_ATTACHMENT_CROSS_PLATFORM: String

  • The key for the resident key requirement.

    Declaration

    Swift

    public static let FIELD_REQUIRE_RESIDENT_KEY: String

  • The key for the resident key preference.

    Declaration

    Swift

    public static let FIELD_RESIDENT_KEY: String

  • The key indicating support for a JSON response.

    Declaration

    Swift

    public static let FIELD_SUPPORTS_JSON_RESPONSE: String

  • The key for the assertion value in a DaVinci response.

    Declaration

    Swift

    public static let FIELD_ASSERTION_VALUE: String

  • The key for the attestation value in a DaVinci response.

    Declaration

    Swift

    public static let FIELD_ATTESTATION_VALUE: String

Private/Internal Fields

Standard Field Names

  • The standard key for the relying party name.

    Declaration

    Swift

    public static let FIELD_RELYING_PARTY_NAME: String

  • The standard key for the user ID.

    Declaration

    Swift

    public static let FIELD_USER_ID: String

  • The standard key for the user name.

    Declaration

    Swift

    public static let FIELD_USER_NAME: String

  • The standard key for the attestation preference.

    Declaration

    Swift

    public static let FIELD_ATTESTATION_PREFERENCE: String

  • The key for the public key credential creation options.

    Declaration

    Swift

    public static let FIELD_PUBLIC_KEY_CREDENTIAL_CREATION_OPTIONS: String

  • The key for the public key credential request options.

    Declaration

    Swift

    public static let FIELD_PUBLIC_KEY_CREDENTIAL_REQUEST_OPTIONS: String

Default Values

  • The default timeout for FIDO operations (60 seconds).

    Declaration

    Swift

    public static let DEFAULT_TIMEOUT: Int

  • The default attestation preference (“none”).

    Declaration

    Swift

    public static let DEFAULT_ATTESTATION: String

  • The default user verification preference (“required”).

    Declaration

    Swift

    public static let DEFAULT_USER_VERIFICATION: String

  • The default resident key requirement (“required”).

    Declaration

    Swift

    public static let DEFAULT_RESIDENT_KEY_REQUIRED: String

  • The value for a discouraged resident key.

    Declaration

    Swift

    public static let RESIDENT_KEY_DISCOURAGED: String

  • The default relying party ID for testing.

    Declaration

    Swift

    public static let DEFAULT_RELYING_PARTY_ID: String

Separators

  • The separator used for concatenating data in legacy FIDO responses.

    Declaration

    Swift

    public static let DATA_SEPARATOR: String

  • The separator used for integer arrays.

    Declaration

    Swift

    public static let INT_SEPARATOR: String

Callback IDs

  • The ID for the WebAuthn outcome callback.

    Declaration

    Swift

    public static let WEB_AUTHN_OUTCOME: String

Error Types

  • An unsupported error type.

    Declaration

    Swift

    public static let ERROR_UNSUPPORTED: String

  • A timeout error type.

    Declaration

    Swift

    public static let ERROR_TIMEOUT: String

  • The error code for a cancelled operation.

    Declaration

    Swift

    public static let ERROR_NOT_ALLOWED: String

  • The error code for an unknown error.

    Declaration

    Swift

    public static let ERROR_UNKNOWN: String

  • The message for a cancelled operation.

    Declaration

    Swift

    public static let ERROR_NOT_ALLOWED_MESSAGE: String

  • The error code for an invalid state.

    Declaration

    Swift

    public static let ERROR_INVALID_STATE: String

  • The error code for an unsupported operation.

    Declaration

    Swift

    public static let ERROR_NOT_SUPPORTED: String

  • The prefix for error messages.

    Declaration

    Swift

    public static let ERROR_PREFIX: String

FIDO JSON Response Keys

  • The key for legacy data in a JSON response.

    Declaration

    Swift

    public static let FIELD_LEGACY_DATA: String

Callback Types

  • The type for the FIDO registration callback.

    Declaration

    Swift

    public static let FIDO_REGISTRATION_CALLBACK: String

  • The type for the FIDO authentication callback.

    Declaration

    Swift

    public static let FIDO_AUTHENTICATION_CALLBACK: String