Package net.shibboleth.idp.plugin.authn.totp.impl

Class GoogleTOTPAuthenticator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.idp.plugin.authn.totp.impl.GoogleTOTPAuthenticator

All Implemented Interfaces:

TOTPAuthenticator, Component, DestructableComponent, InitializableComponent

@ThreadSafeAfterInit
public class GoogleTOTPAuthenticator
extends AbstractInitializableComponent
implements TOTPAuthenticator

A TOTP implementation based on Google Authenticator code.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.plugin.authn.totp.impl.TOTPAuthenticator

TOTPAuthenticator.TOTPCredential

Field Summary

Fields

Modifier and Type	Field	Description
private com.warrenstrange.googleauth.GoogleAuthenticatorConfig	authconfig	Google Authenticator config.
private com.warrenstrange.googleauth.GoogleAuthenticator	authenticator	The implementation.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
GoogleTOTPAuthenticator()

Method Summary

Modifier and Type	Method	Description
TOTPAuthenticator.TOTPCredential	createCredential(String issuer, String accountName)	Generate a new credential.
protected void	doInitialize()
void	setGoogleAuthenticatorConfig(com.warrenstrange.googleauth.GoogleAuthenticatorConfig config)	Set the GoogleAuthenticatorConfig to use.
boolean	validate(byte[] secret, int code)	Validate a secret and code.

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

authconfig

@NonnullAfterInit
private com.warrenstrange.googleauth.GoogleAuthenticatorConfig authconfig

Google Authenticator config.

authenticator

@NonnullAfterInit
private com.warrenstrange.googleauth.GoogleAuthenticator authenticator

The implementation.

Constructor Details

GoogleTOTPAuthenticator

public GoogleTOTPAuthenticator()

Method Details

setGoogleAuthenticatorConfig

public void setGoogleAuthenticatorConfig(@Nonnull
 com.warrenstrange.googleauth.GoogleAuthenticatorConfig config)

Set the GoogleAuthenticatorConfig to use.

Parameters:

config - configuration to use

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

createCredential

@Nonnull
public TOTPAuthenticator.TOTPCredential createCredential(@Nullable @NotEmpty
 String issuer,
 @Nullable @NotEmpty
 String accountName)
                                                  throws GeneralSecurityException

Generate a new credential.

Specified by:

createCredential in interface TOTPAuthenticator

Parameters:

issuer - TOTP credential issuer

accountName - TOTP account holder

Returns:

a new credential

Throws:

GeneralSecurityException - if unable to generate the credential

validate

public boolean validate(@Nonnull @NotEmpty
 byte[] secret,
 int code)

Validate a secret and code.

Specified by:

validate in interface TOTPAuthenticator

Parameters:

secret - token secret/seed, unencoded

code - token code to validate

Returns:

true iff the code is valid