IPWorks Encrypt 2020 ActiveX Edition

Questions / Feedback?

SMIME Configuration

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.

SMIME Configuration Settings

ApplyB64Encoding:   Instructs the control 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 control.

The default value is True.

IncludeHeaders:   Tells the control whether to include the headers when encoding the message.

If true, the control 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 control whether or not to include the internal headers when encoding the message.

If true, the control 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 control 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 control 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:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
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:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
ParseInternalHeaders:   Tells the control whether or not to parse the message part headers when decrypting a message.

If true, the control 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 control 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 control 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 control 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 control 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:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

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:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

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 control 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 control will use its internal S/MIME engine.

Base Configuration 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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multlingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangeul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

UseInternalSecurityAPI:   Tells the control whether or not to use the system security libraries or an internal implementation.

By default the control will use the system security libraries to perform cryptographic functions. Setting this to True tells the control to use the internal implementation instead of using the system's security API.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 ActiveX Edition - Version 20.0 [Build 8155]