Hash Class
Properties Methods Events Configuration Settings Errors
The Hash class allows you to compute a hash using various algorithms.
Syntax
class ipworksencrypt.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:
When a valid source is found the search stops.Call the compute_hash method to hash the data. The hash_value 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 encode_hash 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.
| algorithm | The algorithm used to create the hash. |
| encode_hash | Whether the hash value is hex encoded. |
| hash_value | The hash value. |
| input_file | The file to process. |
| input_message | The message to process. |
| key | The secret key for the hash algorithm. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| compute_hash | Computes a hash. |
| config | Sets or retrieves a configuration setting. |
| hash_block | Computes the hash value of specified data. |
| reset | Resets the class. |
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.
| on_error | Information about errors during data delivery. |
| on_progress | Fired as progress is made. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| HashSize | The size of the computed hash code, read-only. |
| SHA3Version | The version of the SHA3 implementation. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |