Hash Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 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
• InputFile
• InputMessage

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 component with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

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

Algorithm Property (Hash Component)

The algorithm used to create the hash.

Syntax

• C#
• VB.NET

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
}

Public Property Algorithm As HashAlgorithms

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
End Enum

Default Value

2

Remarks

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

EncodeHash Property (Hash Component)

Whether the hash value is hex encoded.

Syntax

• C#
• VB.NET

public bool EncodeHash { get; set; }

Public Property EncodeHash As Boolean

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 Component)

The hash value.

Syntax

• C#
• VB.NET

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

Public ReadOnly Property HashValue As String
Public ReadOnly Property HashValueB As Byte()

Default Value

""

Remarks

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

This property is read-only.

InputFile Property (Hash Component)

The file to process.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

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
• InputFile
• InputMessage

InputMessage Property (Hash Component)

The message to process.

Syntax

• C#
• VB.NET

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

Public Property InputMessage As String
Public Property InputMessageB As Byte()

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
• InputFile
• InputMessage

Key Property (Hash Component)

The secret key for the hash algorithm.

Syntax

• C#
• VB.NET

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

Public Property Key As String
Public Property KeyB As Byte()

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)

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 Component)

Computes a hash.

Syntax

• C#
• VB.NET

public void ComputeHash();

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

Public Sub ComputeHash()

Async Version
Public Sub ComputeHash() As Task
Public Sub ComputeHash(cancellationToken As CancellationToken) As Task

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 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
• InputMessage

The Progress event will fire with updates during this operation.

Config Method (Hash Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

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

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

HashBlock Method (Hash Component)

Computes the hash value of specified data.

Syntax

• C#
• VB.NET

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);

Public Function HashBlock(ByVal InputBuffer As String, ByVal LastBlock As Boolean) As String

Async Version
Public Function HashBlock(ByVal InputBuffer As String, ByVal LastBlock As Boolean) As Task(Of String)
Public Function HashBlock(ByVal InputBuffer As String, ByVal LastBlock As Boolean, cancellationToken As CancellationToken) As Task(Of String)

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 Component)

Resets the component

Syntax

• C#
• VB.NET

public void Reset();

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

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SetInputStream Method (Hash Component)

Sets the stream from which the component will read data.

Syntax

• C#
• VB.NET

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);

Public Sub SetInputStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

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
• InputMessage

Error Event (Hash Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As HashErrorEventArgs)

Public Class HashErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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 section.

Progress Event (Hash Component)

Fired as progress is made.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

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

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

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As HashProgressEventArgs)

Public Class HashProgressEventArgs Inherits EventArgs
  Public ReadOnly Property BytesProcessed As Long
  Public ReadOnly Property PercentProcessed As Integer
End Class

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 Component)

Hash Config Settings

Base Config Settings

Trappable Errors (Hash Component)

Hash Errors