Interface CodeVerifier
@AvailableSince("0.0.25")
public interface CodeVerifier
Use this interface to verify if the given totp code is valid (it's safe against timing attacks)
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic CodeVerifiercreate(CodeGenerator codeGenerator, TimeProvider timeProvider) static CodeVerifiercreate(CodeGenerator codeGenerator, TimeProvider timeProvider, int timePeriod, int allowedTimePeriodDiscrepancy) booleanisValidCode(String secret, String attemptCode) Use this method to check if the given code is valid (it's safe against timing attacks)
-
Method Details
-
create
- Parameters:
codeGenerator- which code generator to usetimeProvider- which time provider to use- Returns:
- the created code verifier
-
create
static CodeVerifier create(CodeGenerator codeGenerator, TimeProvider timeProvider, int timePeriod, int allowedTimePeriodDiscrepancy) - Parameters:
codeGenerator- which code generator to usetimeProvider- which time provider to usetimePeriod- the time period in seconds (default is 30 sec)allowedTimePeriodDiscrepancy- the allowed time period discrepancy in seconds (default is 1) Note if it's 1 it will check 30 seconds before and ahead of the current time)- Returns:
- the created code verifier
-
isValidCode
Use this method to check if the given code is valid (it's safe against timing attacks)- Parameters:
secret- The shared secret key to generate the code withattemptCode- The n-digit code given by the user- Returns:
- True if the code is valid, else false
-