Show / Hide Table of Contents

GetUvRetriesCommand Class

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

Gets the number of UV retries remaining for FIDO2.

C#
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

Name Description
GetUvRetriesCommand()

Constructs a new instance of GetUvRetriesCommand.

Properties

Name Description
Application

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

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.

In this article
Back to top Generated by DocFX