Table of Contents

Class BioEnrollBeginResponse

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

The response partner to the GetBioModalityCommand, containing information about the biometric technique of the YubiKey.

public class BioEnrollBeginResponse : Fido2Response, IYubiKeyResponseWithData<BioEnrollSampleResult>, IYubiKeyResponse
Inheritance
object
BioEnrollBeginResponse
Implements
Inherited Members

Constructors

BioEnrollBeginResponse(ResponseApdu)

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

public BioEnrollBeginResponse(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

A response APDU containing the CBOR response data for the authenticatorBioEnrollment command.

Properties

StatusCodeMap

Overridden to modify the messages associated with certain status words. The messages match the status words' meanings as described in the FIDO2 specifications.

protected override YubiKeyResponse.ResponseStatusPair StatusCodeMap { get; }

Property Value

YubiKeyResponse.ResponseStatusPair

Methods

GetData()

Gets the data from the YubiKey response.

public BioEnrollSampleResult GetData()

Returns

BioEnrollSampleResult

The data returned by the YubiKey, presented in a manner specific to each implementation.

Remarks

If the method cannot return the data, it will throw an exception. This happens when the Status property indicates an error, or the data returned from the YubiKey was malformed or incomplete.

For example, 

IYubiKeyConnection connection = key.Connect(YubiKeyApplication.Piv);
GetDataCommand getDataCommand = new GetDataCommand(PivDataTag.Chuid);
GetDataResponse getDataResponse = connection.SendCommand(getDataCommand);
if (getDataResponse.Status == ResponseStatus.Success)
{
    byte[] getChuid = getDataResponse.GetData();
}