# EzRand Class

The EzRand class can be used to generate random numbers or bytes using a variety of algorithms.

## Class Name

**IPWorksEncrypt_EzRand**

## Procedural Interface

```text
 ipworksencrypt_ezrand_open();
 ipworksencrypt_ezrand_close($res);
 ipworksencrypt_ezrand_register_callback($res, $id, $function);
 ipworksencrypt_ezrand_get_last_error($res);
 ipworksencrypt_ezrand_get_last_error_code($res);
 ipworksencrypt_ezrand_set($res, $id, $index, $value);
 ipworksencrypt_ezrand_get($res, $id, $index);
 ipworksencrypt_ezrand_do_config($res, $configurationstring);
 ipworksencrypt_ezrand_do_getnextbytes($res);
 ipworksencrypt_ezrand_do_getnextint($res);
 ipworksencrypt_ezrand_do_reset($res);
```

## Remarks

The EzRand class can be used to generate random numbers or bytes using a variety of algorithms and implementations.

To begin first set the [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class) property to the desired value. This property specifies the algorithm and implementation that will be used to generate the number or bytes. Possible choices include ISAAC, the Microsoft Crypto API, and platform specific random and secure random implementations.

Next set [Min](#min-property-ipworksencrypt_ezrand-class) and [Max](#max-property-ipworksencrypt_ezrand-class) to define the acceptable range of values when generating an integer. The [Seed](#seed-property-ipworksencrypt_ezrand-class) property may optionally be set. Then simply call [GetNextInt](#getnextint-method-ipworksencrypt_ezrand-class) to generate a random number. the [RandInt](#randint-property-ipworksencrypt_ezrand-class) property will be populated with the generated value.

To generate a random set of bytes set [RandBytesLength](#randbyteslength-property-ipworksencrypt_ezrand-class) to the desired number of bytes and call [GetNextBytes](#getnextbytes-method-ipworksencrypt_ezrand-class).

## 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_ezrand-class) | The random number algorithm. |
| [Max](#max-property-ipworksencrypt_ezrand-class) | The exclusive upper bound. |
| [Min](#min-property-ipworksencrypt_ezrand-class) | The inclusive lower bound. |
| [RandBytes](#randbytes-property-ipworksencrypt_ezrand-class) | The random byte array. |
| [RandBytesLength](#randbyteslength-property-ipworksencrypt_ezrand-class) | The length of the byte array to be generated. |
| [RandInt](#randint-property-ipworksencrypt_ezrand-class) | The random integer. |
| [Seed](#seed-property-ipworksencrypt_ezrand-class) | The seed. |

## Method List

*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Config](#config-method-ipworksencrypt_ezrand-class) | Sets or retrieves a configuration setting. |
| [GetNextBytes](#getnextbytes-method-ipworksencrypt_ezrand-class) | Generates a sequence of random bytes. |
| [GetNextInt](#getnextint-method-ipworksencrypt_ezrand-class) | Generates a random integer. |
| [Reset](#reset-method-ipworksencrypt_ezrand-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_ezrand-class) | Fired when information is available about errors during data delivery. |

## Config Settings

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

|  |  |
| --- | --- |
| [OutputEncoding](#OutputEncoding) | The encoding applied to the generated bytes. |
| [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_EzRand](#ezrand-class) Class)

The random number algorithm.

## Object Oriented Interface

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

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 1 );
ipworksencrypt_ezrand_set($res, 1, $value );
```

## Possible Values

```text
EZRAND_ALGORITHM_ISAAC(0), EZRAND_ALGORITHM_MSCRYPTO_API(1), EZRAND_ALGORITHM_PLATFORM(2), EZRAND_ALGORITHM_SECURE_PLATFORM(3), EZRAND_ALGORITHM_RC4RANDOM(4)
```

## Default Value

0

## Remarks

This property specifies the algorithm used to generate the random number or bytes. Possible values are:

|  |  |
| --- | --- |
| 0 (raISAAC) | ISAAC (indirection, shift, accumulate, add, and count) |
| 1 (raMSCryptoAPI) | The Microsoft Crypto API. This is only available on Windows. |
| 2 (raPlatform) | The platform's random implementation. |
| 3 (raSecurePlatform) | The platform's secure random implementation. This is only applicable in .NET and Java. In .NET the class uses the "RNGCryptoServiceProvider" class. In Java the class uses the "SecureRandom" class. |
| 4 (raRC4Random) | RC4 based random implementation. |

## Data Type

Integer

# Max Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The exclusive upper bound.

## Object Oriented Interface

```text
public function getMax();
public function setMax($value);
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 2 );
ipworksencrypt_ezrand_set($res, 2, $value );
```

## Default Value

100

## Remarks

This property specifies the exclusive upper bound of the random integer to be generated. The value must be greater than [Min](#min-property-ipworksencrypt_ezrand-class). The default value is 100.

## Data Type

Integer

# Min Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The inclusive lower bound.

## Object Oriented Interface

```text
public function getMin();
public function setMin($value);
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 3 );
ipworksencrypt_ezrand_set($res, 3, $value );
```

## Default Value

0

## Remarks

This property specifies the inclusive lower bound of the random integer to be generated. The value must be less than [Max](#max-property-ipworksencrypt_ezrand-class), and must not be negative. The default value is 0.

## Data Type

Integer

# RandBytes Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The random byte array.

## Object Oriented Interface

```text
public function getRandBytes();
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 4 );
```

## Default Value

''

## Remarks

This property holds the random byte array generated by calling [GetNextBytes](#getnextbytes-method-ipworksencrypt_ezrand-class).

This property is read-only.

## Data Type

Binary String

# RandBytesLength Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The length of the byte array to be generated.

## Object Oriented Interface

```text
public function getRandBytesLength();
public function setRandBytesLength($value);
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 5 );
ipworksencrypt_ezrand_set($res, 5, $value );
```

## Default Value

16

## Remarks

This property specifies the length of the random byte array to be generated. The [RandBytes](#randbytes-property-ipworksencrypt_ezrand-class) property will hold the byte array after [GetNextBytes](#getnextbytes-method-ipworksencrypt_ezrand-class) is called. The default value is 16.

## Data Type

Integer

# RandInt Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The random integer.

## Object Oriented Interface

```text
public function getRandInt();
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 6 );
```

## Default Value

0

## Remarks

This property holds the random integer generated by calling [GetNextInt](#getnextint-method-ipworksencrypt_ezrand-class).

This property is read-only.

## Data Type

Integer

# Seed Property ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

The seed.

## Object Oriented Interface

```text
public function getSeed();
public function setSeed($value);
```

## Procedural Interface

```text
ipworksencrypt_ezrand_get($res, 7 );
ipworksencrypt_ezrand_set($res, 7, $value );
```

## Default Value

''

## Remarks

This property specifies the seed. This value is optional. If not specified and a seed is required the class will use the current time.

**Seed Notes**

- When [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class) is set to 0 (raISAAC) the class uses the leftmost 256 bytes.
- When [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class) is set to 1 (raMSCryptoAPI) the seed is ignored.
- When [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class) is set to 2 (raPlatform) the class uses the leftmost 4 bytes.
- When [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class) is set to 3 (raSecurePlatform) in .NET the seed is ignored. The seed is applicable in Java.

## Data Type

Binary String

# Config Method ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

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

## Procedural Interface

```text
ipworksencrypt_ezrand_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-ezrand-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-ezrand-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# GetNextBytes Method ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

Generates a sequence of random bytes.

## Object Oriented Interface

```text
public function doGetNextBytes();
```

## Procedural Interface

```text
ipworksencrypt_ezrand_do_getnextbytes($res);
```

## Remarks

This method generates a new sequence of random bytes. The [RandBytesLength](#randbyteslength-property-ipworksencrypt_ezrand-class) property specifies the length of the byte array. After calling this method the [RandBytes](#randbytes-property-ipworksencrypt_ezrand-class) will hold the random bytes. The following properties are applicable when calling this method:

- [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class)
- [RandBytesLength](#randbyteslength-property-ipworksencrypt_ezrand-class)
- [Seed](#seed-property-ipworksencrypt_ezrand-class)

# GetNextInt Method ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

Generates a random integer.

## Object Oriented Interface

```text
public function doGetNextInt();
```

## Procedural Interface

```text
ipworksencrypt_ezrand_do_getnextint($res);
```

## Remarks

This method generates a random integer. The [Min](#min-property-ipworksencrypt_ezrand-class) and [Max](#max-property-ipworksencrypt_ezrand-class) properties define the minimum and maximum values. After calling this method the [RandInt](#randint-property-ipworksencrypt_ezrand-class) property will hold the integer. The following properties are applicable when calling this method:

- [Algorithm](#algorithm-property-ipworksencrypt_ezrand-class)
- [Min](#min-property-ipworksencrypt_ezrand-class)
- [Max](#max-property-ipworksencrypt_ezrand-class)
- [Seed](#seed-property-ipworksencrypt_ezrand-class)

# Reset Method ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

Resets the class.

## Object Oriented Interface

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

## Procedural Interface

```text
ipworksencrypt_ezrand_do_reset($res);
```

## Remarks

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

# Error Event ([IPWorksEncrypt_EzRand](#ezrand-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

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

## Procedural Interface

```text
ipworksencrypt_ezrand_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-ezrand-class) section.

# Config Settings ([EzRand](#ezrand-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_ezrand-class) method.

### EzRand Config Settings

**OutputEncoding**: The encoding applied to the generated bytes.This setting optionally specifies an encoding to apply to the bytes generated when [GetNextBytes](#getnextbytes-method-ipworksencrypt_ezrand-class) is called. This may be useful in situations where the bytes are displayed or transmitted as text. Possible values are:

- 0 (none - default)
- 1 (Base64)
- 2 (Hex)
- 3 (Base64URL)

The [RandBytes](#randbytes-property-ipworksencrypt_ezrand-class) property will hold the string.

### 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 ([EzRand](#ezrand-class) Class)

### EzRand Errors

|  |  |
| --- | --- |
| 101 | Unsupported algorithm. |
| 105 | Invalid Min, Max, or RandomBytesLength value. |