com.gemalto.idp.mobile.otp.util

Class OtpTools

java.lang.Object

com.gemalto.idp.mobile.otp.util.OtpTools

public final class OtpTools
extends Object

Class for utility functions like OTP scrambling and formatting functions.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OtpTools.FormatType Supported formatting modes for OTP.
static class	OtpTools.ScrambleType Supported scramble modes for OTP.

Method Summary

Modifier and Type	Method and Description
static SecureString	formatOtp(OtpTools.FormatType mode, SecureString otp) Format the OTP with according provided mode.
static SecureString	padOtpWithZero(SecureString otp, int minLength) left pad an OTP with Zero if needed.
static SecureString	scrambleOtp(OtpTools.ScrambleType mode, SecureString otp) Compute a scrambled OTP from original OTP.

Methods inherited from class java.lang.Object

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

Method Detail

scrambleOtp

public static SecureString scrambleOtp(OtpTools.ScrambleType mode,
                                       SecureString otp)

Compute a scrambled OTP from original OTP.

Parameters:

mode - - Specifies the mode of scrambling function

otp - - Original otp. Length must greater or equal to 5 and only digits are accepted.

Returns:

The scrambled OTP

Throws:

IllegalArgumentException - When scramble type or otp is invalid

formatOtp

public static SecureString formatOtp(OtpTools.FormatType mode,
                                     SecureString otp)

Format the OTP with according provided mode.

Parameters:

mode - - Specifies the mode of formatting function

otp - - original OTP if mode is see OtpTools.FormatType.CAP

OTP length	Formatted OTP
1	X
2	XX
3	XXX
4	XXXX
5	XX XXX
6	XXX XXX
7	XXX XXXX
8	XXXX XXXX
9	XXX XXX XXX
10	XX XXXX XXXX
11	XXXXXXXXXXX
12	XXXXXXXXXXXX
>12	not changed

Returns:

The formatted OTP

Throws:

IllegalArgumentException - when the otp or format type is invalid

IllegalArgumentException - when the mode is CAP and the otp contains a non-digit character.

padOtpWithZero

public static SecureString padOtpWithZero(SecureString otp,
                                          int minLength)

left pad an OTP with Zero if needed.

Parameters:

otp - OTP to pad.

minLength - The minimum length of the padded OTP. If minLength is lower than the otp length, no padding is added and a copy of otp is returned (so original one can be wiped).

Returns:

The OTP value padded.