org.forgerock.openam.authentication.modules.oath

Class TOTPAlgorithm

java.lang.Object

org.forgerock.openam.authentication.modules.oath.TOTPAlgorithm

public class TOTPAlgorithm
extends Object

This is an example implementation of the OATH TOTP algorithm. Visit www.openauthentication.org for more information.

Author:

Johan Rydell, PortWise, Inc.

Method Summary

Modifier and Type	Method and Description
static String	generateTOTP(byte[] key, String time, String returnDigits) This method generates a TOTP value for the given set of parameters.
static String	generateTOTP(byte[] key, String time, String returnDigits, String crypto) This method generates a TOTP value for the given set of parameters.
static String	generateTOTP256(byte[] key, String time, String returnDigits) This method generates a TOTP value for the given set of parameters.
static String	generateTOTP512(byte[] key, String time, String returnDigits) This method generates a TOTP value for the given set of parameters.

Methods inherited from class java.lang.Object

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

Method Detail

generateTOTP

public static String generateTOTP(byte[] key,
                                  String time,
                                  String returnDigits)

This method generates a TOTP value for the given set of parameters.

Parameters:

key - the shared secret HEX encoded

time - a value that reflects a time

returnDigits - number of digits to return

Returns:

a numeric String in base 10 that includes truncationDigits digits

generateTOTP256

public static String generateTOTP256(byte[] key,
                                     String time,
                                     String returnDigits)

This method generates a TOTP value for the given set of parameters.

Parameters:

key - the shared secret

time - a value that reflects a time

returnDigits - number of digits to return

Returns:

a numeric String in base 10 that includes truncationDigits digits

generateTOTP512

public static String generateTOTP512(byte[] key,
                                     String time,
                                     String returnDigits)

This method generates a TOTP value for the given set of parameters.

Parameters:

key - the shared secret

time - a value that reflects a time

returnDigits - number of digits to return

Returns:

a numeric String in base 10 that includes truncationDigits digits

generateTOTP

public static String generateTOTP(byte[] key,
                                  String time,
                                  String returnDigits,
                                  String crypto)

This method generates a TOTP value for the given set of parameters.

Parameters:

key - the shared secret

time - a value that reflects a time

returnDigits - number of digits to return

crypto - the crypto function to use

Returns:

a numeric String in base 10 that includes truncationDigits digits