# Salsa20 Class The Salsa20 class can be used to encrypt and decrypt data with the XSalsa20 and Salsa20 algorithm. ## Syntax ```text ipworksencrypt.Salsa20 ``` ## Remarks The class implements XSalsa20 as well as Salsa20. The [Algorithm](#algorithm-property-salsa20-class) 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-class) and [Decrypt](#decrypt-method-salsa20-class) or chunk by chunk by calling [EncryptBlock](#encryptblock-method-salsa20-class) and [DecryptBlock](#decryptblock-method-salsa20-class). In all operations a [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) must be used. If [IV](#iv-property-salsa20-class) is not set one is automatically generated. [KeyPassword](#keypassword-property-salsa20-class) may be set in order to automatically generate both a [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) when a method is called. The same [KeyPassword](#keypassword-property-salsa20-class), or [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) pair are used on both sides of the operation data can be encrypted and decrypted. ## Encrypt Notes [Encrypt](#encrypt-method-salsa20-class) will encrypt the specified data. The following properties are applicable: - [IV](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Additional Notes** The [Key](#key-property-salsa20-class) property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If [KeyPassword](#keypassword-property-salsa20-class) is set both [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) will be automatically generated when [Encrypt](#encrypt-method-salsa20-class) is called. The [IV](#iv-property-salsa20-class) must be set to a 192 bit (24 byte) value when [Algorithm](#algorithm-property-salsa20-class) is set to XSalsa. The [IV](#iv-property-salsa20-class) must be set to a 64 bit (8 byte) value when [Algorithm](#algorithm-property-salsa20-class) is set to Salsa. If [IV](#iv-property-salsa20-class) is not set a value will automatically be generated by the class when [Encrypt](#encrypt-method-salsa20-class) is called. During encryption the [Progress](#progress-event-salsa20-class) 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](#encryptblock-method-salsa20-class) 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-class) (required) - [Key](#key-property-salsa20-class) (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-class) will decrypt the specified data. The following properties are applicable: - [IV](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Additional Notes** The [Key](#key-property-salsa20-class) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [IV](#iv-property-salsa20-class) must be set to the original IV value used to encrypt the data. If using a password, [KeyPassword](#keypassword-property-salsa20-class) must be set to the same [KeyPassword](#keypassword-property-salsa20-class) used when encrypting the data. This will automatically generate both [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) when [Decrypt](#decrypt-method-salsa20-class) is called. During decryption the [Progress](#progress-event-salsa20-class) 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](#decryptblock-method-salsa20-class) 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-class) (required) - [Key](#key-property-salsa20-class) (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](#algorithm-property-salsa20-class) | The Salsa20 algorithm. | | [InputFile](#inputfile-property-salsa20-class) | The file to process. | | [InputMessage](#inputmessage-property-salsa20-class) | The message to process. | | [IV](#iv-property-salsa20-class) | The initialization vector (IV). | | [Key](#key-property-salsa20-class) | The secret key for the symmetric algorithm. | | [KeyPassword](#keypassword-property-salsa20-class) | A password to generate the Key and IV . | | [OutputFile](#outputfile-property-salsa20-class) | The output file when encrypting or decrypting. | | [OutputMessage](#outputmessage-property-salsa20-class) | The output message after processing. | | [Overwrite](#overwrite-property-salsa20-class) | Indicates whether or not the class should overwrite files. | | [UseHex](#usehex-property-salsa20-class) | 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](#config-method-salsa20-class) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-salsa20-class) | Decrypts the data. | | [DecryptBlock](#decryptblock-method-salsa20-class) | Decrypts a block and returns the decrypted data. | | [Encrypt](#encrypt-method-salsa20-class) | Encrypts the data. | | [EncryptBlock](#encryptblock-method-salsa20-class) | Encrypts data and returns the encrypted block. | | [Reset](#reset-method-salsa20-class) | Resets the class. | | [SetInputStream](#setinputstream-method-salsa20-class) | Sets the stream from which the class will read data to encrypt or decrypt. | | [SetOutputStream](#setoutputstream-method-salsa20-class) | 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](#error-event-salsa20-class) | Fired when information is available about errors during data delivery. | | [Progress](#progress-event-salsa20-class) | 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.* | | | | --- | --- | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Determines whether or not the input stream is closed after processing. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Determines whether or not the output stream is closed after processing. | | [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. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # Algorithm Property ([Salsa20](#salsa20-class) Class) The Salsa20 algorithm. ## Syntax ```text public int getAlgorithm(); public void setAlgorithm(int algorithm); Enumerated values: public final static int saSALSA20 = 0; public final static int saXSALSA20 = 1; ``` ## 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. # InputFile Property ([Salsa20](#salsa20-class) Class) The file to process. ## Syntax ```text public String getInputFile(); public void setInputFile(String inputFile); ``` ## 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: - [SetInputStream](#setinputstream-method-salsa20-class) - InputFile - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # InputMessage Property ([Salsa20](#salsa20-class) Class) The message to process. ## Syntax ```text public byte[] getInputMessage(); public void setInputMessage(byte[] inputMessage); ``` ## 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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # IV Property ([Salsa20](#salsa20-class) Class) The initialization vector (IV). ## Syntax ```text public byte[] getIV(); public void setIV(byte[] IV); ``` ## 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](#keypassword-property-salsa20-class) or [Key](#key-property-salsa20-class) is set before [Encrypt](#encrypt-method-salsa20-class) or [EncryptBlock](#encryptblock-method-salsa20-class) 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](#salsa20-class) Class) The secret key for the symmetric algorithm. ## Syntax ```text public byte[] getKey(); public void setKey(byte[] key); ``` ## 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](#keypassword-property-salsa20-class) is specified, a Key value will be generated by the class as necessary. # KeyPassword Property ([Salsa20](#salsa20-class) Class) A password to generate the Key and IV . ## Syntax ```text public String getKeyPassword(); public void setKeyPassword(String keyPassword); ``` ## Default Value "" ## Remarks When this property is set the class will calculate values for [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) values directly. # OutputFile Property ([Salsa20](#salsa20-class) Class) The output file when encrypting or decrypting. ## Syntax ```text public String getOutputFile(); public void setOutputFile(String outputFile); ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written when [Encrypt](#encrypt-method-salsa20-class) or [Decrypt](#decrypt-method-salsa20-class) is called. This may be set to an absolute or relative path. This property is only applicable to [Encrypt](#encrypt-method-salsa20-class) and [Decrypt](#decrypt-method-salsa20-class). **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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - OutputFile - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # OutputMessage Property ([Salsa20](#salsa20-class) Class) The output message after processing. ## Syntax ```text public byte[] getOutputMessage(); ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#outputfile-property-salsa20-class) and [SetOutputStream](#setoutputstream-method-salsa20-class) are 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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - OutputMessage: The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). This property is read-only and not available at design time. # Overwrite Property ([Salsa20](#salsa20-class) Class) Indicates whether or not the class should overwrite files. ## Syntax ```text public boolean isOverwrite(); public void setOverwrite(boolean overwrite); ``` ## Default Value False ## Remarks This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-salsa20-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-salsa20-class) exists before an operation. The default value is False. # UseHex Property ([Salsa20](#salsa20-class) Class) Whether input or output is hex encoded. ## Syntax ```text public boolean isUseHex(); public void setUseHex(boolean useHex); ``` ## Default Value False ## Remarks This property specifies whether the encrypted data is hex encoded. If set to True, when [Encrypt](#encrypt-method-salsa20-class) is called the class will perform the encryption as normal and then hex encode the output. [OutputMessage](#outputmessage-property-salsa20-class) or [OutputFile](#outputfile-property-salsa20-class) will hold hex encoded data. If set to True, when [Decrypt](#decrypt-method-salsa20-class) is called the class will expect [InputMessage](#inputmessage-property-salsa20-class) or [InputFile](#inputfile-property-salsa20-class) to hold hex encoded data. The class will then hex decode the data and perform decryption as normal. # Config Method ([Salsa20](#salsa20-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-salsa20-class) 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-salsa20-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([Salsa20](#salsa20-class) Class) Decrypts the data. ## Syntax ```text public void decrypt(); ``` ## Remarks Decrypt will decrypt the specified data. The following properties are applicable: - [IV](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Additional Notes** The [Key](#key-property-salsa20-class) property must be set to the 256 bit (32 byte) value originally used to encrypt the data. [IV](#iv-property-salsa20-class) must be set to the original IV value used to encrypt the data. If using a password, [KeyPassword](#keypassword-property-salsa20-class) must be set to the same [KeyPassword](#keypassword-property-salsa20-class) used when encrypting the data. This will automatically generate both [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) when Decrypt is called. During decryption the [Progress](#progress-event-salsa20-class) 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!" ``` # DecryptBlock Method ([Salsa20](#salsa20-class) Class) Decrypts a block and returns the decrypted data. ## Syntax ```text public byte[] decryptBlock(byte[] 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](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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](#salsa20-class) Class) Encrypts the data. ## Syntax ```text public void encrypt(); ``` ## Remarks Encrypt will encrypt the specified data. The following properties are applicable: - [IV](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Additional Notes** The [Key](#key-property-salsa20-class) property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If [KeyPassword](#keypassword-property-salsa20-class) is set both [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class) will be automatically generated when Encrypt is called. The [IV](#iv-property-salsa20-class) must be set to a 192 bit (24 byte) value when [Algorithm](#algorithm-property-salsa20-class) is set to XSalsa. The [IV](#iv-property-salsa20-class) must be set to a 64 bit (8 byte) value when [Algorithm](#algorithm-property-salsa20-class) is set to Salsa. If [IV](#iv-property-salsa20-class) is not set a value will automatically be generated by the class when Encrypt is called. During encryption the [Progress](#progress-event-salsa20-class) 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 } ``` # EncryptBlock Method ([Salsa20](#salsa20-class) Class) Encrypts data and returns the encrypted block. ## Syntax ```text public byte[] encryptBlock(byte[] 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](#iv-property-salsa20-class) (required) - [Key](#key-property-salsa20-class) (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](#salsa20-class) Class) Resets the class. ## Syntax ```text public void reset(); ``` ## Remarks When called, the class will reset all of its properties to their default values. # SetInputStream Method ([Salsa20](#salsa20-class) Class) Sets the stream from which the class will read data to encrypt or decrypt. ## Syntax ```text public void setInputStream(java.io.InputStream inputStream); ``` ## 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: - SetInputStream - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-salsa20-class) - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # SetOutputStream Method ([Salsa20](#salsa20-class) Class) Sets the stream to which the class will write encrypted or decrypted data. ## Syntax ```text public void setOutputStream(java.io.OutputStream outputStream); ``` ## 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: - [SetInputStream](#setinputstream-method-salsa20-class) - [InputFile](#inputfile-property-salsa20-class) - [InputMessage](#inputmessage-property-salsa20-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - SetOutputStream - [OutputFile](#outputfile-property-salsa20-class) - [OutputMessage](#outputmessage-property-salsa20-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # Error Event ([Salsa20](#salsa20-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultSalsa20EventListener implements Salsa20EventListener { ... public void error(Salsa20ErrorEvent e) {} ... } public class Salsa20ErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. 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-salsa20-class) section. # Progress Event ([Salsa20](#salsa20-class) Class) Fired as progress is made. ## Syntax ```text public class DefaultSalsa20EventListener implements Salsa20EventListener { ... public void progress(Salsa20ProgressEvent e) {} ... } public class Salsa20ProgressEvent { public long bytesProcessed; public 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](#salsa20-class) 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](#config-method-salsa20-class) method. ### XSalsa20 Config Settings **CloseInputStreamAfterProcessing**: Determines whether or not the input stream is closed after processing.Determines whether or not the input stream set by [SetInputStream](#setinputstream-method-salsa20-class) is closed after processing is complete. The default value is True. **CloseOutputStreamAfterProcessing**: Determines whether or not the output stream is closed after processing.Determines whether or not the output stream set by [SetOutputStream](#setoutputstream-method-salsa20-class) is closed after processing is complete. The default value is True. **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-class) is called the class will perform the encryption as normal and then encode the output as specified here. [OutputMessage](#outputmessage-property-salsa20-class) or [OutputFile](#outputfile-property-salsa20-class) will hold the encoded data. When [Decrypt](#decrypt-method-salsa20-class) is called the class will expect [InputMessage](#inputmessage-property-salsa20-class) or [InputFile](#inputfile-property-salsa20-class) 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](#encrypt-method-salsa20-class). When calling [Decrypt](#decrypt-method-salsa20-class) 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-class) and [IV](#iv-property-salsa20-class) from [KeyPassword](#keypassword-property-salsa20-class). 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](#keypassword-property-salsa20-class) to calculate values for [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class). 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](#keypassword-property-salsa20-class) when calculating values for [Key](#key-property-salsa20-class) and [IV](#iv-property-salsa20-class). **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](#algorithm-property-salsa20-class) 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. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **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*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; ``` The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); ``` When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation. To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider; ``` The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); ``` NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **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. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # Trappable Errors ([Salsa20](#salsa20-class) 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](#algorithm-property-salsa20-class) is set to Salsa must be 8, 12, or 20. |