# Salsa20 Class

The Salsa20 class 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](#salsa20algorithm-property) 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](#salsa20encrypt-method) and [Decrypt](#salsa20decrypt-method) or chunk by chunk by calling [EncryptBlock](#salsa20encryptblock-method) and [DecryptBlock](#salsa20decryptblock-method).

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

## Encrypt Notes

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

- [IV](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [Key](#salsa20key-property) property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If [KeyPassword](#salsa20keypassword-property) is set both [Key](#salsa20key-property) and [IV](#salsa20iv-property) will be automatically generated when [Encrypt](#salsa20encrypt-method) is called.

The [IV](#salsa20iv-property) must be set to a 192 bit (24 byte) value when [Algorithm](#salsa20algorithm-property) is set to XSalsa. The [IV](#salsa20iv-property) must be set to a 64 bit (8 byte) value when [Algorithm](#salsa20algorithm-property) is set to Salsa.

If [IV](#salsa20iv-property) is not set a value will automatically be generated by the class when [Encrypt](#salsa20encrypt-method) is called.

During encryption the [Progress](#salsa20progress-event) 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

[EncryptBlock](#salsa20encryptblock-method) 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](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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](#salsa20decrypt-method) will decrypt the specified data. The following properties are applicable:

- [IV](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [Key](#salsa20key-property) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [IV](#salsa20iv-property) must be set to the original IV value used to encrypt the data.

If using a password, [KeyPassword](#salsa20keypassword-property) must be set to the same [KeyPassword](#salsa20keypassword-property) used when encrypting the data. This will automatically generate both [Key](#salsa20key-property) and [IV](#salsa20iv-property) when [Decrypt](#salsa20decrypt-method) is called.

During decryption the [Progress](#salsa20progress-event) 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

[DecryptBlock](#salsa20decryptblock-method) 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](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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);
```

## Property List

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

|  |  |
| --- | --- |
| [Algorithm](#salsa20algorithm-property) | The Salsa20 algorithm. |
| [InputFile](#salsa20inputfile-property) | The file to process. |
| [InputMessage](#salsa20inputmessage-property) | The message to process. |
| [IV](#salsa20iv-property) | The initialization vector (IV). |
| [Key](#salsa20key-property) | The secret key for the symmetric algorithm. |
| [KeyPassword](#salsa20keypassword-property) | A password to generate the Key and IV . |
| [OutputFile](#salsa20outputfile-property) | The output file when encrypting or decrypting. |
| [OutputMessage](#salsa20outputmessage-property) | The output message after processing. |
| [Overwrite](#salsa20overwrite-property) | Indicates whether or not the class should overwrite files. |
| [UseHex](#salsa20usehex-property) | Whether input or output is hex encoded. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#salsa20config-method) | Sets or retrieves a configuration setting. |
| [Decrypt](#salsa20decrypt-method) | Decrypts the data. |
| [DecryptBlock](#salsa20decryptblock-method) | Decrypts a block and returns the decrypted data. |
| [Encrypt](#salsa20encrypt-method) | Encrypts the data. |
| [EncryptBlock](#salsa20encryptblock-method) | Encrypts data and returns the encrypted block. |
| [Reset](#salsa20reset-method) | Resets the class. |
| [SetInputStream](#salsa20setinputstream-method) | Sets the stream from which the class will read data to encrypt or decrypt. |
| [SetOutputStream](#salsa20setoutputstream-method) | Sets the stream to which the class will write encrypted or decrypted data. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#salsa20error-event) | Fired when information is available about errors during data delivery. |
| [Progress](#salsa20progress-event) | Fired as progress is made. |

## Config Settings

*The following is a list of config settings for the class 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. |

# [Salsa20](#salsa20-class).Algorithm Property

The Salsa20 algorithm.

## Syntax

```text
getAlgorithm(): Salsa20Algorithms;
setAlgorithm(algorithm: Salsa20Algorithms): void;
enum Salsa20Algorithms {
  saSALSA20,
  saXSALSA20
}
```

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

# [Salsa20](#salsa20-class).InputFile Property

The file to process.

## Syntax

```text
getInputFile(): string;
setInputFile(inputFile: string): void;
```

## 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](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

# [Salsa20](#salsa20-class).InputMessage Property

The message to process.

## Syntax

```text
getInputMessage(): Uint8Array;
setInputMessage(inputMessage: Uint8Array): void;
```

## 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](#salsa20inputfile-property)
- InputMessage

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

# [Salsa20](#salsa20-class).IV Property

The initialization vector (IV).

## Syntax

```text
getIV(): Uint8Array;
setIV(IV: Uint8Array): void;
```

## 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](#salsa20keypassword-property) or [Key](#salsa20key-property) is set before [Encrypt](#salsa20encrypt-method) or [EncryptBlock](#salsa20encryptblock-method) 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).

# [Salsa20](#salsa20-class).Key Property

The secret key for the symmetric algorithm.

## Syntax

```text
getKey(): Uint8Array;
setKey(key: Uint8Array): void;
```

## 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](#salsa20keypassword-property) is specified, a Key value will be generated by the class as necessary.

# [Salsa20](#salsa20-class).KeyPassword Property

A password to generate the Key and IV .

## Syntax

```text
getKeyPassword(): string;
setKeyPassword(keyPassword: string): void;
```

## Default Value

""

## Remarks

When this property is set the class will calculate values for [Key](#salsa20key-property) and [IV](#salsa20iv-property) using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing [Key](#salsa20key-property) and [IV](#salsa20iv-property) values directly.

# [Salsa20](#salsa20-class).OutputFile Property

The output file when encrypting or decrypting.

## Syntax

```text
getOutputFile(): string;
setOutputFile(outputFile: string): void;
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when [Encrypt](#salsa20encrypt-method) or [Decrypt](#salsa20decrypt-method) is called. This may be set to an absolute or relative path.

This property is only applicable to [Encrypt](#salsa20encrypt-method) and [Decrypt](#salsa20decrypt-method).

**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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- OutputFile
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

# [Salsa20](#salsa20-class).OutputMessage Property

The output message after processing.

## Syntax

```text
getOutputMessage(): Uint8Array;
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [OutputFile](#salsa20outputfile-property) 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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only and not available at design time.

# [Salsa20](#salsa20-class).Overwrite Property

Indicates whether or not the class should overwrite files.

## Syntax

```text
isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;
```

## Default Value

FALSE

## Remarks

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

# [Salsa20](#salsa20-class).UseHex Property

Whether input or output is hex encoded.

## Syntax

```text
isUseHex(): boolean;
setUseHex(useHex: boolean): void;
```

## Default Value

FALSE

## Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when [Encrypt](#salsa20encrypt-method) is called the class will perform the encryption as normal and then hex encode the output. [OutputMessage](#salsa20outputmessage-property) or [OutputFile](#salsa20outputfile-property) will hold hex encoded data.

If set to True, when [Decrypt](#salsa20decrypt-method) is called the class will expect [InputMessage](#salsa20inputmessage-property) or [InputFile](#salsa20inputfile-property) to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

# [Salsa20](#salsa20-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async salsa20.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksencryptsalsa20) 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](#config-settings-class-ipworksencryptsalsa20), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [Salsa20](#salsa20-class).decrypt Method

Decrypts the data.

## Syntax

```text
async salsa20.decrypt(): Promise< void>
```

## Remarks

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

- [IV](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

**Additional Notes**

The [Key](#salsa20key-property) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [IV](#salsa20iv-property) must be set to the original IV value used to encrypt the data.

If using a password, [KeyPassword](#salsa20keypassword-property) must be set to the same [KeyPassword](#salsa20keypassword-property) used when encrypting the data. This will automatically generate both [Key](#salsa20key-property) and [IV](#salsa20iv-property) when Decrypt is called.

During decryption the [Progress](#salsa20progress-event) 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!"
```

# [Salsa20](#salsa20-class).decryptBlock Method

Decrypts a block and returns the decrypted data.

## Syntax

```text
async salsa20.decryptBlock(inputBuffer : Uint8ArraylpSize: number = 0): Promise< Uint8Array>
```

## 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](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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);
```

# [Salsa20](#salsa20-class).encrypt Method

Encrypts the data.

## Syntax

```text
async salsa20.encrypt(): Promise< void>
```

## Remarks

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

- [IV](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

**Additional Notes**

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

The [IV](#salsa20iv-property) must be set to a 192 bit (24 byte) value when [Algorithm](#salsa20algorithm-property) is set to XSalsa. The [IV](#salsa20iv-property) must be set to a 64 bit (8 byte) value when [Algorithm](#salsa20algorithm-property) is set to Salsa.

If [IV](#salsa20iv-property) is not set a value will automatically be generated by the class when Encrypt is called.

During encryption the [Progress](#salsa20progress-event) 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 }
```

# [Salsa20](#salsa20-class).encryptBlock Method

Encrypts data and returns the encrypted block.

## Syntax

```text
async salsa20.encryptBlock(inputBuffer : Uint8ArraylpSize: number = 0): Promise< Uint8Array>
```

## 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](#salsa20iv-property) (required)
- [Key](#salsa20key-property) (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);
```

# [Salsa20](#salsa20-class).reset Method

Resets the class.

## Syntax

```text
async salsa20.reset(): Promise< void>
```

## Remarks

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

# [Salsa20](#salsa20-class).setInputStream Method

Sets the stream from which the class will read data to encrypt or decrypt.

## Syntax

```text
async salsa20.setInputStream(inputStream : ReadableStream): Promise< void>
```

## Remarks

This method sets the stream from which the class will read data to encrypt or 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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

# [Salsa20](#salsa20-class).setOutputStream Method

Sets the stream to which the class will write encrypted or decrypted data.

## Syntax

```text
async salsa20.setOutputStream(outputStream : WriteableStream): Promise< void>
```

## Remarks

This method sets the stream to which the class will write encrypted or decrypted data.

**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](#salsa20inputfile-property)
- [InputMessage](#salsa20inputmessage-property)

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

- [OutputFile](#salsa20outputfile-property)
- [OutputMessage](#salsa20outputmessage-property): The output data is written to this property if no other destination is specified.

# [Salsa20](#salsa20-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
salsa20.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## 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](#trappable-errors-class-ipworksencryptsalsa20) section.

# [Salsa20](#salsa20-class).Progress Event

Fired as progress is made.

## Syntax

```text
salsa20.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )
```

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

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The Salsa20 class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the Salsa20 class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The Salsa20 class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the Salsa20 class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworksencrypt.[salsa20](#salsa20-class))

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#salsa20config-method) 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](#salsa20encrypt-method) is called the class will perform the encryption as normal and then encode the output as specified here. [OutputMessage](#salsa20outputmessage-property) or [OutputFile](#salsa20outputfile-property) will hold the encoded data.

When [Decrypt](#salsa20decrypt-method) is called the class will expect [InputMessage](#salsa20inputmessage-property) or [InputFile](#salsa20inputfile-property) to hold the encoded data as specified here. The class 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](#salsa20encrypt-method). When calling [Decrypt](#salsa20decrypt-method) 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](#salsa20key-property) and [IV](#salsa20iv-property) from [KeyPassword](#salsa20keypassword-property). 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 [KeyPassword](#salsa20keypassword-property) to calculate values for [Key](#salsa20key-property) and [IV](#salsa20iv-property). 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 [KeyPassword](#salsa20keypassword-property) when calculating values for [Key](#salsa20key-property) and [IV](#salsa20iv-property).

**SalsaRounds**: The number of rounds to perform.This setting specifies the number of rounds to perform. The default value is 20. The class also supports 12 and 8 round variants which offer better performance but reduce overall security. This setting is only applicable when [Algorithm](#salsa20algorithm-property) 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 class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**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 class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class 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 (*class *ipworksencrypt.[salsa20](#salsa20-class))

### 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](#salsa20algorithm-property) is set to Salsa must be 8, 12, or 20. |