EzRand Class
Properties Methods Events Config Settings Errors
The EzRand class can be used to generate random numbers or bytes using a variety of algorithms.
Class Name
IPWorksEncrypt_EzRand
Procedural Interface
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 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 and Max to define the acceptable range of values when generating an integer. The Seed property may optionally be set. Then simply call GetNextInt to generate a random number. the RandInt property will be populated with the generated value.
To generate a random set of bytes set RandBytesLength to the desired number of bytes and call GetNextBytes.
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 random number algorithm. |
| Max | The exclusive upper bound. |
| Min | The inclusive lower bound. |
| RandBytes | The random byte array. |
| RandBytesLength | The length of the byte array to be generated. |
| RandInt | The random integer. |
| Seed | 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 | Sets or retrieves a configuration setting. |
| GetNextBytes | Generates a sequence of random bytes. |
| GetNextInt | Generates a random integer. |
| 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.
| Error | Information 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 | The encoding applied to the generated bytes. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| 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. |
Algorithm Property (IPWorksEncrypt_EzRand Class)
The random number algorithm.
Object Oriented Interface
public function getAlgorithm(); public function setAlgorithm($value);
Procedural Interface
ipworksencrypt_ezrand_get($res, 1 ); ipworksencrypt_ezrand_set($res, 1, $value );
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 Class)
The exclusive upper bound.
Object Oriented Interface
public function getMax(); public function setMax($value);
Procedural Interface
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. The default value is 100.
Data Type
Integer
Min Property (IPWorksEncrypt_EzRand Class)
The inclusive lower bound.
Object Oriented Interface
public function getMin(); public function setMin($value);
Procedural Interface
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, and must not be negative. The default value is 0.
Data Type
Integer
RandBytes Property (IPWorksEncrypt_EzRand Class)
The random byte array.
Object Oriented Interface
public function getRandBytes();
Procedural Interface
ipworksencrypt_ezrand_get($res, 4 );
Default Value
''
Remarks
This property holds the random byte array generated by calling GetNextBytes.
This property is read-only.
Data Type
Binary String
RandBytesLength Property (IPWorksEncrypt_EzRand Class)
The length of the byte array to be generated.
Object Oriented Interface
public function getRandBytesLength(); public function setRandBytesLength($value);
Procedural Interface
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 property will hold the byte array after GetNextBytes is called. The default value is 16.
Data Type
Integer
RandInt Property (IPWorksEncrypt_EzRand Class)
The random integer.
Object Oriented Interface
public function getRandInt();
Procedural Interface
ipworksencrypt_ezrand_get($res, 6 );
Default Value
0
Remarks
This property holds the random integer generated by calling GetNextInt.
This property is read-only.
Data Type
Integer
Seed Property (IPWorksEncrypt_EzRand Class)
The seed.
Object Oriented Interface
public function getSeed(); public function setSeed($value);
Procedural Interface
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 is set to 0 (raISAAC) the class uses the leftmost 256 bytes.
- When Algorithm is set to 1 (raMSCryptoAPI) the seed is ignored.
- When Algorithm is set to 2 (raPlatform) the class uses the leftmost 4 bytes.
- When Algorithm 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 Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
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 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.
GetNextBytes Method (IPWorksEncrypt_EzRand Class)
Generates a sequence of random bytes.
Object Oriented Interface
public function doGetNextBytes();
Procedural Interface
ipworksencrypt_ezrand_do_getnextbytes($res);
Remarks
This method generates a new sequence of random bytes. The RandBytesLength property specifies the length of the byte array. After calling this method the RandBytes will hold the random bytes. The following properties are applicable when calling this method:
GetNextInt Method (IPWorksEncrypt_EzRand Class)
Generates a random integer.
Object Oriented Interface
public function doGetNextInt();
Procedural Interface
ipworksencrypt_ezrand_do_getnextint($res);
Remarks
This method generates a random integer. The Min and Max properties define the minimum and maximum values. After calling this method the RandInt property will hold the integer. The following properties are applicable when calling this method:
Reset Method (IPWorksEncrypt_EzRand Class)
Resets the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksencrypt_ezrand_do_reset($res);
Remarks
When called, the class will reset all of its properties to their default values.
Error Event (IPWorksEncrypt_EzRand Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksencrypt_ezrand_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The 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.
Config Settings (EzRand 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 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 is called. This
may be useful in situations where the bytes are displayed or transmitted as text. Possible values are:
The RandBytes 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
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 false.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class 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 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 section. |
Trappable Errors (EzRand Class)
EzRand Errors
| 101 Unsupported algorithm. | |
| 105 Invalid Min, Max, or RandomBytesLength value. |