SecureBlackbox 2020 macOS Edition

Questions / Feedback?

HashFunction Module

Properties   Methods   Events   Configuration Settings   Errors  

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




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

AlgorithmThe hash algorithm to use when hashing data.
JsonSettingsProvides a container for JSON settings.
KeyThe key to use during the hashing.
OutputEncodingThe encoding to use for the output data.

Method List

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

ConfigSets or retrieves a configuration setting.
FinishCompletes the hash and returns the resulting message digest.
HashCalculates a message digest over a byte array.
HashFileCalculates a message digest over data contained in a file.
HashStreamCalculates a message digest over data contained in a stream.
ResetResets the hash function context.
UpdateFeeds a chunk of data to the hash function.
UpdateFileFeeds the contents of a file to the hash function.
UpdateStreamFeeds the contents of a stream to the hash function.

Event List

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

ErrorInforms about errors during cryptographic operations.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings

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

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]