com.virgilsecurity.crypto

Class VirgilHash

java.lang.Object

com.virgilsecurity.crypto.VirgilAsn1Compatible

com.virgilsecurity.crypto.VirgilHash

All Implemented Interfaces:

AutoCloseable

public class VirgilHash
extends VirgilAsn1Compatible
implements AutoCloseable

Provides hashing algorithms.

Author:

Andrii Iakovenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirgilHash.Algorithm Enumerates possible Hash algorithms.

Field Summary

Fields inherited from class com.virgilsecurity.crypto.VirgilAsn1Compatible

swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
	VirgilHash() Create a new instance of VirgilHash
protected	VirgilHash(long cPtr, boolean cMemoryOwn)
	VirgilHash(String name) Create a new instance of VirgilHash with given algorithm name.
	VirgilHash(VirgilHash.Algorithm alg) Create a new instance of VirgilHash with given algorithm.

Method Summary

Modifier and Type	Method and Description
void	close()
void	delete()
protected void	finalize()
byte[]	finish() Return final data hash.
protected static long	getCPtr(VirgilHash obj)
byte[]	hash(byte[] data) Process the given data immediately and return it's hash.
byte[]	hmac(byte[] key, byte[] data) Process the given message immediately and return it's HMAC hash.
byte[]	hmacFinish() Return final data HMAC hash.
void	hmacReset() Reset HMAC hashing for the new data hash.
void	hmacStart(byte[] key) Initialize HMAC hashing for the new data hash.
void	hmacUpdate(byte[] data) Update / process message HMAC hash.
String	name() Returns name of the hash function.
void	start() Initialize hashing for the new data hash.
int	type() Return underlying hash type.
void	update(byte[] data) Update / process message hash.

Methods inherited from class com.virgilsecurity.crypto.VirgilAsn1Compatible

fromAsn1, getCPtr, toAsn1

Methods inherited from class java.lang.Object

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

Constructor Detail

VirgilHash

protected VirgilHash(long cPtr,
                     boolean cMemoryOwn)

VirgilHash

public VirgilHash()

Create a new instance of VirgilHash

VirgilHash

public VirgilHash(VirgilHash.Algorithm alg)

Create a new instance of VirgilHash with given algorithm.

Parameters:

alg - The algorithm.

VirgilHash

public VirgilHash(String name)

Create a new instance of VirgilHash with given algorithm name.

Parameters:

name - The algorithm name.

Method Detail

getCPtr

protected static long getCPtr(VirgilHash obj)

finalize

protected void finalize()

Overrides:

finalize in class VirgilAsn1Compatible

delete

public void delete()

Overrides:

delete in class VirgilAsn1Compatible

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class VirgilAsn1Compatible

name

public String name()

Returns name of the hash function.

Returns:

Name of the hash function.

type

public int type()

Return underlying hash type. Used for internal purposes only.

Returns:

the hash type.

hash

public byte[] hash(byte[] data)

Process the given data immediately and return it's hash.

Parameters:

data - Date to be hashed.

Returns:

Hash of the given data.

start

public void start()

Initialize hashing for the new data hash.

update

public void update(byte[] data)

Update / process message hash.

This method MUST be used after start() method only. This method MAY be called multiple times to process long message splitted to a shorter chunks.

Parameters:

data - The data to be hashed.

finish

public byte[] finish()

Return final data hash.

Returns:

Data hash processed by series of update(byte[]) method.

hmac

public byte[] hmac(byte[] key,
                   byte[] data)

Process the given message immediately and return it's HMAC hash.

Parameters:

key - Secret key.

data - Data to be hashed.

Returns:

HMAC hash of the given data.

hmacStart

public void hmacStart(byte[] key)

Initialize HMAC hashing for the new data hash.

Parameters:

key - Secret key.

hmacReset

public void hmacReset()

Reset HMAC hashing for the new data hash.

hmacUpdate

public void hmacUpdate(byte[] data)

Update / process message HMAC hash.

This method MUST be used after hmacStart(byte[]) or hmacReset() methods only. This method MAY be called multiple times to process long message splitted to a shorter chunks.

Parameters:

data - Data to be hashed.

hmacFinish

public byte[] hmacFinish()

Return final data HMAC hash.

Returns:

Data HMAC hash processed by series of hmacUpdate(byte[]) method.