Salsa20 Module

Properties   Methods   Events   Config Settings   Errors  

The Salsa20 module can be used to encrypt and decrypt data with the XSalsa20 and Salsa20 algorithm.

Syntax

IPWorksEncrypt.Salsa20

Remarks

The class implements XSalsa20 as well as Salsa20. The Algorithm property specifies which algorithm to use when encrypting and decryption. In addition the 12 and 8 round variants of Salsa20 are supported.

Data may be encrypted and decrypted in its entirety by calling Encrypt and Decrypt or chunk by chunk by calling EncryptBlock and DecryptBlock.

In all operations a Key and IV must be used. If IV is not set one is automatically generated. KeyPassword may be set in order to automatically generate both a Key and IV when a method is called. The same KeyPassword, or Key and IV pair are used on both sides of the operation data can be encrypted and decrypted.

Encrypt Notes

Encrypt will encrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If KeyPassword is set both Key and IV will be automatically generated when Encrypt is called.

The IV must be set to a 192 bit (24 byte) value when Algorithm is set to XSalsa. The IV must be set to a 64 bit (8 byte) value when Algorithm is set to Salsa.

If IV is not set a value will automatically be generated by the class when Encrypt is called.

During encryption the Progress event will fire as data is encrypted.

Encrypt Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; salsa.InputMessage = "hello salsa!"; salsa.Encrypt(); //salsa.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes. // { 0x06, 0xF4, 0xD9, 0xB4, 0x67, 0x31, 0x1C, 0x1E, 0x8E, 0xD6, 0xB5, 0x6B }

Encrypt Block Notes

EncryptBlock will encrypt the input data and return the encrypted block. The encrypted block will always be the same length as the decrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to encrypt.

EncryptBlock Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; byte[] tempEncryptedBlock; //Encrypt any number of blocks of any size tempEncryptedBlock = salsa.EncryptBlock(part1); tempEncryptedBlock = salsa.EncryptBlock(part2);

Decrypt Notes

Decrypt will decrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to the 256 bit (32 byte) value originally used to encrypt the data. IV must be set to the original IV value used to encrypt the data.

If using a password, KeyPassword must be set to the same KeyPassword used when encrypting the data. This will automatically generate both Key and IV when Decrypt is called.

During decryption the Progress event will fire as data is decrypted.

Decrypt Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; salsa.InputMessageB = new byte[] { 0x06, 0xF4, 0xD9, 0xB4, 0x67, 0x31, 0x1C, 0x1E, 0x8E, 0xD6, 0xB5, 0x6B }; salsa.Decrypt(); Console.WriteLine(salsa.OutputMessage); //outputs "hello salsa!"

Decrypt Block Notes

DecryptBlock will decrypt the input data and return the decrypted block. The decrypted block will always be the same length as the encrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to decrypt.

DecryptBlock Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; byte[] tempDecryptedBlock; //Decrypt any number of blocks of any size tempDecryptedBlock = salsa.DecryptBlock(part1); tempDecryptedBlock = salsa.DecryptBlock(part2);

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

The Salsa20 algorithm.

Syntax

• Swift
• Objective-C

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

public enum Salsa20Algorithms: Int32 {
  case saSALSA20 = 0
  case saXSALSA20 = 1
}

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

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

Default Value

1

Remarks

This property specifies the Salsa implementation to use. Possible values are:

• 0 (Salsa20)
• 1 (XSalsa20 - default)

The XSalsa20 algorithm is recommended and generally to be considered more secure. The Salsa20 algorithm is fully supported for implementations that require this. In addition the reduced 12 and 8 round variants of Salsa20 are also supported, please see SalsaRounds for details.

InputFile Property (Salsa20 Module)

The file to process.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

InputMessage Property (Salsa20 Module)

The message to process.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=inputMessage,setter=setInputMessage:) NSString* inputMessage;

- (NSString*)inputMessage;
- (void)setInputMessage :(NSString*)newInputMessage;

@property (nonatomic,readwrite,assign,getter=inputMessageB,setter=setInputMessageB:) NSData* inputMessageB;

- (NSData*)inputMessageB;
- (void)setInputMessageB :(NSData*)newInputMessage;

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

IV Property (Salsa20 Module)

The initialization vector (IV).

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=IV,setter=setIV:) NSString* IV;

- (NSString*)IV;
- (void)setIV :(NSString*)newIV;

@property (nonatomic,readwrite,assign,getter=IVB,setter=setIVB:) NSData* IVB;

- (NSData*)IVB;
- (void)setIVB :(NSData*)newIV;

Default Value

""

Remarks

This property specifies the initialization vector (IV). This is also referred to as the nonce. By default this property is empty and the class will automatically generate a new IV value if KeyPassword or Key is set before Encrypt or EncryptBlock is called.

XSalsa Notes:

When Algorithm is set to XSalsa the length of the IV must be 192 bits in length (24 bytes).

Salsa Notes:

When Algorithm is set to Salsa the length of the IV must be 64 bits in length (8 bytes).

Key Property (Salsa20 Module)

The secret key for the symmetric algorithm.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=key,setter=setKey:) NSString* key;

- (NSString*)key;
- (void)setKey :(NSString*)newKey;

@property (nonatomic,readwrite,assign,getter=keyB,setter=setKeyB:) NSData* keyB;

- (NSData*)keyB;
- (void)setKeyB :(NSData*)newKey;

Default Value

""

Remarks

This secret key is used both for encryption and decryption. The secret key should be known only to the sender and the receiver. This key must be 256 bits in length (32 bytes).

If this property is left empty and KeyPassword is specified, a Key value will be generated by the class as necessary.

KeyPassword Property (Salsa20 Module)

A password to generate the Key and IV .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=keyPassword,setter=setKeyPassword:) NSString* keyPassword;

- (NSString*)keyPassword;
- (void)setKeyPassword :(NSString*)newKeyPassword;

Default Value

""

Remarks

When this property is set the class will calculate values for Key and IV using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

OutputFile Property (Salsa20 Module)

The output file when encrypting or decrypting.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

OutputMessage Property (Salsa20 Module)

The output message after processing.

Syntax

• Swift
• Objective-C

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

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

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

- (NSString*)outputMessage;

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

- (NSData*)outputMessageB;

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only.

Overwrite Property (Salsa20 Module)

Indicates whether or not the module should overwrite files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

UseHex Property (Salsa20 Module)

Whether input or output is hex encoded.

Syntax

• Swift
• Objective-C

public var useHex: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useHex,setter=setUseHex:) BOOL useHex;

- (BOOL)useHex;
- (void)setUseHex :(BOOL)newUseHex;

Default Value

False

Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when Encrypt is called the class will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the class will expect InputMessage or InputFile to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

Config Method (Salsa20 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.

Decrypt Method (Salsa20 Module)

Decrypts the data.

Syntax

• Swift
• Objective-C

public func decrypt() throws -> Void

- (void)decrypt;

Remarks

Decrypt will decrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to the 256 bit (32 byte) value originally used to encrypt the data. IV must be set to the original IV value used to encrypt the data.

If using a password, KeyPassword must be set to the same KeyPassword used when encrypting the data. This will automatically generate both Key and IV when Decrypt is called.

During decryption the Progress event will fire as data is decrypted.

Decrypt Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; salsa.InputMessageB = new byte[] { 0x06, 0xF4, 0xD9, 0xB4, 0x67, 0x31, 0x1C, 0x1E, 0x8E, 0xD6, 0xB5, 0x6B }; salsa.Decrypt(); Console.WriteLine(salsa.OutputMessage); //outputs "hello salsa!"

DecryptBlock Method (Salsa20 Module)

Decrypts a block and returns the decrypted data.

Syntax

• Swift
• Objective-C

public func decryptBlock(inputBuffer: Data) throws -> Data

- (NSData*)decryptBlock:(NSData*)inputBuffer;

Remarks

DecryptBlock will decrypt the input data and return the decrypted block. The decrypted block will always be the same length as the encrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to decrypt.

DecryptBlock Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; byte[] tempDecryptedBlock; //Decrypt any number of blocks of any size tempDecryptedBlock = salsa.DecryptBlock(part1); tempDecryptedBlock = salsa.DecryptBlock(part2);

Encrypt Method (Salsa20 Module)

Encrypts the data.

Syntax

• Swift
• Objective-C

public func encrypt() throws -> Void

- (void)encrypt;

Remarks

Encrypt will encrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If KeyPassword is set both Key and IV will be automatically generated when Encrypt is called.

The IV must be set to a 192 bit (24 byte) value when Algorithm is set to XSalsa. The IV must be set to a 64 bit (8 byte) value when Algorithm is set to Salsa.

If IV is not set a value will automatically be generated by the class when Encrypt is called.

During encryption the Progress event will fire as data is encrypted.

Encrypt Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; salsa.InputMessage = "hello salsa!"; salsa.Encrypt(); //salsa.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes. // { 0x06, 0xF4, 0xD9, 0xB4, 0x67, 0x31, 0x1C, 0x1E, 0x8E, 0xD6, 0xB5, 0x6B }

EncryptBlock Method (Salsa20 Module)

Encrypts data and returns the encrypted block.

Syntax

• Swift
• Objective-C

public func encryptBlock(inputBuffer: Data) throws -> Data

- (NSData*)encryptBlock:(NSData*)inputBuffer;

Remarks

EncryptBlock will encrypt the input data and return the encrypted block. The encrypted block will always be the same length as the decrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to encrypt.

EncryptBlock Example

Salsa20 salsa = new Salsa20(); //32 Bytes salsa.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; //24 Bytes salsa.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7, 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; byte[] tempEncryptedBlock; //Encrypt any number of blocks of any size tempEncryptedBlock = salsa.EncryptBlock(part1); tempEncryptedBlock = salsa.EncryptBlock(part2);

Reset Method (Salsa20 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 (Salsa20 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.

Progress Event (Salsa20 Module)

Fired as progress is made.

Syntax

• Swift
• Objective-C

func onProgress(bytesProcessed: Int64, percentProcessed: Int32)

- (void)onProgress:(long long)bytesProcessed :(int)percentProcessed;

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Config Settings (Salsa20 Module)

XSalsa20 Config Settings

Base Config Settings

Trappable Errors (Salsa20 Module)

XSalsa20 Errors