Class UpdateSlotCommand

Namespace

Yubico.YubiKey.Otp.Commands

Assembly

Yubico.YubiKey.dll

Applies a subset of configurable flags to one of the two OTP slots.

public class UpdateSlotCommand : SlotConfigureBase, IYubiKeyCommand<ReadStatusResponse>

Inheritance

object

SlotConfigureBase

UpdateSlotCommand

Implements

IYubiKeyCommand<ReadStatusResponse>

Inherited Members

SlotConfigureBase.FixedDataOffset

SlotConfigureBase.UidOffset

SlotConfigureBase.AesKeyOffset

SlotConfigureBase.AccessCodeOffset

SlotConfigureBase.FixedSizeOffset

SlotConfigureBase.ExtendedFlagsOffset

SlotConfigureBase.TicketFlagsOffset

SlotConfigureBase.ConfigurationFlagsOffset

SlotConfigureBase.ReservedOffset

SlotConfigureBase.CrcOffset

SlotConfigureBase.CurrentAccessCodeOffset

SlotConfigureBase.ConfigurationStructSize

SlotConfigureBase.ConfigurationBuffer

SlotConfigureBase.CalculateCrc

SlotConfigureBase.OtpSlot

SlotConfigureBase.Application

SlotConfigureBase.ApplyCurrentAccessCode(ReadOnlySpan<byte>)

SlotConfigureBase.SetAccessCode(ReadOnlySpan<byte>)

SlotConfigureBase.YubiKeyFlags

SlotConfigureBase.CreateCommandApdu()

SlotConfigureBase.Clear()

SlotConfigureBase.CreateResponseForApdu(ResponseApdu)

Properties

ConfigurationFlags

Flags that define the mode and other configurable options for this slot.

public override ConfigurationFlags ConfigurationFlags { get; set; }

Property Value

ConfigurationFlags

Remarks

Use10msPacing	Add an inter-character pacing time of 10ms between keystrokes.
Use20msPacing	Add an inter-character pacing time of 20ms between keystrokes.

Exceptions

InvalidOperationException

Thrown if an invalid flag set is specified.

ExtendedFlags

Extended flags that control behaviors on either a slot or global basis.

public override ExtendedFlags ExtendedFlags { get; set; }

Property Value

ExtendedFlags

Remarks

AllowUpdate	Allows certain non-security related flags to be modified after the configuration has been written.
Dormant	Allows a configuration to be stored without being accessible.
FastTrigger	Causes the trigger action of the YubiKey button to become faster.
InvertLed	Inverts the configured state of the LED.
SerialNumberApiVisible	Allows the serial number to be read by proprietary means, including being visible to the Yubico.YubiKey SDK.
SerialNumberButtonVisible	Allows the serial number to be retrieved by holding the touch button while inserting the device into the USB port.
SerialNumberUsbVisible	Makes the serial number appear in the YubiKey's USB descriptor's iSerialNumber field.
UseNumericKeypad	Causes numeric characters to be sent as keystrokes from the numeric keypad rather than the normal numeric keys on an 84-key keyboard.

The AllowUpdate flag must be present if the slot is to remain updatable. Failure to set this flag will effectively make the configuration read-only, until a brand new, unrelated configuration overwrites it.

Exceptions

InvalidOperationException

Thrown if an invalid flag set is specified.

LongPressCode

The code to use for indicating the long-press OTP slot.

protected override byte LongPressCode { get; }

Property Value

byte

ShortPressCode

The code to use for indicating the short-press OTP slot.

protected override byte ShortPressCode { get; }

Property Value

byte

TicketFlags

Flags that control the output format of the text returned by the YubiKey button press.

public override TicketFlags TicketFlags { get; set; }

Property Value

TicketFlags

Remarks

Exceptions

InvalidOperationException

Thrown if an invalid flag set is specified.