org.jboss.sasl.util

Class UsernamePasswordHashUtil

java.lang.Object

org.jboss.sasl.util.UsernamePasswordHashUtil

public class UsernamePasswordHashUtil
extends java.lang.Object

A utility class for generating both the {user-name : realm-value : passwd } hash and the hex encoded version of the hash.

This class makes use of the MessageDigest by single calls to the .digest(byte[]) method, however beyond that there is no synchronisation so this should not be considered thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
private static byte	COLON
private java.security.MessageDigest	digest
private static java.lang.String	MD5

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordHashUtil() The default constructor for UsernamePasswordHashUtil, when instantiated using this constructor a local MD5 MessageDigest will be used for the generated hashes.
UsernamePasswordHashUtil(java.security.MessageDigest digest) Constructor to allow a pre-instantiated MessageDigest to be supplied.

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateHashedHexURP(java.lang.String userName, java.lang.String realm, char[] password)
java.lang.String	generateHashedHexURP(java.lang.String userName, java.lang.String realm, char[] password, boolean utf8StringConversion)
byte[]	generateHashedURP(java.lang.String userName, java.lang.String realm, char[] password)
byte[]	generateHashedURP(java.lang.String userName, java.lang.String realm, char[] password, boolean utf8StringConversion) Takes the supplied username, realm and password and generates the digested { username ':' realm ':' password}
static void	main(java.lang.String[] args)
private byte[]	stringToByte(char[] toConvert, boolean allowUTF8) A version of stringToByte that takes in a char[]
private byte[]	stringToByte(java.lang.String toConvert, boolean allowUTF8) An interpretation of the stringToByte_8859_1 method previously from DigestMD5Base.

Methods inherited from class java.lang.Object

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

Field Detail

MD5

private static final java.lang.String MD5

See Also:

Constant Field Values

COLON

private static final byte COLON

See Also:

Constant Field Values

digest

private final java.security.MessageDigest digest

Constructor Detail

UsernamePasswordHashUtil

public UsernamePasswordHashUtil()
                         throws java.security.NoSuchAlgorithmException

The default constructor for UsernamePasswordHashUtil, when instantiated using this constructor a local MD5 MessageDigest will be used for the generated hashes.

Throws:

java.security.NoSuchAlgorithmException - - If the MD5 MessageDigest fails to be created.

UsernamePasswordHashUtil

public UsernamePasswordHashUtil(java.security.MessageDigest digest)

Constructor to allow a pre-instantiated MessageDigest to be supplied.

The supplied MessageDigest will be used for the hash generation requests,

Parameters:

digest - The MessageDigest to use for hash generation requests.

Method Detail

stringToByte

private byte[] stringToByte(java.lang.String toConvert,
                            boolean allowUTF8)

An interpretation of the stringToByte_8859_1 method previously from DigestMD5Base.

Converts the supplied String to a byte array using 8859_1 encoding, however if any of the characters in the String are outside of the range for 8859_1 and if allowUTF8 is true the String will be converted to UTF-8.

Parameters:

toConvert - the raw String to convert.

allowUTF8 - should the conversion use UTF-8 if non 8859_1 chars are found.

Returns:

the resulting byte[]

stringToByte

private byte[] stringToByte(char[] toConvert,
                            boolean allowUTF8)

A version of stringToByte that takes in a char[]

Parameters:

toConvert - the character array to convert.

allowUTF8 - should the conversion use UTF-8 if non 8859_1 chars are found.

Returns:

the resulting byte[]

generateHashedURP

public byte[] generateHashedURP(java.lang.String userName,
                                java.lang.String realm,
                                char[] password,
                                boolean utf8StringConversion)

Takes the supplied username, realm and password and generates the digested { username ':' realm ':' password}

Parameters:

userName - The username to use in the generated hash.

realm - The realm to use in the generated hash.

password - The password to use in the generated hash.

utf8StringConversion - Should a conversion to UTF-8 be allowed if non 8859_1 chars are encountered.

Returns:

The generated hash.

generateHashedURP

public byte[] generateHashedURP(java.lang.String userName,
                                java.lang.String realm,
                                char[] password)

generateHashedHexURP

public java.lang.String generateHashedHexURP(java.lang.String userName,
                                             java.lang.String realm,
                                             char[] password,
                                             boolean utf8StringConversion)

generateHashedHexURP

public java.lang.String generateHashedHexURP(java.lang.String userName,
                                             java.lang.String realm,
                                             char[] password)

main

public static void main(java.lang.String[] args)
                 throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException