IPWorks Encrypt 2022 Python Edition
Version 22.0 [Build 8369]

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.

algorithmThe random number algorithm.
maxThe exclusive upper bound.
minThe inclusive lower bound.
rand_bytesThe random byte array.
rand_bytes_lengthThe length of the byte array to be generated.
rand_intThe random integer.
seedThe 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.

configSets or retrieves a configuration setting.
get_next_bytesGenerates a sequence of random bytes.
get_next_intGenerates a random integer.
resetResets 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.

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

OutputEncodingThe encoding applied to the generated bytes.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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:

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

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:

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:

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

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

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.

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

OutputEncoding:   The encoding applied to the generated bytes.

This setting optionally specifies an encoding to apply to the bytes generated when get_next_bytes 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 rand_bytes 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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

EzRand Errors

EzRand Errors

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 Python Edition - Version 22.0 [Build 8369]