com.yubico.yubikit.oath

Class CredentialData

java.lang.Object

com.yubico.yubikit.oath.CredentialData

All Implemented Interfaces:

java.io.Serializable

public class CredentialData
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DIGITS
static int	DEFAULT_PERIOD

Constructor Summary

Constructors

Constructor and Description
CredentialData(java.lang.String name, OathType oathType, HashAlgorithm hashAlgorithm, byte[] secret, int digits, int period, int counter, java.lang.String issuer) Creates instance of Credential

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getCounter() Initial counter (for HOTP) , default is 0
int	getDigits() Number of digits that going to be used for code (value: 6,7 or 8)
HashAlgorithm	getHashAlgorithm() Hash algorithm HashAlgorithm
byte[]	getId() Gets name of credential that used as unique identifier
java.lang.String	getIssuer() Name of credential issuer (e.g.
java.lang.String	getName() Get the name of the credential, typically a username.
OathType	getOathType() Oath type OathType
int	getPeriod() Period in seconds for how long code is valid from its calculation/generation time
byte[]	getSecret() Secret that is going to be hashed with hashAlgorithm
int	hashCode()
boolean	isTouchRequired()
static CredentialData	parseUri(android.net.Uri uri) Parse credential properties from an otpauth:// URI, as specified by https://github.com/google/google-authenticator/wiki/Key-Uri-Format Format example: otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example
void	setIssuer(java.lang.String issuer) Set the issuer for the Credential, typically the name of the service.
void	setName(java.lang.String name) Set the name of the Credential, typically a username.
void	setTouchRequired(boolean touchRequired) Sets flag that credential requires touch.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PERIOD

public static final int DEFAULT_PERIOD

See Also:

Constant Field Values

DEFAULT_DIGITS

public static final int DEFAULT_DIGITS

See Also:

Constant Field Values

Constructor Detail

CredentialData

public CredentialData(java.lang.String name,
                      OathType oathType,
                      HashAlgorithm hashAlgorithm,
                      byte[] secret,
                      int digits,
                      int period,
                      int counter,
                      java.lang.String issuer)

Creates instance of Credential

Parameters:

name - the name/label

oathType - TOTP or HOTP

hashAlgorithm - SHA1, SHA265 or SHA 512

secret - the key data

digits - the number of digits in OATH code

period - the period in seconds how long TOTP is valid

counter - Imf for HOTP

issuer - issuer name

Method Detail

parseUri

public static CredentialData parseUri(android.net.Uri uri)
                               throws ParseUriException

Parse credential properties from an otpauth:// URI, as specified by https://github.com/google/google-authenticator/wiki/Key-Uri-Format Format example: otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example

Parameters:

uri - Uri that received from QR reader or manually from server that requires TOTP/HOTP

Returns:

Credential object that needs to be sent to yubikey to store and generate codes

Throws:

ParseUriException - in case if Uri format is incorrect

setIssuer

public void setIssuer(java.lang.String issuer)

Set the issuer for the Credential, typically the name of the service.

Parameters:

issuer - the name of the issuer.

setName

public void setName(java.lang.String name)

Set the name of the Credential, typically a username.

Parameters:

name - the name of the Credential.

setTouchRequired

public void setTouchRequired(boolean touchRequired)

Sets flag that credential requires touch. Use it when create new Credential and user specified that calculation requires touch

Parameters:

touchRequired - true if requires touch, default is false

getName

public java.lang.String getName()

Get the name of the credential, typically a username.

Returns:

the name

getId

public byte[] getId()

Gets name of credential that used as unique identifier

Returns:

[PERIOD/][ISSUER:]NAME

getOathType

public OathType getOathType()

Oath type OathType

Returns:

HOTP or TOTP

getHashAlgorithm

public HashAlgorithm getHashAlgorithm()

Hash algorithm HashAlgorithm

Returns:

SHA1, SHA256, SHA512

getSecret

public byte[] getSecret()

Secret that is going to be hashed with hashAlgorithm

Returns:

the secret

getIssuer

public java.lang.String getIssuer()

Name of credential issuer (e.g. Google, Amazon, Facebook, etc)

Returns:

the issuer

getDigits

public int getDigits()

Number of digits that going to be used for code (value: 6,7 or 8)

Returns:

number of digits in code

getPeriod

public int getPeriod()

Period in seconds for how long code is valid from its calculation/generation time

Returns:

the period (in seconds)

getCounter

public int getCounter()

Initial counter (for HOTP) , default is 0

Returns:

the counter

isTouchRequired

public boolean isTouchRequired()

Returns:

true if calculation requires touch on yubikey button

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object