Rnd Class

Properties   Methods   Events   Config Settings   Errors  

The Rnd class class is a basic provider of random number generation functionality.

Class Name

SecureBlackbox_Rnd

Procedural Interface

 secureblackbox_rnd_open();
 secureblackbox_rnd_close($res);
 secureblackbox_rnd_register_callback($res, $id, $function);
 secureblackbox_rnd_get_last_error($res);
 secureblackbox_rnd_get_last_error_code($res);
 secureblackbox_rnd_set($res, $id, $index, $value);
 secureblackbox_rnd_get($res, $id, $index);
 secureblackbox_rnd_do_config($res, $configurationstring);
 secureblackbox_rnd_do_doaction($res, $actionid, $actionparams);
 secureblackbox_rnd_do_nextbytes($res, $len);
 secureblackbox_rnd_do_nextint($res);
 secureblackbox_rnd_do_nextpass($res, $lowercase, $uppercase, $digits, $specials, $len);
 secureblackbox_rnd_do_nextstring($res, $len);
 secureblackbox_rnd_do_randomize($res);
 secureblackbox_rnd_do_seedbytes($res, $value);
 secureblackbox_rnd_do_seedint($res, $intvalue);
 secureblackbox_rnd_do_seedstring($res, $strvalue);
 secureblackbox_rnd_do_seedtime($res);

Remarks

Use Rnd control to generate pseudo-random numbers or sequences. Methods like NextBytes and NextInt return the next PRNG output, whereas SeedBytes or SeedInt seed the generator with outside entropy.

It is a good idea to use one shared (singleton) Rnd object per process, as it helps spread the entropy across many part of the project, resulting in better and more secure randomization.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

Alphabet Property (SecureBlackbox_Rnd Class)

Alphabet to use for random string generation.

Object Oriented Interface

public function getAlphabet();


public function setAlphabet($value);

Procedural Interface

secureblackbox_rnd_get($res, 1 );


secureblackbox_rnd_set($res, 1, $value );

Default Value

''

Remarks

Use this property to provide a list of characters to be used by NextString method. The empty value has a special meaning, and is equivalent to 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'.

Data Type

String

FIPSMode Property (SecureBlackbox_Rnd Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_rnd_get($res, 2 );


secureblackbox_rnd_set($res, 2, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Config Method (SecureBlackbox_Rnd Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoAction Method (SecureBlackbox_Rnd Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_rnd_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

NextBytes Method (SecureBlackbox_Rnd Class)

Generates an array of random bytes.

Object Oriented Interface

public function doNextBytes($len);

Procedural Interface

secureblackbox_rnd_do_nextbytes($res, $len);

Remarks

Call this method to generate an array of random bytes of length Len.

NextInt Method (SecureBlackbox_Rnd Class)

Generates a random integer.

Object Oriented Interface

public function doNextInt();

Procedural Interface

secureblackbox_rnd_do_nextint($res);

Remarks

Use this method to generate a random integer value.

NextPass Method (SecureBlackbox_Rnd Class)

Generates a random password.

Object Oriented Interface

public function doNextPass($lowercase, $uppercase, $digits, $specials, $len);

Procedural Interface

secureblackbox_rnd_do_nextpass($res, $lowercase, $uppercase, $digits, $specials, $len);

Remarks

Use this method to generate a random password. Tune up the desired length and composition of the password using Lowercase, Uppercase, Digits, Specials, and Len parameters.

NextString Method (SecureBlackbox_Rnd Class)

Generates a random string of characters.

Object Oriented Interface

public function doNextString($len);

Procedural Interface

secureblackbox_rnd_do_nextstring($res, $len);

Remarks

Use this method to generate a random string using characters supplied via the Alphabet property.

Randomize Method (SecureBlackbox_Rnd Class)

Seeds the random generator with a system-originating input.

Object Oriented Interface

public function doRandomize();

Procedural Interface

secureblackbox_rnd_do_randomize($res);

Remarks

Use this method to randomize the generator by seeding it with a system-produced random input.

SeedBytes Method (SecureBlackbox_Rnd Class)

Seeds the generator with a data in a byte array.

Object Oriented Interface

public function doSeedBytes($value);

Procedural Interface

secureblackbox_rnd_do_seedbytes($res, $value);

Remarks

Use this method to seed the generator with data provided in a byte array.

SeedInt Method (SecureBlackbox_Rnd Class)

Seeds the generator with an integer value.

Object Oriented Interface

public function doSeedInt($intvalue);

Procedural Interface

secureblackbox_rnd_do_seedint($res, $intvalue);

Remarks

Use this method to seed the generator with an integer value.

SeedString Method (SecureBlackbox_Rnd Class)

Seeds the generator with a string value.

Object Oriented Interface

public function doSeedString($strvalue);

Procedural Interface

secureblackbox_rnd_do_seedstring($res, $strvalue);

Remarks

Use this method to seed the generator with a string value.

SeedTime Method (SecureBlackbox_Rnd Class)

Seeds the generator with current time.

Object Oriented Interface

public function doSeedTime();

Procedural Interface

secureblackbox_rnd_do_seedtime($res);

Remarks

Use this method to seed the generator with current system time.

Error Event (SecureBlackbox_Rnd Class)

Informs about errors during cryptographic operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_rnd_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

Class fires this event if an error happens during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

Notification Event (SecureBlackbox_Rnd Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_rnd_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (Rnd 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.

Base Config Settings

Trappable Errors (Rnd Class)

Rnd Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)