SMIME 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.SMIME Configuration Settings
| ApplyB64Encoding: Instructs the component to base64 encode the message when signing or encrypting.This setting allows you to control the base64 encoding of the resulting message. By default,
this value is true, and the message will be base64 encoded when signing or encrypting.
NOTE: When signing, this config may only be used when DetachedSignature is false. | |
| CSP: The Cryptographic Service Provider.For the Win32 editions, the name of the Cryptographic Service Provider used to provide
access to encryption/decryption and signature operations.
NOTE: This config may only be used when the UseCryptoAPI is true. | |
| GenerateSignatureTimestamp: Whether to generate timestamps in signatures.
For the Java and .NET Editions, if GenerateSignatureTimestamp is True,
a timestamp will be generated and added to all signatures created by the component.
The default value is True. | |
| IncludeHeaders: Tells the component whether to include the headers when encoding the message.If true, the component will include the headers when Sign, Encrypt,
or SignAndEncrypt are called. If false, only the message will be
encoded.
The default value for IncludeHeaders is false. | |
| IncludeInternalHeaders: Tells the component whether or not to include the internal headers when encoding the message.If true, the component will include the internal message part headers when
Sign, Encrypt, or SignAndEncrypt are called. When set to false,
only the message will be encoded.
The default value for IncludeInternalHeaders is true. | |
| ParseInternalHeaders: Tells the component whether or not to parse the message part headers when decrypting a message.If true, the component will parse the internal message part headers when Decrypt,
or DecryptAndVerifySignature are called. These headers will be placed in the
InternalHeaders property. If false, the entire message will be decoded.
The default value for ParseInternalHeaders is true. | |
| RecipientCert: Used to specify the public certificate when using a PEM key to decrypt.When decrypting, the component must search through the Recipient Info collection to find
which encrypted key to use for decryption. Since PEM keys do not contain a serial number
or any additional information about the key itself, the public key associated with this
private key must be supplied.
This configuration may be set to the entire blob of the public certificate the component should use to select the correct recipient encrypted key to use for decryption. | |
| RecipientCertFile: Used to specify the public certificate file when using a PEM key to decrypt.When decrypting, the component must search through the Recipient Info collection to find
which encrypted key to use for decryption. Since PEM keys do not contain a serial number
or any additional information about the key itself, the public key associated with this
private key must be supplied.
This configuration may be set to the file which contains the public certificate the component should use to select the correct recipient encrypted key to use for decryption. | |
| UseCryptoAPI: Whether to use the Microsoft Crypto API for cryptographic message generation.
If UseCryptoAPI is set to true, the component will use the Microsoft Crypto API
to process encrypted and/or signed data. Note that compression will be impossible in this
case.
If set to false (the default), the component will use its internal S/MIME engine. | |
| UseOAEP: Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA.Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA. By default this value is False and the component will use PKCS1. |
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. |