IPWorks Encrypt 2022 Python Edition
Version 22.0 [Build 8369]

Hash Class

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

algorithmThe algorithm used to create the hash.
encode_hashWhether the hash value is hex encoded.
hash_valueThe hash value.
input_fileThe file to process.
input_messageThe message to process.
keyThe 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_hashComputes a hash.
configSets or retrieves a configuration setting.
hash_blockComputes the hash value of specified data.
resetResets 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_errorInformation about errors during data delivery.
on_progressFired as progress is made.

Config Settings


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

HashSizeThe size of the computed hash code, read-only.
SHA3UseKeccakWhether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm.
UsePlatformHashWhether or not to use the Windows platform hash implementation.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

algorithm Property

The algorithm used to create the hash.

Syntax

def get_algorithm() -> int: ...
def set_algorithm(value: int) -> None: ...

algorithm = property(get_algorithm, set_algorithm)

Default Value

2

Remarks

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

0 (haSHA1) SHA1
1 (haSHA224) SHA-224
2 (haSHA256 - default) SHA-256
3 (haSHA384) SHA-384
4 (haSHA512) SHA-512
5 (haMD2) MD2
6 (haMD4) MD4
7 (haMD5) MD5
8 (haRIPEMD160) RIPEMD-160
9 (haMD5SHA1) MD5SHA1
10 (haHMACMD5) HMAC-MD5
11 (haHMACSHA1) HMAC-SHA1
12 (haHMACSHA224) HMAC-SHA224
13 (haHMACSHA256) HMAC-SHA256
14 (haHMACSHA384) HMAC-SHA384
15 (haHMACSHA512) HMAC-SHA512
16 (haHMACRIPEMD160) HMAC-RIPEMD-160
17 (haSHA3_224) SHA-3-224 (originally known as Keccak)
18 (haSHA3_256) SHA-3-256 (originally known as Keccak)
19 (haSHA3_384) SHA-3-384 (originally known as Keccak)
20 (haSHA3_512) SHA-3-512 (originally known as Keccak)
21 (haSHA512_224) SHA-512/224
22 (haSHA512_256) SHA-512/256

encode_hash Property

Whether the hash value is hex encoded.

Syntax

def get_encode_hash() -> bool: ...
def set_encode_hash(value: bool) -> None: ...

encode_hash = property(get_encode_hash, set_encode_hash)

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.

hash_value Property

The hash value.

Syntax

def get_hash_value() -> bytes: ...

hash_value = property(get_hash_value, None)

Default Value

""

Remarks

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

This property is read-only.

input_file Property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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:

When a valid source is found the search stops.

input_message Property

The message to process.

Syntax

def get_input_message() -> bytes: ...
def set_input_message(value: bytes) -> None: ...

input_message = property(get_input_message, set_input_message)

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:

When a valid source is found the search stops.

key Property

The secret key for the hash algorithm.

Syntax

def get_key() -> bytes: ...
def set_key(value: bytes) -> None: ...

key = property(get_key, set_key)

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)

SHA1SHA224SHA256SHA384SHA512MD5RIPEMD160
Recommended Key Size20 28 32 48 64 16 20
Hash Size 20 28 32 48 64 16 20
Block Size 64 64 64 128 128 64 64

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.

compute_hash Method

Computes a hash.

Syntax

def compute_hash() -> None: ...

Remarks

This method computes a hash of the data specified by input_message or input_file. The algorithm used is specified by algorithm. The hash_value 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:

When a valid source is found the search stops.

The on_progress event will fire with updates during this operation.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

hash_block Method

Computes the hash value of specified data.

Syntax

def hash_block(input_buffer: bytes, last_block: bool) -> bytes: ...

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

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

class HashErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Hash:
@property
def on_error() -> Callable[[HashErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[HashErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_progress Event

Fired as progress is made.

Syntax

class HashProgressEventParams(object):
  @property
  def bytes_processed() -> int: ...

  @property
  def percent_processed() -> int: ...

# In class Hash:
@property
def on_progress() -> Callable[[HashProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[HashProgressEventParams], None]) -> None: ...

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.

Hash Config Settings

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.

Hash Config Settings

HashSize:   The size of the computed hash code, read-only.

The size of the computed hash code in bytes.

SHA3UseKeccak:   Whether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm.

The official SHA-3 FIPS 202 standard does not generate the same hash value as the Keccak algorithm. If set to False (default), the official standard is used. If set to True, the Keccak algorithm is used.

UsePlatformHash:   Whether or not to use the Windows platform hash implementation.

Applies only for Windows OS. If set to False (default), the internal implementation is used. If set to True, the Windows platform hash implementation is used. Supported algorithms are:

  • MD5
  • SHA1
  • SHA256
  • SHA384
  • SHA512

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Hash Errors

Hash Errors

101   Unsupported algorithm.
104   Cannot read or write file.
304   Cannot write file.
305   Cannot read file.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 Python Edition - Version 22.0 [Build 8369]