Interface IYubiKeyDeviceInfo
Detailed device and capabilities information for a YubiKey.
public interface IYubiKeyDeviceInfoProperties
AutoEjectTimeout
The CCID auto-eject timeout (in seconds).
int AutoEjectTimeout { get; }Property Value
- int
Remarks
This field is only meaningful if TouchEject in
DeviceFlags is set. A value of 0 means that the timeout
is disabled (the smart card will not be ejected automatically).
The range is ushort.MinValue through ushort.MaxValue.
AvailableNfcCapabilities
The paid-for YubiKey features that are available over NFC.
YubiKeyCapabilities AvailableNfcCapabilities { get; }Property Value
AvailableUsbCapabilities
The paid-for YubiKey features that are available over USB (and Lightning).
YubiKeyCapabilities AvailableUsbCapabilities { get; }Property Value
ChallengeResponseTimeout
The period of time (in seconds) after which the OTP challenge-response command should timeout.
byte ChallengeResponseTimeout { get; }Property Value
- byte
Remarks
The default value for the timeout is 15 seconds.
ConfigurationLocked
Indicates whether or not the YubiKey's configuration has been locked by the user.
bool ConfigurationLocked { get; }Property Value
- bool
DeviceFlags
Device flags that can control device-global behavior.
DeviceFlags DeviceFlags { get; }Property Value
EnabledNfcCapabilities
The NFC features that are currently enabled over NFC.
YubiKeyCapabilities EnabledNfcCapabilities { get; }Property Value
EnabledUsbCapabilities
The USB features that are currently enabled over USB (and Lightning).
YubiKeyCapabilities EnabledUsbCapabilities { get; }Property Value
FipsApproved
The set of YubiKey applications that are currently configured to meet FIPS requirements.
YubiKeyCapabilities FipsApproved { get; }Property Value
FipsCapable
The set of YubiKey applications that are capable of being put into FIPS mode.
YubiKeyCapabilities FipsCapable { get; }Property Value
FirmwareVersion
The version of the firmware currently running on the YubiKey.
FirmwareVersion FirmwareVersion { get; }Property Value
FormFactor
The form-factor of the YubiKey.
FormFactor FormFactor { get; }Property Value
ImageProcessorVersion
The version of the chip/firmware performing the image processing. If
there is no image processing chip, this will be null.
ImageProcessorVersion? ImageProcessorVersion { get; }Property Value
IsFipsSeries
Indicates whether or not the YubiKey is a FIPS Series device.
bool IsFipsSeries { get; }Property Value
- bool
Remarks
When using a YubiKey FIPS Series device as an authenticator in a FIPS environment, all of the sub-modules must be in a FIPS approved mode of operation for the YubiKey FIPS Series device as a whole to be considered as operating in a FIPS approved mode. This value does not determine whether the YubiKey is in a FIPS approved mode.
IsNfcRestricted
Indicates if the NFC connectivity on the device is temporarily disabled
bool IsNfcRestricted { get; }Property Value
- bool
IsPinComplexityEnabled
Whether or not pin complexity is enabled on the Yubikey. For more information see this documentation on pin complexity
bool IsPinComplexityEnabled { get; }Property Value
- bool
IsSkySeries
Indicates whether or not this device is a "Security Key by Yubico" series device.
bool IsSkySeries { get; }Property Value
- bool
Remarks
Security Key Series devices only support the U2F and FIDO2 applications. This property helps differentiate these devices from a standard YubiKey that only has these two applications enabled.
PartNumber
The part number for the Secure Element processor, if available, otherwise null
string? PartNumber { get; }Property Value
- string
ResetBlocked
The set of YubiKey applications that are blocked from being reset.
YubiKeyCapabilities ResetBlocked { get; }Property Value
SerialNumber
The serial number of the YubiKey, if one is present.
int? SerialNumber { get; }Property Value
- int?
TemplateStorageVersion
The version of the chip/firmware storing the fingerprints (the second
secure element). If there is no template storage chip, this will be
null.
TemplateStorageVersion? TemplateStorageVersion { get; }