# Hash Component

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

## Syntax

```text
nsoftware.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](#algorithm-property-hash-component) property.

Next specify the data to hash. **Input Notes**

The component 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:

- [SetInputStream](#setinputstream-method-hash-component)
- [InputFile](#inputfile-property-hash-component)
- [InputMessage](#inputmessage-property-hash-component)

 When a valid source is found the search stops.

Call the [ComputeHash](#computehash-method-hash-component) method to hash the data. The [HashValue](#hashvalue-property-hash-component) 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](#encodehash-property-hash-component) to False.

## Property List

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

|  |  |
| --- | --- |
| [Algorithm](#algorithm-property-hash-component) | The algorithm used to create the hash. |
| [EncodeHash](#encodehash-property-hash-component) | Whether the hash value is hex encoded. |
| [HashValue](#hashvalue-property-hash-component) | The hash value. |
| [InputFile](#inputfile-property-hash-component) | The file to process. |
| [InputMessage](#inputmessage-property-hash-component) | The message to process. |
| [Key](#key-property-hash-component) | The secret key for the hash algorithm. |

## Method List

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

|  |  |
| --- | --- |
| [ComputeHash](#computehash-method-hash-component) | Computes a hash. |
| [Config](#config-method-hash-component) | Sets or retrieves a configuration setting. |
| [HashBlock](#hashblock-method-hash-component) | Computes the hash value of specified data. |
| [Reset](#reset-method-hash-component) | Resets the component. |
| [SetInputStream](#setinputstream-method-hash-component) | Sets the stream from which the component will read data. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-hash-component) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-hash-component) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Determines whether or not the input stream is closed after processing. |
| [HashSize](#HashSize) | The size of the computed hash code, read-only. |
| [SHA3UseKeccak](#SHA3UseKeccak) | Whether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Algorithm Property ([Hash](#hash-component) Component)

The algorithm used to create the hash.

## Syntax

```text
public HashAlgorithms Algorithm { get; set; }
enum HashAlgorithms {
  haSHA1,
  haSHA224,
  haSHA256,
  haSHA384,
  haSHA512,
  haMD2,
  haMD4,
  haMD5,
  haRIPEMD160,
  haMD5SHA1,
  haHMACMD5,
  haHMACSHA1,
  haHMACSHA224,
  haHMACSHA256,
  haHMACSHA384,
  haHMACSHA512,
  haHMACRIPEMD160,
  haSHA3_224,
  haSHA3_256,
  haSHA3_384,
  haSHA3_512,
  haSHA512_224,
  haSHA512_256
}
```

## Default Value

2

## Remarks

This property specifies the algorithm used when calling [ComputeHash](#computehash-method-hash-component). 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](#hash-component) Component)

Whether the hash value is hex encoded.

## Syntax

```text
public bool EncodeHash { get; set; }
```

## Default Value

True

## Remarks

This property specifies whether the computed hash value is hex encoded. When set to True (default) the component 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](#hash-component) Component)

The hash value.

## Syntax

```text
public string HashValue { get; }
public byte[] HashValueB { get; }
```

## Default Value

""

## Remarks

The computed hash value. This property is populated after calling [ComputeHash](#computehash-method-hash-component).

This property is read-only.

# InputFile Property ([Hash](#hash-component) Component)

The file to process.

## Syntax

```text
public string InputFile { get; set; }
```

## 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 component 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:

- [SetInputStream](#setinputstream-method-hash-component)
- InputFile
- [InputMessage](#inputmessage-property-hash-component)

 When a valid source is found the search stops.

# InputMessage Property ([Hash](#hash-component) Component)

The message to process.

## Syntax

```text
public string InputMessage { get; set; }
public byte[] InputMessageB { get; set; }
```

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input Notes**

The component 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:

- [SetInputStream](#setinputstream-method-hash-component)
- [InputFile](#inputfile-property-hash-component)
- InputMessage

 When a valid source is found the search stops.

# Key Property ([Hash](#hash-component) Component)

The secret key for the hash algorithm.

## Syntax

```text
public string Key { get; set; }
public byte[] KeyB { get; set; }
```

## 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](#algorithm-property-hash-component) 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)**

|  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- |
|  | SHA1 | SHA224 | SHA256 | SHA384 | SHA512 | MD5 | RIPEMD160 |
| Recommended Key Size | 20 | 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 it is first hashed with the same algorithm.

# ComputeHash Method ([Hash](#hash-component) Component)

Computes a hash.

## Syntax

```text
public void ComputeHash();

Async Version
public async Task ComputeHash();
public async Task ComputeHash(CancellationToken cancellationToken);
```

## Remarks

This method computes a hash of the data specified by [SetInputStream](#setinputstream-method-hash-component), [InputMessage](#inputmessage-property-hash-component), or [InputFile](#inputfile-property-hash-component). The algorithm used is specified by [Algorithm](#algorithm-property-hash-component). The [HashValue](#hashvalue-property-hash-component) property will be populated with the computed hash.

**Input Notes**

The component 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:

- [SetInputStream](#setinputstream-method-hash-component)
- [InputFile](#inputfile-property-hash-component)
- [InputMessage](#inputmessage-property-hash-component)

 When a valid source is found the search stops.

The [Progress](#progress-event-hash-component) event will fire with updates during this operation.

# Config Method ([Hash](#hash-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-hash-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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](#config-settings-hash-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# HashBlock Method ([Hash](#hash-component) Component)

Computes the hash value of specified data.

## Syntax

```text
public byte[] HashBlock(byte[] inputBuffer, bool lastBlock);

Async Version
public async Task<byte[]> HashBlock(byte[] inputBuffer, bool lastBlock);
public async Task<byte[]> HashBlock(byte[] inputBuffer, bool lastBlock, CancellationToken cancellationToken);
```

## 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:

```text
Hash.HashBlock(part1,false);
Hash.HashBlock(part2,false);
Hash.HashBlock(part3,false);
byte[] hashValue = Hash.HashBlock(lastPart,true);
```

# Reset Method ([Hash](#hash-component) Component)

Resets the component.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

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

# SetInputStream Method ([Hash](#hash-component) Component)

Sets the stream from which the component will read data.

## Syntax

```text
public void SetInputStream(System.IO.Stream inputStream);

Async Version
public async Task SetInputStream(System.IO.Stream inputStream);
public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken);
```

## Remarks

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

**Input Notes**

The component 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:

- SetInputStream
- [InputFile](#inputfile-property-hash-component)
- [InputMessage](#inputmessage-property-hash-component)

 When a valid source is found the search stops.

# Error Event ([Hash](#hash-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, HashErrorEventArgs e);

public class HashErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

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

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-hash-component) section.

# Progress Event ([Hash](#hash-component) Component)

Fired as progress is made.

## Syntax

```text
public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, HashProgressEventArgs e);

public class HashProgressEventArgs : EventArgs {
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}
```

## Remarks

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

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](#hash-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-hash-component) 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](#setinputstream-method-hash-component) 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.

### 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**: 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 component 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](#GUIAvailable) to *false* will ensure that the component 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 component 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.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([Hash](#hash-component) Component)

### Hash Errors

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