com.yubico.client.v2

Class YubicoClient

java.lang.Object

com.yubico.client.v2.YubicoClient

Direct Known Subclasses:

YubicoClientImpl

public abstract class YubicoClient
extends Object

Base class for doing YubiKey validations using version 2 of the validation protocol. Example usage would be:

  YubicoClient client = YubicoClient.getClient(CLIENT_ID);
  YubicoResponse response = client.verify(otp);
  if(response.getStatus() == YubicoResponseStatus.OK) {
    return true;
  } else {
    return false;
  }
  

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	clientId
protected byte[]	key
private static Integer	OTP_MAX_LEN
private static Integer	OTP_MIN_LEN
protected String	sync
protected String	userAgent
protected String[]	wsapi_urls

Constructor Summary

Constructors

Constructor and Description
YubicoClient()

Method Summary

Methods

Modifier and Type	Method and Description
static YubicoClient	getClient(Integer clientId) Instantiate a YubicoClient object.
Integer	getClientId() Get the ykval client identifier uset do identify the applicaiton.
String	getKey() Get the api key that is used for signing requests
static String	getPublicId(String otp) Extract the public ID of a Yubikey from an OTP it generated.
String	getSync() Get the sync percentage required for a successful auth.
String	getUserAgent() Get the previously set user agent to be used for requests
String[]	getWsapiUrls() Get the list of URLs that will be used for validating OTPs.
static boolean	isValidOTPFormat(String otp) Determines whether a given OTP is of the correct length and only contains printable characters, as per the recommendation.
void	setClientId(Integer clientId) Set the ykval client identifier, used to identify the client application to the validation servers.
void	setKey(String key) Set api key to be used for signing requests
void	setSync(String sync) Set the sync percentage required for a successful auth.
void	setUserAgent(String userAgent) Set user agent to be used in request to validation server
void	setWsapiUrls(String[] wsapi) Configure what URLs to use for validating OTPs.
abstract YubicoResponse	verify(String otp) Validate an OTP using a webservice call to one or more ykval validation servers.

Methods inherited from class java.lang.Object

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

Field Detail

clientId

protected Integer clientId

key

protected byte[] key

sync

protected String sync

wsapi_urls

protected String[] wsapi_urls

userAgent

protected String userAgent

OTP_MIN_LEN

private static final Integer OTP_MIN_LEN

OTP_MAX_LEN

private static final Integer OTP_MAX_LEN

Constructor Detail

YubicoClient

public YubicoClient()

Method Detail

verify

public abstract YubicoResponse verify(String otp)
                               throws YubicoValidationException,
                                      YubicoValidationFailure

Validate an OTP using a webservice call to one or more ykval validation servers.

Parameters:

otp - YubiKey OTP in modhex format

Returns:

result of the webservice validation operation, null on failure

Throws:

YubicoValidationException - for validation errors, like unreachable servers

YubicoValidationFailure - for validation failures, like non matching otps in request and response

IllegalArgumentException - for arguments that are not correctly formatted OTP strings.

getClientId

public Integer getClientId()

Get the ykval client identifier uset do identify the applicaiton.

Returns:

ykval client identifier

See Also:

setClientId(Integer)

setClientId

public void setClientId(Integer clientId)

Set the ykval client identifier, used to identify the client application to the validation servers. Such validation is only required for non-https-v2.0 validation querys, where the clientId tells the server what API key (shared secret) to use to validate requests and sign responses. You can get a clientId and API key for the YubiCloud validation service at https://upgrade.yubico.com/getapikey/

Parameters:

clientId - ykval client identifier

setKey

public void setKey(String key)

Set api key to be used for signing requests

Parameters:

key - ykval client key

See Also:

setClientId(Integer)

getKey

public String getKey()

Get the api key that is used for signing requests

Returns:

ykval client key

See Also:

setClientId(Integer)

setSync

public void setSync(String sync)

Set the sync percentage required for a successful auth. Default is to let the server decide.

Parameters:

sync - percentage or strings 'secure' or 'fast'

getSync

public String getSync()

Get the sync percentage required for a successful auth.

Returns:

sync percentage or strings 'secure' or 'fast'

getWsapiUrls

public String[] getWsapiUrls()

Get the list of URLs that will be used for validating OTPs.

Returns:

list of base URLs

setWsapiUrls

public void setWsapiUrls(String[] wsapi)

Configure what URLs to use for validating OTPs. These URLs will have all the necessary parameters appended to them. Example : {"https://api.yubico.com/wsapi/2.0/verify"}

Parameters:

wsapi - list of base URLs

setUserAgent

public void setUserAgent(String userAgent)

Set user agent to be used in request to validation server

Parameters:

userAgent - the user agent used in requests

getUserAgent

public String getUserAgent()

Get the previously set user agent to be used for requests

Returns:

the user agent that will be used in requests

getClient

public static YubicoClient getClient(Integer clientId)

Instantiate a YubicoClient object.

Returns:

client that can be used to validate YubiKey OTPs

getPublicId

public static String getPublicId(String otp)

Extract the public ID of a Yubikey from an OTP it generated.

Parameters:

otp - The OTP to extract ID from, in modhex format.

Returns:

string Public ID of Yubikey that generated otp. Between 0 and 12 characters.

Throws:

IllegalArgumentException - for arguments that are null or too short to be valid OTP strings.

isValidOTPFormat

public static boolean isValidOTPFormat(String otp)

Determines whether a given OTP is of the correct length and only contains printable characters, as per the recommendation.

Parameters:

otp - The OTP to validate

Returns:

boolean Returns true if it's valid; false otherwise

See Also: