Index (oath 2.8.0 API)

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

A

AccessKey - Interface in com.yubico.yubikit.oath: Allows the implementation of custom backends to unlock an OathSession.

B

Base32 - Class in com.yubico.yubikit.oath: Base32 implementation of RFC4684, section 6
Base32() - Constructor for class com.yubico.yubikit.oath.Base32
blockSize - Variable in enum class com.yubico.yubikit.oath.HashAlgorithm

C

calculateCode(Credential) - Method in class com.yubico.yubikit.oath.OathSession: Returns a new Code for a stored Credential.
calculateCode(Credential, Long) - Method in class com.yubico.yubikit.oath.OathSession: Returns a new Code for a stored Credential.
calculateCodes() - Method in class com.yubico.yubikit.oath.OathSession: Get a map of all Credentials stored on the YubiKey, together with a Code for each of them.
calculateCodes(long) - Method in class com.yubico.yubikit.oath.OathSession: Get a map of all Credentials stored on the YubiKey, together with a Code for each of them.
calculateResponse(byte[]) - Method in interface com.yubico.yubikit.oath.AccessKey: Create a HMAC-SHA1 signature over the given challenge, using an OATH Access Key.
calculateResponse(byte[], byte[]) - Method in class com.yubico.yubikit.oath.OathSession: Calculate a full (non-truncated) HMAC signature using a Credential.
close() - Method in class com.yubico.yubikit.oath.OathSession
Code - Class in com.yubico.yubikit.oath: A one-time OATH code, calculated from a Credential stored in a YubiKey.
Code(String, long, long) - Constructor for class com.yubico.yubikit.oath.Code
com.yubico.yubikit.oath - package com.yubico.yubikit.oath
Credential - Class in com.yubico.yubikit.oath: A reference to an OATH Credential stored on a YubiKey.
CredentialData - Class in com.yubico.yubikit.oath: Data object holding all required information to add a new Credential to a YubiKey.
CredentialData(String, OathType, HashAlgorithm, byte[], int, int, int, String) - Constructor for class com.yubico.yubikit.oath.CredentialData: Constructs a new instance from the given parameters.

D

decode(String) - Static method in class com.yubico.yubikit.oath.Base32
DEFAULT_DIGITS - Static variable in class com.yubico.yubikit.oath.CredentialData: The default number of digits for calculated Codes.
DEFAULT_TOTP_PERIOD - Static variable in class com.yubico.yubikit.oath.CredentialData: The default time period for TOTP Credentials.
deleteAccessKey() - Method in class com.yubico.yubikit.oath.OathSession: Removes the access key, if one is set.
deleteCredential(byte[]) - Method in class com.yubico.yubikit.oath.OathSession: Deletes an existing Credential from the YubiKey.
deleteCredential(Credential) - Method in class com.yubico.yubikit.oath.OathSession: Deletes an existing Credential from the YubiKey.
deriveAccessKey(char[]) - Method in class com.yubico.yubikit.oath.OathSession: Derives an access key from a password and the device-specific salt.

E

encode(byte[]) - Static method in class com.yubico.yubikit.oath.Base32
equals(Object) - Method in class com.yubico.yubikit.oath.Credential
equals(Object) - Method in class com.yubico.yubikit.oath.CredentialData

F

FEATURE_RENAME - Static variable in class com.yubico.yubikit.oath.OathSession: Support for renaming a stored credential.
FEATURE_SCP - Static variable in class com.yubico.yubikit.oath.OathSession: Support for secure messaging.
FEATURE_SHA512 - Static variable in class com.yubico.yubikit.oath.OathSession: Support for credentials using the SHA-512 hash algorithm.
FEATURE_TOUCH - Static variable in class com.yubico.yubikit.oath.OathSession: Support for credentials that require touch to use.
fromString(String) - Static method in enum class com.yubico.yubikit.oath.HashAlgorithm: Returns the algorithm corresponding to the given name, as used in otpauth:// URIs.
fromString(String) - Static method in enum class com.yubico.yubikit.oath.OathType: Returns the OATH type corresponding to the given name, as used in otpauth:// URIs.
fromValue(byte) - Static method in enum class com.yubico.yubikit.oath.HashAlgorithm: Returns the algorithm corresponding to the given YKOATH ALGORITHM constant.
fromValue(byte) - Static method in enum class com.yubico.yubikit.oath.OathType: Returns the OATH type corresponding to the given YKOATH TYPE constant.

G

getAccountName() - Method in class com.yubico.yubikit.oath.Credential: Returns the name of the account (typically a username or email address).
getAccountName() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the name of the credential.
getCounter() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the initial counter value for a HOTP credential.
getCredentials() - Method in class com.yubico.yubikit.oath.OathSession: Get a list of all Credentials stored on the YubiKey.
getDeviceId() - Method in class com.yubico.yubikit.oath.OathSession: Returns a unique ID which can be used to identify a particular YubiKey.
getDigits() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the number of digits in Codes calculated from the credential.
getHashAlgorithm() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the hash algorithm used by the credential.
getId() - Method in class com.yubico.yubikit.oath.Credential: Returns the ID of a Credential which is used to identify it to the YubiKey.
getId() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the credentials ID, as used to identify it on a YubiKey.
getIssuer() - Method in class com.yubico.yubikit.oath.Credential: Returns the name of the Credential issuer (e.g.
getIssuer() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the name of the credential issuer.
getOathType() - Method in class com.yubico.yubikit.oath.Credential: Returns the OATH type (HOTP or TOTP) of the Credential.
getOathType() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the OATH type (HOTP or TOTP) of the credential.
getPeriod() - Method in class com.yubico.yubikit.oath.Credential: Returns the validity time period in seconds for a Code generated from this Credential.
getPeriod() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the validity time period in seconds for a Code generated from this credential.
getSecret() - Method in class com.yubico.yubikit.oath.CredentialData: Returns the credential secret.
getValidFrom() - Method in class com.yubico.yubikit.oath.Code: Returns a UNIX timestamp in ms for when the validity period starts.
getValidUntil() - Method in class com.yubico.yubikit.oath.Code: Returns a UNIX timestamp in ms for when the validity period ends.
getValue() - Method in class com.yubico.yubikit.oath.Code: Returns the String value, typically a 6-8 digit code.
getVersion() - Method in class com.yubico.yubikit.oath.OathSession

H

hasAccessKey() - Method in class com.yubico.yubikit.oath.OathSession: Deprecated.
Use OathSession.isAccessKeySet() instead.
HashAlgorithm - Enum Class in com.yubico.yubikit.oath: Supported hash algorithms for use with the OATH YubiKey application.
hashCode() - Method in class com.yubico.yubikit.oath.Credential
hashCode() - Method in class com.yubico.yubikit.oath.CredentialData
HOTP - Enum constant in enum class com.yubico.yubikit.oath.OathType: OATH HOTP (event based), as defined in RFC 4226

I

isAccessKeySet() - Method in class com.yubico.yubikit.oath.OathSession: Returns true if an Access Key is currently set.
isLocked() - Method in class com.yubico.yubikit.oath.OathSession: Returns true if the session is locked.
isTouchRequired() - Method in class com.yubico.yubikit.oath.Credential: Returns whether or not a user presence check (a physical touch on the sensor of the YubiKey) is required for calculating a Code from this Credential.
isValid(String) - Static method in class com.yubico.yubikit.oath.Base32

O

OathSession - Class in com.yubico.yubikit.oath: Communicates with the OATH application on a YubiKey.
OathSession(SmartCardConnection) - Constructor for class com.yubico.yubikit.oath.OathSession: Establishes a new session with a YubiKeys OATH application.
OathSession(SmartCardConnection, ScpKeyParams) - Constructor for class com.yubico.yubikit.oath.OathSession: Establishes a new session with a YubiKeys OATH application.
OathType - Enum Class in com.yubico.yubikit.oath: Supported OATH variants for use with the OATH YubiKey application.

P

parseUri(URI) - Static method in class com.yubico.yubikit.oath.CredentialData: Parses an otpauth:// URI.
ParseUriException - Exception in com.yubico.yubikit.oath: Thrown when an OATH otpauth:// URI couldn't be parsed.
ParseUriException(String) - Constructor for exception com.yubico.yubikit.oath.ParseUriException
putCredential(CredentialData, boolean) - Method in class com.yubico.yubikit.oath.OathSession: Adds a new Credential to the YubiKey.

R

renameCredential(byte[], byte[]) - Method in class com.yubico.yubikit.oath.OathSession: Change the issuer and name of a Credential already stored on the YubiKey.
renameCredential(Credential, String, String) - Method in class com.yubico.yubikit.oath.OathSession: Change the issuer and name of a Credential already stored on the YubiKey.
reset() - Method in class com.yubico.yubikit.oath.OathSession: Resets the application, deleting all credentials and removing any lock code.

S

setAccessKey(byte[]) - Method in class com.yubico.yubikit.oath.OathSession: Sets an access key.
setPassword(char[]) - Method in class com.yubico.yubikit.oath.OathSession: Sets an Access Key derived from a password.
SHA1 - Enum constant in enum class com.yubico.yubikit.oath.HashAlgorithm
SHA256 - Enum constant in enum class com.yubico.yubikit.oath.HashAlgorithm
SHA512 - Enum constant in enum class com.yubico.yubikit.oath.HashAlgorithm

T

TOTP - Enum constant in enum class com.yubico.yubikit.oath.OathType: OATH TOTP (time based), as defined in RFC 6238

U

unlock(char[]) - Method in class com.yubico.yubikit.oath.OathSession: Unlocks other commands when an Access Key is set, using a password to derive the Access Key.
unlock(AccessKey) - Method in class com.yubico.yubikit.oath.OathSession: Unlocks other commands when an Access Key is set.

V

value - Variable in enum class com.yubico.yubikit.oath.HashAlgorithm
value - Variable in enum class com.yubico.yubikit.oath.OathType
valueOf(String) - Static method in enum class com.yubico.yubikit.oath.HashAlgorithm: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.yubico.yubikit.oath.OathType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.yubico.yubikit.oath.HashAlgorithm: 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.oath.OathType: Returns an array containing the constants of this enum class, in the order they are declared.

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