com.inmanlabs.commons.user

Class Secret

java.lang.Object

com.inmanlabs.commons.user.Secret

@Embeddable
public class Secret
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXPIRATION_IN_MINUTES

Constructor Summary

Constructors

Constructor and Description
Secret()

Method Summary

Modifier and Type	Method and Description
java.time.Instant	getExpiration()
String	getHash()
String	getSalt()
static boolean	isValid(String plainText, Secret secret) Returns true if the plaintext "attempt" matches the given hash/salt AND the secret is not expired
static Secret	newSecret(String plainText) Builds a new hashed secret from the plainText string.
static Secret	newSecret(String plainText, int expirationInMinutes) Builds a new hashed secret from the plainText string.
void	setExpiration(java.time.Instant expiration)
void	setHash(String hash)
void	setSalt(String salt)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRATION_IN_MINUTES

public static int DEFAULT_EXPIRATION_IN_MINUTES

Constructor Detail

Secret

public Secret()

Method Detail

getHash

public String getHash()

setHash

public void setHash(String hash)

getSalt

public String getSalt()

setSalt

public void setSalt(String salt)

getExpiration

public java.time.Instant getExpiration()

setExpiration

public void setExpiration(java.time.Instant expiration)

newSecret

public static Secret newSecret(String plainText,
                               int expirationInMinutes)

Builds a new hashed secret from the plainText string. Generates its own salt and sets the given expiration time.

Parameters:

plainText - plaintext of the secret

expirationInMinutes - the number of minutes in which this secret should expire

Returns:

A Hashed, Salted, Expiring Secret

newSecret

public static Secret newSecret(String plainText)
                        throws BadRequestException

Builds a new hashed secret from the plainText string. Generates its own salt and sets the default expiration time.

Parameters:

plainText - A new plaintext secret

Returns:

A Hashed, Salted, Expiring Secret

Throws:

BadRequestException - if plainText is blank

isValid

public static boolean isValid(String plainText,
                              Secret secret)

Returns true if the plaintext "attempt" matches the given hash/salt AND the secret is not expired

Parameters:

plainText - the plaintext attempt

secret - the known fingerprint of the secret

Returns:

a boolean indicating whether the attempt is valid (ie. matches and is not expired)