Class RecoveryCodeService

java.lang.Object

com.codename1.backend.security.mfa.RecoveryCodeService

public final class RecoveryCodeService
extends Object

Recovery codes: what signs a user in when their authenticator app is gone.

generate(String) makes ten, to be shown to the user once and never again -- the server keeps a salted PBKDF2 password hash of each and cannot show them a second time. Each works once, in place of a one-time code at sign-in. Generating again replaces whatever was left.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COUNT	How many codes generate(String) makes.

Constructor Summary

Constructors

Constructor	Description
RecoveryCodeService(RecoveryCodeRepository repository)

Method Summary

Modifier and Type	Method	Description
boolean	consume(String username, String code)	Uses a code up.
List<String>	generate(String username)	Makes COUNT new codes for username, replacing any they had.
static boolean	isCodeShaped(String code)	Whether code is written as a recovery code is: ten letters and digits, with or without the dash.
int	remaining(String username)	How many codes username has left.

Methods inherited from class Object

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

Field Details

COUNT

public static final int COUNT

How many codes generate(String) makes.

See Also:

• Constant Field Values

Constructor Details

RecoveryCodeService

public RecoveryCodeService(RecoveryCodeRepository repository)

Method Details

generate

public List<String> generate(String username)

Makes COUNT new codes for username, replacing any they had.

Returns:

the codes, each written xxxxx-xxxxx: the only time they exist outside the user's keeping

consume

public boolean consume(String username,
 String code)

Uses a code up. At most four verifications run in this process, and at most one per username (case insensitive). A busy verifier returns false immediately; it does not consume a code or queue password-hashing work.

Returns:

whether code was one of username's unused codes

isCodeShaped

public static boolean isCodeShaped(String code)

Whether code is written as a recovery code is: ten letters and digits, with or without the dash. It says nothing about whether anybody has that code -- only that it is not something else, such as the digits of a one-time code.

remaining

public int remaining(String username)

How many codes username has left.