Table of Contents

Class BaseYubiHsmAuthResponseWithRetries

Namespace
Yubico.YubiKey.YubiHsmAuth.Commands
Assembly
Yubico.YubiKey.dll

The base class of YubiHSM Auth response types that are paired with commands that require authentication.

public abstract class BaseYubiHsmAuthResponseWithRetries : BaseYubiHsmAuthResponse, IYubiKeyResponse
Inheritance
object
BaseYubiHsmAuthResponseWithRetries
Implements
Derived
Inherited Members

Remarks

Some commands require authentication with either the management key or a credential password. There is a limit to the number of retries that are allowed. In the event that authentication fails, this class will return the number of retries remaining.

Constructors

BaseYubiHsmAuthResponseWithRetries(ResponseApdu) 

protected BaseYubiHsmAuthResponseWithRetries(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

Properties

RetriesRemaining

The number of retries remaining after failing to authenticate.

public int? RetriesRemaining { get; }

Property Value

int?

Remarks

If the command failed to authenticate, the Status is set to AuthenticationRequired, and this property returns the number of retries remaining. Otherwise this property returns null.

This property represents the retries remaining on either the management key or a credential password. Refer to the implementing class's documentation for more information.

StatusCodeMap

Retrieves the details describing the processing state.

protected override YubiKeyResponse.ResponseStatusPair StatusCodeMap { get; }

Property Value

YubiKeyResponse.ResponseStatusPair

The ResponseStatus and a descriptive message, as a YubiKeyResponse.ResponseStatusPair.

Remarks

Implementers of subtypes can override this member to change or add mappings.

StatusWordContainsRetries

Checks whether the status word contains a retry count.

protected bool StatusWordContainsRetries { get; }

Property Value

bool

Remarks

Use RetriesRemaining to get the value.