Skip navigation links
A B C D E G H I L M N O P R S T U V Y 

A

Apdu - Class in com.yubico.yubikit.apdu
Data model for encapsulating an APDU command, as defined by ISO/IEC 7816-4 standard.
Apdu(int, int, int, int, byte[], Apdu.Type) - Constructor for class com.yubico.yubikit.apdu.Apdu
Creates a new APDU binary command from a list of parameters specified by the ISO/IEC 7816-4 standard.
Apdu(int, int, int, int, byte[]) - Constructor for class com.yubico.yubikit.apdu.Apdu
Creates a new APDU binary command from a list of parameters specified by the ISO/IEC 7816-4 standard.
Apdu(byte[]) - Constructor for class com.yubico.yubikit.apdu.Apdu
Creates a new APDU with pre-built data.
Apdu(byte[], Apdu.Type) - Constructor for class com.yubico.yubikit.apdu.Apdu
Creates a new APDU with pre-built data.
Apdu.Type - Enum in com.yubico.yubikit.apdu
Refers to the encoding type of APDU as defined in ISO/IEC 7816-4 standard.
ApduException - Exception in com.yubico.yubikit.exceptions
Exception is thrown if used APDU utils to parse received data and it has unexpected status code (not equal success == 0x9000)
ApduException(ApduResponse) - Constructor for exception com.yubico.yubikit.exceptions.ApduException
 
ApduException(ApduResponse, String) - Constructor for exception com.yubico.yubikit.exceptions.ApduException
 
ApduResponse - Class in com.yubico.yubikit.apdu
Parses response to APDU from a key
ApduResponse(byte[]) - Constructor for class com.yubico.yubikit.apdu.ApduResponse
Creates a new response from a key
ApduUtils - Class in com.yubico.yubikit.apdu
Methods that allow to send APDU commands and handle input and output that doesn't fit into 1 APDU blob
ApduUtils() - Constructor for class com.yubico.yubikit.apdu.ApduUtils
 
ApplicationNotFound - Exception in com.yubico.yubikit.exceptions
Thrown when specific applet is not found/disabled on device
ApplicationNotFound(String) - Constructor for exception com.yubico.yubikit.exceptions.ApplicationNotFound
 

B

BadRequestException - Exception in com.yubico.yubikit.exceptions
The data provided to create a request to send to the YubiKey is invalid.
BadRequestException(String) - Constructor for exception com.yubico.yubikit.exceptions.BadRequestException
 
BadResponseException - Exception in com.yubico.yubikit.exceptions
The data contained in a YubiKey response was invalid.
BadResponseException(String) - Constructor for exception com.yubico.yubikit.exceptions.BadResponseException
 
BadResponseException(String, Throwable) - Constructor for exception com.yubico.yubikit.exceptions.BadResponseException
 
bytesToHex(byte[]) - Static method in class com.yubico.yubikit.utils.StringUtils
Helper method that convert byte array into string for logging
bytesToHex(byte[], int, int) - Static method in class com.yubico.yubikit.utils.StringUtils
Helper method that convert byte array into string for logging

C

calculateCrc(byte[], int) - Static method in class com.yubico.yubikit.utils.ChecksumUtils
Method for calculating a CRC13239 checksum over a byte buffer.
checkCrc(byte[], int) - Static method in class com.yubico.yubikit.utils.ChecksumUtils
Verify a checksum.
ChecksumUtils - Class in com.yubico.yubikit.utils
Utility methods for calculating and verifying the CRC13239 checksum used for YubiKeys.
ChecksumUtils() - Constructor for class com.yubico.yubikit.utils.ChecksumUtils
 
close() - Method in class com.yubico.yubikit.HidApplication
 
close() - Method in class com.yubico.yubikit.Iso7816Application
 
close() - Method in interface com.yubico.yubikit.transport.Iso7816Connection
Closes the communication with the key and disables the key connection events.
close() - Method in class com.yubico.yubikit.transport.nfc.NfcIso7816Connection
 
close() - Method in class com.yubico.yubikit.transport.usb.UsbHidConnection
 
close() - Method in class com.yubico.yubikit.transport.usb.UsbIso7816Connection
 
com.yubico.yubikit - package com.yubico.yubikit
 
com.yubico.yubikit.apdu - package com.yubico.yubikit.apdu
 
com.yubico.yubikit.exceptions - package com.yubico.yubikit.exceptions
 
com.yubico.yubikit.transport - package com.yubico.yubikit.transport
 
com.yubico.yubikit.transport.nfc - package com.yubico.yubikit.transport.nfc
 
com.yubico.yubikit.transport.usb - package com.yubico.yubikit.transport.usb
 
com.yubico.yubikit.utils - package com.yubico.yubikit.utils
 
compareTo(Version) - Method in class com.yubico.yubikit.apdu.Version
 

D

d(String) - Static method in class com.yubico.yubikit.utils.Logger
 
decode(String) - Static method in class com.yubico.yubikit.utils.Modhex
Decodes Modhex encoded string.
disable(Activity) - Method in class com.yubico.yubikit.transport.nfc.NfcDeviceManager
Disable active listening of nfc events
disable(Activity) - Method in interface com.yubico.yubikit.transport.nfc.NfcDispatcher
 
disable(Activity) - Method in class com.yubico.yubikit.transport.nfc.NfcReaderDispatcher
 
disable() - Method in class com.yubico.yubikit.transport.usb.UsbDeviceManager
Unregisters receiver on usb connection event

E

e(String, Throwable) - Static method in class com.yubico.yubikit.utils.Logger
 
enable(Activity, NfcConfiguration) - Method in class com.yubico.yubikit.transport.nfc.NfcDeviceManager
Enable discovery of nfc tags for foreground activity
enable(Activity, NfcConfiguration) - Method in interface com.yubico.yubikit.transport.nfc.NfcDispatcher
 
enable(Activity, NfcConfiguration) - Method in class com.yubico.yubikit.transport.nfc.NfcReaderDispatcher
 
enable(UsbConfiguration) - Method in class com.yubico.yubikit.transport.usb.UsbDeviceManager
Registers receiver on usb connection event
encode(byte[]) - Static method in class com.yubico.yubikit.utils.Modhex
Encode data as Modhex.
equals(Object) - Method in class com.yubico.yubikit.apdu.Version
 
equals(Object) - Method in class com.yubico.yubikit.transport.usb.UsbSession
 
execute(Apdu) - Method in interface com.yubico.yubikit.transport.Iso7816Connection
Sends synchronously to the key a raw APDU command to be executed.
execute(Apdu) - Method in class com.yubico.yubikit.transport.nfc.NfcIso7816Connection
 
execute(Apdu) - Method in class com.yubico.yubikit.transport.usb.UsbIso7816Connection
 

G

getAid() - Method in class com.yubico.yubikit.Iso7816Application
 
getApdu() - Method in exception com.yubico.yubikit.exceptions.ApduException
Get the ResponseApdu.
getAtr() - Method in class com.yubico.yubikit.Iso7816Application
Answer to reset
getAtr() - Method in interface com.yubico.yubikit.transport.Iso7816Connection
Retrieve Answer to reset (or answer to select for NFC)
getAtr() - Method in class com.yubico.yubikit.transport.nfc.NfcIso7816Connection
 
getAtr() - Method in class com.yubico.yubikit.transport.usb.UsbIso7816Connection
 
getBytes() - Method in class com.yubico.yubikit.apdu.Apdu
Byte stream of APDU command
getBytes() - Method in class com.yubico.yubikit.apdu.ApduResponse
 
getBytes() - Method in class com.yubico.yubikit.apdu.Tlv
 
getBytes() - Method in class com.yubico.yubikit.apdu.Version
 
getCla() - Method in class com.yubico.yubikit.apdu.Apdu
 
getConnection() - Method in class com.yubico.yubikit.HidApplication
 
getConnection() - Method in class com.yubico.yubikit.Iso7816Application
 
getData() - Method in class com.yubico.yubikit.apdu.Apdu
APDU command data
getData() - Method in class com.yubico.yubikit.apdu.ApduResponse
 
getIns() - Method in class com.yubico.yubikit.apdu.Apdu
 
getLength() - Method in class com.yubico.yubikit.apdu.Tlv
 
getOffset() - Method in class com.yubico.yubikit.apdu.Tlv
 
getP1() - Method in class com.yubico.yubikit.apdu.Apdu
 
getP2() - Method in class com.yubico.yubikit.apdu.Apdu
 
getStatus() - Method in class com.yubico.yubikit.HidApplication
Receive status bytes from YubiKey
getStatus() - Method in class com.yubico.yubikit.transport.usb.UsbHidConnection
Receive status bytes from YubiKey
getStatusCode() - Method in exception com.yubico.yubikit.exceptions.ApduException
Gets error code that received via APDU response
getSw() - Method in class com.yubico.yubikit.apdu.ApduResponse
 
getTag() - Method in class com.yubico.yubikit.apdu.Tlv
 
getTag() - Method in class com.yubico.yubikit.transport.nfc.NfcSession
 
getType() - Method in class com.yubico.yubikit.apdu.Apdu
Type of command
getUsbDevice() - Method in class com.yubico.yubikit.transport.usb.UsbSession
Returns yubikey device attached to the android device with the android device acting as the USB host.
getUsbManager() - Method in class com.yubico.yubikit.transport.usb.UsbSession
Get the UsbManager service used to interact with the YubiKey device.
getValue() - Method in class com.yubico.yubikit.apdu.Tlv
 

H

hashCode() - Method in class com.yubico.yubikit.apdu.Version
 
hashCode() - Method in class com.yubico.yubikit.transport.usb.UsbSession
 
HidApplication - Class in com.yubico.yubikit
Application that requires communication over HID Keyboard interface of YubiKey
HidApplication(UsbSession) - Constructor for class com.yubico.yubikit.HidApplication
Create new instance of Iso7816Application and selects the application for use

I

isAtLeast(int, int, int) - Method in class com.yubico.yubikit.apdu.Version
 
isDisableNfcDiscoverySound() - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
 
isHandleUnavailableNfc() - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
 
isLessThan(int, int, int) - Method in class com.yubico.yubikit.apdu.Version
 
Iso7816Application - Class in com.yubico.yubikit
Class that allows to open ISO 7816 connection to YubiKey and communicate using APDUs
Iso7816Application(byte[], YubiKeySession) - Constructor for class com.yubico.yubikit.Iso7816Application
Create new instance of Iso7816Application and selects the application for use
Iso7816Connection - Interface in com.yubico.yubikit.transport
Defines the interface for execution of raw Apdu commands
isSkipNdefCheck() - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
 

L

logDebug(String) - Method in class com.yubico.yubikit.utils.Logger
Logs message (debug level)
logError(String, Throwable) - Method in class com.yubico.yubikit.utils.Logger
Logs message (error level)
Logger - Class in com.yubico.yubikit.utils
Helper class allows to customize logs within the SDK SDK has only 2 levels of logging: debug information and error If a Logger implementation is not provided the SDK won't produce any logs
Logger() - Constructor for class com.yubico.yubikit.utils.Logger
 

M

major - Variable in class com.yubico.yubikit.apdu.Version
 
micro - Variable in class com.yubico.yubikit.apdu.Version
 
minor - Variable in class com.yubico.yubikit.apdu.Version
 
Modhex - Class in com.yubico.yubikit.utils
Modhex mapping: https://developers.yubico.com/yubico-c/Manuals/modhex.1.html
Modhex() - Constructor for class com.yubico.yubikit.utils.Modhex
 

N

NFC_SETTINGS_ACTION - Static variable in class com.yubico.yubikit.transport.nfc.NfcDeviceManager
Action for intent to tweak NFC settings in Android settings view on Q Android supports Settings.Panel.ACTION_NFC, we might update with release on Q
NfcConfiguration - Class in com.yubico.yubikit.transport.nfc
Additional configurations for NFC discovery
NfcConfiguration() - Constructor for class com.yubico.yubikit.transport.nfc.NfcConfiguration
 
NfcDeviceManager - Class in com.yubico.yubikit.transport.nfc
This class allows you to communicate with local NFC adapter
NfcDeviceManager(Context, NfcDispatcher) - Constructor for class com.yubico.yubikit.transport.nfc.NfcDeviceManager
Creates instance of NfcDeviceManager
NfcDeviceManager(Context) - Constructor for class com.yubico.yubikit.transport.nfc.NfcDeviceManager
 
NfcDisabledException - Exception in com.yubico.yubikit.exceptions
 
NfcDisabledException(String) - Constructor for exception com.yubico.yubikit.exceptions.NfcDisabledException
 
NfcDispatcher - Interface in com.yubico.yubikit.transport.nfc
 
NfcDispatcher.OnTagHandler - Interface in com.yubico.yubikit.transport.nfc
 
NfcIso7816Connection - Class in com.yubico.yubikit.transport.nfc
NFC service for interacting with the YubiKey
NfcNotFoundException - Exception in com.yubico.yubikit.exceptions
 
NfcNotFoundException(String) - Constructor for exception com.yubico.yubikit.exceptions.NfcNotFoundException
 
NfcReaderDispatcher - Class in com.yubico.yubikit.transport.nfc
 
NfcReaderDispatcher(NfcAdapter) - Constructor for class com.yubico.yubikit.transport.nfc.NfcReaderDispatcher
 
NfcSession - Class in com.yubico.yubikit.transport.nfc
 
NfcSessionListener - Interface in com.yubico.yubikit.transport.nfc
 
NoDataException - Exception in com.yubico.yubikit.transport.usb
Exception returned when no data was received from YubiKey
NoDataException(String) - Constructor for exception com.yubico.yubikit.transport.usb.NoDataException
 
NoPermissionsException - Exception in com.yubico.yubikit.exceptions
Exception that thrown when user didn't provide permissions to connect to USB device
NoPermissionsException(UsbDevice) - Constructor for exception com.yubico.yubikit.exceptions.NoPermissionsException
 
NotSupportedOperation - Exception in com.yubico.yubikit.exceptions
Thrown when an operation is not supported on the connected device.
NotSupportedOperation(String) - Constructor for exception com.yubico.yubikit.exceptions.NotSupportedOperation
 

O

onRequestPermissionsResult(UsbSession, boolean) - Method in interface com.yubico.yubikit.transport.usb.UsbSessionListener
If discovery was started with handling permissions than user will be prompted with UI dialog to ask for necessary permissions to communicate with device
onSessionReceived(NfcSession) - Method in interface com.yubico.yubikit.transport.nfc.NfcSessionListener
 
onSessionReceived(UsbSession, boolean) - Method in interface com.yubico.yubikit.transport.usb.UsbSessionListener
Invoked when detected inserted device after usb discovery started
onSessionRemoved(UsbSession) - Method in interface com.yubico.yubikit.transport.usb.UsbSessionListener
Invoked when detected removal/ejection of usb device after usb discovery started
onTag(Tag) - Method in interface com.yubico.yubikit.transport.nfc.NfcDispatcher.OnTagHandler
 
openHidKeyboardConnection() - Method in class com.yubico.yubikit.transport.usb.UsbSession
Creates and starts session for communication with yubikey using HID interface
openIso7816Connection() - Method in class com.yubico.yubikit.transport.nfc.NfcSession
 
openIso7816Connection() - Method in class com.yubico.yubikit.transport.usb.UsbSession
 
openIso7816Connection() - Method in interface com.yubico.yubikit.transport.YubiKeySession
Creates and starts session for communication with yubikey using protocol ISO-7816 if it's supported by connected device

P

packTlvList(List<Tlv>) - Static method in class com.yubico.yubikit.apdu.TlvUtils
Converts list of Tlvs into raw byte array
parse(byte[]) - Static method in class com.yubico.yubikit.apdu.Version
 
parse(String) - Static method in class com.yubico.yubikit.apdu.Version
Parses from string format "Firmware version 5.2.1"
parseTlvList(byte[]) - Static method in class com.yubico.yubikit.apdu.TlvUtils
Converts raw data into list of Tlvs
parseTlvMap(byte[]) - Static method in class com.yubico.yubikit.apdu.TlvUtils
Converts raw data into map of Tlvs

R

receive(int) - Method in class com.yubico.yubikit.HidApplication
Read data from YubiKey
receive(int) - Method in class com.yubico.yubikit.transport.usb.UsbHidConnection
Read data from YubiKey

S

select() - Method in class com.yubico.yubikit.Iso7816Application
Sends an APDU to SELECT the Application.
send(byte, byte[]) - Method in class com.yubico.yubikit.HidApplication
Send data to YubiKey
send(byte, byte[]) - Method in class com.yubico.yubikit.transport.usb.UsbHidConnection
Send data to YubiKey
sendAndReceive(Iso7816Connection, Apdu) - Static method in class com.yubico.yubikit.apdu.ApduUtils
Sends APDU command and receives byte array from connection In case if length of output blob is bigger than 255 than it splits into set of APDU commands In case if output has status code that it has remaining info sends another APDU command to receive what's remaining
sendAndReceive(Iso7816Connection, Apdu, byte) - Static method in class com.yubico.yubikit.apdu.ApduUtils
Sends APDU command and receives byte array from connection In case if length of output blob is bigger than 255 than it splits into set of APDU commands In case if output has status code that it has remaining info sends another APDU command to receive what's remaining
sendAndReceive(Apdu) - Method in class com.yubico.yubikit.Iso7816Application
Sends APDU command and receives byte array from connection In case if length of output blob is bigger than 255 than it splits into set of APDU commands In case if output has status code that it has remaining info sends another APDU command to receive what's remaining
setDisableNfcDiscoverySound(boolean) - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
Setting this flag allows the caller to prevent the platform from playing sounds when it discovers a tag.
setFilterYubicoDevices(boolean) - Method in class com.yubico.yubikit.transport.usb.UsbConfiguration
 
setHandlePermissions(boolean) - Method in class com.yubico.yubikit.transport.usb.UsbConfiguration
Set YubiKitManager to show dialog for permissions on USB connection
setHandleUnavailableNfc(boolean) - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
Set it to true to shows view with settings nfc setting if NFC is disabled, otherwise start of NFC session will return error in callback if no permissions/setting and allows user to handle disabled NFC reader (show error or snackbar or refer to settings) Default value is false
setListener(NfcSessionListener) - Method in class com.yubico.yubikit.transport.nfc.NfcDeviceManager
Sets listener to Nfc session discovery
setListener(UsbSessionListener) - Method in class com.yubico.yubikit.transport.usb.UsbDeviceManager
Sets listener to Usb session discovery
setLogger(Logger) - Static method in class com.yubico.yubikit.utils.Logger
Set the Logger implementation to use.
setOnTagHandler(NfcDispatcher.OnTagHandler) - Method in interface com.yubico.yubikit.transport.nfc.NfcDispatcher
 
setOnTagHandler(NfcDispatcher.OnTagHandler) - Method in class com.yubico.yubikit.transport.nfc.NfcReaderDispatcher
 
setSkipNdefCheck(boolean) - Method in class com.yubico.yubikit.transport.nfc.NfcConfiguration
Setting this flag allows the caller to prevent the platform from performing an NDEF check on the tags it
setTimeout(int) - Method in interface com.yubico.yubikit.transport.Iso7816Connection
Sets connection/communication timeout in milliseconds
setTimeout(int) - Method in class com.yubico.yubikit.transport.nfc.NfcIso7816Connection
 
setTimeout(int) - Method in class com.yubico.yubikit.transport.usb.UsbIso7816Connection
 
startNfcDiscovery(NfcConfiguration, Activity, NfcSessionListener) - Method in class com.yubico.yubikit.YubiKitManager
Subscribe on changes that happen via NFC and detect if there any Yubikeys tags got passed This registers broadcast receivers and blocks Ndef tags to be passed to activity, to unsubscribe use YubiKitManager.stopNfcDiscovery(Activity)
startUsbDiscovery(UsbConfiguration, UsbSessionListener) - Method in class com.yubico.yubikit.YubiKitManager
Subscribe on changes that happen via USB and detect if there any Yubikeys got connected This registers broadcast receivers, to unsubscribe from receiver use YubiKitManager.stopUsbDiscovery()
stopNfcDiscovery(Activity) - Method in class com.yubico.yubikit.YubiKitManager
Unsubscribe from changes that happen via NFC
stopUsbDiscovery() - Method in class com.yubico.yubikit.YubiKitManager
Unsubscribe from changes that happen via USB
StringUtils - Class in com.yubico.yubikit.utils
 
StringUtils() - Constructor for class com.yubico.yubikit.utils.StringUtils
 

T

Tlv - Class in com.yubico.yubikit.apdu
Tag, length, Value structure that helps to parse APDU response data.
Tlv(byte[], int) - Constructor for class com.yubico.yubikit.apdu.Tlv
Creates instance of Tlv
Tlv(int, byte[]) - Constructor for class com.yubico.yubikit.apdu.Tlv
Creates instance of Tlv
TlvUtils - Class in com.yubico.yubikit.apdu
Helper methods to parse data into multiple of Tlvs
TlvUtils() - Constructor for class com.yubico.yubikit.apdu.TlvUtils
 
toString() - Method in class com.yubico.yubikit.apdu.Version
 

U

UnexpectedTagException - Exception in com.yubico.yubikit.exceptions
Unexpected TLV tag in a response from a YubiKey.
UnexpectedTagException(int, int) - Constructor for exception com.yubico.yubikit.exceptions.UnexpectedTagException
 
UNKNOWN - Static variable in class com.yubico.yubikit.apdu.Version
 
unwrapTlv(byte[], int) - Static method in class com.yubico.yubikit.apdu.TlvUtils
Helper method extracts tlv data from another byte array and verifies tag
UsbConfiguration - Class in com.yubico.yubikit.transport.usb
Additional configurations for USB discovery management
UsbConfiguration() - Constructor for class com.yubico.yubikit.transport.usb.UsbConfiguration
 
UsbDeviceManager - Class in com.yubico.yubikit.transport.usb
This class allows you to access the state of USB_TRANSPORT and communicate with USB_TRANSPORT devices.
UsbDeviceManager(Context) - Constructor for class com.yubico.yubikit.transport.usb.UsbDeviceManager
Initialize instance of UsbDeviceManager
UsbHidConnection - Class in com.yubico.yubikit.transport.usb
Class that provides interface to read and send data over YubiKey HID (keyboard) interface
UsbIso7816Connection - Class in com.yubico.yubikit.transport.usb
USB service for interacting with the YubiKey https://www.usb.org/sites/default/files/DWG_Smart-Card_CCID_Rev110.pdf
UsbSession - Class in com.yubico.yubikit.transport.usb
 
UsbSessionListener - Interface in com.yubico.yubikit.transport.usb
 

V

valueOf(String) - Static method in enum com.yubico.yubikit.apdu.Apdu.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.yubico.yubikit.apdu.Apdu.Type
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.yubico.yubikit.apdu
Class that allows to parse version of yubikey
Version(int, int, int) - Constructor for class com.yubico.yubikit.apdu.Version
 
Version(byte, byte, byte) - Constructor for class com.yubico.yubikit.apdu.Version
 

Y

YubiKeyCommunicationException - Exception in com.yubico.yubikit.exceptions
General error in communicating with a YubiKey.
YubiKeyCommunicationException(String) - Constructor for exception com.yubico.yubikit.exceptions.YubiKeyCommunicationException
 
YubiKeyCommunicationException(String, Throwable) - Constructor for exception com.yubico.yubikit.exceptions.YubiKeyCommunicationException
 
YubiKeySession - Interface in com.yubico.yubikit.transport
Session for communication with YubiKey Implementation of this session allows to connect to YubiKey with some transportation protocol (ex, USB_TRANSPORT or NFC_TRANSPORT)
YubiKitManager - Class in com.yubico.yubikit
 
YubiKitManager(Context) - Constructor for class com.yubico.yubikit.YubiKitManager
Initialize instance of YubiKitManager
YubiKitManager(Context, Handler) - Constructor for class com.yubico.yubikit.YubiKitManager
Initialize instance of YubiKitManager
YubiKitManager(Handler, UsbDeviceManager, NfcDeviceManager) - Constructor for class com.yubico.yubikit.YubiKitManager
Initialize instance of YubiKitManager
A B C D E G H I L M N O P R S T U V Y 
Skip navigation links