Class GetAssertionCommand

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

Instruct the YubiKey to get an assertion based on the input parameters.

public class GetAssertionCommand : IYubiKeyCommand<GetAssertionResponse>

Inheritance

object

GetAssertionCommand

Implements

IYubiKeyCommand<GetAssertionResponse>

Constructors

GetAssertionCommand(GetAssertionParameters)

Constructs an instance of the GetAssertionCommand class using the given parameters.

public GetAssertionCommand(GetAssertionParameters getAssertionParameters)

Parameters

getAssertionParameters GetAssertionParameters

An object containing all the parameters the YubiKey will use to get an assertion.

Remarks

This class will copy a reference to the input parameters object. It will no longer need it after the call to SendCommand.

Properties

Application

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

public YubiKeyApplication Application { get; }

Property Value

YubiKeyApplication

YubiKeyApplication.Otp, YubiKeyApplication.Piv, etc.

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

GetAssertionResponse

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