Class GetUvRetriesCommand

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

Gets the number of UV retries remaining for FIDO2.

public class GetUvRetriesCommand : IYubiKeyCommand<GetUvRetriesResponse>

Inheritance

object

GetUvRetriesCommand

Implements

IYubiKeyCommand<GetUvRetriesResponse>

Remarks

The number of UV attempts remaining may vary based the configured maximum and the number of failed attempts since the last successful verification. Use this command to query for the current number of retries remaining for this specific YubiKey.

The number of remaining UV attempts should also be displayed to the user, so that they know that they may be reaching the limit. Exhausting the number of UV retries is not as catastrophic as exhausting the number of PIN attempts. When the number of UV retries reaches 0, the authenticator will no longer attempt UV with the on-board sensor, and will instead require PIN entry. Once the PIN has been successfully entered, the UV retry count will be reset - even if it was previous blocked.

See the user manual entry on PIN protocols for a much more in depth guide to working with user verification within FIDO2.

Constructors

GetUvRetriesCommand()

Constructs a new instance of GetUvRetriesCommand.

public GetUvRetriesCommand()

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 GetUvRetriesResponse CreateResponseForApdu(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

GetUvRetriesResponse

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