# Struct ipworksencrypt::Salsa20

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

## Syntax

```text
ipworksencrypt::Salsa20
```

## Remarks

The struct implements XSalsa20 as well as Salsa20. The [algorithm](#algorithm-property-salsa20-struct) 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](#encrypt-method-salsa20-struct) and [decrypt](#decrypt-method-salsa20-struct) or chunk by chunk by calling [encrypt_block](#encrypt_block-method-salsa20-struct) and [decrypt_block](#decrypt_block-method-salsa20-struct).

In all operations a [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) must be used. If [iv](#iv-property-salsa20-struct) is not set one is automatically generated. [key_password](#key_password-property-salsa20-struct) may be set in order to automatically generate both a [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) when a method is called. The same [key_password](#key_password-property-salsa20-struct), or [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) pair are used on both sides of the operation data can be encrypted and decrypted.

## Encrypt Notes

[encrypt](#encrypt-method-salsa20-struct) will encrypt the specified data. The following properties are applicable:

- [iv](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [key](#key-property-salsa20-struct) property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If [key_password](#key_password-property-salsa20-struct) is set both [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) will be automatically generated when [encrypt](#encrypt-method-salsa20-struct) is called.

The [iv](#iv-property-salsa20-struct) must be set to a 192 bit (24 byte) value when [algorithm](#algorithm-property-salsa20-struct) is set to XSalsa. The [iv](#iv-property-salsa20-struct) must be set to a 64 bit (8 byte) value when [algorithm](#algorithm-property-salsa20-struct) is set to Salsa.

If [iv](#iv-property-salsa20-struct) is not set a value will automatically be generated by the struct when [encrypt](#encrypt-method-salsa20-struct) is called.

During encryption the [on_progress](#on_progress-event-salsa20-struct) event will fire as data is encrypted.

**Encrypt Example**

```csharp
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

[encrypt_block](#encrypt_block-method-salsa20-struct) 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](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

*InputBuffer* specifies the input data to encrypt.

**EncryptBlock Example**

```csharp
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](#decrypt-method-salsa20-struct) will decrypt the specified data. The following properties are applicable:

- [iv](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [key](#key-property-salsa20-struct) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [iv](#iv-property-salsa20-struct) must be set to the original IV value used to encrypt the data.

If using a password, [key_password](#key_password-property-salsa20-struct) must be set to the same [key_password](#key_password-property-salsa20-struct) used when encrypting the data. This will automatically generate both [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) when [decrypt](#decrypt-method-salsa20-struct) is called.

During decryption the [on_progress](#on_progress-event-salsa20-struct) event will fire as data is decrypted.

**Decrypt Example**

```csharp
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

[decrypt_block](#decrypt_block-method-salsa20-struct) 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](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

*InputBuffer* specifies the input data to decrypt.

**DecryptBlock Example**

```csharp
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);
```

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the Salsa20 struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of Salsa20 when you have finished using the instance.

## Property List

*The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [algorithm](#algorithm-property-salsa20-struct) | The Salsa20 algorithm. |
| [input_file](#input_file-property-salsa20-struct) | The file to process. |
| [input_message](#input_message-property-salsa20-struct) | The message to process. |
| [iv](#iv-property-salsa20-struct) | The initialization vector (IV). |
| [key](#key-property-salsa20-struct) | The secret key for the symmetric algorithm. |
| [key_password](#key_password-property-salsa20-struct) | A password to generate the Key and IV . |
| [output_file](#output_file-property-salsa20-struct) | The output file when encrypting or decrypting. |
| [output_message](#output_message-property-salsa20-struct) | The output message after processing. |
| [overwrite](#overwrite-property-salsa20-struct) | Indicates whether or not the struct should overwrite files. |
| [use_hex](#use_hex-property-salsa20-struct) | Whether input or output is hex encoded. |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method-salsa20-struct) | Sets or retrieves a configuration setting. |
| [decrypt](#decrypt-method-salsa20-struct) | Decrypts the data. |
| [decrypt_block](#decrypt_block-method-salsa20-struct) | Decrypts a block and returns the decrypted data. |
| [encrypt](#encrypt-method-salsa20-struct) | Encrypts the data. |
| [encrypt_block](#encrypt_block-method-salsa20-struct) | Encrypts data and returns the encrypted block. |
| [reset](#reset-method-salsa20-struct) | Resets the struct. |

## Event List

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

|  |  |
| --- | --- |
| [on_error](#on_error-event-salsa20-struct) | Fired when information is available about errors during data delivery. |
| [on_progress](#on_progress-event-salsa20-struct) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [EncryptedDataEncoding](#EncryptedDataEncoding) | The encoding of the encrypted input or output data. |
| [IncludeIV](#IncludeIV) | Whether to prepend the IV to the output data and read the IV from the input data. |
| [KeyPasswordAlgorithm](#KeyPasswordAlgorithm) | The hash algorithm used to derive the Key and IV from the KeyPassword property. |
| [KeyPasswordIterations](#KeyPasswordIterations) | The number of iterations performed when using KeyPassword to derive the Key and IV. |
| [KeyPasswordSalt](#KeyPasswordSalt) | The salt value used in conjunction with the KeyPassword to derive the Key and IV. |
| [SalsaRounds](#SalsaRounds) | The number of rounds to perform. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# algorithm property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The Salsa20 algorithm.

## Syntax

*Rust Syntax*

```text
fn algorithm(&self ) -> Result<i32, IPWorksEncryptError> fn set_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError>
```

## Possible Values

```text
0   // SALSA201   // XSALSA20
```

## 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](#SalsaRounds) for details.

## Data Type

i32

# input_file property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The file to process.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, IPWorksEncryptError> fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## 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 struct 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:

- input_file
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# input_message property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The message to process.

## Syntax

*Rust Syntax*

```text
fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_input_message(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_input_message_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- input_message

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

## Data Type

Vec

# iv property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The initialization vector (IV).

## Syntax

*Rust Syntax*

```text
fn iv(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_iv(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_iv_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## 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 struct will automatically generate a new iv value if [key_password](#key_password-property-salsa20-struct) or [key](#key-property-salsa20-struct) is set before [encrypt](#encrypt-method-salsa20-struct) or [encrypt_block](#encrypt_block-method-salsa20-struct) 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).

## Data Type

Vec

# key property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The secret key for the symmetric algorithm.

## Syntax

*Rust Syntax*

```text
fn key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## 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 [key_password](#key_password-property-salsa20-struct) is specified, a key value will be generated by the struct as necessary.

## Data Type

Vec

# key_password property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

A password to generate the Key and IV .

## Syntax

*Rust Syntax*

```text
fn key_password(&self ) -> Result<String, IPWorksEncryptError> fn set_key_password(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_key_password_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

When this property is set the struct will calculate values for [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) values directly.

## Data Type

String

# output_file property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The output file when encrypting or decrypting.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, IPWorksEncryptError> fn set_output_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when [encrypt](#encrypt-method-salsa20-struct) or [decrypt](#decrypt-method-salsa20-struct) is called. This may be set to an absolute or relative path.

This property is only applicable to [encrypt](#encrypt-method-salsa20-struct) and [decrypt](#decrypt-method-salsa20-struct).

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- output_file
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# output_message property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

The output message after processing.

## Syntax

*Rust Syntax*

```text
fn output_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [output_file](#output_file-property-salsa20-struct) is not set.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- output_message: The output data is written to this property if no other destination is specified.

This property is read-only.

## Data Type

Vec

# overwrite property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Indicates whether or not the struct should overwrite files.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, IPWorksEncryptError> fn set_overwrite(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

false

## Remarks

This property indicates whether or not the struct will overwrite [output_file](#output_file-property-salsa20-struct). If overwrite is False, an error will be thrown whenever [output_file](#output_file-property-salsa20-struct) exists before an operation. The default value is False.

## Data Type

bool

# use_hex property ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Whether input or output is hex encoded.

## Syntax

*Rust Syntax*

```text
fn use_hex(&self ) -> Result<bool, IPWorksEncryptError> fn set_use_hex(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

false

## Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when [encrypt](#encrypt-method-salsa20-struct) is called the struct will perform the encryption as normal and then hex encode the output. [output_message](#output_message-property-salsa20-struct) or [output_file](#output_file-property-salsa20-struct) will hold hex encoded data.

If set to True, when [decrypt](#decrypt-method-salsa20-struct) is called the struct will expect [input_message](#input_message-property-salsa20-struct) or [input_file](#input_file-property-salsa20-struct) to hold hex encoded data. The struct will then hex decode the data and perform decryption as normal.

## Data Type

bool

# config method ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-salsa20-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-salsa20-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# decrypt method ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Decrypts the data.

## Syntax

*Rust Syntax*

```text
fn decrypt(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

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

- [iv](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [key](#key-property-salsa20-struct) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [iv](#iv-property-salsa20-struct) must be set to the original IV value used to encrypt the data.

If using a password, [key_password](#key_password-property-salsa20-struct) must be set to the same [key_password](#key_password-property-salsa20-struct) used when encrypting the data. This will automatically generate both [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) when decrypt is called.

During decryption the [on_progress](#on_progress-event-salsa20-struct) event will fire as data is decrypted.

**Decrypt Example**

```csharp
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 method ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Decrypts a block and returns the decrypted data.

## Syntax

*Rust Syntax*

```text
fn decrypt_block(&self, input_buffer : &[u8]) ->  Result<Vec<u8>, IPWorksEncryptError>
```

## Remarks

decrypt_block 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](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

*InputBuffer* specifies the input data to decrypt.

**DecryptBlock Example**

```csharp
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](#struct-ipworksencryptsalsa20) Struct)

Encrypts the data.

## Syntax

*Rust Syntax*

```text
fn encrypt(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

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

- [iv](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-salsa20-struct)
- [input_message](#input_message-property-salsa20-struct)

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

- [output_file](#output_file-property-salsa20-struct)
- [output_message](#output_message-property-salsa20-struct): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [key](#key-property-salsa20-struct) property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If [key_password](#key_password-property-salsa20-struct) is set both [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) will be automatically generated when encrypt is called.

The [iv](#iv-property-salsa20-struct) must be set to a 192 bit (24 byte) value when [algorithm](#algorithm-property-salsa20-struct) is set to XSalsa. The [iv](#iv-property-salsa20-struct) must be set to a 64 bit (8 byte) value when [algorithm](#algorithm-property-salsa20-struct) is set to Salsa.

If [iv](#iv-property-salsa20-struct) is not set a value will automatically be generated by the struct when encrypt is called.

During encryption the [on_progress](#on_progress-event-salsa20-struct) event will fire as data is encrypted.

**Encrypt Example**

```csharp
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 method ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Encrypts data and returns the encrypted block.

## Syntax

*Rust Syntax*

```text
fn encrypt_block(&self, input_buffer : &[u8]) ->  Result<Vec<u8>, IPWorksEncryptError>
```

## Remarks

encrypt_block 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](#iv-property-salsa20-struct) (required)
- [key](#key-property-salsa20-struct) (required)

*InputBuffer* specifies the input data to encrypt.

**EncryptBlock Example**

```csharp
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](#struct-ipworksencryptsalsa20) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

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

# on_error event ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// Salsa20ErrorEventArgs carries the Salsa20 Error event's parameters.
pub struct Salsa20ErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// Salsa20ErrorEvent defines the signature of the Salsa20 Error event's handler function.
pub trait Salsa20ErrorEvent {
  fn on_error(&self, sender : Salsa20, e : &mut Salsa20ErrorEventArgs);
}

impl <'a> Salsa20<'a> {
  pub fn on_error(&self) -> &'a dyn Salsa20ErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn Salsa20ErrorEvent);
  ...
}
```

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The *error_code* 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](#trappable-errors-salsa20-struct) section.

# on_progress event ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

Fired as progress is made.

## Syntax

*Rust Syntax*

```text
// Salsa20ProgressEventArgs carries the Salsa20 Progress event's parameters.
pub struct Salsa20ProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// Salsa20ProgressEvent defines the signature of the Salsa20 Progress event's handler function.
pub trait Salsa20ProgressEvent {
  fn on_progress(&self, sender : Salsa20, e : &mut Salsa20ProgressEventArgs);
}

impl <'a> Salsa20<'a> {
  pub fn on_progress(&self) -> &'a dyn Salsa20ProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn Salsa20ProgressEvent);
  ...
}
```

## Remarks

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

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](#struct-ipworksencryptsalsa20) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-salsa20-struct) method.

### XSalsa20 Config Settings

**EncryptedDataEncoding**: The encoding of the encrypted input or output data.This configuration setting specifies how the encrypted data is encoded (if at all).

When [encrypt](#encrypt-method-salsa20-struct) is called the struct will perform the encryption as normal and then encode the output as specified here. [output_message](#output_message-property-salsa20-struct) or [output_file](#output_file-property-salsa20-struct) will hold the encoded data.

When [decrypt](#decrypt-method-salsa20-struct) is called the struct will expect [input_message](#input_message-property-salsa20-struct) or [input_file](#input_file-property-salsa20-struct) to hold the encoded data as specified here. The struct will then decode the data and perform decryption as normal.

Possible values are:

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

**IncludeIV**: Whether to prepend the IV to the output data and read the IV from the input data.If this config is true, the IV will be automatically prepended to the output data when calling [encrypt](#encrypt-method-salsa20-struct). When calling [decrypt](#decrypt-method-salsa20-struct) and this setting is True, the IV is automatically extracted form the ciphertext. The default value is False.

**KeyPasswordAlgorithm**: The hash algorithm used to derive the Key and IV from the KeyPassword property.This configuration setting specifies which hash algorithm will be used when deriving the [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct) from [key_password](#key_password-property-salsa20-struct). The default value is "MD5". Possible values are:

- "SHA1"
- "MD2"
- "MD5" (default)
- "HMAC-SHA1"
- "HMAC-SHA224"
- "HMAC-SHA256"
- "HMAC-SHA384"
- "HMAC-SHA512"
- "HMAC-MD5"
- "HMAC-RIPEMD160"

When using any HMAC algorithm the PBKDF#2 method from RFC 2898 is used. Any other algorithm uses PBKDF#1 from the same RFC.

**KeyPasswordIterations**: The number of iterations performed when using KeyPassword to derive the Key and IV.This configuration setting specifies the number of iterations performed when using [key_password](#key_password-property-salsa20-struct) to calculate values for [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct). When using PBKDF#2 the default number of iterations is 10,000. When using PBKDF#1 the default number is 10.

**KeyPasswordSalt**: The salt value used in conjunction with the KeyPassword to derive the Key and IV.This configuration setting specifies the hex encoded salt value to be used along with the [key_password](#key_password-property-salsa20-struct) when calculating values for [key](#key-property-salsa20-struct) and [iv](#iv-property-salsa20-struct).

**SalsaRounds**: The number of rounds to perform.This setting specifies the number of rounds to perform. The default value is 20. The struct also supports 12 and 8 round variants which offer better performance but reduce overall security. This setting is only applicable when [algorithm](#algorithm-property-salsa20-struct) is set to *saSALSA20*. Possible values are:

- 20 (default - recommended)
- 12
- 8

### 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:

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

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

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct 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.

**MaskSensitiveData**: 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 *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([Salsa20](#struct-ipworksencryptsalsa20) Struct)

### XSalsa20 Errors

|  |  |
| --- | --- |
| 101 | Unsupported algorithm. |
| 102 | No Key specified. |
| 103 | No IV specified. |
| 104 | Cannot read or write file. |
| 107 | Block size is not valid for this algorithm. |
| 108 | Key size is not valid for this algorithm. |
| 111 | OutputFile already exists and Overwrite is False. |
| 121 | The specified key is invalid. |
| 123 | IV size is not valid for this algorithm. |
| 304 | Cannot write file. |
| 305 | Cannot read file. |
| 306 | Cannot create file. |
| 2004 | Invalid padding. This may be an indication that the key is incorrect. |
| 130 | Invalid number of rounds. The number of rounds used when [algorithm](#algorithm-property-salsa20-struct) is set to Salsa must be 8, 12, or 20. |