com.gemalto.idp.mobile.otp.cap

Interface CapDevice

public interface CapDevice

An interface defining a device that generates CAP based OTPs.

Method Summary

Modifier and Type	Method and Description
SecureString	getOtpMode1(AuthInput authInput, SecureString challenge, SecureString amount, Currency currency) Creates a mode 1 OTP.
SecureString	getOtpMode2(AuthInput authInput) Creates a mode 2 OTP.
SecureString	getOtpMode2Tds(AuthInput authInput, List<SecureString> dataToSign) Creates a mode 2 transaction data signature OTP.
SecureString	getOtpMode3(AuthInput authInput, SecureString challenge) Creates a mode 3 OTP.
boolean	isMode1AmountRequired() Check if amount is required for a mode 1 operation (getOtpMode1(com.gemalto.idp.mobile.authentication.AuthInput, com.gemalto.idp.mobile.core.util.SecureString, com.gemalto.idp.mobile.core.util.SecureString, java.util.Currency)).
boolean	isMode1CurrencyRequired() Check if currency is required for a mode 1 operation (getOtpMode1(com.gemalto.idp.mobile.authentication.AuthInput, com.gemalto.idp.mobile.core.util.SecureString, com.gemalto.idp.mobile.core.util.SecureString, java.util.Currency)).

Method Detail

isMode1AmountRequired

boolean isMode1AmountRequired()

Check if amount is required for a mode 1 operation (getOtpMode1(com.gemalto.idp.mobile.authentication.AuthInput, com.gemalto.idp.mobile.core.util.SecureString, com.gemalto.idp.mobile.core.util.SecureString, java.util.Currency)).

This method is affected by the IAF value. For example, an IAF of 0x70 does not include the amount while 0xA0 includes the amount

Returns:

true if amount is required

isMode1CurrencyRequired

boolean isMode1CurrencyRequired()

Check if currency is required for a mode 1 operation (getOtpMode1(com.gemalto.idp.mobile.authentication.AuthInput, com.gemalto.idp.mobile.core.util.SecureString, com.gemalto.idp.mobile.core.util.SecureString, java.util.Currency)).

This method is affected by the IAF value. For example, an IAF of 0x70 does not include the currency while 0x80 includes the amount

Returns:

true if currency is required

getOtpMode1

SecureString getOtpMode1(AuthInput authInput,
                         SecureString challenge,
                         SecureString amount,
                         Currency currency)
                  throws IdpException

Creates a mode 1 OTP. The typical use case of this OTP is for purchasing items from a merchant.

Parameters:

authInput - the AuthInput

challenge - the merchant challenge: An unpredictable number of up to 8 hexdecimal digits

amount - the amount. If isMode1AmountRequired() returns true the argument is required. Otherwise the argument is ignored.

currency - the currency of the transaction. If isMode1CurrencyRequired() returns true the argument is required. Otherwise the argument is ignored.

Returns:

the mode 1 OTP

Throws:

IdpRuntimeException - when there is a cryptography operation failure.

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when there is a database operation failure.

WrappedCounterException - when the ATC/counter reaches its maximum value.

DeviceFingerprintException - when the token's fingerprint checksum does not match.

PasswordManagerException - when the TOKEN domain is not logged in (using one of the password managers)

IdpAuthException - when the authentication mode is not supported by the token.

Since:

4.0

getOtpMode2

SecureString getOtpMode2(AuthInput authInput)
                  throws IdpException

Creates a mode 2 OTP. The typical use case of this mode is for simple authentication.

Parameters:

authInput - the AuthInput

Returns:

the mode 2 OTP

Throws:

IdpRuntimeException - when there is a cryptography operation failure.

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when there is a database operation failure.

WrappedCounterException - when the ATC/counter reaches its maximum value.

DeviceFingerprintException - when the token's fingerprint checksum does not match.

PasswordManagerException - when the TOKEN domain is not logged in (using one of the password managers)

IdpAuthException - when the authentication mode is not supported by the token.

Since:

4.0

getOtpMode2Tds

SecureString getOtpMode2Tds(AuthInput authInput,
                            List<SecureString> dataToSign)
                     throws IdpException

Creates a mode 2 transaction data signature OTP. The typical use case of this mode is for signing a set of transaction data. One such example is to sign the destination bank account in a transaction.

Parameters:

authInput - the AuthInput

dataToSign - the list of data to be signed, data should only contain digits, maximum 10 digit per data and maximum 10 data fields in the list. Don't pass empty data, at least one non-empty data is required.

Returns:

the mode 2 TDS OTP

Throws:

IdpRuntimeException - when there is a cryptography operation failure.

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when there is a database operation failure.

WrappedCounterException - when the ATC/counter reaches its maximum value.

DeviceFingerprintException - when the token's fingerprint checksum does not match.

PasswordManagerException - when the TOKEN domain is not logged in (using one of the password managers)

IdpAuthException - when the authentication mode is not supported by the token.

Since:

4.0

getOtpMode3

SecureString getOtpMode3(AuthInput authInput,
                         SecureString challenge)
                  throws IdpException

Creates a mode 3 OTP. The typical use case of this mode is for challenge/response. One such example is to log into a bank's website.

Parameters:

authInput - the AuthInput

challenge - the login challenge: An unpredictable number of up to 8 hexdecimal digits

Returns:

the mode 3 OTP

Throws:

IdpRuntimeException - when there is a cryptography operation failure

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when there is a database operation failure

WrappedCounterException - when the ATC/counter reaches its maximum value.

DeviceFingerprintException - when the token's fingerprint checksum does not match.

PasswordManagerException - when the TOKEN domain is not logged in (using one of the password managers)

IdpAuthException - when the authentication mode is not supported by the token.

Since:

4.0