# EzRand Module

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

## Syntax

```text
IPWorksEncrypt.EzRand
```

## 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-ezrand-module) 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-ezrand-module) and [Max](#max-property-ezrand-module) to define the acceptable range of values when generating an integer. The [Seed](#seed-property-ezrand-module) property may optionally be set. Then simply call [GetNextInt](#getnextint-method-ezrand-module) to generate a random number. the [RandInt](#randint-property-ezrand-module) property will be populated with the generated value.

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

## Property List

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

|  |  |
| --- | --- |
| [Algorithm](#algorithm-property-ezrand-module) | The random number algorithm. |
| [Max](#max-property-ezrand-module) | The exclusive upper bound. |
| [Min](#min-property-ezrand-module) | The inclusive lower bound. |
| [RandBytes](#randbytes-property-ezrand-module) | The random byte array. |
| [RandBytesLength](#randbyteslength-property-ezrand-module) | The length of the byte array to be generated. |
| [RandInt](#randint-property-ezrand-module) | The random integer. |
| [Seed](#seed-property-ezrand-module) | The seed. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-ezrand-module) | Sets or retrieves a configuration setting. |
| [GetNextBytes](#getnextbytes-method-ezrand-module) | Generates a sequence of random bytes. |
| [GetNextInt](#getnextint-method-ezrand-module) | Generates a random integer. |
| [Reset](#reset-method-ezrand-module) | Resets the module. |

## Event List

*The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Error](#error-event-ezrand-module) | Fired when information is available about errors during data delivery. |

## Config Settings

*The following is a list of config settings for the module 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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Algorithm Property ([EzRand](#ezrand-module) Module)

The random number algorithm.

## Syntax

```text
public var algorithm: EzRandAlgorithms {
  get {...}
  set {...}
}
public enum EzRandAlgorithms: Int32 {
  case raISAAC = 0
  case raMSCryptoAPI = 1
  case raPlatform = 2
  case raSecurePlatform = 3
  case raRC4Random = 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. |

# Max Property ([EzRand](#ezrand-module) Module)

The exclusive upper bound.

## Syntax

```text
public var max: Int32 {
  get {...}
  set {...}
}
```

## 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-ezrand-module). The default value is 100.

# Min Property ([EzRand](#ezrand-module) Module)

The inclusive lower bound.

## Syntax

```text
public var min: Int32 {
  get {...}
  set {...}
}
```

## 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-ezrand-module), and must not be negative. The default value is 0.

# RandBytes Property ([EzRand](#ezrand-module) Module)

The random byte array.

## Syntax

```text
public var randBytes: String {
  get {...}
}
public var randBytesB: Data {
  get {...}
}
```

## Default Value

""

## Remarks

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

This property is read-only.

# RandBytesLength Property ([EzRand](#ezrand-module) Module)

The length of the byte array to be generated.

## Syntax

```text
public var randBytesLength: Int32 {
  get {...}
  set {...}
}
```

## Default Value

16

## Remarks

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

# RandInt Property ([EzRand](#ezrand-module) Module)

The random integer.

## Syntax

```text
public var randInt: Int32 {
  get {...}
}
```

## Default Value

0

## Remarks

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

This property is read-only.

# Seed Property ([EzRand](#ezrand-module) Module)

The seed.

## Syntax

```text
public var seed: String {
  get {...}
  set {...}
}
public var seedB: Data {
  get {...}
  set {...}
}
```

## 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-ezrand-module) is set to 0 (raISAAC) the class uses the leftmost 256 bytes.
- When [Algorithm](#algorithm-property-ezrand-module) is set to 1 (raMSCryptoAPI) the seed is ignored.
- When [Algorithm](#algorithm-property-ezrand-module) is set to 2 (raPlatform) the class uses the leftmost 4 bytes.
- When [Algorithm](#algorithm-property-ezrand-module) is set to 3 (raSecurePlatform) in .NET the seed is ignored. The seed is applicable in Java.

# Config Method ([EzRand](#ezrand-module) Module)

Sets or retrieves a configuration setting.

## Syntax

```text
public func config(configurationString: String) throws -> String
```

## Remarks

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

# GetNextBytes Method ([EzRand](#ezrand-module) Module)

Generates a sequence of random bytes.

## Syntax

```text
public func getNextBytes() throws -> Void
```

## Remarks

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

- [Algorithm](#algorithm-property-ezrand-module)
- [RandBytesLength](#randbyteslength-property-ezrand-module)
- [Seed](#seed-property-ezrand-module)

# GetNextInt Method ([EzRand](#ezrand-module) Module)

Generates a random integer.

## Syntax

```text
public func getNextInt() throws -> Void
```

## Remarks

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

- [Algorithm](#algorithm-property-ezrand-module)
- [Min](#min-property-ezrand-module)
- [Max](#max-property-ezrand-module)
- [Seed](#seed-property-ezrand-module)

# Reset Method ([EzRand](#ezrand-module) Module)

Resets the component.

## Syntax

```text
public func reset() throws -> Void
```

## Remarks

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

# Error Event ([EzRand](#ezrand-module) Module)

Fired when information is available about errors during data delivery.

## Syntax

```text
func onError(errorCode: Int32, description: String)
```

## Remarks

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

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

# Config Settings ([EzRand](#ezrand-module) Module)

 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-ezrand-module) 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-ezrand-module) 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-ezrand-module) 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*.

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

 This setting is set to *false* by default on all platforms.

# Trappable Errors ([EzRand](#ezrand-module) Module)

### EzRand Errors

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