org.kocakosm.jblake2

Interface Blake2

All Known Implementing Classes:

Blake2b, Blake2s

public interface Blake2

Common interface for BLAKE2 flavors BLAKE2b and BLAKE2s.

Author:

Osman Koçak

See Also:

Blake2b, Blake2s, blake2.net, RFC 7693

Method Summary

Modifier and Type	Method and Description
String	algorithm() Returns the algorithm name.
void	burn() Erases the key and resets the digest, thus making this instance functionally equivalent to a newly created unkeyed digest.
Blake2	copy() Returns a copy of this object.
byte[]	digest() Completes the digest computation.
default byte[]	digest(byte... input) Performs a final update on the digest using the specified array of bytes, then completes the digest computation.
default byte[]	digest(byte[] input, int off, int len) Performs a final update on the digest using the specified data bytes, then completes the digest computation.
int	length() Returns the digest's length (in bytes).
Blake2	reset() Resets the digest.
Blake2	update(byte... input) Updates the digest using the given array of bytes.
Blake2	update(byte input) Updates the digest using the given byte.
Blake2	update(byte[] input, int off, int len) Updates the digest using the specified number of bytes from the given array, starting at the specified offset.

Method Detail

algorithm

String algorithm()

Returns the algorithm name.

Returns:

the algorithm name.

burn

void burn()

Erases the key and resets the digest, thus making this instance functionally equivalent to a newly created unkeyed digest. If this instance is already unkeyed, calling this method has no other effect than resetting the digest. Please note that this method can only guarantee that the active copy of the key is erased. Indeed, in practice, an object may have several copies of itself in physical RAM. This is mainly due to the fact that most modern garbage collection algorithms regularly "move" objects in memory. This method is primarily here because it is still considered a good practice to erase sensitive information as soon as possible.

copy

Blake2 copy()

Returns a copy of this object.

Returns:

a copy of this object.

length

int length()

Returns the digest's length (in bytes).

Returns:

the digest's length (in bytes).

reset

Blake2 reset()

Resets the digest. Note that this does not erase the key.

Returns:

this object.

update

Blake2 update(byte input)

Updates the digest using the given byte.

Parameters:

input - the byte with which to update the digest.

Returns:

this object.

update

Blake2 update(byte... input)

Updates the digest using the given array of bytes.

Parameters:

input - the array of bytes with which to update the digest.

Returns:

this object.

Throws:

NullPointerException - if input is null.

update

Blake2 update(byte[] input,
              int off,
              int len)

Updates the digest using the specified number of bytes from the given array, starting at the specified offset.

Parameters:

input - the array of bytes.

off - the offset to start from in the array, inclusive.

len - the number of bytes to use, starting at off.

Returns:

this object.

Throws:

NullPointerException - if input is null.

IllegalArgumentException - if off < 0 || len < 0.

IndexOutOfBoundsException - if off + len > input.length.

digest

default byte[] digest(byte... input)

Performs a final update on the digest using the specified array of bytes, then completes the digest computation. That is, this method first calls update(byte...), passing the input array to the update method, then calls digest(). Note that the digest is reset after this call is made.

Parameters:

input - the array of bytes with which to update the digest before completing its computation.

Returns:

the resulting digest.

Throws:

NullPointerException - if input is null.

digest

default byte[] digest(byte[] input,
                      int off,
                      int len)

Performs a final update on the digest using the specified data bytes, then completes the digest computation. That is, this method first calls update(byte[], int, int), passing the input array to the update method, then calls digest(). Note that the digest is reset after this call is made.

Parameters:

input - the array of bytes.

off - the offset to start from in the array, inclusive.

len - the number of bytes to use, starting at off.

Returns:

the resulting digest.

Throws:

NullPointerException - if input is null.

IllegalArgumentException - if off < 0 || len < 0.

IndexOutOfBoundsException - if off + len > input.length.

digest

byte[] digest()

Completes the digest computation. Note that this digest is reset after this call is made.

Returns:

the resulting digest.