HashFunction Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

HashFunction

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

The hash algorithm to use when hashing data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlgorithm();
int SetAlgorithm(const char* lpszAlgorithm);

Unicode (Windows)
LPWSTR GetAlgorithm();
INT SetAlgorithm(LPCWSTR lpszAlgorithm);

char* secureblackbox_hashfunction_getalgorithm(void* lpObj);
int secureblackbox_hashfunction_setalgorithm(void* lpObj, const char* lpszAlgorithm);

QString GetAlgorithm();
int SetAlgorithm(QString qsAlgorithm);

Default Value

"SHA256"

Remarks

Data Type

String

FIPSMode Property (HashFunction Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_hashfunction_getfipsmode(void* lpObj);
int secureblackbox_hashfunction_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

JsonSettings Property (HashFunction Class)

Provides a container for JSON settings.

Syntax

• C++
• C
• Qt

SecureBlackboxJWSettings* GetJsonSettings();

char* secureblackbox_hashfunction_getjsonkeyheaderparams(void* lpObj);
int secureblackbox_hashfunction_setjsonkeyheaderparams(void* lpObj, const char* lpszJsonKeyHeaderParams);

char* secureblackbox_hashfunction_getjsonprotectedheader(void* lpObj);
int secureblackbox_hashfunction_setjsonprotectedheader(void* lpObj, const char* lpszJsonProtectedHeader);

char* secureblackbox_hashfunction_getjsonunprotectedheader(void* lpObj);
int secureblackbox_hashfunction_setjsonunprotectedheader(void* lpObj, const char* lpszJsonUnprotectedHeader);

char* secureblackbox_hashfunction_getjsonunprotectedheaderparams(void* lpObj);
int secureblackbox_hashfunction_setjsonunprotectedheaderparams(void* lpObj, const char* lpszJsonUnprotectedHeaderParams);

QString GetJsonKeyHeaderParams();
int SetJsonKeyHeaderParams(QString qsJsonKeyHeaderParams);

QString GetJsonProtectedHeader();
int SetJsonProtectedHeader(QString qsJsonProtectedHeader);

QString GetJsonUnprotectedHeader();
int SetJsonUnprotectedHeader(QString qsJsonUnprotectedHeader);

QString GetJsonUnprotectedHeaderParams();
int SetJsonUnprotectedHeaderParams(QString qsJsonUnprotectedHeaderParams);

Remarks

Use this property when using JSON Web Signatures to tune up the JSON parameters.

This property is read-only.

Data Type

SecureBlackboxJWSettings

Key Property (HashFunction Class)

The key to use during the hashing.

Syntax

• C++
• C
• Qt

SecureBlackboxCryptoKey* GetKey();
int SetKey(SecureBlackboxCryptoKey* val);

int64 secureblackbox_hashfunction_getkeyhandle(void* lpObj);
int secureblackbox_hashfunction_setkeyhandle(void* lpObj, int64 lKeyHandle);

int secureblackbox_hashfunction_getkeykey(void* lpObj, char** lpKeyKey, int* lenKeyKey);

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

QByteArray GetKeyKey();

Remarks

Assign a properly configured cryptographic key object to this property to use it during the hashing operation. This would normally be a HMAC key.

This property is not available at design time.

Data Type

SecureBlackboxCryptoKey

OutputEncoding Property (HashFunction Class)

The encoding to use for the output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

Unicode (Windows)
INT GetOutputEncoding();
INT SetOutputEncoding(INT iOutputEncoding);

CET_DEFAULT(0), 
CET_BINARY(1), 
CET_BASE_64(2), 
CET_COMPACT(3), 
CET_JSON(4)

int secureblackbox_hashfunction_getoutputencoding(void* lpObj);
int secureblackbox_hashfunction_setoutputencoding(void* lpObj, int iOutputEncoding);

int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_hashfunction_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (HashFunction Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_hashfunction_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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;....

Common ActionIDs:

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Finish Method (HashFunction Class)

Completes the hash and returns the resulting message digest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Finish(int *lpSize = NULL);

Unicode (Windows)
LPSTR Finish(LPINT lpSize = NULL);

char* secureblackbox_hashfunction_finish(void* lpObjint *lpSize);

QByteArray 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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Hash Method (HashFunction Class)

Calculates a message digest over a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Hash(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Hash(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_hashfunction_hash(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Hash(QByteArray qbaBuffer);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

HashFile Method (HashFunction Class)

Calculates a message digest over data contained in a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* HashFile(const char* lpszSourceFile, int *lpSize = NULL);

Unicode (Windows)
LPSTR HashFile(LPCWSTR lpszSourceFile, LPINT lpSize = NULL);

char* secureblackbox_hashfunction_hashfile(void* lpObj, const char* lpszSourceFile, int *lpSize);

QByteArray HashFile(const QString& qsSourceFile);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

HashStream Method (HashFunction Class)

Calculates a message digest over data contained in a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* HashStream(int *lpSize = NULL);

Unicode (Windows)
LPSTR HashStream(LPINT lpSize = NULL);

char* secureblackbox_hashfunction_hashstream(void* lpObjint *lpSize);

QByteArray 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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (HashFunction Class)

Resets the hash function context.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_hashfunction_reset(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Update Method (HashFunction Class)

Feeds a chunk of data to the hash function.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update(const char* lpBuffer, int lenBuffer);

Unicode (Windows)
INT Update(LPCSTR lpBuffer, INT lenBuffer);

int secureblackbox_hashfunction_update(void* lpObj, const char* lpBuffer, int lenBuffer);

int Update(QByteArray qbaBuffer);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateFile Method (HashFunction Class)

Feeds the contents of a file to the hash function.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateFile(const char* lpszSourceFile);

Unicode (Windows)
INT UpdateFile(LPCWSTR lpszSourceFile);

int secureblackbox_hashfunction_updatefile(void* lpObj, const char* lpszSourceFile);

int UpdateFile(const QString& qsSourceFile);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateStream Method (HashFunction Class)

Feeds the contents of a stream to the hash function.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateStream();

Unicode (Windows)
INT UpdateStream();

int secureblackbox_hashfunction_updatestream(void* lpObj);

int 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 Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (HashFunction Class)

Informs about errors during cryptographic operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(HashFunctionErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} HashFunctionErrorEventParams;


Unicode (Windows)
virtual INT FireError(HashFunctionErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} HashFunctionErrorEventParams;

#define EID_HASHFUNCTION_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class HashFunctionErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(HashFunctionErrorEventParams *e);

// Or, subclass HashFunction and override this emitter function.
virtual int FireError(HashFunctionErrorEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(HashFunctionNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} HashFunctionNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(HashFunctionNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} HashFunctionNotificationEventParams;

#define EID_HASHFUNCTION_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class HashFunctionNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(HashFunctionNotificationEventParams *e);

// Or, subclass HashFunction and override this emitter function.
virtual int FireNotification(HashFunctionNotificationEventParams *e) {...}

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.

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

CryptoKey()

JWSettings Type

This container represents JSON web security settings.

Syntax

SecureBlackboxJWSettings (declared in secureblackbox.h)

Remarks

This type contains properties specific to JSON Web Security.

Fields

Constructors

JWSettings()

Config Settings (HashFunction Class)

HashFunction Config Settings

Base Config Settings

Trappable Errors (HashFunction Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

HashFunction Errors