IPWorks Encrypt 2022 Java Edition
Version 22.0 [Build 8369]

Hash Class

Properties   Methods   Events   Config Settings   Errors  

The Hash class allows you to compute a hash using various algorithms.

Syntax

ipworksencrypt.Hash

Remarks

The Hash component allows you to compute a hash using various algorithms including SHA1, SHA224, SHA256, SHA384, SHA512, MD2, MD4, MD5, RIPEMD160, MD5SHA1, HMACMD5, HMACSHA1, HMACSHA224, HMACSHA256, HMACSHA384, HMACSHA512, etc.

To begin, first select the algorithm you wish to use when computing the hash. Common choices include MD5 and SHA1. For a full list of supported algorithms see the Algorithm property.

Next specify the data to hash. Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

When a valid source is found the search stops.

Call the ComputeHash method to hash the data. The HashValue property will hold the computed hash. By default the hash value is hex encoded for ease of use, but you may disable this by setting EncodeHash to False.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AlgorithmThe algorithm used to create the hash.
EncodeHashWhether the hash value is hex encoded.
HashValueThe hash value.
InputFileThe file to process.
InputMessageThe message to process.
KeyThe secret key for the hash algorithm.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ComputeHashComputes a hash.
ConfigSets or retrieves a configuration setting.
HashBlockComputes the hash value of specified data.
ResetResets the class.
SetInputStreamSets the stream from which the class will read data.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
ProgressFired as progress is made.

Config Settings


The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CloseInputStreamAfterProcessingDetermines whether or not the input stream is closed after processing.
HashSizeThe size of the computed hash code, read-only.
SHA3UseKeccakWhether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm.
UsePlatformHashWhether or not to use the Windows platform hash implementation.
BuildInfoInformation about the product's build.
GUIAvailableTells the class whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Algorithm Property (Hash Class)

The algorithm used to create the hash.

Syntax


public int getAlgorithm();


public void setAlgorithm(int algorithm);


Enumerated values:
  public final static int haSHA1 = 0;
  public final static int haSHA224 = 1;
  public final static int haSHA256 = 2;
  public final static int haSHA384 = 3;
  public final static int haSHA512 = 4;
  public final static int haMD2 = 5;
  public final static int haMD4 = 6;
  public final static int haMD5 = 7;
  public final static int haRIPEMD160 = 8;
  public final static int haMD5SHA1 = 9;
  public final static int haHMACMD5 = 10;
  public final static int haHMACSHA1 = 11;
  public final static int haHMACSHA224 = 12;
  public final static int haHMACSHA256 = 13;
  public final static int haHMACSHA384 = 14;
  public final static int haHMACSHA512 = 15;
  public final static int haHMACRIPEMD160 = 16;
  public final static int haSHA3_224 = 17;
  public final static int haSHA3_256 = 18;
  public final static int haSHA3_384 = 19;
  public final static int haSHA3_512 = 20;
  public final static int haSHA512_224 = 21;
  public final static int haSHA512_256 = 22;

Default Value

2

Remarks

This property specifies the algorithm used when calling ComputeHash. Possible values are:

0 (haSHA1) SHA1
1 (haSHA224) SHA-224
2 (haSHA256 - default) SHA-256
3 (haSHA384) SHA-384
4 (haSHA512) SHA-512
5 (haMD2) MD2
6 (haMD4) MD4
7 (haMD5) MD5
8 (haRIPEMD160) RIPEMD-160
9 (haMD5SHA1) MD5SHA1
10 (haHMACMD5) HMAC-MD5
11 (haHMACSHA1) HMAC-SHA1
12 (haHMACSHA224) HMAC-SHA224
13 (haHMACSHA256) HMAC-SHA256
14 (haHMACSHA384) HMAC-SHA384
15 (haHMACSHA512) HMAC-SHA512
16 (haHMACRIPEMD160) HMAC-RIPEMD-160
17 (haSHA3_224) SHA-3-224 (originally known as Keccak)
18 (haSHA3_256) SHA-3-256 (originally known as Keccak)
19 (haSHA3_384) SHA-3-384 (originally known as Keccak)
20 (haSHA3_512) SHA-3-512 (originally known as Keccak)
21 (haSHA512_224) SHA-512/224
22 (haSHA512_256) SHA-512/256

EncodeHash Property (Hash Class)

Whether the hash value is hex encoded.

Syntax


public boolean isEncodeHash();


public void setEncodeHash(boolean encodeHash);

Default Value

True

Remarks

This property specifies whether the computed hash value is hex encoded. When set to True (default) the class will hex encoded the computed hash for easier use. Set this value to False to obtain the hash value in an unmodified form.

The default value is True.

HashValue Property (Hash Class)

The hash value.

Syntax


public byte[] getHashValue();


Default Value

""

Remarks

The computed hash value. This property is populated after calling ComputeHash.

This property is read-only.

InputFile Property (Hash Class)

The file to process.

Syntax


public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

When a valid source is found the search stops.

InputMessage Property (Hash Class)

The message to process.

Syntax


public byte[] getInputMessage();


public void setInputMessage(byte[] inputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

When a valid source is found the search stops.

Key Property (Hash Class)

The secret key for the hash algorithm.

Syntax


public byte[] getKey();


public void setKey(byte[] key);

Default Value

""

Remarks

This property holds the secret key used when creating the hash. The key can be arbitrarily long.

Note: This property is only applicable when Algorithm is set to an HMAC algorithm.

It is recommended that the length of the key be equal to or larger than the hash size of the algorithm. Use of keys shorter than the hash size is discouraged.

Sizes (in bytes)

SHA1SHA224SHA256SHA384SHA512MD5RIPEMD160
Recommended Key Size20 28 32 48 64 16 20
Hash Size 20 28 32 48 64 16 20
Block Size 64 64 64 128 128 64 64

Key Length Details

As mentioned above it is recommended to use a key size equal to the hash size. Use of keys larger than the hash size does not typically significantly increase the function strength. Keys of any length are technically valid however see the below processing rules to understand how keys of varying lengths are treated:

  • If the key length is equal to the hash size (recommended) it is used without modification.
  • If the key length is less than the hash size it is used without modification.
  • If the key length is less than or equal to the block size it is used without modification.
  • If the key length is larger than the block size is it first hashed with the same algorithm.

ComputeHash Method (Hash Class)

Computes a hash.

Syntax

public void computeHash();

Remarks

This method computes a hash of the data specified by SetInputStream, InputMessage, or InputFile. The algorithm used is specified by Algorithm. The HashValue property will be populated with the computed hash.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

When a valid source is found the search stops.

The Progress event will fire with updates during this operation.

Config Method (Hash Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

HashBlock Method (Hash Class)

Computes the hash value of specified data.

Syntax

public byte[] hashBlock(byte[] inputBuffer, boolean lastBlock);

Remarks

This method will compute the hash value of the input data. This method will return the hash value only when the parameter LastBlock is True.

InputBuffer specifies the input data.

LastBlock specifies whether the block is the last block. If this is False the method will return an empty byte array.

To calculate the hash value of data that is broken apart into multiple blocks make multiple calls to this method. For instance: Hash.HashBlock(part1,false); Hash.HashBlock(part2,false); Hash.HashBlock(part3,false); byte[] hashValue = Hash.HashBlock(lastPart,true);

Reset Method (Hash Class)

Resets the class.

Syntax

public void reset();

Remarks

When called, the class will reset all of its properties to their default values.

SetInputStream Method (Hash Class)

Sets the stream from which the class will read data.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method sets the stream from which the class will read data.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

When a valid source is found the search stops.

Error Event (Hash Class)

Information about errors during data delivery.

Syntax

public class DefaultHashEventListener implements HashEventListener {
  ...
  public void error(HashErrorEvent e) {}
  ...
}

public class HashErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (Hash Class)

Fired as progress is made.

Syntax

public class DefaultHashEventListener implements HashEventListener {
  ...
  public void progress(HashProgressEvent e) {}
  ...
}

public class HashProgressEvent {
  public long bytesProcessed;
  public int percentProcessed;
}

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Config Settings (Hash Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Hash Config Settings

CloseInputStreamAfterProcessing:   Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is True.

HashSize:   The size of the computed hash code, read-only.

The size of the computed hash code in bytes.

SHA3UseKeccak:   Whether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm.

The official SHA-3 FIPS 202 standard does not generate the same hash value as the Keccak algorithm. If set to false (default), the official standard is used. If set to true, the Keccak algorithm is used.

UsePlatformHash:   Whether or not to use the Windows platform hash implementation.

Applies only for Windows OS. If set to false (default), the internal implementation is used. If set to true, the Windows platform hash implementation is used. Supported algorithms are:

  • SHA1
  • SHA256
  • SHA384
  • SHA512
  • HMAC_SHA1
  • HMAC_SHA256
  • HMAC_SHA384
  • HMAC_SHA512

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the class whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (Hash Class)

Hash Errors

101   Unsupported algorithm.
104   Cannot read or write file.
304   Cannot write file.
305   Cannot read file.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 Java Edition - Version 22.0 [Build 8369]