Table of Contents

Class GetBioMetadataCommand

Namespace
Yubico.YubiKey.Piv.Commands
Assembly
Yubico.YubiKey.dll

Get information about a YubiKey Bio multi-protocol key.

public sealed class GetBioMetadataCommand : IYubiKeyCommand<GetBioMetadataResponse>
Inheritance
object
GetBioMetadataCommand
Implements

Remarks

The GetBioMetadataCommand is available on YubiKey Bio multi-protocol keys.

The partner Response class is GetBioMetadataResponse.

See the User's Manual entry on getting bio metadata for specific information about what information is returned.

Example: 

IYubiKeyConnection connection = key.Connect(YubiKeyApplication.Piv);
GetBioMetadataCommand command = new GetBioMetadataCommand();
GetBioMetadataResponse response = connection.SendCommand(command);
if (response.Status == ResponseStatus.Success)
{
    PivBioMetadata data = response.GetData();
}

Constructors

GetBioMetadataCommand()

Initializes a new instance of the GetBioMetadataCommand class.

public GetBioMetadataCommand()

Properties

Application

Gets the YubiKeyApplication to which this command belongs. For this command it's PIV.

public YubiKeyApplication Application { get; }

Property Value

YubiKeyApplication

YubiKeyApplication.Piv

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

GetBioMetadataResponse

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