BioEnrollmentCommand Class

Namespace: Yubico.YubiKey.Fido2.Commands Assembly: Yubico.YubiKey.dll

The BioEnrollmentCommand is the class for authenticatorBioEnrollment. This command has a number of subcommands, each of which is represented by its own class.

C#

public class BioEnrollmentCommand : Object, IYubiKeyCommand<BioEnrollmentResponse>

Inheritance System.Object BioEnrollmentCommand

Implements

IYubiKeyCommand<BioEnrollmentResponse>

Remarks

The authenticatorBioEnrollment (0x09) FIDO2 command can be thought of as a "meta" command. That is, it provides the structure and mechanism for performing a number of subcommands. These subcommands are:

- enrollBegin (0x01)
- enrollCaptureNextSample (0x02)
- cancelCurrentEnrollment (0x03)
- enumerateEnrollments (0x04)
- setFriendlyName (0x05)
- removeEnrollment (0x06)
- getFingerprintSensorInfo (0x07)

Since the SDK does not have the concept of a subcommand natively, these are all exposed as their own separate commands.

See the user manual entry on Bio Enrollment for a more in depth guide to enrolling fingerprints within FIDO2. For more information on a particular subcommand, see the API reference documentation for that command class.

Some of the subcommands return data (e.g. a template ID), others return only a success or failure response code.

Constructors

Name	Description
BioEnrollmentCommand()	This constructor will throw NotImplementedException. It is the default constructor explicitly defined. We don't want it to be used. It is made protected rather than private because there are subclasses.
BioEnrollmentCommand(Int32)	Constructs a new instance of BioEnrollmentCommand.
BioEnrollmentCommand(Int32, Byte[], ReadOnlyMemory<Byte>, PinUvAuthProtocolBase)	Constructs a new instance of BioEnrollmentCommand.

Properties

Name	Description
Application	Gets the YubiKeyApplication (e.g. PIV, OATH, etc.) to which this command applies.
PinUvAuthParam	The output of calling authenticate on the PIN/UV protocol specific to a particular subcommand.
PinUvAuthProtocol	The PIN/UV protocol version chosen by the platform.
SubCommand	The BioEnrollment subcommand to issue to the YubiKey.
SubCommandParameters	The encoded params for the specified subcommand. If a subcommand has no parameters, this will be null.

Methods

Name	Description
CreateCommandApdu()	Creates a well-formed CommandApdu to send to the YubiKey.
CreateResponseForApdu(ResponseApdu)	Creates the corresponding IYubiKeyResponse implementation for the current command.