Table of Contents

Class BioEnrollSetFriendlyNameCommand

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

Set the friendly name of an enrolled fingerprint. If there is a friendly name already, this replaces it. This is a subcommand of the CTAP command "authenticatorBioEnrollment".

public sealed class BioEnrollSetFriendlyNameCommand : IYubiKeyCommand<Fido2Response>
Inheritance
object
BioEnrollSetFriendlyNameCommand
Implements

Remarks

The partner Response class is Fido2Response. This command does not return any data, it only returns "success" or "failure", and has some FIDO2-specific error information.

Constructors

BioEnrollSetFriendlyNameCommand() 

public BioEnrollSetFriendlyNameCommand()

BioEnrollSetFriendlyNameCommand(ReadOnlyMemory<byte>, string, ReadOnlyMemory<byte>, PinUvAuthProtocolBase)

Constructs an instance of the BioEnrollSetFriendlyNameCommand class.

public BioEnrollSetFriendlyNameCommand(ReadOnlyMemory<byte> templateId, string friendlyName, ReadOnlyMemory<byte> pinUvAuthToken, PinUvAuthProtocolBase authProtocol)

Parameters

templateId ReadOnlyMemory<byte>

The ID of the fingerprint template for which the friendly name is being set.

friendlyName string

The name that will be associated with the template.

pinUvAuthToken ReadOnlyMemory<byte>

The PIN/UV Auth Token built from the PIN. This is the encrypted token key.

authProtocol PinUvAuthProtocolBase

The Auth Protocol used to build the Auth Token.

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

Fido2Response

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