SCRAM - common 2.1 · com.ongres.scram.common.util.CryptoUtil

Modifier and Type	Class and Description
private static class	CryptoUtil.SecureRandomHolder

Modifier and Type	Field and Description
private static final int	EXCLUDED_CHAR
private static final int	MAX_ASCII_PRINTABLE_RANGE
private static final int	MIN_ASCII_PRINTABLE_RANGE

Access	Constructor and Description
public	CryptoUtil()

Method Summary

Modifier and Type	Method and Description
public static byte[]	Returns: The bytes of the computed Hi value hi(SecretKeyFactory The SecretKeyFactory to generate the SecretKey secretKeyFactory, int The length of the key (in bits) keyLength, char[] The char array to compute the Hi function value, byte[] The salt salt, int The number of iterations iterations) Compute the "Hi" function for SCRAM.
public static byte[]	Returns: The bytes of the computed HMAC value hmac(SecretKeySpec A key of the given algorithm secretKeySpec, Mac A MAC instance of the given algorithm mac, byte[] The message to compute the HMAC message) Computes the HMAC of a given message.
public static String	Returns: The String representing the nonce nonce(int The length of the nonce, in characters/bytes size, SecureRandom The SecureRandom to use random) Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').
public static String	Returns: The String representing the nonce nonce(int The length of the nonce, in characters/bytes size) Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').
public static byte[]	xor(byte[] value1, byte[] value2) Computes a byte-by-byte xor operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EXCLUDED_CHAR	back to summary
private static final int EXCLUDED_CHAR

MAX_ASCII_PRINTABLE_RANGE	back to summary
private static final int MAX_ASCII_PRINTABLE_RANGE

MIN_ASCII_PRINTABLE_RANGE	back to summary
private static final int MIN_ASCII_PRINTABLE_RANGE

CryptoUtil	back to summary
public CryptoUtil()

Method Detail

hi back to summary

hi	back to summary
public static byte[] hi(SecretKeyFactory secretKeyFactory, int keyLength, char[] value, byte[] salt, int iterations) Compute the "Hi" function for SCRAM. `Hi(str, salt, i): U1 := HMAC(str, salt + INT(1)) U2 := HMAC(str, U1) ... Ui-1 := HMAC(str, Ui-2) Ui := HMAC(str, Ui-1) Hi := U1 XOR U2 XOR ... XOR Ui where "i" is the iteration count, "+" is the string concatenation operator, and INT(g) is a 4-octet encoding of the integer g, most significant octet first. Hi() is, essentially, PBKDF2 [RFC2898] with HMAC() as the pseudorandom function (PRF) and with dkLen == output length of HMAC() == output length of H().` Parameters secretKeyFactory:SecretKeyFactory The SecretKeyFactory to generate the SecretKey keyLength:int The length of the key (in bits) value:char[] The char array to compute the Hi function salt:byte[] The salt iterations:int The number of iterations Returns:byte[] The bytes of the computed Hi value

public static byte[] hi(SecretKeyFactory secretKeyFactory, int keyLength, char[] value, byte[] salt, int iterations)

Compute the "Hi" function for SCRAM. Hi(str, salt, i): U1 := HMAC(str, salt + INT(1)) U2 := HMAC(str, U1) ... Ui-1 := HMAC(str, Ui-2) Ui := HMAC(str, Ui-1) Hi := U1 XOR U2 XOR ... XOR Ui where "i" is the iteration count, "+" is the string concatenation operator, and INT(g) is a 4-octet encoding of the integer g, most significant octet first. Hi() is, essentially, PBKDF2 [RFC2898] with HMAC() as the pseudorandom function (PRF) and with dkLen == output length of HMAC() == output length of H().

Parameters

secretKeyFactory:SecretKeyFactory: The SecretKeyFactory to generate the SecretKey
keyLength:int: The length of the key (in bits)
value:char[]: The char array to compute the Hi function
salt:byte[]: The salt
iterations:int: The number of iterations

Returns:byte[]

The bytes of the computed Hi value

hmac back to summary

hmac	back to summary
public static byte[] hmac(SecretKeySpec secretKeySpec, Mac mac, byte[] message) Computes the HMAC of a given message. `HMAC(key, str): Apply the HMAC keyed hash algorithm (defined in [RFC2104]) using the octet string represented by "key" as the key and the octet string "str" as the input string. The size of the result is the hash result size for the hash function in use. For example, it is 20 octets for SHA-1 (see [RFC3174]).` Parameters secretKeySpec:SecretKeySpec A key of the given algorithm mac:Mac A MAC instance of the given algorithm message:byte[] The message to compute the HMAC Returns:byte[] The bytes of the computed HMAC value

public static byte[] hmac(SecretKeySpec secretKeySpec, Mac mac, byte[] message)

Computes the HMAC of a given message. HMAC(key, str): Apply the HMAC keyed hash algorithm (defined in [RFC2104]) using the octet string represented by "key" as the key and the octet string "str" as the input string. The size of the result is the hash result size for the hash function in use. For example, it is 20 octets for SHA-1 (see [RFC3174]).

Parameters

secretKeySpec:SecretKeySpec: A key of the given algorithm
mac:Mac: A MAC instance of the given algorithm
message:byte[]: The message to compute the HMAC

Returns:byte[]

The bytes of the computed HMAC value

nonce	back to summary
public static String nonce(int size, SecureRandom random) Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (','). Parameters size:int The length of the nonce, in characters/bytes random:SecureRandom The SecureRandom to use Returns:String The String representing the nonce

nonce

back to summary

public static String nonce(int size, SecureRandom random)

Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').

Parameters

size:int: The length of the nonce, in characters/bytes
random:SecureRandom: The SecureRandom to use

Returns:String

The String representing the nonce

nonce	back to summary
public static String nonce(int size) Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (','). It uses a default SecureRandom instance. Parameters size:int The length of the nonce, in characters/bytes Returns:String The String representing the nonce

nonce

back to summary

public static String nonce(int size)

Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (','). It uses a default SecureRandom instance.

Parameters

size:int: The length of the nonce, in characters/bytes

Returns:String

The String representing the nonce

xor	back to summary
public static byte[] xor(byte[] value1, byte[] value2) throws IllegalArgumentException Computes a byte-by-byte xor operation. `XOR: Apply the exclusive-or operation to combine the octet string on the left of this operator with the octet string on the right of this operator. The length of the output and each of the two inputs will be the same for this use.`

public Class CryptoUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CryptoUtil.SecureRandomHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail