com.yubico.yubikit.configurator

Class YubiKeyConfigurationApplication

java.lang.Object

com.yubico.yubikit.configurator.YubiKeyConfigurationApplication

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class YubiKeyConfigurationApplication
extends java.lang.Object
implements java.io.Closeable

Application that allows to calculate HMAC SHA1 using YubiKey

Constructor Summary

Constructors

Constructor and Description
YubiKeyConfigurationApplication(YubiKeySession session) Create new instance of Iso7816Application and selects the application for use

Method Summary

Modifier and Type	Method and Description
byte[]	calculateHmacSha1(byte[] challenge, Slot slot) Calculates HMAC-SHA1 on given challenge (using secret that configured/programmed on YubiKey)
void	close()
Version	getVersion() Firmware version
void	setHmacSha1ChallengeResponseSecret(byte[] secret, Slot slot, boolean requireTouch) Configures HMAC-SHA1 challenge response secret on YubiKey (@see calculateHmacSha1() how to use it after configuration)
void	setHotpKey(byte[] secret, Slot slot, boolean hotp8digits) Configures YubiKey to return HOTP
void	setOtpKey(byte[] publicId, byte[] privateId, byte[] key, Slot slot) Configures YubiKey to return YubiOTP (one-time password) on touch
void	setStaticPassword(byte[] scanCodes, Slot slot) Configures YubiKey to return static password on touch
void	swapSlots() Method allows to swap data between 1st and 2nd slot of the YubiKey

Methods inherited from class java.lang.Object

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

Constructor Detail

YubiKeyConfigurationApplication

public YubiKeyConfigurationApplication(YubiKeySession session)
                                throws java.io.IOException,
                                       YubiKeyCommunicationException

Create new instance of Iso7816Application and selects the application for use

Parameters:

session - session with YubiKey

Throws:

java.io.IOException - in case of connection error

ApplicationNotFound - if the application is missing or disabled.

YubiKeyCommunicationException

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

calculateHmacSha1

public byte[] calculateHmacSha1(byte[] challenge,
                                Slot slot)
                         throws java.io.IOException,
                                ApduException,
                                NotSupportedOperation

Calculates HMAC-SHA1 on given challenge (using secret that configured/programmed on YubiKey)

Parameters:

challenge - generated challenge that will be sent

slot - the slot on YubiKey that configured with challenge response secret

Returns:

response on challenge returned from YubiKey

Throws:

java.io.IOException - in case of communication error

ApduException

NotSupportedOperation

setHmacSha1ChallengeResponseSecret

public void setHmacSha1ChallengeResponseSecret(byte[] secret,
                                               Slot slot,
                                               boolean requireTouch)
                                        throws java.io.IOException,
                                               NotSupportedOperation,
                                               BadResponseException,
                                               ApduException

Configures HMAC-SHA1 challenge response secret on YubiKey (@see calculateHmacSha1() how to use it after configuration)

Parameters:

secret - the 20 bytes secret for YubiKey to store

slot - the slot on YubiKey that will be configured with challenge response secret

Throws:

java.io.IOException - in case of communication error

NotSupportedOperation

BadResponseException

ApduException

setStaticPassword

public void setStaticPassword(byte[] scanCodes,
                              Slot slot)
                       throws java.io.IOException,
                              ApduException,
                              BadRequestException,
                              BadResponseException

Configures YubiKey to return static password on touch

Parameters:

scanCodes - the password to store on YubiKey as an array of keyboard scan codes.

slot - the slot on YubiKey that will be configured with provided password (One - short touch, Two - long touch)

Throws:

java.io.IOException - in case of communication error

ApduException - in case of unexpected usage or error response from YubiKey

BadRequestException

BadResponseException

setOtpKey

public void setOtpKey(byte[] publicId,
                      byte[] privateId,
                      byte[] key,
                      Slot slot)
               throws java.io.IOException,
                      NotSupportedOperation,
                      BadResponseException,
                      ApduException

Configures YubiKey to return YubiOTP (one-time password) on touch

Parameters:

publicId - public id

privateId - private id

key - the secret key to store on YubiKey

slot - the slot on YubiKey that will be configured with OTP (One - short touch, Two - long touch)

Throws:

java.io.IOException - in case of communication error

NotSupportedOperation

BadResponseException

ApduException

setHotpKey

public void setHotpKey(byte[] secret,
                       Slot slot,
                       boolean hotp8digits)
                throws java.io.IOException,
                       NotSupportedOperation,
                       BadResponseException,
                       ApduException

Configures YubiKey to return HOTP

Parameters:

secret - the 20 bytes secret for YubiKey to store

slot - the slot on YubiKey that will be configured with HOTP (slot 1 - short touch, slot 2 - long touch)

hotp8digits - if true will generate 8 digits code (default is 6)

Throws:

java.io.IOException - in case of communication error

NotSupportedOperation

BadResponseException

ApduException

swapSlots

public void swapSlots()
               throws java.io.IOException,
                      NotSupportedOperation,
                      BadResponseException,
                      ApduException

Method allows to swap data between 1st and 2nd slot of the YubiKey

Throws:

java.io.IOException - in case of communication error

NotSupportedOperation

BadResponseException

ApduException

getVersion

public Version getVersion()

Firmware version

Returns:

Yubikey firmware version