HashFunction Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_HashFunction

Procedural Interface

 secureblackbox_hashfunction_open();
 secureblackbox_hashfunction_close($res);
 secureblackbox_hashfunction_register_callback($res, $id, $function);
 secureblackbox_hashfunction_get_last_error($res);
 secureblackbox_hashfunction_get_last_error_code($res);
 secureblackbox_hashfunction_set($res, $id, $index, $value);
 secureblackbox_hashfunction_get($res, $id, $index);
 secureblackbox_hashfunction_do_config($res, $configurationstring);
 secureblackbox_hashfunction_do_doaction($res, $actionid, $actionparams);
 secureblackbox_hashfunction_do_finish($res);
 secureblackbox_hashfunction_do_hash($res, $buffer);
 secureblackbox_hashfunction_do_hashfile($res, $sourcefile);
 secureblackbox_hashfunction_do_hashstream($res);
 secureblackbox_hashfunction_do_reset($res);
 secureblackbox_hashfunction_do_update($res, $buffer);
 secureblackbox_hashfunction_do_updatefile($res, $sourcefile);
 secureblackbox_hashfunction_do_updatestream($res);

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Algorithm Property (SecureBlackbox_HashFunction Class)

The hash algorithm to use when hashing data.

Object Oriented Interface

public function getAlgorithm();


public function setAlgorithm($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 1 );


secureblackbox_hashfunction_set($res, 1, $value );

Default Value

'SHA256'

Remarks

Data Type

String

FIPSMode Property (SecureBlackbox_HashFunction Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 2 );


secureblackbox_hashfunction_set($res, 2, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

JsonKeyHeaderParams Property (SecureBlackbox_HashFunction Class)

Contains key header parameters.

Object Oriented Interface

public function getJsonKeyHeaderParams();


public function setJsonKeyHeaderParams($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 3 );


secureblackbox_hashfunction_set($res, 3, $value );

Default Value

'kid'

Remarks

Contains key header parameters.

Data Type

String

JsonProtectedHeader Property (SecureBlackbox_HashFunction Class)

Provides access to the header being protected.

Object Oriented Interface

public function getJsonProtectedHeader();


public function setJsonProtectedHeader($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 4 );


secureblackbox_hashfunction_set($res, 4, $value );

Default Value

''

Remarks

Provides access to the header being protected.

Data Type

String

JsonUnprotectedHeader Property (SecureBlackbox_HashFunction Class)

Provides access to the unprotected part of the header.

Object Oriented Interface

public function getJsonUnprotectedHeader();


public function setJsonUnprotectedHeader($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 5 );


secureblackbox_hashfunction_set($res, 5, $value );

Default Value

''

Remarks

Provides access to the unprotected part of the header.

Data Type

String

JsonUnprotectedHeaderParams Property (SecureBlackbox_HashFunction Class)

Contains unprotected header parameters.

Object Oriented Interface

public function getJsonUnprotectedHeaderParams();


public function setJsonUnprotectedHeaderParams($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 6 );


secureblackbox_hashfunction_set($res, 6, $value );

Default Value

''

Remarks

Contains unprotected header parameters.

Data Type

String

KeyAlgorithm Property (SecureBlackbox_HashFunction Class)

The algorithm of the cryptographic key.

Object Oriented Interface

public function getKeyAlgorithm();


public function setKeyAlgorithm($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 7 );


secureblackbox_hashfunction_set($res, 7, $value );

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 (SecureBlackbox_HashFunction Class)

The length of the key in bits.

Object Oriented Interface

public function getKeyBits();

Procedural Interface

secureblackbox_hashfunction_get($res, 8 );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeyCurve();


public function setKeyCurve($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 9 );


secureblackbox_hashfunction_set($res, 9, $value );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeyExportable();

Procedural Interface

secureblackbox_hashfunction_get($res, 10 );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeyHandle();


public function setKeyHandle($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 11 );


secureblackbox_hashfunction_set($res, 11, $value );

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 (SecureBlackbox_HashFunction Class)

Provides access to a storage-specific key identifier.

Object Oriented Interface

public function getKeyID();


public function setKeyID($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 12 );


secureblackbox_hashfunction_set($res, 12, $value );

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 (SecureBlackbox_HashFunction Class)

The initialization vector (IV) of a symmetric key.

Object Oriented Interface

public function getKeyIV();


public function setKeyIV($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 13 );


secureblackbox_hashfunction_set($res, 13, $value );

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 (SecureBlackbox_HashFunction Class)

The byte array representation of the key.

Object Oriented Interface

public function getKeyKey();

Procedural Interface

secureblackbox_hashfunction_get($res, 14 );

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 (SecureBlackbox_HashFunction Class)

A nonce value associated with a key.

Object Oriented Interface

public function getKeyNonce();


public function setKeyNonce($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 15 );


secureblackbox_hashfunction_set($res, 15, $value );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeyPrivate();

Procedural Interface

secureblackbox_hashfunction_get($res, 16 );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeyPublic();

Procedural Interface

secureblackbox_hashfunction_get($res, 17 );

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 (SecureBlackbox_HashFunction Class)

Returns the key subject.

Object Oriented Interface

public function getKeySubject();


public function setKeySubject($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 18 );


secureblackbox_hashfunction_set($res, 18, $value );

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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function getKeySymmetric();

Procedural Interface

secureblackbox_hashfunction_get($res, 19 );

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 (SecureBlackbox_HashFunction Class)

Returns True if this key is valid.

Object Oriented Interface

public function getKeyValid();

Procedural Interface

secureblackbox_hashfunction_get($res, 20 );

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 (SecureBlackbox_HashFunction Class)

The encoding to use for the output data.

Object Oriented Interface

public function getOutputEncoding();


public function setOutputEncoding($value);

Procedural Interface

secureblackbox_hashfunction_get($res, 21 );


secureblackbox_hashfunction_set($res, 21, $value );

Default Value

0

Remarks

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

Data Type

Integer

Config Method (SecureBlackbox_HashFunction Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_hashfunction_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (SecureBlackbox_HashFunction Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_hashfunction_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. 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 (SecureBlackbox_HashFunction Class)

Completes the hash and returns the resulting message digest.

Object Oriented Interface

public function doFinish();

Procedural Interface

secureblackbox_hashfunction_do_finish($res);

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 (SecureBlackbox_HashFunction Class)

Calculates a message digest over a byte array.

Object Oriented Interface

public function doHash($buffer);

Procedural Interface

secureblackbox_hashfunction_do_hash($res, $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 (SecureBlackbox_HashFunction Class)

Calculates a message digest over data contained in a file.

Object Oriented Interface

public function doHashFile($sourcefile);

Procedural Interface

secureblackbox_hashfunction_do_hashfile($res, $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 (SecureBlackbox_HashFunction Class)

Calculates a message digest over data contained in a stream.

Object Oriented Interface

public function doHashStream();

Procedural Interface

secureblackbox_hashfunction_do_hashstream($res);

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 (SecureBlackbox_HashFunction Class)

Resets the hash function context.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_hashfunction_do_reset($res);

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 (SecureBlackbox_HashFunction Class)

Feeds a chunk of data to the hash function.

Object Oriented Interface

public function doUpdate($buffer);

Procedural Interface

secureblackbox_hashfunction_do_update($res, $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 (SecureBlackbox_HashFunction Class)

Feeds the contents of a file to the hash function.

Object Oriented Interface

public function doUpdateFile($sourcefile);

Procedural Interface

secureblackbox_hashfunction_do_updatefile($res, $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 (SecureBlackbox_HashFunction Class)

Feeds the contents of a stream to the hash function.

Object Oriented Interface

public function doUpdateStream();

Procedural Interface

secureblackbox_hashfunction_do_updatestream($res);

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 (SecureBlackbox_HashFunction Class)

Informs about errors during cryptographic operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_hashfunction_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

Class 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 (SecureBlackbox_HashFunction Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_hashfunction_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (HashFunction Class)

The class 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 class, access to these internal properties is provided through the Config method.

HashFunction Config Settings

Base Config Settings

Trappable Errors (HashFunction Class)

HashFunction Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class 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)