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.

Syntax

class 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 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 get_next_int to generate a random number. the rand_int property will be populated with the generated value.

To generate a random set of bytes set rand_bytes_length to the desired number of bytes and call get_next_bytes.

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.

algorithm Property

The random number algorithm.

Syntax

def get_algorithm() -> int: ...
def set_algorithm(value: int) -> None: ...

algorithm = property(get_algorithm, set_algorithm)

Default Value

0

Remarks

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

max Property

The exclusive upper bound.

Syntax

def get_max() -> int: ...
def set_max(value: int) -> None: ...

max = property(get_max, set_max)

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.

min Property

The inclusive lower bound.

Syntax

def get_min() -> int: ...
def set_min(value: int) -> None: ...

min = property(get_min, set_min)

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.

rand_bytes Property

The random byte array.

Syntax

def get_rand_bytes() -> bytes: ...

rand_bytes = property(get_rand_bytes, None)

Default Value

""

Remarks

This property holds the random byte array generated by calling get_next_bytes.

This property is read-only.

rand_bytes_length Property

The length of the byte array to be generated.

Syntax

def get_rand_bytes_length() -> int: ...
def set_rand_bytes_length(value: int) -> None: ...

rand_bytes_length = property(get_rand_bytes_length, set_rand_bytes_length)

Default Value

16

Remarks

This property specifies the length of the random byte array to be generated. The rand_bytes property will hold the byte array after get_next_bytes is called. The default value is 16.

rand_int Property

The random integer.

Syntax

def get_rand_int() -> int: ...

rand_int = property(get_rand_int, None)

Default Value

0

Remarks

This property holds the random integer generated by calling get_next_int.

This property is read-only.

seed Property

The seed.

Syntax

def get_seed() -> bytes: ...
def set_seed(value: bytes) -> None: ...

seed = property(get_seed, set_seed)

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.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

get_next_bytes Method

Generates a sequence of random bytes.

Syntax

def get_next_bytes() -> None: ...

Remarks

This method generates a new sequence of random bytes. The rand_bytes_length property specifies the length of the byte array. After calling this method the rand_bytes will hold the random bytes. The following properties are applicable when calling this method:

• algorithm
• rand_bytes_length
• seed

get_next_int Method

Generates a random integer.

Syntax

def get_next_int() -> None: ...

Remarks

This method generates a random integer. The min and max properties define the minimum and maximum values. After calling this method the rand_int property will hold the integer. The following properties are applicable when calling this method:

• algorithm
• min
• max
• seed

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class EzRandErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class EzRand:
@property
def on_error() -> Callable[[EzRandErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[EzRandErrorEventParams], None]) -> None: ...

Remarks

The on_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 section.

EzRand Config Settings

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

Base Config Settings

EzRand Errors

EzRand Errors

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