com.yubico.base

Class Token

java.lang.Object

com.yubico.base.Token

public class Token
extends Object

Represents decrypted and parsed YubiKey OTP.

Author:

Simon

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	BLOCK_SIZE
(package private) byte[]	crc
(package private) static int	KEY_SIZE
(package private) byte[]	random
(package private) byte[]	sessionCounter
(package private) byte	timestampHigh
(package private) byte[]	timestampLow
(package private) byte	timesUsed
(package private) byte[]	uid
(package private) static int	UID_SIZE

Constructor Summary

Constructors

Constructor and Description
Token(byte[] b) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getCleanCounter() Gets session counter bytes with cap-lock triggered bit cleared.
byte[]	getCrc() Gets reference to the CRC16 checksum of the OTP.
byte[]	getRandom() Gets reference to the random bytes of the OTP.
byte[]	getSessionCounter() Gets reference to byte sequence of session counter.
byte	getTimestampHigh() Gets high byte of time stamp.
byte[]	getTimestampLow() Gets reference to byte sequence of low part of time stamp.
byte	getTimesUsed() Gets byte value of counter that increases for each generated OTP during a session.
byte[]	getUid() Gets reference to bytes making up secret id.
String	toString()
private static String	toString(byte b)
(package private) static String	toString(byte[] b)
boolean	wasCapsLockOn() Tells if triggered by caps lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCK_SIZE

static int BLOCK_SIZE

KEY_SIZE

static int KEY_SIZE

UID_SIZE

static int UID_SIZE

uid

byte[] uid

sessionCounter

byte[] sessionCounter

timestampLow

byte[] timestampLow

timestampHigh

byte timestampHigh

timesUsed

byte timesUsed

random

byte[] random

crc

byte[] crc

Constructor Detail

Token

public Token(byte[] b)

Constructor.

Parameters:

b - Decrypted OTP to be parsed.

Throws:

IllegalArgumentException - If b not accepted as being a OTP.

Method Detail

getCrc

public byte[] getCrc()

Gets reference to the CRC16 checksum of the OTP.

This property is of little interest to other then unit test code since the checksum was validated when constructing this.

Returns:

CRC16.

getRandom

public byte[] getRandom()

Gets reference to the random bytes of the OTP.

This property is of little interest to other then unit test code.

Returns:

Random bytes.

getUid

public byte[] getUid()

Gets reference to bytes making up secret id.

Returns:

Secret id.

getSessionCounter

public byte[] getSessionCounter()

Gets reference to byte sequence of session counter.

Returns:

Session counter byte sequence.

See Also:

getCleanCounter()

getTimestampHigh

public byte getTimestampHigh()

Gets high byte of time stamp.

Returns:

High time stamp.

getTimestampLow

public byte[] getTimestampLow()

Gets reference to byte sequence of low part of time stamp.

Returns:

Session counter byte sequence of length 2.

toString

private static String toString(byte b)

toString

static String toString(byte[] b)

getCleanCounter

public byte[] getCleanCounter()

Gets session counter bytes with cap-lock triggered bit cleared.

Returns:

Session counter.

getTimesUsed

public byte getTimesUsed()

Gets byte value of counter that increases for each generated OTP during a session.

Returns:

Value.

wasCapsLockOn

public boolean wasCapsLockOn()

Tells if triggered by caps lock.

Returns:

true if, false if not.

toString

public String toString()

Overrides:

toString in class Object