Hash Component
Properties Methods Events Config Settings Errors
The Hash component allows you to compute a hash using various algorithms.
Syntax
TipcHash
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:
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 component with short descriptions. Click on the links for further details.
| Algorithm | The algorithm used to create the hash. |
| EncodeHash | Whether the hash value is hex encoded. |
| HashValue | The hash value. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| Key | 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 | Computes a hash. |
| Config | Sets or retrieves a configuration setting. |
| HashBlock | Computes the hash value of specified data. |
| Reset | Resets the component. |
| SetInputStream | 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 | Information about errors during data delivery. |
| Progress | 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 | Determines whether or not the input stream is closed after processing. |
| HashSize | The size of the computed hash code, read-only. |
| SHA3UseKeccak | Whether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm. |
| UsePlatformHash | Whether or not to use the Windows platform hash implementation. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
Algorithm Property (Hash Component)
The algorithm used to create the hash.
Syntax
property Algorithm: TipcTHASHAlgorithms read get_Algorithm write set_Algorithm;
TipcTHASHAlgorithms = ( 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
haSHA256
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 Component)
Whether the hash value is hex encoded.
Syntax
property EncodeHash: Boolean read get_EncodeHash write set_EncodeHash;
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
property HashValue: String read get_HashValue; property HashValueB: TBytes read get_HashValueB;
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
property InputFile: String read get_InputFile write set_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 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:
- InputFile
- InputMessage
InputMessage Property (Hash Component)
The message to process.
Syntax
property InputMessage: String read get_InputMessage write set_InputMessage; property InputMessageB: TBytes read get_InputMessageB write set_InputMessageB;
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:
- InputFile
- InputMessage
Key Property (Hash Component)
The secret key for the hash algorithm.
Syntax
property Key: String read get_Key write set_Key; property KeyB: TBytes read get_KeyB write set_KeyB;
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)
| 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 is it first hashed with the same algorithm.
ComputeHash Method (Hash Component)
Computes a hash.
Syntax
procedure ComputeHash();
Remarks
This method computes a hash of the data specified by 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:
When a valid source is found the search stops.The Progress event will fire with updates during this operation.
Config Method (Hash Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): 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
function HashBlock(InputBuffer: TBytes; LastBlock: Boolean): TBytes;
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
procedure Reset();
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
procedure SetInputStream(InputStream: TStream);
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:
When a valid source is found the search stops.Error Event (Hash Component)
Information about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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 Component)
Fired as progress is made.
Syntax
type TProgressEvent = procedure ( Sender: TObject; BytesProcessed: Int64; PercentProcessed: Integer ) of Object;
property OnProgress: TProgressEvent read FOnProgress write FOnProgress;
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)
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 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
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 False.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the component 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.
Setting this setting to True tells the component to use the internal implementation instead of using the system security libraries. This setting is set to False by default on all platforms. |
Trappable Errors (Hash Component)
Hash Errors
| 101 Unsupported algorithm. | |
| 104 Cannot read or write file. | |
| 304 Cannot write file. | |
| 305 Cannot read file. |