com.github.davidcarboni.cryptolite

Class Password

java.lang.Object

com.github.davidcarboni.cryptolite.Password

public class Password
extends Object

This class provides password hashing and verification. The returned hashes consist of the password hash, prepended with a random salt value. In order to verify a password, the plaintext password should be passed to verify(String, String) along with the stored value originally produced by hash(String). This password hashing and verification is done in the same way as Jasypt, but uses "PBKDF2WithHmacSHA1", rather than MD5.

Author:

David Carboni

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM The password hashing function.
static int	HASH_SIZE The number of bytes to produce in the hash.
static int	ITERATION_COUNT The iteration count for the function.

Constructor Summary

Constructors

Constructor and Description
Password()

Method Summary

Methods

Modifier and Type	Method and Description
static String	hash(String password) Produces a good hash of the given password, using "PBKDF2WithHmacSHA1", an iteration count of 1024 and a random salt value of bytes.
static boolean	verify(String password, String hash) Verifies the given plaintext password against a value that hash(String) produced.

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM

public static final String ALGORITHM

The password hashing function.

See Also:

Constant Field Values

ITERATION_COUNT

public static final int ITERATION_COUNT

The iteration count for the function.

See Also:

Constant Field Values

HASH_SIZE

public static final int HASH_SIZE

The number of bytes to produce in the hash.

See Also:

Constant Field Values

Constructor Detail

Password

public Password()

Method Detail

hash

public static String hash(String password)

Produces a good hash of the given password, using "PBKDF2WithHmacSHA1", an iteration count of 1024 and a random salt value of bytes. The returned value is a concatenation of the salt value and the password hash and this should be passed as returned to verify(String, String) along with the plaintext password.

Parameters:

password - The password to be hashed.

Returns:

The password hash as a base-64 encoded String. If the given password is null, null is returned.

verify

public static boolean verify(String password,
             String hash)

Verifies the given plaintext password against a value that hash(String) produced.

Parameters:

password - A plaintext password. If this is null, false will be returned.

hash - A value previously produced by hash(String). If this is empty or shorter than expected, false will be returned.

Returns:

If the password hashes to the same value as that contained in the hash parameter, true.