com.helger.security.password.salt

Class PasswordSalt

java.lang.Object

com.helger.security.password.salt.PasswordSalt

All Implemented Interfaces:

IPasswordSalt

@Nonnegative
 @Immutable
public final class PasswordSalt
extends Object
implements IPasswordSalt

Default implementation of IPasswordSalt using VerySecureRandom.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SALT_BYTES Default salt byte length is nothing else is specified.

Constructor Summary

Constructors

Constructor and Description
PasswordSalt() Deprecated. Since 10.1.4. Use createRandom() instead
PasswordSalt(byte[] aBytes) Constructor with salt bytes.
PasswordSalt(int nSaltBytes) Deprecated. Since 10.1.4. Use createRandom(int) instead

Method Summary

Modifier and Type	Method and Description
static PasswordSalt	createFromStringMaybe(String sSalt) Try to create a PasswordSalt object from the passed string.
static PasswordSalt	createRandom()
static PasswordSalt	createRandom(int nSaltBytes) Create a new password salt with the provided byte count.
boolean	equals(Object o)
int	getSaltByteCount()
byte[]	getSaltBytes()
String	getSaltString()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SALT_BYTES

public static final int DEFAULT_SALT_BYTES

Default salt byte length is nothing else is specified.

See Also:

Constant Field Values

Constructor Detail

PasswordSalt

@Deprecated
public PasswordSalt()

Deprecated. Since 10.1.4. Use createRandom() instead

Create a new password salt with the default length of 32 and random bytes.

PasswordSalt

@Deprecated
public PasswordSalt(@Nonnegative
                                 int nSaltBytes)

Deprecated. Since 10.1.4. Use createRandom(int) instead

Constructor to create a new password salt with the provided byte count.

Parameters:

nSaltBytes - The number of salt bytes to use. Must be > 0.

PasswordSalt

public PasswordSalt(@Nonnull @Nonempty
                    byte[] aBytes)

Constructor with salt bytes.

Parameters:

aBytes - Salt bytes to use. May not be null or empty.

Method Detail

getSaltByteCount

@Nonnegative
public int getSaltByteCount()

Specified by:

getSaltByteCount in interface IPasswordSalt

Returns:

The number of salt bytes used. Always > 0.

getSaltBytes

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public byte[] getSaltBytes()

Specified by:

getSaltBytes in interface IPasswordSalt

Returns:

A copy of the pure salt bytes. Never null nor empty.

getSaltString

@Nonnull
 @Nonempty
public String getSaltString()

Specified by:

getSaltString in interface IPasswordSalt

Returns:

The salt bytes in a string representation for easy serialization. Never null nor empty.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createRandom

@Nonnull
public static PasswordSalt createRandom()

Returns:

A new password salt with the default length of 32 and random bytes.

Since:

10.1.4

createRandom

@Nonnull
public static PasswordSalt createRandom(@Nonnegative
                                                  int nSaltBytes)

Create a new password salt with the provided byte count.

Parameters:

nSaltBytes - The number of salt bytes to use. Must be > 0.

Returns:

the new salt object

Since:

10.1.4

createFromStringMaybe

@Nullable
public static PasswordSalt createFromStringMaybe(@Nullable
                                                            String sSalt)

Try to create a PasswordSalt object from the passed string. First the string is hex decoded into a byte array and this is the password salt.

Parameters:

sSalt - The string to be used. May be null.

Returns:

null if the passed salt string is null or empty.

Throws:

IllegalArgumentException - if the passed salt string cannot be hex decoded.