SMIME Class
Properties Methods Events Config Settings Errors
The S/MIME class implements the S/MIME standard for encryption and decryption with public key cryptography and X.509 digital certificates.
Syntax
SMIME
Remarks
The S/MIME class implements the S/MIME V3 standard for encryption and decryption using Public Key Cryptography Standards (PKCS). In addition, the class can be used to both generate and verify RSA digital signatures. Using this class for decrypting or signing requires a valid digital certificate with a private key.
Before performing an operation the input and output values should be specified.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Signing
To sign the current data included in the input message with a certificate, the Certificate property must be set to a valid Certificate object for the signing certificate. The IncludeCertificate and DetachedSignature properties allow you to specify additional details about the signing process. By setting IncludeCertificate to True, digital certificates can be encoded and included in message signature when signing the document. Including a certificate is the preferred method of building signed messages. In addition the S/MIME class can also generate PKCS #7 formatted detached digital signatures and envelopes by specifying DetachedSignature.
Encrypting
To encrypt a message with the class in a PKCS envelope, you must first specify the Certificate for each recipient in the RecipientCerts properties to encrypt the message with. You can easily add these with the AddRecipientCert method. Once you have done this you can call the Encrypt method to encrypt the message with the recipient certificates.
In addition, the class allows you to sign and encrypt simultaneously with the SignAndEncrypt method. You must set all of the properties needed for both Sign and Encrypt
The result of the encrypted or signed data will be replaced in the OutputMessage property and the OutputMessageHeaders property will be filled with the appropriate mime headers if applicable.
Decrypting
Decrypting PKCS envelopes is handled with the Decrypt method. When this method is called, the class will attempt to find an appropriate certificate in the Certificate property that matches the encrypting certificate. If it cannot find an appropriate certificate, an exception will be thrown and the message will not be decrypted.
Verifying Signatures
In addition, the S/MIME class can be used to verify signatures included in signed messages or documents. After specifying the input, VerifySignature can then be used to verify the signature. If the message does not have a certificate attached, more then likely an exception will be thrown and the class will not be able to verify the signature. If VerifySignature is successful, the SignerCert and SignerCertChain properties will be filled with the certificate information of the message signer. This information can be used to verify the signing certificates.
Similar to SignAndEncrypt, DecryptAndVerifySignature can be used to both decrypt and verify the message in Message.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CertEncoded | This is the certificate (PEM/Base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
DetachedSignature | This property specifies whether to include a detached signature when signing a message. |
EncryptingAlgorithm | The property includes textual description of the encrypting algorithm. |
IncludeCertificate | This property specifies whether to include the signer's certificate with the signed message. |
IncludeChain | This property specifies whether to include the signer's certificate chain with the signed message. |
IncludeHeaders | This property tells the class whether to include the headers when encoding the message. |
InputFile | This property includes the file to process. |
InputMessage | This property includes the message to process. |
InputMessageHeaderCount | The number of records in the InputMessageHeader arrays. |
InputMessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
InputMessageHeaderValue | This property contains the header contents. |
InputMessageHeadersString | This property includes the string version of headers from the S/MIME message. |
InternalHeaders | This property includes the headers of the MIME entity inside the encrypted or signed message. |
MessageEncrypted | This property specifies whether or not the current message is encrypted. |
MessageSigned | This property specifies whether or not the current message is signed. |
OutputFile | This property specifies the output file. |
OutputMessage | This property includes the output message after processing. |
OutputMessageHeaderCount | The number of records in the OutputMessageHeader arrays. |
OutputMessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
OutputMessageHeaderValue | This property contains the header contents. |
OutputMessageHeadersString | This property includes a string version of headers from the S/MIME message. |
Overwrite | This property indicates whether or not the class should overwrite files. |
RecipientCertCount | The number of records in the RecipientCert arrays. |
RecipientCertEncoded | This is the certificate (PEM/Base64 encoded). |
RecipientCertStore | This is the name of the certificate store for the client certificate. |
RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RecipientCertStoreType | This is the type of certificate store for this certificate. |
RecipientCertSubject | This is the subject of the certificate used for client authentication. |
SignerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SignerCertIssuer | This is the issuer of the certificate. |
SignerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SignerCertStore | This is the name of the certificate store for the client certificate. |
SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SignerCertStoreType | This is the type of certificate store for this certificate. |
SignerCertSubject | This is the subject of the certificate used for client authentication. |
SignerCertChainCount | The number of records in the SignerCertChain arrays. |
SignerCertChainEncoded | This is the certificate (PEM/Base64 encoded). |
SigningAlgorithm | This property includes a textual description of the signature hash algorithm. |
UseOAEP | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). |
UsePSS | This property specifies whether or not RSA-PSS will be used during signing and verification. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddRecipientCert | This method is used to add recipient certificates used to encrypt messages. |
CheckMessageEncrypted | This method checks whether or not the current message is encrypted. |
CheckMessageSigned | This method checks whether or not the current message is signed. |
Config | Sets or retrieves a configuration setting. |
Decrypt | This method decrypts the current Message . |
DecryptAndVerifySignature | This method decrypts and verifies the signature of the current message. |
Encrypt | This method encrypts the message. |
GetRecipientInfo | This method gets the recipient information for an encrypted message. |
GetSignerCertInfo | This method gets the signature information for an signed message. |
Reset | This method resets the class properties. |
Sign | This method signs the current message. |
SignAndEncrypt | This method signs and encrypts the current message. |
VerifySignature | This method verifies the signature of the current message. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
RecipientInfo | This event is fired for each recipient certificate of the encrypted message. |
SignerCertInfo | This event is fired during verification of the signed message. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ApplyB64Encoding | Instructs the class to base64 encode the message when signing or encrypting. |
CSP | The Cryptographic Service Provider. |
GenerateSignatureTimestamp | Whether to generate timestamps in signatures. |
IncludeHeaders | Tells the class whether to include the headers when encoding the message. |
IncludeInternalHeaders | Tells the class whether or not to include the internal headers when encoding the message. |
InputContentTransferEncoding | Sets the Content-Transfer-Encoding for the signed message. |
InputContentType | Sets the Content-Type for the signed message. |
InputMessageEncrypted | Whether or not the input message is encrypted. |
InputMessageSigned | Whether or not the input message is signed. |
NormalizeCRLF | Whether or not the class will normalize line endings of the input data to CrLf. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used with OAEP. |
OAEPParams | The hex encoded OAEP parameters. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used with OAEP. |
ParseInternalHeaders | Tells the class whether or not to parse the message part headers when decrypting a message. |
RecipientCert | Used to specify the public certificate when using a PEM key to decrypt. |
RecipientCertFile | Used to specify the public certificate file when using a PEM key to decrypt. |
RecipientInfoType | The type of signer information to include in the signed message. |
SignerInfoType | The type of signer information to include in the signed message. |
UseAlgorithmOIDs | Whether OIDs are used when providing information about the algorithms. |
UseCryptoAPI | Whether to use the Microsoft Crypto API for cryptographic message generation. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CertEncoded Property (SMIME Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded); Unicode (Windows) INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);
int ipworksencrypt_smime_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_smime_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);
QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
CertStore Property (SMIME Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore); Unicode (Windows) INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);
int ipworksencrypt_smime_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_smime_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);
QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
CertStorePassword Property (SMIME Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword); Unicode (Windows) LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);
char* ipworksencrypt_smime_getcertstorepassword(void* lpObj);
int ipworksencrypt_smime_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);
QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
CertStoreType Property (SMIME Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetCertStoreType();
int SetCertStoreType(int iCertStoreType); Unicode (Windows) INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_smime_getcertstoretype(void* lpObj);
int ipworksencrypt_smime_setcertstoretype(void* lpObj, int iCertStoreType);
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
CertSubject Property (SMIME Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject); Unicode (Windows) LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);
char* ipworksencrypt_smime_getcertsubject(void* lpObj);
int ipworksencrypt_smime_setcertsubject(void* lpObj, const char* lpszCertSubject);
QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
DetachedSignature Property (SMIME Class)
This property specifies whether to include a detached signature when signing a message.
Syntax
ANSI (Cross Platform) int GetDetachedSignature();
int SetDetachedSignature(int bDetachedSignature); Unicode (Windows) BOOL GetDetachedSignature();
INT SetDetachedSignature(BOOL bDetachedSignature);
int ipworksencrypt_smime_getdetachedsignature(void* lpObj);
int ipworksencrypt_smime_setdetachedsignature(void* lpObj, int bDetachedSignature);
bool GetDetachedSignature();
int SetDetachedSignature(bool bDetachedSignature);
Default Value
TRUE
Remarks
This property specifies whether to include a detached signature when signing a message. If the value of this property is True, Message will be encoded as a multipart/signed MIME message with a detached signature when calling Sign. This will create a message with two MIME parts, one with the contents of Message, and another with the detached signature.
If this property is False, the current contents of Message will be PKCS encoded and included with the signature in Message. This will create a single-part message with no MIME boundaries.
Data Type
Boolean
EncryptingAlgorithm Property (SMIME Class)
The property includes textual description of the encrypting algorithm.
Syntax
ANSI (Cross Platform) char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm); Unicode (Windows) LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);
char* ipworksencrypt_smime_getencryptingalgorithm(void* lpObj);
int ipworksencrypt_smime_setencryptingalgorithm(void* lpObj, const char* lpszEncryptingAlgorithm);
QString GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(QString qsEncryptingAlgorithm);
Default Value
"3DES"
Remarks
This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.
Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
Data Type
String
IncludeCertificate Property (SMIME Class)
This property specifies whether to include the signer's certificate with the signed message.
Syntax
ANSI (Cross Platform) int GetIncludeCertificate();
int SetIncludeCertificate(int bIncludeCertificate); Unicode (Windows) BOOL GetIncludeCertificate();
INT SetIncludeCertificate(BOOL bIncludeCertificate);
int ipworksencrypt_smime_getincludecertificate(void* lpObj);
int ipworksencrypt_smime_setincludecertificate(void* lpObj, int bIncludeCertificate);
bool GetIncludeCertificate();
int SetIncludeCertificate(bool bIncludeCertificate);
Default Value
TRUE
Remarks
If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling Sign or SignAndEncrypt.
Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.
Data Type
Boolean
IncludeChain Property (SMIME Class)
This property specifies whether to include the signer's certificate chain with the signed message.
Syntax
ANSI (Cross Platform) int GetIncludeChain();
int SetIncludeChain(int bIncludeChain); Unicode (Windows) BOOL GetIncludeChain();
INT SetIncludeChain(BOOL bIncludeChain);
int ipworksencrypt_smime_getincludechain(void* lpObj);
int ipworksencrypt_smime_setincludechain(void* lpObj, int bIncludeChain);
bool GetIncludeChain();
int SetIncludeChain(bool bIncludeChain);
Default Value
FALSE
Remarks
If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling Sign or SignAndEncrypt.
Note: To include the chain, the IncludeCertificate property must also be set to true.
Data Type
Boolean
IncludeHeaders Property (SMIME Class)
This property tells the class whether to include the headers when encoding the message.
Syntax
ANSI (Cross Platform) int GetIncludeHeaders();
int SetIncludeHeaders(int bIncludeHeaders); Unicode (Windows) BOOL GetIncludeHeaders();
INT SetIncludeHeaders(BOOL bIncludeHeaders);
int ipworksencrypt_smime_getincludeheaders(void* lpObj);
int ipworksencrypt_smime_setincludeheaders(void* lpObj, int bIncludeHeaders);
bool GetIncludeHeaders();
int SetIncludeHeaders(bool bIncludeHeaders);
Default Value
FALSE
Remarks
If True, the class 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.
Data Type
Boolean
InputFile Property (SMIME Class)
This property includes the file to process.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworksencrypt_smime_getinputfile(void* lpObj);
int ipworksencrypt_smime_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.
Encrypt and/or Sign
When encrypting or signing, this may be set to a file containing content that will be encrypted and/or signed.
Decrypt and/or Verify
When decrypting or verifying a signature, this may be set to a file containing the fully encoded S/MIME message.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
Data Type
String
InputMessage Property (SMIME Class)
This property includes the message to process.
Syntax
ANSI (Cross Platform) int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage); Unicode (Windows) INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);
int ipworksencrypt_smime_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_smime_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);
QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);
Default Value
""
Remarks
This property specifies the message to be processed.
Encrypt and/or Sign
When encrypting or signing, this may be set to the content that will be encrypted and/or signed.
Decrypt and/or Verify
When decrypting or verifying a signature, this may be set to the fully encoded S/MIME message.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
Data Type
Binary String
InputMessageHeaderCount Property (SMIME Class)
The number of records in the InputMessageHeader arrays.
Syntax
ANSI (Cross Platform) int GetInputMessageHeaderCount();
int SetInputMessageHeaderCount(int iInputMessageHeaderCount); Unicode (Windows) INT GetInputMessageHeaderCount();
INT SetInputMessageHeaderCount(INT iInputMessageHeaderCount);
int ipworksencrypt_smime_getinputmessageheadercount(void* lpObj);
int ipworksencrypt_smime_setinputmessageheadercount(void* lpObj, int iInputMessageHeaderCount);
int GetInputMessageHeaderCount();
int SetInputMessageHeaderCount(int iInputMessageHeaderCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at InputMessageHeaderCount - 1.
This property is not available at design time.
Data Type
Integer
InputMessageHeaderField Property (SMIME Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
ANSI (Cross Platform) char* GetInputMessageHeaderField(int iInputMessageHeaderIndex);
int SetInputMessageHeaderField(int iInputMessageHeaderIndex, const char* lpszInputMessageHeaderField); Unicode (Windows) LPWSTR GetInputMessageHeaderField(INT iInputMessageHeaderIndex);
INT SetInputMessageHeaderField(INT iInputMessageHeaderIndex, LPCWSTR lpszInputMessageHeaderField);
char* ipworksencrypt_smime_getinputmessageheaderfield(void* lpObj, int inputmessageheaderindex);
int ipworksencrypt_smime_setinputmessageheaderfield(void* lpObj, int inputmessageheaderindex, const char* lpszInputMessageHeaderField);
QString GetInputMessageHeaderField(int iInputMessageHeaderIndex);
int SetInputMessageHeaderField(int iInputMessageHeaderIndex, QString qsInputMessageHeaderField);
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The InputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the InputMessageHeaderCount property.
This property is not available at design time.
Data Type
String
InputMessageHeaderValue Property (SMIME Class)
This property contains the header contents.
Syntax
ANSI (Cross Platform) char* GetInputMessageHeaderValue(int iInputMessageHeaderIndex);
int SetInputMessageHeaderValue(int iInputMessageHeaderIndex, const char* lpszInputMessageHeaderValue); Unicode (Windows) LPWSTR GetInputMessageHeaderValue(INT iInputMessageHeaderIndex);
INT SetInputMessageHeaderValue(INT iInputMessageHeaderIndex, LPCWSTR lpszInputMessageHeaderValue);
char* ipworksencrypt_smime_getinputmessageheadervalue(void* lpObj, int inputmessageheaderindex);
int ipworksencrypt_smime_setinputmessageheadervalue(void* lpObj, int inputmessageheaderindex, const char* lpszInputMessageHeaderValue);
QString GetInputMessageHeaderValue(int iInputMessageHeaderIndex);
int SetInputMessageHeaderValue(int iInputMessageHeaderIndex, QString qsInputMessageHeaderValue);
Default Value
""
Remarks
This property contains the Header contents.
The InputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the InputMessageHeaderCount property.
This property is not available at design time.
Data Type
String
InputMessageHeadersString Property (SMIME Class)
This property includes the string version of headers from the S/MIME message.
Syntax
ANSI (Cross Platform) char* GetInputMessageHeadersString();
int SetInputMessageHeadersString(const char* lpszInputMessageHeadersString); Unicode (Windows) LPWSTR GetInputMessageHeadersString();
INT SetInputMessageHeadersString(LPCWSTR lpszInputMessageHeadersString);
char* ipworksencrypt_smime_getinputmessageheadersstring(void* lpObj);
int ipworksencrypt_smime_setinputmessageheadersstring(void* lpObj, const char* lpszInputMessageHeadersString);
QString GetInputMessageHeadersString();
int SetInputMessageHeadersString(QString qsInputMessageHeadersString);
Default Value
""
Remarks
This property contains the string version of headers from the S/MIME message.
This property may be set to the headers of the message that will be decrypted/verified.
Data Type
String
InternalHeaders Property (SMIME Class)
This property includes the headers of the MIME entity inside the encrypted or signed message.
Syntax
ANSI (Cross Platform) char* GetInternalHeaders();
int SetInternalHeaders(const char* lpszInternalHeaders); Unicode (Windows) LPWSTR GetInternalHeaders();
INT SetInternalHeaders(LPCWSTR lpszInternalHeaders);
char* ipworksencrypt_smime_getinternalheaders(void* lpObj);
int ipworksencrypt_smime_setinternalheaders(void* lpObj, const char* lpszInternalHeaders);
QString GetInternalHeaders();
int SetInternalHeaders(QString qsInternalHeaders);
Default Value
""
Remarks
After an encryption, decryption, signing, or verification operation is completed, this property shows the headers of the encrypted or signed message part.
This property is not available at design time.
Data Type
String
MessageEncrypted Property (SMIME Class)
This property specifies whether or not the current message is encrypted.
Syntax
ANSI (Cross Platform) int GetMessageEncrypted(); Unicode (Windows) BOOL GetMessageEncrypted();
int ipworksencrypt_smime_getmessageencrypted(void* lpObj);
bool GetMessageEncrypted();
Default Value
FALSE
Remarks
This property indicates whether or not the current message is encrypted. This property will return True if the current message appears to be encrypted, according to the value of MessageHeaders.
This property is read-only.
Data Type
Boolean
MessageSigned Property (SMIME Class)
This property specifies whether or not the current message is signed.
Syntax
ANSI (Cross Platform) int GetMessageSigned(); Unicode (Windows) BOOL GetMessageSigned();
int ipworksencrypt_smime_getmessagesigned(void* lpObj);
bool GetMessageSigned();
Default Value
FALSE
Remarks
This property indicates whether or not the current message is signed. This property will return True if the current message appears to be signed, according to the value of MessageHeaders.
Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.
This property is read-only.
Data Type
Boolean
OutputFile Property (SMIME Class)
This property specifies the output file.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworksencrypt_smime_getoutputfile(void* lpObj);
int ipworksencrypt_smime_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
This property specifies the file to which the output will be written. This may be set to an absolute or relative path.
Encrypt and/or Sign
When encrypting or signing, this specifies a file where the fully encoded S/MIME message will be written.
Decrypt and/or Verify
When decrypting or verifying a signature, this specifies a file where the decrypted/verified content will be written.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Data Type
String
OutputMessage Property (SMIME Class)
This property includes the output message after processing.
Syntax
ANSI (Cross Platform) int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage); Unicode (Windows) INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);
int ipworksencrypt_smime_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);
QByteArray GetOutputMessage();
Default Value
""
Remarks
This property will be populated with the output of the operation if OutputFile is not set.
Encrypt and/or Sign
When encrypting or signing, this will hold the fully encoded S/MIME message.
Decrypt and/or Verify
When decrypting or verifying a signature, this will hold the decrypted/verified content.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
This property is read-only.
Data Type
Binary String
OutputMessageHeaderCount Property (SMIME Class)
The number of records in the OutputMessageHeader arrays.
Syntax
ANSI (Cross Platform) int GetOutputMessageHeaderCount(); Unicode (Windows) INT GetOutputMessageHeaderCount();
int ipworksencrypt_smime_getoutputmessageheadercount(void* lpObj);
int GetOutputMessageHeaderCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at OutputMessageHeaderCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
OutputMessageHeaderField Property (SMIME Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
ANSI (Cross Platform) char* GetOutputMessageHeaderField(int iOutputMessageHeaderIndex); Unicode (Windows) LPWSTR GetOutputMessageHeaderField(INT iOutputMessageHeaderIndex);
char* ipworksencrypt_smime_getoutputmessageheaderfield(void* lpObj, int outputmessageheaderindex);
QString GetOutputMessageHeaderField(int iOutputMessageHeaderIndex);
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The OutputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutputMessageHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
OutputMessageHeaderValue Property (SMIME Class)
This property contains the header contents.
Syntax
ANSI (Cross Platform) char* GetOutputMessageHeaderValue(int iOutputMessageHeaderIndex); Unicode (Windows) LPWSTR GetOutputMessageHeaderValue(INT iOutputMessageHeaderIndex);
char* ipworksencrypt_smime_getoutputmessageheadervalue(void* lpObj, int outputmessageheaderindex);
QString GetOutputMessageHeaderValue(int iOutputMessageHeaderIndex);
Default Value
""
Remarks
This property contains the Header contents.
The OutputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutputMessageHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
OutputMessageHeadersString Property (SMIME Class)
This property includes a string version of headers from the S/MIME message.
Syntax
ANSI (Cross Platform) char* GetOutputMessageHeadersString(); Unicode (Windows) LPWSTR GetOutputMessageHeadersString();
char* ipworksencrypt_smime_getoutputmessageheadersstring(void* lpObj);
QString GetOutputMessageHeadersString();
Default Value
""
Remarks
This property contains the string version of headers from the S/MIME message. The class will populate this property after signing and/or encrypting.
The user should use these additional headers when emailing or sending the OutputMessage. This can be done by including these headers in the OtherHeaders property of the class that you wish to send the message with.
After the decryption or verification, this property contains the headers of the verified or decrypted message.
This property is read-only.
Data Type
String
Overwrite Property (SMIME Class)
This property indicates whether or not the class should overwrite files.
Syntax
ANSI (Cross Platform) int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int ipworksencrypt_smime_getoverwrite(void* lpObj);
int ipworksencrypt_smime_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
Default Value
TRUE
Remarks
This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
Boolean
RecipientCertCount Property (SMIME Class)
The number of records in the RecipientCert arrays.
Syntax
ANSI (Cross Platform) int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount); Unicode (Windows) INT GetRecipientCertCount();
INT SetRecipientCertCount(INT iRecipientCertCount);
int ipworksencrypt_smime_getrecipientcertcount(void* lpObj);
int ipworksencrypt_smime_setrecipientcertcount(void* lpObj, int iRecipientCertCount);
int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- RecipientCertEncoded
- RecipientCertStore
- RecipientCertStorePassword
- RecipientCertStoreType
- RecipientCertSubject
The array indices start at 0 and end at RecipientCertCount - 1.
This property is not available at design time.
Data Type
Integer
RecipientCertEncoded Property (SMIME Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetRecipientCertEncoded(int iRecipientCertIndex, char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(int iRecipientCertIndex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded); Unicode (Windows) INT GetRecipientCertEncoded(INT iRecipientCertIndex, LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(INT iRecipientCertIndex, LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);
int ipworksencrypt_smime_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksencrypt_smime_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);
QByteArray GetRecipientCertEncoded(int iRecipientCertIndex);
int SetRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.
When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Binary String
RecipientCertStore Property (SMIME Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetRecipientCertStore(int iRecipientCertIndex, char* &lpRecipientCertStore, int &lenRecipientCertStore);
int SetRecipientCertStore(int iRecipientCertIndex, const char* lpRecipientCertStore, int lenRecipientCertStore); Unicode (Windows) INT GetRecipientCertStore(INT iRecipientCertIndex, LPSTR &lpRecipientCertStore, INT &lenRecipientCertStore);
INT SetRecipientCertStore(INT iRecipientCertIndex, LPCSTR lpRecipientCertStore, INT lenRecipientCertStore);
int ipworksencrypt_smime_getrecipientcertstore(void* lpObj, int recipientcertindex, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksencrypt_smime_setrecipientcertstore(void* lpObj, int recipientcertindex, const char* lpRecipientCertStore, int lenRecipientCertStore);
QByteArray GetRecipientCertStore(int iRecipientCertIndex);
int SetRecipientCertStore(int iRecipientCertIndex, QByteArray qbaRecipientCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Binary String
RecipientCertStorePassword Property (SMIME Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, const char* lpszRecipientCertStorePassword); Unicode (Windows) LPWSTR GetRecipientCertStorePassword(INT iRecipientCertIndex);
INT SetRecipientCertStorePassword(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertStorePassword);
char* ipworksencrypt_smime_getrecipientcertstorepassword(void* lpObj, int recipientcertindex);
int ipworksencrypt_smime_setrecipientcertstorepassword(void* lpObj, int recipientcertindex, const char* lpszRecipientCertStorePassword);
QString GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, QString qsRecipientCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
String
RecipientCertStoreType Property (SMIME Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType); Unicode (Windows) INT GetRecipientCertStoreType(INT iRecipientCertIndex);
INT SetRecipientCertStoreType(INT iRecipientCertIndex, INT iRecipientCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_smime_getrecipientcertstoretype(void* lpObj, int recipientcertindex);
int ipworksencrypt_smime_setrecipientcertstoretype(void* lpObj, int recipientcertindex, int iRecipientCertStoreType);
int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Integer
RecipientCertSubject Property (SMIME Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, const char* lpszRecipientCertSubject); Unicode (Windows) LPWSTR GetRecipientCertSubject(INT iRecipientCertIndex);
INT SetRecipientCertSubject(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertSubject);
char* ipworksencrypt_smime_getrecipientcertsubject(void* lpObj, int recipientcertindex);
int ipworksencrypt_smime_setrecipientcertsubject(void* lpObj, int recipientcertindex, const char* lpszRecipientCertSubject);
QString GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, QString qsRecipientCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
String
SignerCertEncoded Property (SMIME Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded); Unicode (Windows) INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);
int ipworksencrypt_smime_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksencrypt_smime_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);
QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SignerCertIssuer Property (SMIME Class)
This is the issuer of the certificate.
Syntax
ANSI (Cross Platform) char* GetSignerCertIssuer(); Unicode (Windows) LPWSTR GetSignerCertIssuer();
char* ipworksencrypt_smime_getsignercertissuer(void* lpObj);
QString GetSignerCertIssuer();
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SignerCertSerialNumber Property (SMIME Class)
This is the serial number of the certificate encoded as a string.
Syntax
ANSI (Cross Platform) char* GetSignerCertSerialNumber(); Unicode (Windows) LPWSTR GetSignerCertSerialNumber();
char* ipworksencrypt_smime_getsignercertserialnumber(void* lpObj);
QString GetSignerCertSerialNumber();
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SignerCertStore Property (SMIME Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore); Unicode (Windows) INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);
int ipworksencrypt_smime_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksencrypt_smime_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);
QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SignerCertStorePassword Property (SMIME Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword); Unicode (Windows) LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);
char* ipworksencrypt_smime_getsignercertstorepassword(void* lpObj);
int ipworksencrypt_smime_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);
QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SignerCertStoreType Property (SMIME Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType); Unicode (Windows) INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_smime_getsignercertstoretype(void* lpObj);
int ipworksencrypt_smime_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SignerCertSubject Property (SMIME Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject); Unicode (Windows) LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);
char* ipworksencrypt_smime_getsignercertsubject(void* lpObj);
int ipworksencrypt_smime_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);
QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SignerCertChainCount Property (SMIME Class)
The number of records in the SignerCertChain arrays.
Syntax
ANSI (Cross Platform) int GetSignerCertChainCount(); Unicode (Windows) INT GetSignerCertChainCount();
int ipworksencrypt_smime_getsignercertchaincount(void* lpObj);
int GetSignerCertChainCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SignerCertChainCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
SignerCertChainEncoded Property (SMIME Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSignerCertChainEncoded(int iSignerCertChainIndex, char* &lpSignerCertChainEncoded, int &lenSignerCertChainEncoded); Unicode (Windows) INT GetSignerCertChainEncoded(INT iSignerCertChainIndex, LPSTR &lpSignerCertChainEncoded, INT &lenSignerCertChainEncoded);
int ipworksencrypt_smime_getsignercertchainencoded(void* lpObj, int signercertchainindex, char** lpSignerCertChainEncoded, int* lenSignerCertChainEncoded);
QByteArray GetSignerCertChainEncoded(int iSignerCertChainIndex);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertChainStore and SignerCertChainSubject properties also may be used to specify a certificate.
When SignerCertChainEncoded is set, a search is initiated in the current SignerCertChainStore for the private key of the certificate. If the key is found, SignerCertChainSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertChainSubject is set to an empty string.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only and not available at design time.
Data Type
Binary String
SigningAlgorithm Property (SMIME Class)
This property includes a textual description of the signature hash algorithm.
Syntax
ANSI (Cross Platform) char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm); Unicode (Windows) LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);
char* ipworksencrypt_smime_getsigningalgorithm(void* lpObj);
int ipworksencrypt_smime_setsigningalgorithm(void* lpObj, const char* lpszSigningAlgorithm);
QString GetSigningAlgorithm();
int SetSigningAlgorithm(QString qsSigningAlgorithm);
Default Value
"SHA256"
Remarks
This property specifies the hash algorithm used to prepare the message digest for signature.
This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:
- sha1
- md5
- sha-256 (default)
- sha-384
- sha-512
- sha-224
When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.
Data Type
String
UseOAEP Property (SMIME Class)
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
ANSI (Cross Platform) int GetUseOAEP();
int SetUseOAEP(int bUseOAEP); Unicode (Windows) BOOL GetUseOAEP();
INT SetUseOAEP(BOOL bUseOAEP);
int ipworksencrypt_smime_getuseoaep(void* lpObj);
int ipworksencrypt_smime_setuseoaep(void* lpObj, int bUseOAEP);
bool GetUseOAEP();
int SetUseOAEP(bool bUseOAEP);
Default Value
FALSE
Remarks
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the class will use PKCS1.
To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams
Data Type
Boolean
UsePSS Property (SMIME Class)
This property specifies whether or not RSA-PSS will be used during signing and verification.
Syntax
ANSI (Cross Platform) int GetUsePSS();
int SetUsePSS(int bUsePSS); Unicode (Windows) BOOL GetUsePSS();
INT SetUsePSS(BOOL bUsePSS);
int ipworksencrypt_smime_getusepss(void* lpObj);
int ipworksencrypt_smime_setusepss(void* lpObj, int bUsePSS);
bool GetUsePSS();
int SetUsePSS(bool bUsePSS);
Default Value
FALSE
Remarks
This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.
Data Type
Boolean
AddRecipientCert Method (SMIME Class)
This method is used to add recipient certificates used to encrypt messages.
Syntax
ANSI (Cross Platform) int AddRecipientCert(const char* lpCertEncoded, int lenCertEncoded); Unicode (Windows) INT AddRecipientCert(LPCSTR lpCertEncoded, INT lenCertEncoded);
int ipworksencrypt_smime_addrecipientcert(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);
int AddRecipientCert(QByteArray qbaCertEncoded);
Remarks
This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.
The CertMgr class may be used to retrieve the appropriate certificate from the system.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CheckMessageEncrypted Method (SMIME Class)
This method checks whether or not the current message is encrypted.
Syntax
ANSI (Cross Platform) int CheckMessageEncrypted(); Unicode (Windows) INT CheckMessageEncrypted();
int ipworksencrypt_smime_checkmessageencrypted(void* lpObj);
bool CheckMessageEncrypted();
Remarks
This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CheckMessageSigned Method (SMIME Class)
This method checks whether or not the current message is signed.
Syntax
ANSI (Cross Platform) int CheckMessageSigned(); Unicode (Windows) INT CheckMessageSigned();
int ipworksencrypt_smime_checkmessagesigned(void* lpObj);
bool CheckMessageSigned();
Remarks
This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders.
Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Config Method (SMIME Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksencrypt_smime_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Decrypt Method (SMIME Class)
This method decrypts the current Message .
Syntax
ANSI (Cross Platform) int Decrypt(); Unicode (Windows) INT Decrypt();
int ipworksencrypt_smime_decrypt(void* lpObj);
int Decrypt();
Remarks
This method takes attempts to decrypt the encrypted message using the certificate in Certificate.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DecryptAndVerifySignature Method (SMIME Class)
This method decrypts and verifies the signature of the current message.
Syntax
ANSI (Cross Platform) int DecryptAndVerifySignature(); Unicode (Windows) INT DecryptAndVerifySignature();
int ipworksencrypt_smime_decryptandverifysignature(void* lpObj);
int DecryptAndVerifySignature();
Remarks
This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.
Note: This function does not attempt to check the validity of the signing certificate.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (SMIME Class)
This method encrypts the message.
Syntax
ANSI (Cross Platform) int Encrypt(); Unicode (Windows) INT Encrypt();
int ipworksencrypt_smime_encrypt(void* lpObj);
int Encrypt();
Remarks
This method encrypts the data specified in InputFile or InputMessage in a PKCS-encoded envelope with all of the recipient certificates specified in the MessageRecipients properties.
The result of the encrypted data will be written to OutputFile, or OutputMessage. The OutputMessageHeaders property will be filled with the required S/MIME headers.
Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity and providing other headers for the S/MIME wrapper.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetRecipientInfo Method (SMIME Class)
This method gets the recipient information for an encrypted message.
Syntax
ANSI (Cross Platform) int GetRecipientInfo(); Unicode (Windows) INT GetRecipientInfo();
int ipworksencrypt_smime_getrecipientinfo(void* lpObj);
int GetRecipientInfo();
Remarks
This method will fire a RecipientInfo event for every recipient certificate for which the Message has been encrypted. The event will contain information about the Issuer and the SerialNumber for each recipient of the message.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetSignerCertInfo Method (SMIME Class)
This method gets the signature information for an signed message.
Syntax
ANSI (Cross Platform) int GetSignerCertInfo(); Unicode (Windows) INT GetSignerCertInfo();
int ipworksencrypt_smime_getsignercertinfo(void* lpObj);
int GetSignerCertInfo();
Remarks
This method retrieves information about the certificate used to sign the message. This may be called before calling VerifySignature to determine which certificate should be loaded for verification.
When this method is called, the SignerCertInfo event fires once for each signer of the message. Use the parameters of the SignerCertInfo to determine which certificate to specify before calling VerifySignature.
Note: Use of this method is optional. If no certificate is specified before calling VerifySignature, the class will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SMIME Class)
This method resets the class properties.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksencrypt_smime_reset(void* lpObj);
int Reset();
Remarks
This method resets the values of all message and certificate properties. It is an easy way to reset the class properties before starting to populate with new values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Sign Method (SMIME Class)
This method signs the current message.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int ipworksencrypt_smime_sign(void* lpObj);
int Sign();
Remarks
This method digitally signs the input data with the the certificate provided. Certificates are provided by specifying the Certificate property. The IncludeCertificate and DetachedSignature properties allow you to specify addition details about what to include when signing the message.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SignAndEncrypt Method (SMIME Class)
This method signs and encrypts the current message.
Syntax
ANSI (Cross Platform) int SignAndEncrypt(); Unicode (Windows) INT SignAndEncrypt();
int ipworksencrypt_smime_signandencrypt(void* lpObj);
int SignAndEncrypt();
Remarks
This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in DetachedSignature is ignored: the class will always generate an attached signature when calling this method. All other properties used by calling the Sign and Encrypt methods are used in the same manner.
Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity and providing other headers for the S/MIME wrapper.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
VerifySignature Method (SMIME Class)
This method verifies the signature of the current message.
Syntax
ANSI (Cross Platform) int VerifySignature(); Unicode (Windows) INT VerifySignature();
int ipworksencrypt_smime_verifysignature(void* lpObj);
int VerifySignature();
Remarks
This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class fails with an error.
If this method is successful, the SignerCert property will contain the certificate information of the message signer.
Note: This function does not attempt to check the validity of the signing certificate.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- SetInputStream
- InputFile
- InputMessage
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (SMIME Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SMIMEErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SMIMEErrorEventParams;
Unicode (Windows) virtual INT FireError(SMIMEErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SMIMEErrorEventParams;
#define EID_SMIME_ERROR 1 virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SMIMEErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SMIMEErrorEventParams *e);
// Or, subclass SMIME and override this emitter function. virtual int FireError(SMIMEErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
RecipientInfo Event (SMIME Class)
This event is fired for each recipient certificate of the encrypted message.
Syntax
ANSI (Cross Platform) virtual int FireRecipientInfo(SMIMERecipientInfoEventParams *e);
typedef struct {
const char *Issuer;
const char *SerialNumber;
const char *SubjectKeyIdentifier;
const char *EncryptionAlgorithm; int reserved; } SMIMERecipientInfoEventParams;
Unicode (Windows) virtual INT FireRecipientInfo(SMIMERecipientInfoEventParams *e);
typedef struct {
LPCWSTR Issuer;
LPCWSTR SerialNumber;
LPCWSTR SubjectKeyIdentifier;
LPCWSTR EncryptionAlgorithm; INT reserved; } SMIMERecipientInfoEventParams;
#define EID_SMIME_RECIPIENTINFO 2 virtual INT IPWORKSENCRYPT_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, LPSTR &lpszEncryptionAlgorithm);
class SMIMERecipientInfoEventParams { public: const QString &Issuer(); const QString &SerialNumber(); const QString &SubjectKeyIdentifier(); const QString &EncryptionAlgorithm(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RecipientInfo(SMIMERecipientInfoEventParams *e);
// Or, subclass SMIME and override this emitter function. virtual int FireRecipientInfo(SMIMERecipientInfoEventParams *e) {...}
Remarks
When GetRecipientInfo is called on a valid encrypted message, this event will fire once for each recipient certificate that the message has been encrypted for. This may be used to identify the certificate to load.
Issuer is the subject of the issuer certificate.
SerialNumber is the serial number of the encryption certificate.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
SignerCertInfo Event (SMIME Class)
This event is fired during verification of the signed message.
Syntax
ANSI (Cross Platform) virtual int FireSignerCertInfo(SMIMESignerCertInfoEventParams *e);
typedef struct {
const char *Issuer;
const char *SerialNumber;
const char *SubjectKeyIdentifier;
const char *CertEncoded; int lenCertEncoded; int reserved; } SMIMESignerCertInfoEventParams;
Unicode (Windows) virtual INT FireSignerCertInfo(SMIMESignerCertInfoEventParams *e);
typedef struct {
LPCWSTR Issuer;
LPCWSTR SerialNumber;
LPCWSTR SubjectKeyIdentifier;
LPCSTR CertEncoded; INT lenCertEncoded; INT reserved; } SMIMESignerCertInfoEventParams;
#define EID_SMIME_SIGNERCERTINFO 3 virtual INT IPWORKSENCRYPT_CALL FireSignerCertInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, LPSTR &lpCertEncoded, INT &lenCertEncoded);
class SMIMESignerCertInfoEventParams { public: const QString &Issuer(); const QString &SerialNumber(); const QString &SubjectKeyIdentifier(); const QByteArray &CertEncoded(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignerCertInfo(SMIMESignerCertInfoEventParams *e);
// Or, subclass SMIME and override this emitter function. virtual int FireSignerCertInfo(SMIMESignerCertInfoEventParams *e) {...}
Remarks
During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:
Issuer specifies the subject of the issuer of the certificate used to sign the message.
SerialNumber is the serial number of the certificate used to sign the message.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.
Note: When this value is present, the class will automatically use this value to perform signature verification.
The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.
Config Settings (SMIME Class)
The class 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 class, access to these internal properties is provided through the Config method.SMIME Config Settings
This configuration 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 configuration setting may be used only when DetachedSignature is False.
For the Win32 editions, this configuration setting includes the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations.
Note: This configuration setting may be used only when the UseCryptoAPI is True.
If GenerateSignatureTimestamp is True, a timestamp will be generated and added to all signatures created by the class.
The default value is True.
If set to True, the class 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.
If set to True, the class 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.
This configuration setting specifies the Content-Transfer-Encoding header value in signed messages. By default, the class will automatically determine the Content-Transfer-Encoding based on the file extension set in InputFile. This setting may be set to override the determined value or to specify a value if data are 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 applicable only when calling Sign or SignAndEncrypt and DetachedSignature is True.
This configuration setting specifies the Content-Type header value in signed messages. By default, the class will automatically determine the Content-Type based on the file extension set in InputFile. This setting may be set to override the determined value or to specify a value if data are 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 applicable only when calling Sign or SignAndEncrypt and DetachedSignature is True.
This configuration setting will return True if the input message appears to be encrypted according to the value of InputMessageHeaders.
This will return true if the input message appears to be signed according to the value of InputMessageHeaders.
Setting this configuration setting to True will instruct the class to normalize the line endings of the input data to CrLf prior to processing. The default value is False.
This configuration setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
Note: This setting is not applicable when UseFIPSCompliantAPI is set to true or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate OAEPRSAHashAlgorithm and OAEPMGF1HashAlgorithm values. In this case the OAEPRSAHashAlgorithm is also used for MGF1.
This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when UseOAEP is set to True. The specified value should be hex encoded.
This configuration setting specifies that RSA hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
If set to True, the class 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.
When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because 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 setting may be set to the entire blob of the public certificate the class should use to select the correct recipient-encrypted key for decryption.
When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because 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 setting may be set to the file that contains the public certificate the class should use to select the correct recipient-encrypted key for decryption.
This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows:
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
Note: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension.
This configuration setting specifies which type of information about the signer certificate is included in the signed message. Possible values are as follows:
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
Note: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension.
This configuration 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 object identifiers instead.
If UseCryptoAPI is set to True, the class will use the Microsoft Crypto API to process encrypted and/or signed data.
Note: Compression will be impossible in this case.
If set to False (the default), the class will use its internal S/MIME engine.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SMIME Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SMIME Errors
10191 Invalid index (RecipientIndex). | |
10192 Message decoding error (code). | |
10193 Unexpected message type. | |
10194 Unsupported hashing/signing algorithm. | |
10195 The message does not have any signers. | |
10196 The message signature could not be verified. | |
10197 Could not locate a suitable decryption certificate. | |
10198 The signer certificate could not be found. | |
10199 No signing certificate was supplied for signing the message. | |
10201 The specified certificate was not the one required. | |
10202 The specified certificate could not be found. | |
10221 Could not acquire CSP. | |
10222 Type validation error. | |
10223 Unsupported key size. | |
10224 Unrecognized Content-Type object identifier. | |
10225 Unrecognized public key format. | |
10226 No choices specified. | |
10228 Must specify output stream. | |
10280 Invalid part index. | |
10281 Unknown MIME type. | |
10283 No MIME-boundary found. | |
10280 Error decoding certificate. |