Class AuthenticatorSelectionCommand

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

Requests User Presence (UP) on the connected YubiKey so the user may indicate their intention to use the YubiKey by touching it. This method can be useful in situations where a user has more than one YubiKey and the application needs to determine which key to use for a subsequent FIDO2 operation.

public sealed class AuthenticatorSelectionCommand : IYubiKeyCommand<AuthenticatorSelectionResponse>

Inheritance

object

AuthenticatorSelectionCommand

Implements

IYubiKeyCommand<AuthenticatorSelectionResponse>

Remarks

The partner response class is AuthenticatorSelectionResponse. Specified in CTAP 2.1 §6.9 as authenticatorSelection (command byte 0x0B). Supported by YubiKey firmware 5.5.1 and later. There are no command parameters. Whether the authenticator implements this command is firmware-specific; unsupported devices typically return InvalidCommand.

Constructors

AuthenticatorSelectionCommand()

Constructs an instance of the AuthenticatorSelectionCommand class.

public AuthenticatorSelectionCommand()

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

AuthenticatorSelectionResponse

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