FIDO Data Types

The list of public data types used by FIDO layers.

  • An AlgorithmIdentifier instance specifies the cryptographic signature algorithm with which the newly generated credential will be used, and thus the type of asymmetric key pair to be generated.

    See more

    Declaration

    Swift

    public struct AlgorithmIdentifier : RawRepresentable, Equatable, Hashable, Codable
  • The AttachmentHint options describe the method an authenticator uses to communicate with the FIDO User Device.

    See more

    Declaration

    Swift

    public struct AttachmentHint : OptionSet, Codable
  • An authentication request sent to the FIDO Client.

    See more

    Declaration

    Swift

    public struct AuthenticationRequest : UAFRequest
  • The response sent by the FIDO Client after processing a authentication request.

    See more

    Declaration

    Swift

    public struct AuthenticationResponse : Codable
  • The AuthenticatorAttestationID type represents an AAID, which uniquely identifies a specific authenticator model within the range of all UAF-enabled authenticator models made by all authenticator vendors.

    Declaration

    Swift

    public typealias AuthenticatorAttestationID = String
  • An AuthenticatorRegistrationAssertion contains the authenticator’s response to a RegistrationRequest message.

    See more

    Declaration

    Swift

    public struct AuthenticatorRegistrationAssertion : Codable
  • An AuthenticatorSignAssertion contains the authenticator’s response to a AuthenticationRequest message.

    See more

    Declaration

    Swift

    public struct AuthenticatorSignAssertion : Codable
  • A ChannelBinding instance contains channel binding information that can be verified by the FIDO Server in order to detect and prevent MITM attacks.

    See more

    Declaration

    Swift

    public struct ChannelBinding : Codable

Authenticator to be Deregistered

  • A DeregisterAuthenticator object represents an authenticator to be deregistered.

    See more

    Declaration

    Swift

    public struct DeregisterAuthenticator : Codable
  • The mode defining what type of deregistration is executed.

    Note

    The SDK does not support username mode at the moment. This enum lists the supported deregistration modes.
    See more

    Declaration

    Swift

    @available(*, deprecated, message: "Deregistration mode is not used anymore as there are separate deregister functions for each mode.")
    public enum DeregistrationMode
  • A deregistration request sent to the FIDO Client.

    See more

    Declaration

    Swift

    public struct DeregistrationRequest : UAFRequest
  • The DisplayPNGCharacteristicsDescriptor describes a PNG image characteristics as defined in the PNG spec for IHDR (image header) and PLTE (palette table).

    See more

    Declaration

    Swift

    public struct DisplayPNGCharacteristicsDescriptor : Equatable, Codable
  • The Extension type is used to represent a generic extension used in various operations.

    FIDO extensions can appear in several places, including the UAF protocol messages, authenticator commands, or in the assertion signed by the authenticator.

    See more

    Declaration

    Swift

    public struct Extension : Equatable, Codable
  • A GetUAFRequest object represents a request message sent to a relying party server.

    See more

    Declaration

    Swift

    public struct GetUAFRequest : Codable
  • A KeyID is a unique identifier (within the scope of an AAID) used to refer to a specific UAuth.Key, Base64url encoded. It is generated by the authenticator and registered with a FIDO Server.

    Declaration

    Swift

    public typealias KeyID = String
  • The list of possible key protections, which describe the method an authenticator uses to protect the private key material for FIDO registrations.

    See more

    Declaration

    Swift

    public struct KeyProtection : OptionSet, Codable
  • A MatchCriteria represents the matching criteria to be used in the server policy.

    See more

    Declaration

    Swift

    public struct MatchCriteria : Codable
  • The list of possible matcher protections, which describe the method an authenticator uses to protect the matcher that performs user verification.

    See more

    Declaration

    Swift

    public struct MatcherProtection : OptionSet, Equatable, Hashable, Codable
  • The operation type of a UAF message or request for a message.

    See more

    Declaration

    Swift

    public enum Operation : String, Codable
  • A type that represents a UAF message Request and Response header.

    See more

    Declaration

    Swift

    public struct OperationHeader : Codable
  • The OutOfBandPayload contains the data necessary to start an out-of-band operation.

    See more

    Declaration

    Swift

    public struct OutOfBandPayload : Codable
  • A Policy object contains a specification of accepted authenticators and a specification of disallowed authenticators.

    See more

    Declaration

    Swift

    public struct Policy : Codable
  • A registration request sent to the FIDO Client.

    See more

    Declaration

    Swift

    public struct RegistrationRequest : UAFRequest
  • The response sent by the FIDO Client after processing a registration request.

    See more

    Declaration

    Swift

    public struct RegistrationResponse : Codable
  • A ReturnUAFRequest object represents a response sent by a relying party server on a request message.

    See more

    Declaration

    Swift

    public struct ReturnUAFRequest : Codable
  • An RGB three-sample tuple palette entry.

    See more

    Declaration

    Swift

    public struct RGBPaletteEntry : Equatable, Codable
  • A SendUAFResponse object represents a response message delivered to a relying party server.

    See more

    Declaration

    Swift

    public struct SendUAFResponse : Codable
  • A ServerResponse object represents the completion status and additional application-specific additional data that results from successful processing of a UAF operation.

    See more

    Declaration

    Swift

    public struct ServerResponse : Codable
  • A Token object represents an additional authentication or authorization token.

    See more

    Declaration

    Swift

    public struct Token : Codable
  • A transaction to be confirmed by the user.

    See more

    Declaration

    Swift

    public struct Transaction : Equatable, Codable
  • The TransactionConfirmationDisplay options are options that describe the availability and implementation of a transaction confirmation display capability required for the transaction confirmation operation. These constants are used in the authoritative metadata for an authenticator, reported and queried through the UAF Discovery APIs, and used to form authenticator policies in UAF protocol messages.

    See more

    Declaration

    Swift

    public struct TransactionConfirmationDisplay : OptionSet, Codable

Content Types

  • The list of available MIME content types [RFC2049] for a transaction confirmation display.

    See more

    Declaration

    Swift

    public enum TransactionConfirmationDisplayContentType : String
  • A type that encapsulates a UAF message and its data.

    Declaration

    Swift

    public struct UAFMessage<T> : Codable where T : Decodable, T : Encodable
  • UserVerify values describe the methods and capabilities of a UAF authenticator for locally verifying a user. These constants are used in the authoritative metadata for an authenticator, reported and queried through the UAF Discovery APIs, and used to form authenticator policies in UAF protocol messages.

    See more

    Declaration

    Swift

    public struct UserVerify : OptionSet, Codable
  • Represents a generic version with major and minor fields.

    See more

    Declaration

    Swift

    public struct Version : Equatable, Hashable, Codable
    extension Version: Comparable
    extension Version: CustomStringConvertible