Class PivBioMetadata

Namespace

Yubico.YubiKey.Piv

Assembly

Yubico.YubiKey.dll

This class parses the response data from the PIV Get Bio Metadata command. It holds data about Bio multi-protocol key.

public class PivBioMetadata

Inheritance

object

PivBioMetadata

Remarks

The response to the GetBioMetadataCommand is GetBioMetadataResponse. Call the GetData method in the response object to get the metadata. An instance of this class will be returned.

Constructors

PivBioMetadata(ReadOnlyMemory<byte>)

The constructor that takes in the bio metadata encoding returned by the YubiKey in response to the GetBioMetadataCommand.

public PivBioMetadata(ReadOnlyMemory<byte> responseData)

Parameters

responseData ReadOnlyMemory<byte>

The data portion of the response APDU, this is the encoded bio metadata.

Exceptions

InvalidOperationException

The data supplied is not valid PIV bio metadata.

Properties

AttemptsRemaining

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 {@link #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.

public int AttemptsRemaining { get; }

Property Value

int

HasTemporaryPin

Indicates whether a temporary PIN has been generated in the YubiKey in relation to a successful biometric match.

public bool HasTemporaryPin { get; }

Property Value

bool

true if a temporary PIN has been generated.

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.

public bool IsConfigured { get; }

Property Value

bool

true if biometrics are configured or not.