Table of Contents

Class PutCommand

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

Adds or overwrites an OATH credential.

public class PutCommand : IYubiKeyCommand<OathResponse>
Inheritance
object
PutCommand
Implements

Constructors

PutCommand()

Constructs an instance of the PutCommand class.

public PutCommand()

PutCommand(Credential)

Constructs an instance of the PutCommand class.

public PutCommand(Credential credential)

Parameters

credential Credential

The credential to add or overwrite.

Exceptions

ArgumentNullException

The credential is null.

Properties

Application

Gets the YubiKeyApplication to which this command belongs.

public YubiKeyApplication Application { get; }

Property Value

YubiKeyApplication

YubiKeyApplication.Oath

Credential

The credential to add or overwrite.

public Credential? Credential { get; set; }

Property Value

Credential

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

Parameters

responseApdu ResponseApdu

The ResponseApdu returned by the YubiKey.

Returns

OathResponse

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