HashFunction Component

Properties Methods Events Configuration Settings Errors

The HashFunction component implements a wide variety of algorithms for message hashing.

Syntax

TsbxHashFunction

Remarks

HashFunction allows you to hash messages using a variety of industry standard hashing algorithms. Algorithms of both Hash and HMAC type are supported.

You can feed your data to HashFunction in one go, or in chunks. Use Hash method to initialize the hash function, pass the buffer, and calculate the hash in one line of code. Alternatively, use Reset, Update, and Finish in sequence to perform each of those steps individually. You can call Update (and its UpdateFile and UpdateStream variants) repeatedly between Reset and Finish, effectively passing the data in a number of portions:

// Feeding the data in one go:
Hashfunction hf = new Hashfunction();
hf.Algorithm = "SHA256";
byte[] hash = hf.Hash(buffer);
 
// Feeding data chunk by chunk:
Hashfunction hf = new Hashfunction();
hf.Algorithm = "SHA256";
hf.Reset(); 
hf.Update(buffer1);
hf.Update(buffer2);
hf.Update(buffer3);
byte[] hash = hf.Finish();

To use keyed HMAC, you need to provide the secret key first. Use CryptoKeyManager to create and initialize the key object:

Cryptokeymanager km = new Cryptokeymanager();
km.ImportBytes(hmacKey, Constants.kffDER, "SHA256", "", "", Constants.ktSecret);
 
Hashfunction hf = new Hashfunction();
hf.Algorithm = "SHA256";
hf.Key = km.Key;
byte[] hash = hf.Hash(buffer);

Use OutputEncoding to set the desired encoding method.

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 hash algorithm to use when hashing data.
JsonSettings	Provides a container for JSON settings.
Key	The key to use during the hashing.
OutputEncoding	The encoding to use for the output data.

Method List

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


Config	Sets or retrieves a configuration setting.
Finish	Completes the hash and returns the resulting message digest.
Hash	Calculates a message digest over a byte array.
HashFile	Calculates a message digest over data contained in a file.
HashStream	Calculates a message digest over data contained in a stream.
Reset	Resets the hash function context.
Update	Feeds a chunk of data to the hash function.
UpdateFile	Feeds the contents of a file to the hash function.
UpdateStream	Feeds the contents of a stream to the hash function.

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	Informs about errors during cryptographic operations.
Notification	This event notifies the application about an underlying control flow event.

Configuration Settings

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


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client components should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

SecureBlackbox 2020 Delphi Edition