TGFAuthenticator

Objective-C

@protocol TGFAuthenticator <NSObject>

Swift

protocol TGFAuthenticator : NSObjectProtocol

A protocol that defines the common interface for a FIDO2 authenticator.

An authenticator is a component responsible for user verification, such as through a passcode or biometrics. This protocol provides the essential methods for managing the lifecycle of the user’s credential associated with the authenticator, including creation, deletion, and checking its status. @since 1.0.0

  • Checks if the authenticator’s credential (e.g., a passcode) has been created and enrolled.

    Use this method to determine if the user needs to go through the enrollment flow before performing FIDO2 operations.

    Declaration

    Objective-C

    - (BOOL)isPasscodeCreated;

    Swift

    func isPasscodeCreated() -> Bool

    Return Value

    YES if the credential has been created; otherwise, NO.

  • Initiates the flow to create and enroll the authenticator’s credential.

    Users MUST successfully complete this enrollment process before the authenticator can be used for FIDO2 operations. The enrollment process securely stores a means of identification that will be used to verify the user during subsequent authentications.

    Declaration

    Objective-C

    - (void)createPasscode;

    Swift

    func createPasscode()

  • Initiates the flow to remove the authenticator’s credential.

    This operation typically requires user verification before proceeding.

    Warning

    Upon successful deletion, all FIDO2 registrations associated with this authenticator will be permanently invalidated. The user will need to re-enroll to use this authenticator for FIDO2 operations again.

    Declaration

    Objective-C

    - (void)deletePasscode;

    Swift

    func deletePasscode()