Index (management 2.7.0 API)

A B C D E F G H I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values

A

autoEjectTimeout(short) - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Sets the timeout used when the YubiKey is in CCID-only mode with DeviceConfig.FLAG_EJECT set.

B

bit - Variable in enum class com.yubico.yubikit.management.Capability
build() - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Constructs a DeviceConfig using the current configuration.
build() - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
Builder() - Constructor for class com.yubico.yubikit.management.DeviceConfig.Builder
Builder() - Constructor for class com.yubico.yubikit.management.DeviceInfo.Builder

C

Capability - Enum Class in com.yubico.yubikit.management: Identifies a feature (typically an application) on a YubiKey which may or may not be supported, and which can be enabled or disabled.
CCID - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
CCID - Static variable in class com.yubico.yubikit.management.UsbInterface: Deprecated.
challengeResponseTimeout(byte) - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Sets the timeout used by the YubiOTP application, when waiting for a user presence check (physical touch).
close() - Method in class com.yubico.yubikit.management.ManagementSession
com.yubico.yubikit.management - package com.yubico.yubikit.management
config(DeviceConfig) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
create(YubiKeyDevice, Callback<Result<ManagementSession, Exception>>) - Static method in class com.yubico.yubikit.management.ManagementSession: Connects to a YubiKeyDevice and establishes a new session with a YubiKeys Management application.

D

DeviceConfig - Class in com.yubico.yubikit.management: Describes the configuration of a YubiKey which can be altered via the Management application.
DeviceConfig.Builder - Class in com.yubico.yubikit.management: Builder class for use with ManagementSession.updateDeviceConfig(com.yubico.yubikit.management.DeviceConfig, boolean, byte[], byte[]) when altering the device configuration.
deviceFlags(int) - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Sets the Device flags of the YubiKey.
DeviceInfo - Class in com.yubico.yubikit.management: Contains metadata, including Device Configuration, of a YubiKey.
DeviceInfo(DeviceConfig, Integer, Version, FormFactor, Map<Transport, Integer>, boolean) - Constructor for class com.yubico.yubikit.management.DeviceInfo: Deprecated.
DeviceInfo(DeviceConfig, Integer, Version, FormFactor, Map<Transport, Integer>, boolean, boolean, boolean) - Constructor for class com.yubico.yubikit.management.DeviceInfo: Deprecated.
Replaced with DeviceInfo.Builder.build().
DeviceInfo.Builder - Class in com.yubico.yubikit.management
deviceReset() - Method in class com.yubico.yubikit.management.ManagementSession: Perform a device-wide reset in Bio Multi-protocol Edition devices.

E

enabledCapabilities(Transport, int) - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Sets the enabled capabilities for the given transport.
equals(Object) - Method in class com.yubico.yubikit.management.DeviceConfig
equals(Object) - Method in class com.yubico.yubikit.management.DeviceInfo

F

FEATURE_DEVICE_CONFIG - Static variable in class com.yubico.yubikit.management.ManagementSession: Support for writing DeviceConfig data to the YubiKey.
FEATURE_DEVICE_INFO - Static variable in class com.yubico.yubikit.management.ManagementSession: Support for reading the DeviceInfo data from the YubiKey.
FEATURE_DEVICE_RESET - Static variable in class com.yubico.yubikit.management.ManagementSession: Support for device-wide reset.
FEATURE_MODE - Static variable in class com.yubico.yubikit.management.ManagementSession: Support the SET_MODE command to change the USB mode of the YubiKey.
FIDO - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
FIDO - Static variable in class com.yubico.yubikit.management.UsbInterface: Deprecated.
FIDO_CCID - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
FIDO2 - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the FIDO2 (CTAP2) portion of the FIDO application.
fipsApproved(int) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
fipsCapable(int) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
FLAG_EJECT - Static variable in class com.yubico.yubikit.management.DeviceConfig: In pure CCID mode eject/inject the card with the button.
FLAG_REMOTE_WAKEUP - Static variable in class com.yubico.yubikit.management.DeviceConfig: Enables remote wakeup.
formFactor(FormFactor) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
FormFactor - Enum Class in com.yubico.yubikit.management: The physical form factor of a YubiKey.
fpsVersion(Version) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder

G

getAutoEjectTimeout() - Method in class com.yubico.yubikit.management.DeviceConfig: Returns the timeout used when in CCID-only mode with DeviceConfig.FLAG_EJECT enabled.
getChallengeResponseTimeout() - Method in class com.yubico.yubikit.management.DeviceConfig: Returns the timeout value used by the YubiOTP application when waiting for a user presence check (physical touch).
getConfig() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns the current Device configuration of the YubiKey.
getDeviceFlags() - Method in class com.yubico.yubikit.management.DeviceConfig: Returns the device flags that are set.
getDeviceInfo() - Method in class com.yubico.yubikit.management.ManagementSession: Get device information from the YubiKey.
getEnabledCapabilities(Transport) - Method in class com.yubico.yubikit.management.DeviceConfig: Get the currently enabled capabilities for a given Interface.
getFipsApproved() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns FIPS approved flags
getFipsCapable() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns FIPS capable flags
getFormFactor() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns the form factor of the YubiKey.
getFpsVersion() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns FPS version
getMode(int) - Static method in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
getNfcRestricted() - Method in class com.yubico.yubikit.management.DeviceConfig: Returns the NFC restricted flag.
getPartNumber() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns part number
getPinComplexity() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns value of PIN complexity
getResetBlocked() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns reset blocked flags
getSerialNumber() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns the serial number of the YubiKey, if available.
getStmVersion() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns STM version
getSupportedCapabilities(Transport) - Method in class com.yubico.yubikit.management.DeviceInfo: Returns the supported (not necessarily enabled) capabilities for a given transport.
getVersion() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns the version number of the YubiKey firmware.
getVersion() - Method in class com.yubico.yubikit.management.ManagementSession

H

hashCode() - Method in class com.yubico.yubikit.management.DeviceConfig
hashCode() - Method in class com.yubico.yubikit.management.DeviceInfo
hasTransport(Transport) - Method in class com.yubico.yubikit.management.DeviceInfo: Returns whether or not a specific transport is available on this YubiKey.
HSMAUTH - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the HSMAUTH application.

I

interfaces - Variable in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
isFips() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns whether or not this is a FIPS compliant device
isFips(boolean) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
isLocked() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns whether or not a Configuration Lock is set for the Management application on the YubiKey.
isLocked(boolean) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
isSky() - Method in class com.yubico.yubikit.management.DeviceInfo: Returns whether or not this is a Security key
isSky(boolean) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder

M

ManagementSession - Class in com.yubico.yubikit.management: Application to get information about and configure a YubiKey via the Management Application.
ManagementSession(FidoConnection) - Constructor for class com.yubico.yubikit.management.ManagementSession: Establishes a new session with a YubiKeys Management application, over a FidoConnection.
ManagementSession(OtpConnection) - Constructor for class com.yubico.yubikit.management.ManagementSession: Establishes a new session with a YubiKeys Management application, over an OtpConnection.
ManagementSession(SmartCardConnection) - Constructor for class com.yubico.yubikit.management.ManagementSession: Establishes a new session with a YubiKeys Management application, over a SmartCardConnection.
ManagementSession(SmartCardConnection, ScpKeyParams) - Constructor for class com.yubico.yubikit.management.ManagementSession: Establishes a new session with a YubiKeys Management application, over a SmartCardConnection.

N

nfcRestricted(Boolean) - Method in class com.yubico.yubikit.management.DeviceConfig.Builder: Sets the NFC restricted flag of the YubiKey.

O

OATH - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the OATH application, implementing the YKOATH protocol.
OPENPGP - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the OpenPGP application, implementing the OpenPGP Card protocol.
OTP - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the YubiOTP application.
OTP - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
OTP - Static variable in class com.yubico.yubikit.management.UsbInterface: Deprecated.
OTP_CCID - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
OTP_FIDO - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
OTP_FIDO_CCID - Enum constant in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.

P

partNumber(String) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
pinComplexity(boolean) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
PIV - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the PIV application, implementing the PIV protocol.

R

resetBlocked(int) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder

S

serialNumber(Integer) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
setMode(UsbInterface.Mode, byte, short) - Method in class com.yubico.yubikit.management.ManagementSession: Write device configuration for YubiKey NEO and YubiKey 4.
stmVersion(Version) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder
supportedCapabilities(Map<Transport, Integer>) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder

T

toString() - Method in class com.yubico.yubikit.management.DeviceConfig
toString() - Method in class com.yubico.yubikit.management.DeviceInfo

U

U2F - Enum constant in enum class com.yubico.yubikit.management.Capability: Identifies the U2F (CTAP1) portion of the FIDO application.
UNKNOWN - Enum constant in enum class com.yubico.yubikit.management.FormFactor: Used when information about the YubiKey's form factor isn't available.
updateDeviceConfig(DeviceConfig, boolean, byte[], byte[]) - Method in class com.yubico.yubikit.management.ManagementSession: Write device configuration to a YubiKey 5 or later.
USB_A_BIO - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A keychain-sized YubiKey with fingerprint sensor and USB-A connector.
USB_A_KEYCHAIN - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A keychain-sized YubiKey with a USB-A connector.
USB_A_NANO - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A nano-sized YubiKey with a USB-A connector.
USB_C_BIO - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A keychain-sized YubiKey with fingerprint sensor and USB-C connector.
USB_C_KEYCHAIN - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A keychain-sized YubiKey with a USB-C connector.
USB_C_LIGHTNING - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A keychain-sized YubiKey with both USB-C and Lightning connectors.
USB_C_NANO - Enum constant in enum class com.yubico.yubikit.management.FormFactor: A nano-sized YubiKey with a USB-C connector.
UsbInterface - Class in com.yubico.yubikit.management: Deprecated.
This class has been moved to the core module, and will remain here only until YubiKit 3.0 is released.
UsbInterface.Mode - Enum Class in com.yubico.yubikit.management: Deprecated.

V

value - Variable in enum class com.yubico.yubikit.management.FormFactor
value - Variable in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.
valueOf(int) - Static method in enum class com.yubico.yubikit.management.FormFactor: Returns the form factor corresponding to the given Management application form factor constant, or UNKNOWN if the value is unknown.
valueOf(String) - Static method in enum class com.yubico.yubikit.management.Capability: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.yubico.yubikit.management.FormFactor: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.

Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.yubico.yubikit.management.Capability: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.yubico.yubikit.management.FormFactor: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.yubico.yubikit.management.UsbInterface.Mode: Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.
version(Version) - Method in class com.yubico.yubikit.management.DeviceInfo.Builder

A B C D E F G H I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values