Class BioEnrollBeginCommand

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

Begins the process of enrolling a fingerprint. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

public sealed class BioEnrollBeginCommand : IYubiKeyCommand<BioEnrollBeginResponse>

Inheritance

object

BioEnrollBeginCommand

Implements

IYubiKeyCommand<BioEnrollBeginResponse>

Remarks

The partner Response class is BioEnrollBeginResponse.

Constructors

BioEnrollBeginCommand(int?, ReadOnlyMemory<byte>, PinUvAuthProtocolBase)

Constructs a new instance of BioEnrollBeginCommand.

public BioEnrollBeginCommand(int? timeoutMilliseconds, ReadOnlyMemory<byte> pinUvAuthToken, PinUvAuthProtocolBase authProtocol)

Parameters

timeoutMilliseconds int?

The timeout the caller would like the YubiKey to enforce. This is optional and can be null.

pinUvAuthToken ReadOnlyMemory<byte>

The PIN/UV Auth Token built from the PIN. This is the encrypted token key.

authProtocol PinUvAuthProtocolBase

The Auth Protocol used to build the Auth Token.

Properties

Application

Gets the YubiKeyApplication (e.g. PIV, OATH, etc.) to which this command applies.

public YubiKeyApplication Application { get; }

Property Value

YubiKeyApplication

YubiKeyApplication.Otp, YubiKeyApplication.Piv, etc.

Methods

CreateCommandApdu()

Creates a well-formed CommandApdu to send to the YubiKey.

public CommandApdu CreateCommandApdu()

Returns

CommandApdu

A valid CommandApdu that is ready to be sent to the YubiKey, or passed along to additional encoders for further processing.

Remarks

This method will first perform validation on all of the parameters and data provided to it. The CommandAPDU it creates should contain all of the data payload for the command, even if it exceeds 65,535 bytes as specified by the ISO 7816-4 specification. The APDU will be properly chained by the device connection prior to being sent to the YubiKey, and the responses will collapsed into a single result.

CreateResponseForApdu(ResponseApdu)

Creates the corresponding IYubiKeyResponse implementation for the current command.

public BioEnrollBeginResponse CreateResponseForApdu(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

BioEnrollBeginResponse

The implementation of IYubiKeyResponse that parses and presents ths response APDU.