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

Interface TOTPAuthenticator

All Known Implementing Classes:

GoogleTOTPAuthenticator

public interface TOTPAuthenticator

Interface to a TOTP implementation's primitives.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TOTPAuthenticator.TOTPCredential	Interface to a TOTP credential.

Method Summary

Modifier and Type	Method	Description
TOTPAuthenticator.TOTPCredential	createCredential(String issuer, String accountName)	Generate a new credential.
boolean	validate(byte[] secret, int code)	Validate a secret and code.

Method Details

createCredential

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

Generate a new credential.

Parameters:

issuer - TOTP credential issuer

accountName - TOTP account holder

Returns:

a new credential

Throws:

GeneralSecurityException - if unable to generate the credential

validate

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

Validate a secret and code.

Parameters:

secret - token secret/seed, unencoded

code - token code to validate

Returns:

true iff the code is valid