Class GetPinRetriesResponse

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

This is the partner response class to the GetPinRetriesCommand command class.

public class GetPinRetriesResponse : Fido2Response, IYubiKeyResponseWithData<(int retriesRemaining, bool? powerCycleRequired)>, IYubiKeyResponse

Inheritance

object

YubiKeyResponse

Fido2Response

GetPinRetriesResponse

Implements

IYubiKeyResponseWithData<(int retriesRemaining, bool? powerCycleRequired)>

IYubiKeyResponse

Inherited Members

Fido2Response.CtapStatus

Fido2Response.StatusCodeMap

YubiKeyResponse.ResponseApdu

YubiKeyResponse.Status

YubiKeyResponse.StatusWord

YubiKeyResponse.StatusMessage

YubiKeyResponse.ToString()

Constructors

GetPinRetriesResponse(ResponseApdu)

Constructs a new instance of the GetPinRetriesResponse class based on a response APDU provided by the YubiKey.

public GetPinRetriesResponse(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

A response APDU containing the CBOR response for the getPINRetries subcommand of the authenticatorClientPIN CTAP2 command.

Methods

GetData()

Returns the number of PIN retries remaining for this YubiKey's FIDO application, and if a reboot of the YubiKey is required.

public (int retriesRemaining, bool? powerCycleRequired) GetData()

Returns

(int retriesRemaining, bool? powerCycleRequired)

An int/boolean pair. The int is the number of retries remaining, and the boolean (if not null), indicates whether the YubiKey needs to be power-cycled (removed and reinserted) in order to try verifying the PIN again. If the boolean is null, then that is equivalent to false (power-cycle not required).

Remarks

The powerCycleRequired value returned can have three states: true if the YubiKey needs to be power- cycled (rebooted), false if it does not, and null if this information could not be determined.