com.gemalto.idp.mobile.otp.cap.util

Class CapTools

java.lang.Object

com.gemalto.idp.mobile.otp.cap.util.CapTools

public final class CapTools
extends Object

Class for utility functions like OTP scrambling and formatting functions.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static SecureString	prefixSequenceNumberAsHexToOtp(SecureString otp, CapToken token) Prefix an OTP value with token's sequence number as hexadecimal digits.
static SecureString	prefixSequenceNumberToOtp(SecureString otp, CapToken token) Prefix an OTP value with token's sequence number as decimal digits.
static SecureString	prefixSequenceNumberToOtp(SecureString otp, CapToken token, int tokenVersionLength) Prefix an OTP value with a token sequence number, zero padded to the left.

Methods inherited from class java.lang.Object

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

Method Detail

prefixSequenceNumberToOtp

public static SecureString prefixSequenceNumberToOtp(SecureString otp,
                                                     CapToken token,
                                                     int tokenVersionLength)

Prefix an OTP value with a token sequence number, zero padded to the left.

Notice: The token sequence number is not defined for OATH tokens. All OATH token will share the same sequence number as 0xFF.

Warning! This method should be used when token has been provisioned with provisioning protocol v1.

Parameters:

otp - OTP to prefix.

token - The token which generated the otp.

tokenVersionLength - Number of digits to prefix, if needed the tokenSequenceNumber will be zero padded to the left. Maximum length is 3, cannot be 0.

tokenVersionLength	Prefix range
1	1 - 9
2	01 - 99
3	001 - 255

Returns:

The OTP value prefixed.

Throws:

IllegalArgumentException - When tokenSequenceNumber is invalid or the tokenVersionLength is less then the actual length of Sequence Number.

prefixSequenceNumberToOtp

public static SecureString prefixSequenceNumberToOtp(SecureString otp,
                                                     CapToken token)

Prefix an OTP value with token's sequence number as decimal digits.

Notice: The token sequence number is not defined for OATH tokens. All OATH token will share the same sequence number as 0xFF.

Warning! This method should be used when token has been provisioned with provisioning protocol v1.

Parameters:

otp - OTP to prefix.

token - The token which generated the otp. Only significant digits will be used.

Returns:

The OTP value prefixed.

Throws:

IllegalArgumentException - When tokenSequenceNumber is invalid.

prefixSequenceNumberAsHexToOtp

public static SecureString prefixSequenceNumberAsHexToOtp(SecureString otp,
                                                          CapToken token)

Prefix an OTP value with token's sequence number as hexadecimal digits.

Notice: The token sequence number is not defined for OATH tokens. All OATH token will share the same sequence number as 0xFF.

Warning! This method should be used when token has been provisioned with provisioning protocol v2.

Parameters:

otp - OTP to prefix.

token - The token which generated the otp. Only significant digits will be used.

Returns:

The OTP value prefixed.

Throws:

IllegalArgumentException - When tokenSequenceNumber is invalid.