org.sterl.hash.sha

Class PBKDF2WithHmacSHA

java.lang.Object

org.sterl.hash.sha.PBKDF2WithHmacSHA

All Implemented Interfaces:

PasswordHasher

public class PBKDF2WithHmacSHA
extends Object
implements PasswordHasher

Re-implementation of the Soteria Pbkdf2PasswordHashImpl to share it with other frameworks. Use one of the following PBKDF2 algorithms:

PBKDF2WithHmacSHA224
PBKDF2WithHmacSHA256
PBKDF2WithHmacSHA384
PBKDF2WithHmacSHA512 -- default
 

The encoded format produced is as follows:

 <algorithm>:<iterations>:<base64(salt)>:<base64(hash)>
 

Where:

• algorithm -- the algorithm used to generate the hash
• iterations -- the number of iterations used to generate the hash
• base64(salt) -- the salt used to generate the hash, base64-encoded
• base64(hash) -- the hash value, base64-encoded

Because the algorithm and the parameters used to generate the hash are stored with the hash, the built-in PBKDF2WithHmacSHA implementation can verify hashes generated using algorithm and parameter values that differ from the currently configured values. This means the configuration parameters can be changed without impacting the ability to verify existing password hashes.

(Password hashes generated using algorithms/parameters outside the range supported by PBKDF2WithHmacSHA cannot be verified.)

See Also:

Pbkdf2PasswordHashImpl.java

Constructor Summary

Constructors

Constructor and Description
PBKDF2WithHmacSHA() Creates a new instance using PBKDF2WithHmacSHA512.
PBKDF2WithHmacSHA(String algorithm) Creates a new instance wit the given algorithm and 2048 iterations and 32 for salt and 64 key size.
PBKDF2WithHmacSHA(String algorithm, int iterations, int saltSizeBytes, int keySizeBytes, SecureRandom random) Creates a new instance of PBKDF2WithHmacSHA it also adjust the constructor parameters if the min values aren't honored.

Method Summary

Modifier and Type	Method and Description
String	encode(char[] password) Hashes the given password using PBKDF2.
String	encode(CharSequence rawPassword) Encode the raw password using a hash algorithm and salt.
boolean	matches(char[] password, String hashedPassword) Check the given password against the given hash.
boolean	matches(CharSequence rawPassword, String encodedPassword) Verify the encoded password the raw password after.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PBKDF2WithHmacSHA

public PBKDF2WithHmacSHA(String algorithm,
                         int iterations,
                         int saltSizeBytes,
                         int keySizeBytes,
                         SecureRandom random)

Creates a new instance of PBKDF2WithHmacSHA it also adjust the constructor parameters if the min values aren't honored. Algorithms:

 "PBKDF2WithHmacSHA224",
 "PBKDF2WithHmacSHA256",
 "PBKDF2WithHmacSHA384",
 "PBKDF2WithHmacSHA512"
 

Parameters:

algorithm - default PBKDF2WithHmacSHA512

iterations - basically the strength, default 2048

saltSizeBytes - default 32

keySizeBytes - default 64

random - SecureRandom to generate the salt

PBKDF2WithHmacSHA

public PBKDF2WithHmacSHA()

Creates a new instance using PBKDF2WithHmacSHA512.

See Also:

PBKDF2WithHmacSHA(String, int, int, int, SecureRandom)

PBKDF2WithHmacSHA

public PBKDF2WithHmacSHA(String algorithm)

Creates a new instance wit the given algorithm and 2048 iterations and 32 for salt and 64 key size.

Parameters:

algorithm - e.g. PBKDF2WithHmacSHA512 | PBKDF2WithHmacSHA384 | PBKDF2WithHmacSHA256

Method Detail

encode

public String encode(CharSequence rawPassword)

Encode the raw password using a hash algorithm and salt.

Specified by:

encode in interface PasswordHasher

Parameters:

rawPassword - the raw password to encode

Returns:

the hashed / encoded password

encode

public String encode(char[] password)

Hashes the given password using PBKDF2.

Parameters:

password - the password to encode, not null

Returns:

the encoded password, never null

See Also:

encode(CharSequence)

matches

public boolean matches(CharSequence rawPassword,
                       String encodedPassword)

Verify the encoded password the raw password after. Returns true if the passwords matches, false if they do not.

Specified by:

matches in interface PasswordHasher

Parameters:

rawPassword - the raw password to encode and match

encodedPassword - the encoded password from storage to compare with

Returns:

true if the raw password matches the encoded one.

matches

public boolean matches(char[] password,
                       String hashedPassword)

Check the given password against the given hash.

Parameters:

password - the entered password

hashedPassword - the stored password hash to compare

Returns:

true if matches, otherwise false

See Also:

matches(CharSequence, String)

toString

public String toString()

Overrides:

toString in class Object