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.
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. | |
| InputContentTransferEncoding:
Sets the Content-Transfer-Encoding for the signed message.This setting specifies the Content-Transfer-Encoding header value in signed messages. By default the component
will automatically determine the Content-Transfer-Encoding based on the file extension set in InputFile, however
this setting may be set to override the determined value or to specify a value if data is read from InputMessage.
If no value is specified and a value cannot be automatically determined the default value 7bit will be used. Note: This setting is only applicable when calling Sign or SignAndEncrypt and DetachedSignature is True. | |
| InputContentType:
Sets the Content-Type for the signed message.This setting specifies the Content-Type header value in signed messages. By default the component
will automatically determine the Content-Type based on the file extension set in InputFile, however
this setting may be set to override the determined value or to specify a value if data is read from InputMessage.
If no value is specified and a value cannot be automatically determined the default value text/plain; charset="iso-8859-1" will be used. Note: This setting is only applicable when calling Sign or SignAndEncrypt and DetachedSignature is True. | |
| InputMessageEncrypted: Whether or not the input message is encrypted.This will return true if the input message appears to be encrypted according to the value of InputMessageHeaders. | |
| InputMessageSigned: Whether or not the input message is signed.This will return true if the input message appears to be signed according to the value of InputMessageHeaders. | |
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:
| |
| 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. | |
RecipientInfoType:
The type of signer information to include in the signed message.This setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are:
Note: When subjectKeyIdentifier is selected the recipient's encryption certificate must contain the subjectKeyIdentifier extension. | |
SignerInfoType:
The type of signer information to include in the signed message.This setting specifies which type of information about the signer certificate is included in the signed message. Possible values are:
Note: When subjectKeyIdentifier is selected the signing certificate must contain the subjectKeyIdentifier extension. | |
| UseAlgorithmOIDs:
Whether OIDs are used when providing information about the algorithms.This setting controls whether the EncryptionAlgorithm parameter of the RecipientInfo event
is populated with the name of the algorithm such as 3DES or the corresponding OID such as 1.2.840.113549.3.7.
The default value is False and the name of the algorithm is used. Set this to True to use the OIDs instead. | |
| 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. |
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |