Index

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

A

ARG_ACTION_CLASS - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
The YubiKeyPromptAction subclass to use when a YubiKey is attached.
ARG_ALLOW_NFC - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Whether or not to listen for YubiKeys over NFC (default: true).
ARG_ALLOW_USB - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Whether or not to listen for YubiKeys over USB (default: true).
ARG_CANCEL_BUTTON_ID - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
A view ID of a Button to use for cancelling the action.
ARG_CONTENT_VIEW_ID - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
A layout resource to use as the content of the dialog.
ARG_ENABLE_NFC_BUTTON_ID - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
A view ID of a Button to use to enable NFC, if NFC is disabled.
ARG_HELP_TEXT_VIEW_ID - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
A view ID of a TextView where helpful information is displayed.
ARG_TITLE_ID - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
A string resource to use as the title of the dialog.

B

Base64CodecImpl - Class in com.yubico.yubikit.android.internal
 
Base64CodecImpl() - Constructor for class com.yubico.yubikit.android.internal.Base64CodecImpl
 

C

cancelButton - Variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
close() - Method in class com.yubico.yubikit.android.transport.nfc.NfcSmartCardConnection
 
close() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbOtpConnection
 
close() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbSmartCardConnection
 
close() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
com.yubico.yubikit.android - package com.yubico.yubikit.android
 
com.yubico.yubikit.android.internal - package com.yubico.yubikit.android.internal
 
com.yubico.yubikit.android.transport.nfc - package com.yubico.yubikit.android.transport.nfc
 
com.yubico.yubikit.android.transport.usb - package com.yubico.yubikit.android.transport.usb
 
com.yubico.yubikit.android.transport.usb.connection - package com.yubico.yubikit.android.transport.usb.connection
 
com.yubico.yubikit.android.ui - package com.yubico.yubikit.android.ui
 
ConnectionHandler<T extends com.yubico.yubikit.core.YubiKeyConnection> - Interface in com.yubico.yubikit.android.transport.usb.connection
 
ConnectionManager - Class in com.yubico.yubikit.android.transport.usb.connection
 
ConnectionManager(UsbManager, UsbDevice) - Constructor for class com.yubico.yubikit.android.transport.usb.connection.ConnectionManager
 
CONTINUE - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptAction
A result Pair used to keep the dialog open to continue processing YubiKeys.
createConnection(UsbDevice, UsbDeviceConnection) - Method in interface com.yubico.yubikit.android.transport.usb.connection.ConnectionHandler
 
createConnection(UsbDevice, UsbDeviceConnection) - Method in class com.yubico.yubikit.android.transport.usb.connection.FidoConnectionHandler
 
createConnection(UsbDevice, UsbDeviceConnection) - Method in class com.yubico.yubikit.android.transport.usb.connection.OtpConnectionHandler
 
createConnection(UsbDevice, UsbDeviceConnection) - Method in class com.yubico.yubikit.android.transport.usb.connection.SmartCardConnectionHandler
 
createIntent(Context, Class<? extends YubiKeyPromptAction>) - Static method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Helper method to create an Intent to start the YubiKeyPromptActivity with a ConnectionAction.
createIntent(Context, Class<? extends YubiKeyPromptAction>, int) - Static method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Helper method to create an Intent to start the YubiKeyPromptActivity with a ConnectionAction.

D

disable() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyManager
 
disable(Activity) - Method in interface com.yubico.yubikit.android.transport.nfc.NfcDispatcher
 
disable(Activity) - Method in class com.yubico.yubikit.android.transport.nfc.NfcReaderDispatcher
 
disable(Activity) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyManager
Disable active listening of nfc events
disableNfcDiscoverySound(boolean) - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
Setting this flag allows the caller to prevent the platform from playing sounds when it discovers a tag.

E

enable(Activity, NfcConfiguration, NfcDispatcher.OnTagHandler) - Method in interface com.yubico.yubikit.android.transport.nfc.NfcDispatcher
 
enable(Activity, NfcConfiguration, NfcDispatcher.OnTagHandler) - Method in class com.yubico.yubikit.android.transport.nfc.NfcReaderDispatcher
 
enable(Activity, NfcConfiguration, Callback<? super NfcYubiKeyDevice>) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyManager
Enable discovery of nfc tags for foreground activity
enable(UsbConfiguration, Callback<? super UsbYubiKeyDevice>) - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyManager
Registers receiver on usb connection event
enableNfcButton - Variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
EXTRA_ERROR - Static variable in class com.yubico.yubikit.android.ui.OtpActivity
 
EXTRA_OTP - Static variable in class com.yubico.yubikit.android.ui.OtpActivity
 

F

FidoConnectionHandler - Class in com.yubico.yubikit.android.transport.usb.connection
 
FidoConnectionHandler() - Constructor for class com.yubico.yubikit.android.transport.usb.connection.FidoConnectionHandler
 
fromString(String) - Method in class com.yubico.yubikit.android.internal.Base64CodecImpl
 
fromUrlSafeString(String) - Method in class com.yubico.yubikit.android.internal.Base64CodecImpl
 

G

getAtr() - Method in class com.yubico.yubikit.android.transport.nfc.NfcSmartCardConnection
 
getAtr() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbSmartCardConnection
 
getClaimedInterface(UsbDevice, UsbDeviceConnection) - Method in class com.yubico.yubikit.android.transport.usb.connection.FidoConnectionHandler
 
getClaimedInterface(UsbDevice, UsbDeviceConnection) - Method in class com.yubico.yubikit.android.transport.usb.connection.SmartCardConnectionHandler
 
getCommandState() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Get a CommandState for use with some blocking YubiKey actions.
getPid() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
getTag() - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
getTimeout() - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
 
getTransport() - Method in class com.yubico.yubikit.android.transport.nfc.NfcSmartCardConnection
 
getTransport() - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
getTransport() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbSmartCardConnection
 
getTransport() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
getUsbDevice() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
Returns yubikey device attached to the android device with the android device acting as the USB host.
getYubiKitManager() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Get the YubiKitManager used by this activity.

H

handlePermissions(boolean) - Method in class com.yubico.yubikit.android.transport.usb.UsbConfiguration
Set YubiKitManager to show dialog for permissions on USB connection
handleUnavailableNfc(boolean) - Method in class com.yubico.yubikit.android.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
hasPermission() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
helpTextView - Variable in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 

I

isAvailable(UsbDevice) - Method in interface com.yubico.yubikit.android.transport.usb.connection.ConnectionHandler
 
isAvailable(UsbDevice) - Method in class com.yubico.yubikit.android.transport.usb.connection.SmartCardConnectionHandler
 
isClosed() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbOtpConnection
 
isDisabled() - Method in exception com.yubico.yubikit.android.transport.nfc.NfcNotAvailable
If true, the NFC functionality is disabled and can be enabled.
isDisableNfcDiscoverySound() - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
 
isExtendedLengthApduSupported() - Method in class com.yubico.yubikit.android.transport.nfc.NfcSmartCardConnection
 
isExtendedLengthApduSupported() - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbSmartCardConnection
This connection generally supports Extended length APDUs.
isHandleUnavailableNfc() - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
 
isNfcEnabled() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
isSkipNdefCheck() - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
 
isYubiKey() - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
Probe the nfc device whether it is a Yubico hardware.

N

NFC_SETTINGS_ACTION - Static variable in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyManager
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.android.transport.nfc
Additional configurations for NFC discovery
NfcConfiguration() - Constructor for class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
 
NfcDispatcher - Interface in com.yubico.yubikit.android.transport.nfc
 
NfcDispatcher.OnTagHandler - Interface in com.yubico.yubikit.android.transport.nfc
 
NfcNotAvailable - Exception in com.yubico.yubikit.android.transport.nfc
 
NfcNotAvailable(String, boolean) - Constructor for exception com.yubico.yubikit.android.transport.nfc.NfcNotAvailable
 
NfcReaderDispatcher - Class in com.yubico.yubikit.android.transport.nfc
 
NfcReaderDispatcher(NfcAdapter) - Constructor for class com.yubico.yubikit.android.transport.nfc.NfcReaderDispatcher
 
NfcSmartCardConnection - Class in com.yubico.yubikit.android.transport.nfc
NFC service for interacting with the YubiKey
NfcYubiKeyDevice - Class in com.yubico.yubikit.android.transport.nfc
 
NfcYubiKeyDevice(Tag, int, ExecutorService) - Constructor for class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
Instantiates session for nfc tag interaction
NfcYubiKeyManager - Class in com.yubico.yubikit.android.transport.nfc
This class allows you to communicate with local NFC adapter
NfcYubiKeyManager(Context, NfcDispatcher) - Constructor for class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyManager
Creates instance of NfcYubiKeyManager
NoPermissionsException - Exception in com.yubico.yubikit.android.transport.usb
Exception that thrown when user didn't provide permissions to connect to USB device
NoPermissionsException(UsbDevice) - Constructor for exception com.yubico.yubikit.android.transport.usb.NoPermissionsException
 

O

onCaptureComplete(String) - Method in interface com.yubico.yubikit.android.ui.OtpKeyListener.OtpListener
Called when OTP capture has completed.
onCaptureStarted() - Method in interface com.yubico.yubikit.android.ui.OtpKeyListener.OtpListener
Called when the user has triggered OTP output and capture has started.
onCreate(Bundle) - Method in class com.yubico.yubikit.android.ui.OtpActivity
 
onCreate(Bundle) - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
onDestroy() - Method in class com.yubico.yubikit.android.ui.OtpActivity
 
onDestroy() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
onError(Exception) - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptConnectionAction
Overridable method called if opening a connection to a YubiKey throws an error.
onKeyEvent(KeyEvent) - Method in class com.yubico.yubikit.android.ui.OtpKeyListener
 
onKeyUp(int, KeyEvent) - Method in class com.yubico.yubikit.android.ui.OtpActivity
 
onPause() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
onResume() - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
onTag(Tag) - Method in interface com.yubico.yubikit.android.transport.nfc.NfcDispatcher.OnTagHandler
 
onYubiKeyConnection(T, Bundle, CommandState) - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptConnectionAction
Called when a YubiKey supporting the desired connection type is connected.
onYubiKeyDevice(YubiKeyDevice, Runnable) - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Called when a YubiKey is attached.
openConnection(Class<T>) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
openConnection(Class<T>) - Method in class com.yubico.yubikit.android.transport.usb.connection.ConnectionManager
TODO: fixme Checks if a connection type is supported by the device, attempts to acquire the connection lock, and returns a connection.
openConnection(Class<T>) - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
OtpActivity - Class in com.yubico.yubikit.android.ui
An Activity to prompt the user for a YubiKey to retrieve an OTP from a YubiOTP slot.
OtpActivity() - Constructor for class com.yubico.yubikit.android.ui.OtpActivity
 
OtpConnectionHandler - Class in com.yubico.yubikit.android.transport.usb.connection
 
OtpConnectionHandler() - Constructor for class com.yubico.yubikit.android.transport.usb.connection.OtpConnectionHandler
 
OtpKeyListener - Class in com.yubico.yubikit.android.ui
A helper class that is used to intercept keyboard event from a YubiKey to capture an OTP.
OtpKeyListener(OtpKeyListener.OtpListener) - Constructor for class com.yubico.yubikit.android.ui.OtpKeyListener
 
OtpKeyListener.OtpListener - Interface in com.yubico.yubikit.android.ui
Listener interface to react to events.

P

provideResult(int, Intent) - Method in class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
Provides a result to return to the caller of the Activity.

R

readNdef() - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
receive(byte[]) - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbFidoConnection
 
receive(byte[]) - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbOtpConnection
 
registerConnectionHandler(Class<T>, ConnectionHandler<? extends T>) - Static method in class com.yubico.yubikit.android.transport.usb.connection.ConnectionManager
Registers a new ConnectionHandler for creating YubiKeyConnections.
remove(Runnable) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
Closes the device and waits for physical removal.
requestConnection(Class<T>, Callback<Result<T, IOException>>) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
requestConnection(Class<T>, Callback<Result<T, IOException>>) - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
RESULT_CONTINUE - Static variable in class com.yubico.yubikit.android.ui.YubiKeyPromptAction
A special result code which will reset the dialog state to continue processing additional YubiKeys.
RESULT_ERROR - Static variable in class com.yubico.yubikit.android.ui.OtpActivity
 

S

send(byte[]) - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbFidoConnection
 
send(byte[]) - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbOtpConnection
Write single feature report
sendAndReceive(byte[]) - Method in class com.yubico.yubikit.android.transport.nfc.NfcSmartCardConnection
 
sendAndReceive(byte[]) - Method in class com.yubico.yubikit.android.transport.usb.connection.UsbSmartCardConnection
 
setOnClosed(Runnable) - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
skipNdefCheck(boolean) - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
Setting this flag allows the caller to prevent the platform from performing an NDEF check on the tags it
SmartCardConnectionHandler - Class in com.yubico.yubikit.android.transport.usb.connection
 
SmartCardConnectionHandler() - Constructor for class com.yubico.yubikit.android.transport.usb.connection.SmartCardConnectionHandler
 
startNfcDiscovery(NfcConfiguration, Activity, Callback<? super NfcYubiKeyDevice>) - Method in class com.yubico.yubikit.android.YubiKitManager
Subscribe on changes that happen via NFC and detect if there any Yubikeys tags got passed
startUsbDiscovery(UsbConfiguration, Callback<? super UsbYubiKeyDevice>) - Method in class com.yubico.yubikit.android.YubiKitManager
Subscribe on changes that happen via USB and detect if there any Yubikeys got connected
stopNfcDiscovery(Activity) - Method in class com.yubico.yubikit.android.YubiKitManager
Unsubscribe from changes that happen via NFC
stopUsbDiscovery() - Method in class com.yubico.yubikit.android.YubiKitManager
Unsubscribe from changes that happen via USB
supportsConnection(Class<? extends YubiKeyConnection>) - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
supportsConnection(Class<? extends YubiKeyConnection>) - Method in class com.yubico.yubikit.android.transport.usb.connection.ConnectionManager
Checks to see if a given connection type is supported
supportsConnection(Class<? extends YubiKeyConnection>) - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 

T

timeout(int) - Method in class com.yubico.yubikit.android.transport.nfc.NfcConfiguration
The timeout to use for wireless communication.
toString() - Method in class com.yubico.yubikit.android.transport.nfc.NfcYubiKeyDevice
 
toString() - Method in class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
 
toString(byte[]) - Method in class com.yubico.yubikit.android.internal.Base64CodecImpl
 
toUrlSafeString(byte[]) - Method in class com.yubico.yubikit.android.internal.Base64CodecImpl
 

U

UsbConfiguration - Class in com.yubico.yubikit.android.transport.usb
Additional configurations for USB discovery management
UsbConfiguration() - Constructor for class com.yubico.yubikit.android.transport.usb.UsbConfiguration
 
UsbFidoConnection - Class in com.yubico.yubikit.android.transport.usb.connection
 
UsbOtpConnection - Class in com.yubico.yubikit.android.transport.usb.connection
Class that provides interface to read and send data over YubiKey HID (keyboard) interface
UsbSmartCardConnection - Class in com.yubico.yubikit.android.transport.usb.connection
UsbYubiKeyDevice - Class in com.yubico.yubikit.android.transport.usb
 
UsbYubiKeyDevice(UsbManager, UsbDevice) - Constructor for class com.yubico.yubikit.android.transport.usb.UsbYubiKeyDevice
Creates the instance of usb session to interact with the yubikey device.
UsbYubiKeyManager - Class in com.yubico.yubikit.android.transport.usb
 
UsbYubiKeyManager(Context) - Constructor for class com.yubico.yubikit.android.transport.usb.UsbYubiKeyManager
 

Y

YubiKeyPromptAction - Class in com.yubico.yubikit.android.ui
Action to be performed by a YubiKeyPromptActivity when a YubiKey is attached.
YubiKeyPromptAction() - Constructor for class com.yubico.yubikit.android.ui.YubiKeyPromptAction
 
YubiKeyPromptActivity - Class in com.yubico.yubikit.android.ui
A dialog for interacting with a YubiKey.
YubiKeyPromptActivity() - Constructor for class com.yubico.yubikit.android.ui.YubiKeyPromptActivity
 
YubiKeyPromptConnectionAction<T extends com.yubico.yubikit.core.YubiKeyConnection> - Class in com.yubico.yubikit.android.ui
Action to be performed by a YubiKeyPromptActivity when a YubiKey is attached.
YubiKeyPromptConnectionAction(Class<T>) - Constructor for class com.yubico.yubikit.android.ui.YubiKeyPromptConnectionAction
Subclasses need to provide a default (no-arg) constructor which calls this parent constructor.
YubiKitManager - Class in com.yubico.yubikit.android
Starting point for YubiKey device discovery over both USB and NFC.
YubiKitManager(Context) - Constructor for class com.yubico.yubikit.android.YubiKitManager
Initialize instance of YubiKitManager
YubiKitManager(UsbYubiKeyManager, NfcYubiKeyManager) - Constructor for class com.yubico.yubikit.android.YubiKitManager
Initialize an instance of YubiKitManager, providing the USB and NFC YubiKey managers to use for device discovery.
A B C D E F G H I N O P R S T U Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form