XMLEncrypt Configuration
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 method.XMLEnc Configuration Settings
| KeyName: The name of the key used to encrypt the XML.This setting optionally holds the key name which may be useful to the recipient to help identify the key used to
encrypt the data.
This may be set before calling Encrypt.
When calling Decrypt this may be queried inside the EncryptedDataInfo event.
Note that this value is only informative, it does not affect processing. | |||||||||
LogLevel: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the Status event. Possible values are:
| |||||||||
| EncryptedKeyXPath: The XPath of the EncryptedKey element.This setting specifies the XPath where the EncryptedKey element will be written. In most cases this does not need to be changed. By default it is included in the EncryptedData element. | |||||||||
| OAEPParams: The hex encoded OAEP parameters.This setting optionally specifies OAEP parameters to be used when UseOAEP is set to True. The specified value should be hex encoded. | |||||||||
MGF1HashAlgorithm: The MGF1 hash algorithm used with OAEP.This setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is "SHA1". Possible
values are:
| |||||||||
RSAHashAlgorithm: The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key.
This may differ from the hash algorithm used to sign the AS4 message content. Possible values are:
| |||||||||
| UseOAEP: Whether to use Optimal Asymmetric Encryption Padding (OAEP).This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the SymmetricKey
with the certificate specified by RecipientCert. It is only applicable when
calling Encrypt and RecipientCert is specified.
By default this value is False and the component will use PKCS1. | |||||||||
| ReadFromProgressEvent: Whether to read input data from inside the progress event.When set to True this setting allows input data to be specified from within the Progress event. The component will repeatedly fire the Progress event to ask for data. Inside the event set InputXML when the Operation parameter of the event is 1 (Read). When all data has been provided set the IsEOF parameter of the event to True. This allows input data to be chunked and provided piece by piece. The default value is False. | |||||||||
| WriteToProgressEvent: Whether to write output data so it is accessible from inside the progress event.When set to True this setting allows output data to be obtained from within the Progress event. The component will repeatedly fire the Progress event to provide output data. Inside the event check OutputXML when the Operation parameter of the event is 2 (Write). The IsEOF parameter should be checked inside the event to determine when all output data has been provided. This allows output data to be chunked and obtained piece by piece. The default value is False. |
Base Configuration Settings
| GUIAvailable: Tells the component 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 to false will ensure that the component does not attempt to process external events. | |
| UseBackgroundThread: Whether threads created by the component are background threads.If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False. | |
| UseManagedSecurityAPI: Tells the component whether or not to use the system security libraries or a managed implementation.
By default the component will use the system security libraries to perform cryptographic functions. This means
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 to True tells the component to use the internal managed implementation
instead of using the system's security API.
Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file. |