IPWorks Encrypt 2022 Delphi Edition
Version 22.0 [Build 8515]

EzRand Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipcEzRand

Remarks

The EzRand component 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 component with short descriptions. Click on the links for further details.

AlgorithmThe random number algorithm.
MaxThe exclusive upper bound.
MinThe inclusive lower bound.
RandBytesThe random byte array.
RandBytesLengthThe length of the byte array to be generated.
RandIntThe random integer.
SeedThe seed.

Method List


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

ConfigSets or retrieves a configuration setting.
GetNextBytesGenerates a sequence of random bytes.
GetNextIntGenerates a random integer.
ResetResets the component.

Event List


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

ErrorInformation about errors during data delivery.

Config Settings


The following is a list of config settings for the component 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.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Algorithm Property (EzRand Component)

The random number algorithm.

Syntax

property Algorithm: TipcTRands read get_Algorithm write set_Algorithm;
TipcTRands = ( raISAAC, raMSCryptoAPI, raPlatform, raSecurePlatform, raRC4Random );

Default Value

raISAAC

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 component uses the "RNGCryptoServiceProvider" class. In Java the component uses the "SecureRandom" class.
4 (raRC4Random) RC4 based random implementation.

Max Property (EzRand Component)

The exclusive upper bound.

Syntax

property Max: Integer read get_Max write 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 (EzRand Component)

The inclusive lower bound.

Syntax

property Min: Integer read get_Min write 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.

RandBytes Property (EzRand Component)

The random byte array.

Syntax

property RandBytes: String read get_RandBytes;
property RandBytesB: TBytes read get_RandBytesB;

Default Value

''

Remarks

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

This property is read-only.

RandBytesLength Property (EzRand Component)

The length of the byte array to be generated.

Syntax

property RandBytesLength: Integer read get_RandBytesLength write set_RandBytesLength;

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.

RandInt Property (EzRand Component)

The random integer.

Syntax

property RandInt: Integer read get_RandInt;

Default Value

0

Remarks

This property holds the random integer generated by calling GetNextInt.

This property is read-only.

Seed Property (EzRand Component)

The seed.

Syntax

property Seed: String read get_Seed write set_Seed;
property SeedB: TBytes read get_SeedB write set_SeedB;

Default Value

''

Remarks

This property specifies the seed. This value is optional. If not specified and a seed is required the component will use the current time.

Seed Notes

  • When Algorithm is set to 0 (raISAAC) the component uses the leftmost 256 bytes.
  • When Algorithm is set to 1 (raMSCryptoAPI) the seed is ignored.
  • When Algorithm is set to 2 (raPlatform) the component 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 (EzRand Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (EzRand Component)

Generates a sequence of random bytes.

Syntax

procedure GetNextBytes();

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 (EzRand Component)

Generates a random integer.

Syntax

procedure GetNextInt();

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 (EzRand Component)

Resets the component.

Syntax

procedure Reset();

Remarks

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

Error Event (EzRand Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 Component)

The component 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 component, 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:

  • 0 (none - default)
  • 1 (Base64)
  • 2 (Hex)
  • 3 (Base64URL)

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:

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 component 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.
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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

When set to False, the component will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to True tells the component 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 Component)

EzRand Errors

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

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