HashFunction Component

Properties   Methods   Events   Config 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.

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

The hash algorithm to use when hashing data.

Syntax

__property String Algorithm = { read=FAlgorithm, write=FSetAlgorithm };

Default Value

"SHA256"

Remarks

Data Type

String

FIPSMode Property (HashFunction Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

JsonKeyHeaderParams Property (HashFunction Component)

Contains key header parameters.

Syntax

__property String JsonKeyHeaderParams = { read=FJsonKeyHeaderParams, write=FSetJsonKeyHeaderParams };

Default Value

"kid"

Remarks

Contains key header parameters.

Data Type

String

JsonProtectedHeader Property (HashFunction Component)

Provides access to the header being protected.

Syntax

__property String JsonProtectedHeader = { read=FJsonProtectedHeader, write=FSetJsonProtectedHeader };

Default Value

""

Remarks

Provides access to the header being protected.

Data Type

String

JsonUnprotectedHeader Property (HashFunction Component)

Provides access to the unprotected part of the header.

Syntax

__property String JsonUnprotectedHeader = { read=FJsonUnprotectedHeader, write=FSetJsonUnprotectedHeader };

Default Value

""

Remarks

Provides access to the unprotected part of the header.

Data Type

String

JsonUnprotectedHeaderParams Property (HashFunction Component)

Contains unprotected header parameters.

Syntax

__property String JsonUnprotectedHeaderParams = { read=FJsonUnprotectedHeaderParams, write=FSetJsonUnprotectedHeaderParams };

Default Value

""

Remarks

Contains unprotected header parameters.

Data Type

String

KeyAlgorithm Property (HashFunction Component)

The algorithm of the cryptographic key.

Syntax

__property String KeyAlgorithm = { read=FKeyAlgorithm, write=FSetKeyAlgorithm };

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is not available at design time.

Data Type

String

KeyBits Property (HashFunction Component)

The length of the key in bits.

Syntax

__property int KeyBits = { read=FKeyBits };

Default Value

0

Remarks

The length of the key in bits.

This property is read-only and not available at design time.

Data Type

Integer

KeyCurve Property (HashFunction Component)

This property specifies the name of the curve the EC key is built on.

Syntax

__property String KeyCurve = { read=FKeyCurve, write=FSetKeyCurve };

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

This property is not available at design time.

Data Type

String

KeyExportable Property (HashFunction Component)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

__property bool KeyExportable = { read=FKeyExportable };

Default Value

false

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

KeyHandle Property (HashFunction Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

KeyID Property (HashFunction Component)

Provides access to a storage-specific key identifier.

Syntax

__property DynamicArray KeyID = { read=FKeyID, write=FSetKeyID };

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

This property is not available at design time.

Data Type

Byte Array

KeyIV Property (HashFunction Component)

The initialization vector (IV) of a symmetric key.

Syntax

__property DynamicArray KeyIV = { read=FKeyIV, write=FSetKeyIV };

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

This property is not available at design time.

Data Type

Byte Array

KeyKey Property (HashFunction Component)

The byte array representation of the key.

Syntax

__property DynamicArray KeyKey = { read=FKeyKey };

Remarks

The byte array representation of the key. This may not be available for non-KeyExportable keys.

This property is read-only and not available at design time.

Data Type

Byte Array

KeyNonce Property (HashFunction Component)

A nonce value associated with a key.

Syntax

__property DynamicArray KeyNonce = { read=FKeyNonce, write=FSetKeyNonce };

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is not available at design time.

Data Type

Byte Array

KeyPrivate Property (HashFunction Component)

Returns True if the object hosts a private key, and False otherwise.

Syntax

__property bool KeyPrivate = { read=FKeyPrivate };

Default Value

false

Remarks

Returns True if the object hosts a private key, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

KeyPublic Property (HashFunction Component)

Returns True if the object hosts a public key, and False otherwise.

Syntax

__property bool KeyPublic = { read=FKeyPublic };

Default Value

false

Remarks

Returns True if the object hosts a public key, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

KeySubject Property (HashFunction Component)

Returns the key subject.

Syntax

__property DynamicArray KeySubject = { read=FKeySubject, write=FSetKeySubject };

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

This property is not available at design time.

Data Type

Byte Array

KeySymmetric Property (HashFunction Component)

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

__property bool KeySymmetric = { read=FKeySymmetric };

Default Value

false

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

KeyValid Property (HashFunction Component)

Returns True if this key is valid.

Syntax

__property bool KeyValid = { read=FKeyValid };

Default Value

false

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

This property is read-only and not available at design time.

Data Type

Boolean

OutputEncoding Property (HashFunction Component)

The encoding to use for the output data.

Syntax

__property TsbxHashFunctionOutputEncodings OutputEncoding = { read=FOutputEncoding, write=FSetOutputEncoding };

enum TsbxHashFunctionOutputEncodings {
  cetDefault=0,
  cetBinary=1,
  cetBase64=2,
  cetCompact=3,
  cetJSON=4
};

Default Value

cetDefault

Remarks

Use this property to configure the type of encoding to be used for the output data.

Data Type

Integer

Config Method (HashFunction Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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.

DoAction Method (HashFunction Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Finish Method (HashFunction Component)

Completes the hash and returns the resulting message digest.

Syntax

DynamicArray<Byte> __fastcall Finish();

Remarks

This method finalizes the hashing operation and returns the message digest of the input data. Use it in conjuction with Reset and Update methods to process data in chunks.

Hash Method (HashFunction Component)

Calculates a message digest over a byte array.

Syntax

DynamicArray<Byte> __fastcall Hash(DynamicArray<Byte> Buffer);

Remarks

This method calculates and returns a message digest over the content of Buffer. This is a quick way to calculate a hash over a byte array in one go.

HashFile Method (HashFunction Component)

Calculates a message digest over data contained in a file.

Syntax

DynamicArray<Byte> __fastcall HashFile(String SourceFile);

Remarks

This method calculates and returns a message digest over the data contained in file SourceFile. This is a quick way to calculate a hash over a file content in one go.

HashStream Method (HashFunction Component)

Calculates a message digest over data contained in a stream.

Syntax

DynamicArray<Byte> __fastcall HashStream();

Remarks

This method calculates a message digest over the data contained in InputStream. This is a quick way of calculating a message data over a stream content in one go.

Reset Method (HashFunction Component)

Resets the hash function context.

Syntax

void __fastcall Reset();

Remarks

Reset resets the context of the hash function, discarding any data passed to it previously.

Use this method to restart the hash calculation process from scratch.

This method does not affect one-go methods like Hash or HashStream; they reset the hash function context automatically.

Update Method (HashFunction Component)

Feeds a chunk of data to the hash function.

Syntax

void __fastcall Update(DynamicArray<Byte> Buffer);

Remarks

This method feeds Buffer to the hash function. Call this method repeatedly to pass your data to the hash function chunk by chunk.

Remember to initialize the hash function with an Reset call before starting to feed data with this method. After the whole volume of data has been sent, complete the calculation and obtain the resulting message digest with a Finish call.

UpdateFile Method (HashFunction Component)

Feeds the contents of a file to the hash function.

Syntax

void __fastcall UpdateFile(String SourceFile);

Remarks

Call this method to pass the contents of a file to the hash function. You can call this function repeatedly and mix it with Update to feed the hash function with many separate chunks of data.

Remember to initialize the hash function with an Reset call before starting hashing the data. Once all the data chunks have been submitted, finalize the hash function and obtain the resulting message digest by calling Finish.

UpdateStream Method (HashFunction Component)

Feeds the contents of a stream to the hash function.

Syntax

void __fastcall UpdateStream();

Remarks

Call this method to pass the contents of a stream to the hash function. You can call this function repeatedly and mix it with Update to feed the hash function with many separate chunks of data.

Remember to initialize the hash function with an Reset call before starting hashing the data. Once all the data chunks have been submitted, finalize the hash function and obtain the resulting message digest by calling Finish.

Error Event (HashFunction Component)

Informs about errors during cryptographic operations.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxHashFunctionErrorEventParams;
typedef void __fastcall (__closure *TsbxHashFunctionErrorEvent)(System::TObject* Sender, TsbxHashFunctionErrorEventParams *e);
__property TsbxHashFunctionErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

Component fires this event if an error happens during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

Notification Event (HashFunction Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxHashFunctionNotificationEventParams;
typedef void __fastcall (__closure *TsbxHashFunctionNotificationEvent)(System::TObject* Sender, TsbxHashFunctionNotificationEventParams *e);
__property TsbxHashFunctionNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (HashFunction 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.

HashFunction Config Settings

Base Config Settings

Trappable Errors (HashFunction Component)

HashFunction Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)