# Twofish Component Encrypt and decrypt data with Twofish, successor to the Blowfish symmetric key block cipher. ## Syntax ```text nsoftware.IPWorksEncrypt.Twofish ``` ## Remarks The Twofish component is used to encrypt and decrypt data with Twofish, successor to the Blowfish symmetric key block cipher. To begin simply specify the data you wish to encrypt or decrypt. **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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). Before encrypting you must have a valid [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component). There are a few options available to you in regards to key management. The easiest option is to simply set [KeyPassword](#keypassword-property-twofish-component). When [KeyPassword](#keypassword-property-twofish-component) is set the component will automatically create a [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) using the PKCS5 password digest algorithm. This means there is only one value you need to keep track of. If you wish to have more control over the [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) values you may specify the properties yourself. If [IV](#iv-property-twofish-component) is left empty, one will be created for you when you call [Encrypt](#encrypt-method-twofish-component) or [Decrypt](#decrypt-method-twofish-component). A simple example: ```text Component.InputFile = "C:\MyFile.txt"; Component.OutputFile = "C:\Encrypted.txt"; Component.KeyPassword = "password"; Component.Encrypt(); ``` ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CipherMode](#ciphermode-property-twofish-component) | The cipher mode of operation. | | [InputFile](#inputfile-property-twofish-component) | The file to process. | | [InputMessage](#inputmessage-property-twofish-component) | The message to process. | | [IV](#iv-property-twofish-component) | The initialization vector (IV). | | [Key](#key-property-twofish-component) | The secret key for the symmetric algorithm. | | [KeyPassword](#keypassword-property-twofish-component) | A password to generate the [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) . | | [OutputFile](#outputfile-property-twofish-component) | The output file when encrypting or decrypting. | | [OutputMessage](#outputmessage-property-twofish-component) | The output message after processing. | | [Overwrite](#overwrite-property-twofish-component) | Indicates whether or not the component should overwrite files. | | [PaddingMode](#paddingmode-property-twofish-component) | The padding mode. | | [UseHex](#usehex-property-twofish-component) | Whether input or output is hex encoded. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-twofish-component) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-twofish-component) | Decrypts the data. | | [DecryptBlock](#decryptblock-method-twofish-component) | Decrypts a block and returns the decrypted data. | | [Encrypt](#encrypt-method-twofish-component) | Encrypts the data. | | [EncryptBlock](#encryptblock-method-twofish-component) | Encrypts data and returns the encrypted block. | | [Reset](#reset-method-twofish-component) | Resets the component. | | [SetInputStream](#setinputstream-method-twofish-component) | Sets the stream from which the component will read data to encrypt or decrypt. | | [SetOutputStream](#setoutputstream-method-twofish-component) | Sets the stream to which the component will write encrypted or decrypted data. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-twofish-component) | Fired when information is available about errors during data delivery. | | [Progress](#progress-event-twofish-component) | Fired as progress is made. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BlockSize](#BlockSize) | The block size, in bits, of the cryptographic operation. | | [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. | | [KeySize](#KeySize) | The size, in bits, of secret key for the symmetric algorithm. | | [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. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # CipherMode Property ([Twofish](#twofish-component) Component) The cipher mode of operation. ## Syntax ```text public TwofishCipherModes CipherMode { get; set; } enum TwofishCipherModes { cmCBC, cmECB, cmOFB, cmCFB, cmCTS, cm8OFB, cm8CFB } ``` ## Default Value 0 ## Remarks The cipher mode of operation. Possible values are: | | | | --- | --- | | 0 (cmCBC - default) | The Cipher Block Chaining (CBC) is a mode of operation for a block cipher, one in which a sequence of bits is encrypted as a single unit or block with a cipher key applied to the entire block. | | 1 (cmECB) | The Electronic Codebook (ECB) mode encrypts each block separately. Important: It is not recommend to use this model when encrypting more than one block because it may introduce security risks. | | 2 (cmOFB) | The Output Feedback (n-bit, NOFB) mode makes a block cipher into a synchronous stream cipher. It has some similarities to CFB mode in that it permits encryption of differing block sizes, but has the key difference that the output of the encryption block function is the feedback (instead of the ciphertext). | | 3 (cmCFB) | The Cipher Feedback (CFB) mode processes a small amount of incremental text into ciphertext, rather than processing a whole block at one time. | | 4 (cmCTS) | The Cipher Text Stealing (CTS) mode handles any length of plain text and produces cipher text whose length matches the plain text length. This mode behaves like the CBC mode for all but the last two blocks of the plain text. | | 5 (cm8OFB) | 8-bit Output Feedback (OFB) cipher mode. | | 7 (cm8CFB) | 8-bit Cipher Feedback (CFB) cipher mode. | # InputFile Property ([Twofish](#twofish-component) Component) The file to process. ## Syntax ```text public string InputFile { get; set; } ``` ## 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 component 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-twofish-component) - InputFile - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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 ([Twofish](#twofish-component) Component) The message to process. ## Syntax ```text public string InputMessage { get; set; } public byte[] InputMessageB { get; set; } ``` ## Default Value "" ## Remarks This property specifies the message to be processed. **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - 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-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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 ([Twofish](#twofish-component) Component) The initialization vector (IV). ## Syntax ```text public string IV { get; set; } public byte[] IVB { get; set; } ``` ## Default Value "" ## Remarks This property specifies the initialization vector (IV). By default this property is empty and the component will automatically generate a new IV value if [KeyPassword](#keypassword-property-twofish-component) or [Key](#key-property-twofish-component) is set before [Encrypt](#encrypt-method-twofish-component) or [EncryptBlock](#encryptblock-method-twofish-component) is called. The size of the IV property must be equal to the [BlockSize](#BlockSize) divided by 8. # Key Property ([Twofish](#twofish-component) Component) The secret key for the symmetric algorithm. ## Syntax ```text public string Key { get; set; } public byte[] KeyB { get; set; } ``` ## 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. The legal key size varies depending on the algorithm. If this property is left empty and [KeyPassword](#keypassword-property-twofish-component) is specified, a Key value will be generated by the component as necessary. **Legal Key and Block Sizes (in bits)** | | | | | | | | | | | | | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | | AES | Rijndael | CAST | DES | IDEA | RC2 | RC4 | TripleDES | Blowfish | Twofish | TEA | | Minimum Key Size | 128 | 128 | 112 | 64 | 128 | 112 | 112 | 128 | 112 | 128 | 128 | | Maximum Key Size | 256 | 256 | 128 | 64 | 128 | 128 | 2048 | 192 | 448 | 256 | 128 | | Key Size Step | 64 | 64 | 8 | 0 | 0 | 8 | 8 | 64 | 1 | 8 | 0 | | Block Size | 128 | 128/192/256 | 64 | 64 | 64 | 64 | N/A | 64 | 64 | 128 | 64* | Note: When using TEA if Algorithm is set to XXTEA valid block sizes are *64 + n * 32*. Where n is any positive integer. The default [KeySize](#KeySize) is the Maximum Key Size. # KeyPassword Property ([Twofish](#twofish-component) Component) A password to generate the [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) . ## Syntax ```text public string KeyPassword { get; set; } ``` ## Default Value "" ## Remarks When this property is set the component will calculate values for [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component) values directly. The size of the [Key](#key-property-twofish-component) generated is dependent on the value of [KeySize](#KeySize). # OutputFile Property ([Twofish](#twofish-component) Component) The output file when encrypting or decrypting. ## Syntax ```text public string OutputFile { get; set; } ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written when [Encrypt](#encrypt-method-twofish-component) or [Decrypt](#decrypt-method-twofish-component) is called. This may be set to an absolute or relative path. This property is only applicable to [Encrypt](#encrypt-method-twofish-component) and [Decrypt](#decrypt-method-twofish-component). **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - OutputFile - [OutputMessage](#outputmessage-property-twofish-component): 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 ([Twofish](#twofish-component) Component) The output message after processing. ## Syntax ```text public string OutputMessage { get; } public byte[] OutputMessageB { get; } ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#outputfile-property-twofish-component) and [SetOutputStream](#setoutputstream-method-twofish-component) are not set. **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - 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 ([Twofish](#twofish-component) Component) Indicates whether or not the component should overwrite files. ## Syntax ```text public bool Overwrite { get; set; } ``` ## Default Value False ## Remarks This property indicates whether or not the component will overwrite [OutputFile](#outputfile-property-twofish-component). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-twofish-component) exists before an operation. The default value is False. # PaddingMode Property ([Twofish](#twofish-component) Component) The padding mode. ## Syntax ```text public TwofishPaddingModes PaddingMode { get; set; } enum TwofishPaddingModes { pmPKCS7, pmZeros, pmNone, pmANSIX923, pmISO10126 } ``` ## Default Value 0 ## Remarks PaddingMode is used to pad the final input block to guarantee that it is the correct size required for the selected [CipherMode](#ciphermode-property-twofish-component). If the input size is a multiple of the cipher's [BlockSize](#BlockSize), an extra block of padding will be appended to the input. This enables the decrypting agent to know with certainty how many bytes of padding are included. Each mode pads the data differently. Possible values are: | | | | --- | --- | | 0 (pmPKCS7 - default) | The data is padded with a series of bytes that are each equal to the number of bytes used. For instance, in the example below the data must be padded with 3 additional bytes, so each byte value will be 3. Raw Data: AA AA AA AA AA PKCS7 Padded Data: AA AA AA AA AA 03 03 03 | | 1 (pmZeros) | The data is padded with null bytes. | | 2 (pmNone) | No padding will be performed. | | 3 (pmANSIX923) | The ANSIX923 padding string consists of a sequence of bytes filled with zeros before the length. For instance, in the example below the data must be padded with 3 additional bytes, so last byte value will be 3. Raw Data: AA AA AA AA AA ANSIX923 padding Data: AA AA AA AA AA 00 00 03 | | 4 (pmISO10126) | The ISO10126 padding string consists of random data before the length. For instance, in the example below the data must be padded with 3 additional bytes, so last byte value will be 3. Raw Data: AA AA AA AA AA ISO10126 padding Data: AA AA AA AA AA F8 EF 03 | When calling [Decrypt](#decrypt-method-twofish-component) the PaddingMode must match the value used when the data was encrypted. Note: When using a value of 2 (pmNone), unless the length of input is an exact multiple of the cipher's input [BlockSize](#BlockSize), the final block of plaintext may be lost. # UseHex Property ([Twofish](#twofish-component) Component) Whether input or output is hex encoded. ## Syntax ```text public bool UseHex { get; set; } ``` ## Default Value False ## Remarks This property specifies whether the encrypted data is hex encoded. If set to True, when [Encrypt](#encrypt-method-twofish-component) is called the component will perform the encryption as normal and then hex encode the output. [OutputMessage](#outputmessage-property-twofish-component) or [OutputFile](#outputfile-property-twofish-component) will hold hex encoded data. If set to True, when [Decrypt](#decrypt-method-twofish-component) is called the component will expect [InputMessage](#inputmessage-property-twofish-component) or [InputFile](#inputfile-property-twofish-component) to hold hex encoded data. The component will then hex decode the data and perform decryption as normal. # Config Method ([Twofish](#twofish-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); Async Version public async Task Config(string configurationString); public async Task Config(string configurationString, CancellationToken cancellationToken); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-twofish-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-twofish-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([Twofish](#twofish-component) Component) Decrypts the data. ## Syntax ```text public void Decrypt(); Async Version public async Task Decrypt(); public async Task Decrypt(CancellationToken cancellationToken); ``` ## Remarks This method will decrypt the specified data. The following properties are applicable: - [IV](#iv-property-twofish-component) (required) - [Key](#key-property-twofish-component) (required) - [CipherMode](#ciphermode-property-twofish-component) - [PaddingMode](#paddingmode-property-twofish-component) Note that [CipherMode](#ciphermode-property-twofish-component) must be set to the same value used during encryption or the results may be unexpected. If the [CipherMode](#ciphermode-property-twofish-component) value does not match the value used during encryption the operation may succeed but the decrypted data may not be correct. **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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). # DecryptBlock Method ([Twofish](#twofish-component) Component) Decrypts a block and returns the decrypted data. ## Syntax ```text public byte[] DecryptBlock(byte[] inputBuffer, bool lastBlock); Async Version public async Task DecryptBlock(byte[] inputBuffer, bool lastBlock); public async Task DecryptBlock(byte[] inputBuffer, bool lastBlock, CancellationToken cancellationToken); ``` ## Remarks This method will decrypt the specified block and return the decrypted data. *InputBuffer* specifies the encrypted block to decrypt. *LastBlock* indicates whether the block is the last block. # Encrypt Method ([Twofish](#twofish-component) Component) Encrypts the data. ## Syntax ```text public void Encrypt(); Async Version public async Task Encrypt(); public async Task Encrypt(CancellationToken cancellationToken); ``` ## Remarks This method will encrypt the specified data. The following properties are applicable: - [IV](#iv-property-twofish-component) (required) - [Key](#key-property-twofish-component) (required) - [PaddingMode](#paddingmode-property-twofish-component) - [CipherMode](#ciphermode-property-twofish-component) **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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). # EncryptBlock Method ([Twofish](#twofish-component) Component) Encrypts data and returns the encrypted block. ## Syntax ```text public byte[] EncryptBlock(byte[] inputBuffer, bool lastBlock); Async Version public async Task EncryptBlock(byte[] inputBuffer, bool lastBlock); public async Task EncryptBlock(byte[] inputBuffer, bool lastBlock, CancellationToken cancellationToken); ``` ## Remarks This method will encrypt the input data and return the encrypted block. *InputBuffer* specifies the input data to encrypt. *LastBlock* specifies whether the block is the last block. # Reset Method ([Twofish](#twofish-component) Component) Resets the component. ## Syntax ```text public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken); ``` ## Remarks When called, the component will reset all of its properties to their default values. # SetInputStream Method ([Twofish](#twofish-component) Component) Sets the stream from which the component will read data to encrypt or decrypt. ## Syntax ```text public void SetInputStream(System.IO.Stream inputStream); Async Version public async Task SetInputStream(System.IO.Stream inputStream); public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken); ``` ## Remarks This method sets the stream from which the component will read data to encrypt or decrypt. **Input and Output Properties** The component 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-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-twofish-component) - [OutputFile](#outputfile-property-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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 ([Twofish](#twofish-component) Component) Sets the stream to which the component will write encrypted or decrypted data. ## Syntax ```text public void SetOutputStream(System.IO.Stream outputStream); Async Version public async Task SetOutputStream(System.IO.Stream outputStream); public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken); ``` ## Remarks This method sets the stream to which the component will write encrypted or decrypted data. **Input and Output Properties** The component 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-twofish-component) - [InputFile](#inputfile-property-twofish-component) - [InputMessage](#inputmessage-property-twofish-component) 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-twofish-component) - [OutputMessage](#outputmessage-property-twofish-component): 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 ([Twofish](#twofish-component) Component) Fired when information is available about errors during data delivery. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, TwofishErrorEventArgs e); public class TwofishErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component 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-twofish-component) section. # Progress Event ([Twofish](#twofish-component) Component) Fired as progress is made. ## Syntax ```text public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, TwofishProgressEventArgs e); public class TwofishProgressEventArgs : EventArgs { public long BytesProcessed { get; } public int PercentProcessed { get; } } ``` ## Remarks This event is fired automatically as data is processed by the component. The *PercentProcessed* parameter indicates the current status of the operation. The *BytesProcessed* parameter holds the total number of bytes processed so far. # Config Settings ([Twofish](#twofish-component) Component) The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-twofish-component) method. ### Twofish Config Settings **BlockSize**: The block size, in bits, of the cryptographic operation.The block size is a basic data unit in the operation of encrypt or decrypt. Messages longer than the block size are seen as successive blocks. If the message is shorter than the block size, the message will be padded with extra bits to reach the block size according to [PaddingMode](#paddingmode-property-twofish-component). Different symmetric algorithm has different valid block sizes. The following algorithms have a fixed block size: AES, CAST, DES, IDEA, RC2, TripleDES, Blowfish, and Twofish. **CloseInputStreamAfterProcessing**: Determines whether or not the input stream is closed after processing.Determines whether or not the input stream set by [SetInputStream](#setinputstream-method-twofish-component) 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-twofish-component) 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-twofish-component) is called the component will perform the encryption as normal and then encode the output as specified here. [OutputMessage](#outputmessage-property-twofish-component) or [OutputFile](#outputfile-property-twofish-component) will hold the encoded data. When [Decrypt](#decrypt-method-twofish-component) is called the component will expect [InputMessage](#inputmessage-property-twofish-component) or [InputFile](#inputfile-property-twofish-component) to hold the encoded data as specified here. The component 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-twofish-component). When calling [Decrypt](#decrypt-method-twofish-component) 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-twofish-component) and [IV](#iv-property-twofish-component) from [KeyPassword](#keypassword-property-twofish-component). 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-twofish-component) to calculate values for [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component). 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-twofish-component) when calculating values for [Key](#key-property-twofish-component) and [IV](#iv-property-twofish-component). **KeySize**: The size, in bits, of secret key for the symmetric algorithm.The legal key sizes vary depending on the algorithm. The [KeySize](#KeySize) and [BlockSize](#BlockSize) configuration settings may be set to specify the key and block size (in bits). This setting is only applicable when [KeyPassword](#keypassword-property-twofish-component) is specified. Note that when using the EzCrypt component, KeySize should be set after setting the Algorithm property. ### 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 component 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 component 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 component 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*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component 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. 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 components 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: This setting is applicable only on Windows. 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 component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*. Setting this configuration setting to *true* tells the component 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. NOTE: This setting is static. The value set is applicable to all components used in the application. When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file. # Trappable Errors ([Twofish](#twofish-component) Component) ### Twofish 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. |