Package com.yubico.yubikit.management
Class DeviceInfo
java.lang.Object
com.yubico.yubikit.management.DeviceInfo
Contains metadata, including Device Configuration, of a YubiKey.
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionDeviceInfo
(DeviceConfig config, Integer serialNumber, com.yubico.yubikit.core.Version version, FormFactor formFactor, Map<com.yubico.yubikit.core.Transport, Integer> supportedCapabilities, boolean isLocked) Deprecated.DeviceInfo
(DeviceConfig config, Integer serialNumber, com.yubico.yubikit.core.Version version, FormFactor formFactor, Map<com.yubico.yubikit.core.Transport, Integer> supportedCapabilities, boolean isLocked, boolean isFips, boolean isSky) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionReturns the current Device configuration of the YubiKey.Returns the form factor of the YubiKey.boolean
Returns value of PIN complexityReturns the serial number of the YubiKey, if available.int
getSupportedCapabilities
(com.yubico.yubikit.core.Transport transport) Returns the supported (not necessarily enabled) capabilities for a given transport.com.yubico.yubikit.core.Version
Returns the version number of the YubiKey firmware.boolean
hasTransport
(com.yubico.yubikit.core.Transport transport) Returns whether or not a specific transport is available on this YubiKey.boolean
isFips()
Returns whether or not this is a FIPS compliant deviceboolean
isLocked()
Returns whether or not a Configuration Lock is set for the Management application on the YubiKey.boolean
isSky()
Returns whether or not this is a Security keytoString()
-
Constructor Details
-
DeviceInfo
@Deprecated public DeviceInfo(DeviceConfig config, @Nullable Integer serialNumber, com.yubico.yubikit.core.Version version, FormFactor formFactor, Map<com.yubico.yubikit.core.Transport, Integer> supportedCapabilities, boolean isLocked, boolean isFips, boolean isSky) Deprecated.Replaced withDeviceInfo.Builder.build()
.Constructs a new DeviceInfo.- Parameters:
config
- the mutable configuration of the YubiKeyserialNumber
- the YubiKeys serial numberversion
- the firmware version of the YubiKeyformFactor
- the YubiKeys physical form factorsupportedCapabilities
- the capabilities supported by the YubiKeyisLocked
- whether or not the configuration is protected by a lock codeisFips
- whether or not the YubiKey is a FIPS modelisSky
- whether or not the YubiKey is a Security Key by Yubico model
-
DeviceInfo
@Deprecated public DeviceInfo(DeviceConfig config, @Nullable Integer serialNumber, com.yubico.yubikit.core.Version version, FormFactor formFactor, Map<com.yubico.yubikit.core.Transport, Integer> supportedCapabilities, boolean isLocked) Deprecated.Legacy constructor, retained for backwards compatibility until 3.0.0.
-
-
Method Details
-
getConfig
Returns the current Device configuration of the YubiKey. -
getSerialNumber
Returns the serial number of the YubiKey, if available.The serial number can be read if the YubiKey has a serial number, and one of the YubiOTP slots is configured with the SERIAL_API_VISIBLE flag.
-
getVersion
public com.yubico.yubikit.core.Version getVersion()Returns the version number of the YubiKey firmware. -
getFormFactor
Returns the form factor of the YubiKey. -
hasTransport
public boolean hasTransport(com.yubico.yubikit.core.Transport transport) Returns whether or not a specific transport is available on this YubiKey. -
getSupportedCapabilities
public int getSupportedCapabilities(com.yubico.yubikit.core.Transport transport) Returns the supported (not necessarily enabled) capabilities for a given transport. -
isLocked
public boolean isLocked()Returns whether or not a Configuration Lock is set for the Management application on the YubiKey. -
isFips
public boolean isFips()Returns whether or not this is a FIPS compliant device -
isSky
public boolean isSky()Returns whether or not this is a Security key -
getPinComplexity
public boolean getPinComplexity()Returns value of PIN complexity -
toString
-
DeviceInfo.Builder.build()
.