Hash Class

Properties   Methods   Events   Config Settings   Errors  

The Hash class allows you to compute a hash using various algorithms.

Syntax

Hash

Remarks

The Hash component allows you to compute a hash using various algorithms including SHA1, SHA224, SHA256, SHA384, SHA512, MD2, MD4, MD5, RIPEMD160, MD5SHA1, HMACMD5, HMACSHA1, HMACSHA224, HMACSHA256, HMACSHA384, HMACSHA512, etc.

To begin, first select the algorithm you wish to use when computing the hash. Common choices include MD5 and SHA1. For a full list of supported algorithms see the Algorithm property.

Next specify the data to hash. Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

• InputFile
• InputMessage

Call the ComputeHash method to hash the data. The HashValue property will hold the computed hash. By default the hash value is hex encoded for ease of use, but you may disable this by setting EncodeHash to False.

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

The algorithm used to create the hash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAlgorithm();
int SetAlgorithm(int iAlgorithm);

Unicode (Windows)
INT GetAlgorithm();
INT SetAlgorithm(INT iAlgorithm);

HA_SHA1(0), 
HA_SHA224(1), 
HA_SHA256(2), 
HA_SHA384(3), 
HA_SHA512(4), 
HA_MD2(5), 
HA_MD4(6), 
HA_MD5(7), 
HA_RIPEMD160(8), 
HA_MD5SHA1(9), 
HA_HMACMD5(10), 
HA_HMACSHA1(11), 
HA_HMACSHA224(12), 
HA_HMACSHA256(13), 
HA_HMACSHA384(14), 
HA_HMACSHA512(15), 
HA_HMACRIPEMD160(16), 
HA_SHA3_224(17), 
HA_SHA3_256(18), 
HA_SHA3_384(19), 
HA_SHA3_512(20), 
HA_SHA512_224(21), 
HA_SHA512_256(22)

int ipworksencrypt_hash_getalgorithm(void* lpObj);
int ipworksencrypt_hash_setalgorithm(void* lpObj, int iAlgorithm);

int GetAlgorithm();
int SetAlgorithm(int iAlgorithm);

Default Value

2

Remarks

This property specifies the algorithm used when calling ComputeHash. Possible values are:

Data Type

Integer

EncodeHash Property (Hash Class)

Whether the hash value is hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncodeHash();
int SetEncodeHash(int bEncodeHash);

Unicode (Windows)
BOOL GetEncodeHash();
INT SetEncodeHash(BOOL bEncodeHash);

int ipworksencrypt_hash_getencodehash(void* lpObj);
int ipworksencrypt_hash_setencodehash(void* lpObj, int bEncodeHash);

bool GetEncodeHash();
int SetEncodeHash(bool bEncodeHash);

Default Value

TRUE

Remarks

This property specifies whether the computed hash value is hex encoded. When set to True (default) the class will hex encoded the computed hash for easier use. Set this value to False to obtain the hash value in an unmodified form.

The default value is True.

Data Type

Boolean

HashValue Property (Hash Class)

The hash value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashValue(char* &lpHashValue, int &lenHashValue);

Unicode (Windows)
INT GetHashValue(LPSTR &lpHashValue, INT &lenHashValue);

int ipworksencrypt_hash_gethashvalue(void* lpObj, char** lpHashValue, int* lenHashValue);

QByteArray GetHashValue();

Default Value

""

Remarks

The computed hash value. This property is populated after calling ComputeHash.

This property is read-only.

Data Type

Binary String

InputFile Property (Hash Class)

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_hash_getinputfile(void* lpObj);
int ipworksencrypt_hash_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

• InputFile
• InputMessage

Data Type

String

InputMessage Property (Hash Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_hash_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_hash_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

• InputFile
• InputMessage

Data Type

Binary String

Key Property (Hash Class)

The secret key for the hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

int ipworksencrypt_hash_getkey(void* lpObj, char** lpKey, int* lenKey);
int ipworksencrypt_hash_setkey(void* lpObj, const char* lpKey, int lenKey);

QByteArray GetKey();
int SetKey(QByteArray qbaKey);

Default Value

""

Remarks

This property holds the secret key used when creating the hash. The key can be arbitrarily long.

Note: This property is only applicable when Algorithm is set to an HMAC algorithm.

It is recommended that the length of the key be equal to or larger than the hash size of the algorithm. Use of keys shorter than the hash size is discouraged.

Sizes (in bytes)

Key Length Details

As mentioned above it is recommended to use a key size equal to the hash size. Use of keys larger than the hash size does not typically significantly increase the function strength. Keys of any length are technically valid however see the below processing rules to understand how keys of varying lengths are treated:

• If the key length is equal to the hash size (recommended) it is used without modification.
• If the key length is less than the hash size it is used without modification.
• If the key length is less than or equal to the block size it is used without modification.
• If the key length is larger than the block size is it first hashed with the same algorithm.

Data Type

Binary String

ComputeHash Method (Hash Class)

Computes a hash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ComputeHash();

Unicode (Windows)
INT ComputeHash();

int ipworksencrypt_hash_computehash(void* lpObj);

int ComputeHash();

Remarks

This method computes a hash of the data specified by InputMessage or InputFile. The algorithm used is specified by Algorithm. The HashValue property will be populated with the computed hash.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

• InputFile
• InputMessage

The Progress event will fire with updates during this operation.

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

Config Method (Hash 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* ipworksencrypt_hash_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.

HashBlock Method (Hash Class)

Computes the hash value of specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* HashBlock(const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize = NULL);

Unicode (Windows)
LPSTR HashBlock(LPCSTR lpInputBuffer, INT lenInputBuffer, BOOL bLastBlock, LPINT lpSize = NULL);

char* ipworksencrypt_hash_hashblock(void* lpObj, const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize);

QByteArray HashBlock(QByteArray qbaInputBuffer, bool bLastBlock);

Remarks

This method will compute the hash value of the input data. This method will return the hash value only when the parameter LastBlock is True.

InputBuffer specifies the input data.

LastBlock specifies whether the block is the last block. If this is False the method will return an empty byte array.

To calculate the hash value of data that is broken apart into multiple blocks make multiple calls to this method. For instance: Hash.HashBlock(part1,false); Hash.HashBlock(part2,false); Hash.HashBlock(part3,false); byte[] hashValue = Hash.HashBlock(lastPart,true);

Error Handling (C++)

This method returns a Binary String 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 (Hash Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_hash_reset(void* lpObj);

int Reset();

Remarks

When called, the class will reset all of its properties to their default values.

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

SetInputStream Method (Hash Class)

Sets the stream from which the class will read data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_hash_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data.

Input Notes

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

• InputFile
• InputMessage

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

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HASH_ERROR 1

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

class HashErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (Hash Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(HashProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} HashProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(HashProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} HashProgressEventParams;

#define EID_HASH_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class HashProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

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

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

// Or, subclass Hash and override this emitter function.
virtual int FireProgress(HashProgressEventParams *e) {...}

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The Hash class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the Hash class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (Hash Class)

Hash Config Settings

Base Config Settings

Trappable Errors (Hash 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.

Hash Errors