Table of Contents

Class RenameCommand

Namespace
Yubico.YubiKey.Oath.Commands
Assembly
Yubico.YubiKey.dll

Renames an existing credential by setting new issuer and account names. This command is only available on the YubiKeys with firmware version 5.3.0 and later. 

public class RenameCommand : IYubiKeyCommand<RenameResponse>
Inheritance
object
RenameCommand
Implements

Constructors

RenameCommand()

Constructs an instance of the RenameCommand class.

public RenameCommand()

RenameCommand(Credential, string?, string)

Constructs an instance of the RenameCommand class.

public RenameCommand(Credential credential, string? newIssuer, string newAccount)

Parameters

credential Credential

The credential to edit.

newIssuer string

The new issuer.

newAccount string

The new account name.

Exceptions

ArgumentNullException

The credential to rename is null, or the new account name to set is null, empty or consists only of white-space characters.

Properties

Application

Gets the YubiKeyApplication to which this command belongs.

public YubiKeyApplication Application { get; }

Property Value

YubiKeyApplication

YubiKeyApplication.Oath

Credential

The credential to edit.

public Credential? Credential { get; set; }

Property Value

Credential

NewAccount

The new account name.

public string? NewAccount { get; set; }

Property Value

string

NewIssuer

The new issuer.

public string? NewIssuer { get; set; }

Property Value

string

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

RenameResponse

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