Package com.yubico.yubikit.piv

Class BioMetadata

java.lang.Object
com.yubico.yubikit.piv.BioMetadata
public class BioMetadata extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    BioMetadata(boolean configured, int attemptsRemaining, boolean temporaryPin)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAttemptsRemaining()
    Returns value of biometric match retry counter which states how many biometric match retries are left until a YubiKey Bio is blocked.
    boolean
    hasTemporaryPin()
    Indicates whether a temporary PIN has been generated in the YubiKey in relation to a successful biometric match.
    boolean
    isConfigured()
    Indicates whether biometrics are configured or not (fingerprints enrolled or not).

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • BioMetadata

      public BioMetadata(boolean configured, int attemptsRemaining, boolean temporaryPin)

  • Method Details

    • isConfigured

      public boolean isConfigured()
      Indicates whether biometrics are configured or not (fingerprints enrolled or not).

      A false return value indicates a YubiKey Bio without biometrics configured and hence the client should fallback to a PIN based authentication.

      Returns:
      true if biometrics are configured or not.

    • getAttemptsRemaining

      public int getAttemptsRemaining()
      Returns value of biometric match retry counter which states how many biometric match retries are left until a YubiKey Bio is blocked.

      If this method returns 0 and isConfigured() returns true, the device is blocked for biometric match and the client should invoke PIN based authentication to reset the biometric match retry counter.

    • hasTemporaryPin

      public boolean hasTemporaryPin()
      Indicates whether a temporary PIN has been generated in the YubiKey in relation to a successful biometric match.
      Returns:
      true if a temporary PIN has been generated.