Package com.yubico.yubikit.management

Class DeviceInfo

java.lang.Object
com.yubico.yubikit.management.DeviceInfo
public class DeviceInfo extends Object
Contains metadata, including Device Configuration, of a YubiKey.

  • 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 with DeviceInfo.Builder.build().
      Constructs a new DeviceInfo.
      Parameters:
      config - the mutable configuration of the YubiKey
      serialNumber - the YubiKeys serial number
      version - the firmware version of the YubiKey
      formFactor - the YubiKeys physical form factor
      supportedCapabilities - the capabilities supported by the YubiKey
      isLocked - whether or not the configuration is protected by a lock code
      isFips - whether or not the YubiKey is a FIPS model
      isSky - 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

      public DeviceConfig getConfig()
      Returns the current Device configuration of the YubiKey.

    • getSerialNumber

      @Nullable public Integer 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.

    • getVersionName

      public String getVersionName()
      Returns the version of the YubiKey firmware.

    • getFormFactor

      public FormFactor 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

    • getPartNumber

      @Nullable public String getPartNumber()
      Returns part number

    • getFipsCapable

      public int getFipsCapable()
      Returns FIPS capable flags

    • getFipsApproved

      public int getFipsApproved()
      Returns FIPS approved flags

    • getPinComplexity

      public boolean getPinComplexity()
      Returns value of PIN complexity

    • getResetBlocked

      public int getResetBlocked()
      Returns reset blocked flags

    • getFpsVersion

      @Nullable public com.yubico.yubikit.core.Version getFpsVersion()
      Returns FPS version

    • getStmVersion

      @Nullable public com.yubico.yubikit.core.Version getStmVersion()
      Returns STM version

    • getVersionQualifier

      public VersionQualifier getVersionQualifier()
      Returns version qualifier

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object