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
| DecryptWithCryptoAPI:
Whether to use the Crypto API for decrypt operations. This setting determines whether to use the Microsoft Crypto API to decrypt. This is helpful in cases where the certificate is present in the Windows Certificate Store but the private key is not marked as exportable. For instance when using a USB security key. The default value is False. Note: This functionality is only available on Windows. | |||||||||
| 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. | |||||||||
| 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:
| |||||||||
| OAEPMGF1HashAlgorithm:
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 "SHA256". Possible values are:
| |||||||||
| 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. | |||||||||
| OAEPRSAHashAlgorithm:
The RSA hash algorithm used with OAEP. This setting specifies thet RSA Hash Algorithm used when UseOAEP is set to True. The default value is "SHA256". Possible values are:
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 message content. Possible values are:
| |||||||||
| OAEPRSAHashAlgorithm:
The RSA hash algorithm used with OAEP. This setting specifies thet RSA Hash Algorithm used when UseOAEP is set to True. The default value is "SHA256". Possible values are:
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 message content. Possible values are:
| |||||||||
| 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
| BuildInfo:
Information about the product's build. When queried, this setting will return a string containing information about the product's build. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers:
The following is a list of valid code page identifiers for Mac OS only:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation. By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API. |