# Hash Class

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

## Class Name

**IPWorksEncrypt_Hash**

## Procedural Interface

```text
 ipworksencrypt_hash_open();
 ipworksencrypt_hash_close($res);
 ipworksencrypt_hash_register_callback($res, $id, $function);
 ipworksencrypt_hash_get_last_error($res);
 ipworksencrypt_hash_get_last_error_code($res);
 ipworksencrypt_hash_set($res, $id, $index, $value);
 ipworksencrypt_hash_get($res, $id, $index);
 ipworksencrypt_hash_do_computehash($res);
 ipworksencrypt_hash_do_config($res, $configurationstring);
 ipworksencrypt_hash_do_hashblock($res, $inputbuffer, $lastblock);
 ipworksencrypt_hash_do_reset($res);
```

## 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](#algorithm-property-ipworksencrypt_hash-class) 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](#inputfile-property-ipworksencrypt_hash-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_hash-class)

 When a valid source is found the search stops.

Call the [ComputeHash](#computehash-method-ipworksencrypt_hash-class) method to hash the data. The [HashValue](#hashvalue-property-ipworksencrypt_hash-class) 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](#encodehash-property-ipworksencrypt_hash-class) 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](#algorithm-property-ipworksencrypt_hash-class) | The algorithm used to create the hash. |
| [EncodeHash](#encodehash-property-ipworksencrypt_hash-class) | Whether the hash value is hex encoded. |
| [HashValue](#hashvalue-property-ipworksencrypt_hash-class) | The hash value. |
| [InputFile](#inputfile-property-ipworksencrypt_hash-class) | The file to process. |
| [InputMessage](#inputmessage-property-ipworksencrypt_hash-class) | The message to process. |
| [Key](#key-property-ipworksencrypt_hash-class) | 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.*

|  |  |
| --- | --- |
| [ComputeHash](#computehash-method-ipworksencrypt_hash-class) | Computes a hash. |
| [Config](#config-method-ipworksencrypt_hash-class) | Sets or retrieves a configuration setting. |
| [HashBlock](#hashblock-method-ipworksencrypt_hash-class) | Computes the hash value of specified data. |
| [Reset](#reset-method-ipworksencrypt_hash-class) | 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.*

|  |  |
| --- | --- |
| [Error](#error-event-ipworksencrypt_hash-class) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-ipworksencrypt_hash-class) | Fired 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.*

|  |  |
| --- | --- |
| [HashSize](#HashSize) | The size of the computed hash code, read-only. |
| [SHA3UseKeccak](#SHA3UseKeccak) | Whether or not to use the official SHA-3 FIPS 202 standard or the older Keccak algorithm. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Algorithm Property ([IPWorksEncrypt_Hash](#hash-class) Class)

The algorithm used to create the hash.

## Object Oriented Interface

```text
public function getAlgorithm();
public function setAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 1 );
ipworksencrypt_hash_set($res, 1, $value );
```

## Possible Values

```text
HASH_ALGORITHM_SHA1(0), HASH_ALGORITHM_SHA224(1), HASH_ALGORITHM_SHA256(2), HASH_ALGORITHM_SHA384(3), HASH_ALGORITHM_SHA512(4), HASH_ALGORITHM_MD2(5), HASH_ALGORITHM_MD4(6), HASH_ALGORITHM_MD5(7), HASH_ALGORITHM_RIPEMD160(8), HASH_ALGORITHM_MD5SHA1(9), HASH_ALGORITHM_HMACMD5(10), HASH_ALGORITHM_HMACSHA1(11), HASH_ALGORITHM_HMACSHA224(12), HASH_ALGORITHM_HMACSHA256(13), HASH_ALGORITHM_HMACSHA384(14), HASH_ALGORITHM_HMACSHA512(15), HASH_ALGORITHM_HMACRIPEMD160(16), HASH_ALGORITHM_SHA3_224(17), HASH_ALGORITHM_SHA3_256(18), HASH_ALGORITHM_SHA3_384(19), HASH_ALGORITHM_SHA3_512(20), HASH_ALGORITHM_SHA512_224(21), HASH_ALGORITHM_SHA512_256(22)
```

## Default Value

2

## Remarks

This property specifies the algorithm used when calling [ComputeHash](#computehash-method-ipworksencrypt_hash-class). 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 |

## Data Type

Integer

# EncodeHash Property ([IPWorksEncrypt_Hash](#hash-class) Class)

Whether the hash value is hex encoded.

## Object Oriented Interface

```text
public function getEncodeHash();
public function setEncodeHash($value);
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 2 );
ipworksencrypt_hash_set($res, 2, $value );
```

## 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 ([IPWorksEncrypt_Hash](#hash-class) Class)

The hash value.

## Object Oriented Interface

```text
public function getHashValue();
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 3 );
```

## Default Value

''

## Remarks

The computed hash value. This property is populated after calling [ComputeHash](#computehash-method-ipworksencrypt_hash-class).

This property is read-only.

## Data Type

Binary String

# InputFile Property ([IPWorksEncrypt_Hash](#hash-class) Class)

The file to process.

## Object Oriented Interface

```text
public function getInputFile();
public function setInputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 4 );
ipworksencrypt_hash_set($res, 4, $value );
```

## 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](#inputmessage-property-ipworksencrypt_hash-class)

 When a valid source is found the search stops.

## Data Type

String

# InputMessage Property ([IPWorksEncrypt_Hash](#hash-class) Class)

The message to process.

## Object Oriented Interface

```text
public function getInputMessage();
public function setInputMessage($value);
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 5 );
ipworksencrypt_hash_set($res, 5, $value );
```

## 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](#inputfile-property-ipworksencrypt_hash-class)
- InputMessage

 When a valid source is found the search stops.

## Data Type

Binary String

# Key Property ([IPWorksEncrypt_Hash](#hash-class) Class)

The secret key for the hash algorithm.

## Object Oriented Interface

```text
public function getKey();
public function setKey($value);
```

## Procedural Interface

```text
ipworksencrypt_hash_get($res, 6 );
ipworksencrypt_hash_set($res, 6, $value );
```

## 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](#algorithm-property-ipworksencrypt_hash-class) 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)**

|  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- |
|  | SHA1 | SHA224 | SHA256 | SHA384 | SHA512 | MD5 | RIPEMD160 |
| Recommended Key Size | 20 | 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 it is first hashed with the same algorithm.

## Data Type

Binary String

# ComputeHash Method ([IPWorksEncrypt_Hash](#hash-class) Class)

Computes a hash.

## Object Oriented Interface

```text
public function doComputeHash();
```

## Procedural Interface

```text
ipworksencrypt_hash_do_computehash($res);
```

## Remarks

This method computes a hash of the data specified by [InputMessage](#inputmessage-property-ipworksencrypt_hash-class) or [InputFile](#inputfile-property-ipworksencrypt_hash-class). The algorithm used is specified by [Algorithm](#algorithm-property-ipworksencrypt_hash-class). The [HashValue](#hashvalue-property-ipworksencrypt_hash-class) 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](#inputfile-property-ipworksencrypt_hash-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_hash-class)

 When a valid source is found the search stops.

The [Progress](#progress-event-ipworksencrypt_hash-class) event will fire with updates during this operation.

# Config Method ([IPWorksEncrypt_Hash](#hash-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworksencrypt_hash_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-hash-class) 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](#config-settings-hash-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# HashBlock Method ([IPWorksEncrypt_Hash](#hash-class) Class)

Computes the hash value of specified data.

## Object Oriented Interface

```text
public function doHashBlock($inputbuffer, $lastblock);
```

## Procedural Interface

```text
ipworksencrypt_hash_do_hashblock($res, $inputbuffer, $lastblock);
```

## 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:

```text
Hash.HashBlock(part1,false);
Hash.HashBlock(part2,false);
Hash.HashBlock(part3,false);
byte[] hashValue = Hash.HashBlock(lastPart,true);
```

# Reset Method ([IPWorksEncrypt_Hash](#hash-class) Class)

Resets the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworksencrypt_hash_do_reset($res);
```

## Remarks

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

# Error Event ([IPWorksEncrypt_Hash](#hash-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworksencrypt_hash_register_callback($res, 1, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

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

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-hash-class) section.

# Progress Event ([IPWorksEncrypt_Hash](#hash-class) Class)

Fired as progress is made.

## Object Oriented Interface

```text
public function fireProgress($param);
```

## Procedural Interface

```text
ipworksencrypt_hash_register_callback($res, 2, array($this, 'fireProgress'));
```

## Parameter List

```text
 'bytesprocessed' 'percentprocessed'
```

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

# Config Settings ([Hash](#hash-class) 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](#config-method-ipworksencrypt_hash-class) 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.

### 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:

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

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

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

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

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**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 DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([Hash](#hash-class) Class)

### Hash Errors

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