RC4 Control
Properties Methods Events Config Settings Errors
Encrypt and decrypt data with the RC4 (ARC4 / ARCFOUR ) stream cipher.
Syntax
RC4
Remarks
The RC4 component is used to encrypt and decrypt data with the RC4 (ARC4 / ARCFOUR ) stream cipher.
To begin simply specify the data you wish to encrypt or decrypt.
Input and Output Properties
The control 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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Before encrypting you must have a valid Key and IV. There are a few options available to you in regards to key management. The easiest option is to simply set KeyPassword. When KeyPassword is set the component will automatically create a Key and IV 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 and IV values you may specify the properties yourself. If IV is left empty, one will be created for you when you call Encrypt or Decrypt.
A simple example:
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 control with short descriptions. Click on the links for further details.
| InputFile | The file to process. |
| InputMessage | The message to process. |
| IV | The initialization vector (IV). |
| Key | The secret key for the symmetric algorithm. |
| KeyPassword | A password to generate the Key and IV . |
| OutputFile | The output file when encrypting or decrypting. |
| OutputMessage | The output message after processing. |
| Overwrite | Indicates whether or not the control should overwrite files. |
| UseHex | Whether input or output is hex encoded. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Decrypt | Decrypts the data. |
| DecryptBlock | Decrypts a block and returns the decrypted data. |
| Encrypt | Encrypts the data. |
| EncryptBlock | Encrypts data and returns the encrypted block. |
| Reset | Resets the control. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Progress | Fired as progress is made. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| KeySize | The size, in bits, of secret key for the symmetric algorithm. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |
InputFile Property (RC4 Control)
The file to process.
Syntax
rc4control.InputFile[=string]
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 control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
InputMessage Property (RC4 Control)
The message to process.
Syntax
rc4control.InputMessage[=string]
Default Value
""
Remarks
This property specifies the message to be processed.
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputMessageB.
Data Type
Binary String
IV Property (RC4 Control)
The initialization vector (IV).
Syntax
rc4control.IV[=string]
Default Value
""
Remarks
This property specifies the initialization vector (IV). By default this property is empty and the control will automatically generate a new IV value if KeyPassword or Key is set before Encrypt or EncryptBlock is called. The size of the IV property must be equal to the BlockSize divided by 8.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .IVB.
Data Type
Binary String
Key Property (RC4 Control)
The secret key for the symmetric algorithm.
Syntax
rc4control.Key[=string]
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 is specified, a Key value will be generated by the control 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 is the Maximum Key Size.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyB.
Data Type
Binary String
KeyPassword Property (RC4 Control)
A password to generate the Key and IV .
Syntax
rc4control.KeyPassword[=string]
Default Value
""
Remarks
When this property is set the control will calculate values for Key and IV using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
The size of the Key generated is dependent on the value of KeySize.
Data Type
String
OutputFile Property (RC4 Control)
The output file when encrypting or decrypting.
Syntax
rc4control.OutputFile[=string]
Default Value
""
Remarks
This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.
This property is only applicable to Encrypt and Decrypt.
Input and Output Properties
The control 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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
OutputMessage Property (RC4 Control)
The output message after processing.
Syntax
rc4control.OutputMessage
Default Value
""
Remarks
This property will be populated with the output from the operation if OutputFile is not set.
Input and Output Properties
The control 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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputMessageB.
This property is read-only and not available at design time.
Data Type
Binary String
Overwrite Property (RC4 Control)
Indicates whether or not the control should overwrite files.
Syntax
rc4control.Overwrite[=boolean]
Default Value
False
Remarks
This property indicates whether or not the control will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
Boolean
UseHex Property (RC4 Control)
Whether input or output is hex encoded.
Syntax
rc4control.UseHex[=boolean]
Default Value
False
Remarks
This property specifies whether the encrypted data is hex encoded.
If set to True, when Encrypt is called the control will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.
If set to True, when Decrypt is called the control will expect InputMessage or InputFile to hold hex encoded data. The control will then hex decode the data and perform decryption as normal.
Data Type
Boolean
Config Method (RC4 Control)
Sets or retrieves a configuration setting.
Syntax
rc4control.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (RC4 Control)
Decrypts the data.
Syntax
rc4control.Decrypt
Remarks
This method will decrypt the specified data. The following properties are applicable:
Note that CipherMode must be set to the same value used during encryption or the results may be unexpected. If the CipherMode 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 control 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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
DecryptBlock Method (RC4 Control)
Decrypts a block and returns the decrypted data.
Syntax
rc4control.DecryptBlock InputBuffer
Remarks
This method decrypted the data specified by InputBuffer and returns the decrypted data.
Encrypt Method (RC4 Control)
Encrypts the data.
Syntax
rc4control.Encrypt
Remarks
This method will encrypt the specified data. The following properties are applicable:
Input and Output Properties
The control 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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
EncryptBlock Method (RC4 Control)
Encrypts data and returns the encrypted block.
Syntax
rc4control.EncryptBlock InputBuffer
Remarks
This method encrypts the data specified by InputBuffer and returns the encrypted block.
Reset Method (RC4 Control)
Resets the control.
Syntax
rc4control.Reset
Remarks
When called, the control will reset all of its properties to their default values.
Error Event (RC4 Control)
Information about errors during data delivery.
Syntax
Sub rc4control_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Progress Event (RC4 Control)
Fired as progress is made.
Syntax
Sub rc4control_Progress(BytesProcessed As Long64, PercentProcessed As Integer)
Remarks
This event is fired automatically as data is processed by the control.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
Config Settings (RC4 Control)
The control 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 control, access to these internal properties is provided through the Config method.RC4 Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KeySize:
The size, in bits, of secret key for the symmetric algorithm.The legal key sizes vary depending on the algorithm. The KeySize and BlockSize
configuration settings may be set to specify the key and block size (in bits).
This setting is only applicable when KeyPassword is specified. Note that when using the EzCrypt control, KeySize should be set after setting the Algorithm property. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
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 to mask sensitive data. The default is .
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the control whether or not to use the system security libraries or an internal implementation.
When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the control to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms. |
Trappable Errors (RC4 Control)
RC4 Errors
| 20102 Unsupported algorithm. | |
| 20103 No Key specified. | |
| 20104 No IV specified. | |
| 20105 Cannot read or write file. | |
| 20108 Block size is not valid for this algorithm. | |
| 20109 Key size is not valid for this algorithm. | |
| 20112 OutputFile already exists and Overwrite is False. | |
| 20122 The specified key is invalid. | |
| 20124 IV size is not valid for this algorithm. | |
| 20305 Cannot write file. | |
| 20306 Cannot read file. | |
| 20307 Cannot create file. | |
| 22005 Invalid padding. This may be an indication that the key is incorrect. |