Class FingerprintSensorInfo

Namespace

Yubico.YubiKey.Fido2

Assembly

Yubico.YubiKey.dll

Contains the data returned by the YubiKey after calling the GetFingerprintSensorInfo subcommand.

public class FingerprintSensorInfo

Inheritance

object

FingerprintSensorInfo

Constructors

FingerprintSensorInfo(int, int, int)

Build a new instance of FingerprintSensorInfo with the given values.

public FingerprintSensorInfo(int fingerprintKind, int maxCaptureCount, int maxFrienlyNameBytes)

Parameters

fingerprintKind int

The technique of fingerprint capture the YubiKey uses. The standard defines the value of 1 as touch type and 2 as swipe type.

maxCaptureCount int

The number of fingerprint captures needed to enroll a fingerprint.

maxFrienlyNameBytes int

The maximum number of bytes available to hold a template's friendly name.

Properties

FingerprintKind

The kind of fingerprint reader, that is, what method the fingerprint reader uses.

public int FingerprintKind { get; }

Property Value

int

Remarks

The value returned by the YubiKey is an integer. The standard defines what each integer means. Currently only two integers are defined: 1 for touch type sensor and 2 for swipe type sensor.

MaxCaptureCount

The number of "good" fingerprint captures required to enroll.

public int MaxCaptureCount { get; }

Property Value

int

Remarks

In order to enroll a fingerprint, it is necessary to provide the fingerprint. The reader will need several examples of the fingerprint, generally from a number of angles. Once it has MaxCaptureCount good examples, it will consider the fingerprint enrolled. If it cannot get enough "good" examples, it will not accept the fingerprint and will require the user to start over.

MaxFriendlyNameBytes

The maximum length, in bytes, of a template friendly name.

public int MaxFriendlyNameBytes { get; }

Property Value

int

Remarks

A "template" is one biometric entry: all the data the YubiKey stores for one fingerprint. The FIDO2 standard uses the word template because there could be several types of biometric entries, such as fingerprint, face, voice, or more. So one template is one entry. The friendly name can be "right-index" or "left-thumb".

With the SDK, you provide a friendly name as a string. Before it is stored, it is converted to UTF-8. The length, in bytes, of the friendly name is therefore the number of bytes in the UTF-8 array that is the converted string.