com.predic8.membrane.core.interceptor.authentication.session

Class TOTPTokenProvider

java.lang.Object

com.predic8.membrane.core.interceptor.authentication.session.TOTPTokenProvider

All Implemented Interfaces:

TokenProvider

public class TOTPTokenProvider
extends Object
implements TokenProvider

Description

A token provider using the Time-based One-time Password (TOTP) algorithm specified in RFC 6238 to verify tokens using a pre-shared secret.

Explanation

The totpTokenProvider uses the Time-based One-time Password (TOTP) algorithm specified in RFC 6238 to verify tokens using a pre-shared secret.

The tokens consist of 6 digits.

The user's attribute secret is used as the pre-shared secret. If this attribute is missing, the login attempt fails.

Note that the server's system time is taken into account when verifying tokens.

It is possible, for example, to use the Google Authenticator App to store the pre-shared secret and generate such tokens.

Constructor Summary

Constructors

Constructor and Description
TOTPTokenProvider()

Method Summary

Modifier and Type	Method and Description
void	init(Router router)
void	requestToken(Map<String,String> userAttributes)
void	verifyToken(Map<String,String> userAttributes, String token)

Methods inherited from class java.lang.Object

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

Constructor Detail

TOTPTokenProvider

public TOTPTokenProvider()

Method Detail

init

public void init(Router router)

Specified by:

init in interface TokenProvider

requestToken

public void requestToken(Map<String,String> userAttributes)

Specified by:

requestToken in interface TokenProvider

verifyToken

public void verifyToken(Map<String,String> userAttributes,
                        String token)

Specified by:

verifyToken in interface TokenProvider