EzRand Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

Method List

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

Event List

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

Config Settings

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

Algorithm Property (EzRand Module)

The random number algorithm.

Syntax

• Swift
• Objective-C

public var algorithm: EzRandAlgorithms {
  get {...}
  set {...}
}

public enum EzRandAlgorithms: Int32 {
  case raISAAC = 0
  case raMSCryptoAPI = 1
  case raPlatform = 2
  case raSecurePlatform = 3
  case raRC4Random = 4
}

@property (nonatomic,readwrite,assign,getter=algorithm,setter=setAlgorithm:) int algorithm;

- (int)algorithm;
- (void)setAlgorithm :(int)newAlgorithm;

Default Value

0

Remarks

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

Max Property (EzRand Module)

The exclusive upper bound.

Syntax

• Swift
• Objective-C

public var max: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=max,setter=setMax:) int max;

- (int)max;
- (void)setMax :(int)newMax;

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

The inclusive lower bound.

Syntax

• Swift
• Objective-C

public var min: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=min,setter=setMin:) int min;

- (int)min;
- (void)setMin :(int)newMin;

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

The random byte array.

Syntax

• Swift
• Objective-C

public var randBytes: String {
  get {...}
}

public var randBytesB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=randBytes) NSString* randBytes;

- (NSString*)randBytes;

@property (nonatomic,readonly,assign,getter=randBytesB) NSData* randBytesB;

- (NSData*)randBytesB;

Default Value

""

Remarks

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

This property is read-only.

RandBytesLength Property (EzRand Module)

The length of the byte array to be generated.

Syntax

• Swift
• Objective-C

public var randBytesLength: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=randBytesLength,setter=setRandBytesLength:) int randBytesLength;

- (int)randBytesLength;
- (void)setRandBytesLength :(int)newRandBytesLength;

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

The random integer.

Syntax

• Swift
• Objective-C

public var randInt: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=randInt) int randInt;

- (int)randInt;

Default Value

0

Remarks

This property holds the random integer generated by calling GetNextInt.

This property is read-only.

Seed Property (EzRand Module)

The seed.

Syntax

• Swift
• Objective-C

public var seed: String {
  get {...}
  set {...}
}

public var seedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=seed,setter=setSeed:) NSString* seed;

- (NSString*)seed;
- (void)setSeed :(NSString*)newSeed;

@property (nonatomic,readwrite,assign,getter=seedB,setter=setSeedB:) NSData* seedB;

- (NSData*)seedB;
- (void)setSeedB :(NSData*)newSeed;

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

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (EzRand Module)

Generates a sequence of random bytes.

Syntax

• Swift
• Objective-C

public func getNextBytes() throws -> Void

- (void)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:

• Algorithm
• RandBytesLength
• Seed

GetNextInt Method (EzRand Module)

Generates a random integer.

Syntax

• Swift
• Objective-C

public func getNextInt() throws -> Void

- (void)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:

• Algorithm
• Min
• Max
• Seed

Reset Method (EzRand Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

Error Event (EzRand Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

Config Settings (EzRand Module)

EzRand Config Settings

Base Config Settings

Trappable Errors (EzRand Module)

EzRand Errors