Struct ExtendedFlags

Namespace

Yubico.YubiKey.Otp

Assembly

Yubico.YubiKey.dll

Extended properties and configuration settings.

public struct ExtendedFlags

Fields

AllowUpdate

Allows certain non-security related flags to be modified after the configuration has been written.

public const byte AllowUpdate = 32

Field Value

byte

Dormant

Allows a configuration to be stored without being accessible.

public const byte Dormant = 64

Field Value

byte

FastTrigger

Causes the trigger action of the YubiKey button to become faster.

public const byte FastTrigger = 16

Field Value

byte

Remarks

It only applies when one configuration is written. If both configurations are set, this flag has no effect.

InvertLed

Inverts the configured state of the LED.

public const byte InvertLed = 128

Field Value

byte

None

No extended flags are requested for this configuration.

public const byte None = 0

Field Value

byte

SerialNumberApiVisible

Allows the serial number to be read by proprietary means, including being visible to the Yubico.YubiKey SDK.

public const byte SerialNumberApiVisible = 4

Field Value

byte

Remarks

This flag is a device wide setting. If it is set in either configurable slot, it is considered enabled by the device.

SerialNumberButtonVisible

Allows the serial number to be retrieved by holding the touch button while inserting the device into the USB port.

public const byte SerialNumberButtonVisible = 1

Field Value

byte

Remarks

Once the LED starts to flash, release the button and the serial number will then be sent as a string of digits. This flag is a device wide setting. If it is set in either configurable slot, it is considered enabled by the device.

SerialNumberUsbVisible

Makes the serial number appear in the YubiKey's USB descriptor's iSerialNumber field.

public const byte SerialNumberUsbVisible = 2

Field Value

byte

Remarks

Note that this makes each device unique from the host computer's view. This flag is a device wide setting. If it is set in either configurable slot, it is considered enabled by the device.

UseNumericKeypad

Causes numeric characters to be sent as keystrokes from the numeric keypad rather than the normal numeric keys on an 84-key keyboard.

public const byte UseNumericKeypad = 8

Field Value

byte

Methods

ValidateFlagsForUpdate()

Ensure that no flags are set that cannot be used to update an existing configuration.

public void ValidateFlagsForUpdate()

Operators

implicit operator ExtendedFlags(byte)

Implicitly convert a byte to a ExtendedFlags object.

public static implicit operator ExtendedFlags(byte b)

Parameters

b byte

A byte containing the flags.

Returns

ExtendedFlags

implicit operator byte(ExtendedFlags)

Implicitly convert ExtendedFlags to a byte.

public static implicit operator byte(ExtendedFlags flags)

Parameters

flags ExtendedFlags

Flag object to convert.

Returns

byte