org.picketlink.idm.credential.handler

Class TOTPCredentialHandler

java.lang.Object

org.picketlink.idm.credential.handler.AbstractCredentialHandler<S,V,U>

org.picketlink.idm.credential.handler.PasswordCredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

org.picketlink.idm.credential.handler.TOTPCredentialHandler

All Implemented Interfaces:

CredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

@SupportsCredentials(credentialClass={TOTPCredentials.class,TOTPCredential.class},
                     credentialStorage=OTPCredentialStorage.class)
public class TOTPCredentialHandler
extends PasswordCredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

This particular implementation supports the validation of TOTPCredentials, and updating TOTPCredential credentials.

Author:

Shane Bryzak, Pedro Silva

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM
static String	DEFAULT_DEVICE
static String	DELAY_WINDOW
static String	INTERVAL_SECONDS
static String	NUMBER_DIGITS

Fields inherited from class org.picketlink.idm.credential.handler.PasswordCredentialHandler

ALGORITHM_RANDOM_NUMBER, KEY_LENGTH_RANDOM_NUMBER, PASSWORD_ENCODER, RENEW_RANDOM_NUMBER_GENERATOR_INTERVAL, SECURE_RANDOM_PROVIDER

Constructor Summary

Constructors

Constructor and Description
TOTPCredentialHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	setup(CredentialStore<?> store)
void	update(IdentityContext context, Account account, TOTPCredential credential, CredentialStore<?> store, Date effectiveDate, Date expiryDate) Updates the credential for a certain Account.
void	validate(IdentityContext context, TOTPCredentials credentials, CredentialStore<?> store) Validates a credential.

Methods inherited from class org.picketlink.idm.credential.handler.PasswordCredentialHandler

createCredentialStorage, generateSalt, getAccount, getCredentialStorage, getSecureRandomProvider, validateCredential

Methods inherited from class org.picketlink.idm.credential.handler.AbstractCredentialHandler

getAccount, getAccountById, getDefaultLoginNameProperty, getIdentityManager, isDebugEnabled

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM

public static final String ALGORITHM

See Also:

Constant Field Values

INTERVAL_SECONDS

public static final String INTERVAL_SECONDS

See Also:

Constant Field Values

NUMBER_DIGITS

public static final String NUMBER_DIGITS

See Also:

Constant Field Values

DELAY_WINDOW

public static final String DELAY_WINDOW

See Also:

Constant Field Values

DEFAULT_DEVICE

public static final String DEFAULT_DEVICE

See Also:

Constant Field Values

Constructor Detail

TOTPCredentialHandler

public TOTPCredentialHandler()

Method Detail

setup

public void setup(CredentialStore<?> store)

Specified by:

setup in interface CredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

Overrides:

setup in class PasswordCredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

validate

public void validate(IdentityContext context,
            TOTPCredentials credentials,
            CredentialStore<?> store)

Description copied from interface: CredentialHandler

Validates a credential.

Specified by:

validate in interface CredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

Overrides:

validate in class AbstractCredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

Parameters:

context - The contextual invocation context.

credentials - The credential to be validated.

store - The underlying identity store.

update

public void update(IdentityContext context,
          Account account,
          TOTPCredential credential,
          CredentialStore<?> store,
          Date effectiveDate,
          Date expiryDate)

Description copied from interface: CredentialHandler

Updates the credential for a certain Account.

Specified by:

update in interface CredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

Overrides:

update in class AbstractCredentialHandler<CredentialStore<?>,TOTPCredentials,TOTPCredential>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

credential - The credential to be updated.

store - The underlying identity store.

effectiveDate - The date specifying from when this credential is valid.

expiryDate - The date specifying when the credential expires.