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.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Certificate Property (SMIME Class)

This property includes the current selected certificate.

Syntax

• C++
• C
• Qt

IPWorksSMIMECertificate* GetCertificate();
int SetCertificate(IPWorksSMIMECertificate* val);

char* ipworkssmime_smime_getcerteffectivedate(void* lpObj);

char* ipworkssmime_smime_getcertexpirationdate(void* lpObj);

char* ipworkssmime_smime_getcertextendedkeyusage(void* lpObj);

char* ipworkssmime_smime_getcertfingerprint(void* lpObj);

char* ipworkssmime_smime_getcertfingerprintsha1(void* lpObj);

char* ipworkssmime_smime_getcertfingerprintsha256(void* lpObj);

char* ipworkssmime_smime_getcertissuer(void* lpObj);

char* ipworkssmime_smime_getcertprivatekey(void* lpObj);

int ipworkssmime_smime_getcertprivatekeyavailable(void* lpObj);

char* ipworkssmime_smime_getcertprivatekeycontainer(void* lpObj);

char* ipworkssmime_smime_getcertpublickey(void* lpObj);

char* ipworkssmime_smime_getcertpublickeyalgorithm(void* lpObj);

int ipworkssmime_smime_getcertpublickeylength(void* lpObj);

char* ipworkssmime_smime_getcertserialnumber(void* lpObj);

char* ipworkssmime_smime_getcertsignaturealgorithm(void* lpObj);

int ipworkssmime_smime_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworkssmime_smime_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworkssmime_smime_getcertstorepassword(void* lpObj);
int ipworkssmime_smime_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworkssmime_smime_getcertstoretype(void* lpObj);
int ipworkssmime_smime_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworkssmime_smime_getcertsubjectaltnames(void* lpObj);

char* ipworkssmime_smime_getcertthumbprintmd5(void* lpObj);

char* ipworkssmime_smime_getcertthumbprintsha1(void* lpObj);

char* ipworkssmime_smime_getcertthumbprintsha256(void* lpObj);

char* ipworkssmime_smime_getcertusage(void* lpObj);

int ipworkssmime_smime_getcertusageflags(void* lpObj);

char* ipworkssmime_smime_getcertversion(void* lpObj);

char* ipworkssmime_smime_getcertsubject(void* lpObj);
int ipworkssmime_smime_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworkssmime_smime_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworkssmime_smime_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QString GetCertEffectiveDate();

QString GetCertExpirationDate();

QString GetCertExtendedKeyUsage();

QString GetCertFingerprint();

QString GetCertFingerprintSHA1();

QString GetCertFingerprintSHA256();

QString GetCertIssuer();

QString GetCertPrivateKey();

bool GetCertPrivateKeyAvailable();

QString GetCertPrivateKeyContainer();

QString GetCertPublicKey();

QString GetCertPublicKeyAlgorithm();

int GetCertPublicKeyLength();

QString GetCertSerialNumber();

QString GetCertSignatureAlgorithm();

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

QString GetCertSubjectAltNames();

QString GetCertThumbprintMD5();

QString GetCertThumbprintSHA1();

QString GetCertThumbprintSHA256();

QString GetCertUsage();

int GetCertUsageFlags();

QString GetCertVersion();

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Remarks

This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.

Data Type

IPWorksSMIMECertificate

DetachedSignature Property (SMIME Class)

This property specifies whether to include a detached signature when signing a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDetachedSignature();
int SetDetachedSignature(int bDetachedSignature);

Unicode (Windows)
BOOL GetDetachedSignature();
INT SetDetachedSignature(BOOL bDetachedSignature);

int ipworkssmime_smime_getdetachedsignature(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);

char* ipworkssmime_smime_getencryptingalgorithm(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeCertificate();
int SetIncludeCertificate(int bIncludeCertificate);

Unicode (Windows)
BOOL GetIncludeCertificate();
INT SetIncludeCertificate(BOOL bIncludeCertificate);

int ipworkssmime_smime_getincludecertificate(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeChain();
int SetIncludeChain(int bIncludeChain);

Unicode (Windows)
BOOL GetIncludeChain();
INT SetIncludeChain(BOOL bIncludeChain);

int ipworkssmime_smime_getincludechain(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeHeaders();
int SetIncludeHeaders(int bIncludeHeaders);

Unicode (Windows)
BOOL GetIncludeHeaders();
INT SetIncludeHeaders(BOOL bIncludeHeaders);

int ipworkssmime_smime_getincludeheaders(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworkssmime_smime_getinputfile(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

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 ipworkssmime_smime_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworkssmime_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

InputMessageHeaders Property (SMIME Class)

This property includes a collection of headers from the S/MIME message.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEHeader>* GetInputMessageHeaders();
int SetInputMessageHeaders(IPWorksSMIMEList<IPWorksSMIMEHeader>* val);

int ipworkssmime_smime_getinputmessageheadercount(void* lpObj);
int ipworkssmime_smime_setinputmessageheadercount(void* lpObj, int iInputMessageHeaderCount);

char* ipworkssmime_smime_getinputmessageheaderfield(void* lpObj, int inputmessageheaderindex);
int ipworkssmime_smime_setinputmessageheaderfield(void* lpObj, int inputmessageheaderindex, const char* lpszInputMessageHeaderField);

char* ipworkssmime_smime_getinputmessageheadervalue(void* lpObj, int inputmessageheaderindex);
int ipworkssmime_smime_setinputmessageheadervalue(void* lpObj, int inputmessageheaderindex, const char* lpszInputMessageHeaderValue);

int GetInputMessageHeaderCount();
int SetInputMessageHeaderCount(int iInputMessageHeaderCount);

QString GetInputMessageHeaderField(int iInputMessageHeaderIndex);
int SetInputMessageHeaderField(int iInputMessageHeaderIndex, QString qsInputMessageHeaderField);

QString GetInputMessageHeaderValue(int iInputMessageHeaderIndex);
int SetInputMessageHeaderValue(int iInputMessageHeaderIndex, QString qsInputMessageHeaderValue);

Remarks

This property contains a collection of headers from the S/MIME message.

This property may be set to the headers of the message that will be decrypted/verified.

This property is not available at design time.

Data Type

IPWorksSMIMEHeader

InputMessageHeadersString Property (SMIME Class)

This property includes the string version of headers from the S/MIME message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputMessageHeadersString();
int SetInputMessageHeadersString(const char* lpszInputMessageHeadersString);

Unicode (Windows)
LPWSTR GetInputMessageHeadersString();
INT SetInputMessageHeadersString(LPCWSTR lpszInputMessageHeadersString);

char* ipworkssmime_smime_getinputmessageheadersstring(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInternalHeaders();
int SetInternalHeaders(const char* lpszInternalHeaders);

Unicode (Windows)
LPWSTR GetInternalHeaders();
INT SetInternalHeaders(LPCWSTR lpszInternalHeaders);

char* ipworkssmime_smime_getinternalheaders(void* lpObj);
int ipworkssmime_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

OutputFile Property (SMIME Class)

This property specifies the output file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworkssmime_smime_getoutputfile(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage);

Unicode (Windows)
INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);

int ipworkssmime_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

OutputMessageHeaders Property (SMIME Class)

This property includes a collection of headers from the S/MIME message.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEHeader>* GetOutputMessageHeaders();

int ipworkssmime_smime_getoutputmessageheadercount(void* lpObj);

char* ipworkssmime_smime_getoutputmessageheaderfield(void* lpObj, int outputmessageheaderindex);

char* ipworkssmime_smime_getoutputmessageheadervalue(void* lpObj, int outputmessageheaderindex);

int GetOutputMessageHeaderCount();

QString GetOutputMessageHeaderField(int iOutputMessageHeaderIndex);

QString GetOutputMessageHeaderValue(int iOutputMessageHeaderIndex);

Remarks

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 and not available at design time.

Data Type

IPWorksSMIMEHeader

OutputMessageHeadersString Property (SMIME Class)

This property includes a string version of headers from the S/MIME message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputMessageHeadersString();

Unicode (Windows)
LPWSTR GetOutputMessageHeadersString();

char* ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworkssmime_smime_getoverwrite(void* lpObj);
int ipworkssmime_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

RecipientCerts Property (SMIME Class)

This property includes a collection of recipient certificates of the message.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMECertificate>* GetRecipientCerts();
int SetRecipientCerts(IPWorksSMIMEList<IPWorksSMIMECertificate>* val);

int ipworkssmime_smime_getrecipientcertcount(void* lpObj);
int ipworkssmime_smime_setrecipientcertcount(void* lpObj, int iRecipientCertCount);

char* ipworkssmime_smime_getrecipientcerteffectivedate(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertexpirationdate(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertextendedkeyusage(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertfingerprint(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertfingerprintsha1(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertfingerprintsha256(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertissuer(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertprivatekey(void* lpObj, int recipientcertindex);

int ipworkssmime_smime_getrecipientcertprivatekeyavailable(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertprivatekeycontainer(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertpublickey(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertpublickeyalgorithm(void* lpObj, int recipientcertindex);

int ipworkssmime_smime_getrecipientcertpublickeylength(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertserialnumber(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertsignaturealgorithm(void* lpObj, int recipientcertindex);

int ipworkssmime_smime_getrecipientcertstore(void* lpObj, int recipientcertindex, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworkssmime_smime_setrecipientcertstore(void* lpObj, int recipientcertindex, const char* lpRecipientCertStore, int lenRecipientCertStore);

char* ipworkssmime_smime_getrecipientcertstorepassword(void* lpObj, int recipientcertindex);
int ipworkssmime_smime_setrecipientcertstorepassword(void* lpObj, int recipientcertindex, const char* lpszRecipientCertStorePassword);

int ipworkssmime_smime_getrecipientcertstoretype(void* lpObj, int recipientcertindex);
int ipworkssmime_smime_setrecipientcertstoretype(void* lpObj, int recipientcertindex, int iRecipientCertStoreType);

char* ipworkssmime_smime_getrecipientcertsubjectaltnames(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertthumbprintmd5(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertthumbprintsha1(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertthumbprintsha256(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertusage(void* lpObj, int recipientcertindex);

int ipworkssmime_smime_getrecipientcertusageflags(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertversion(void* lpObj, int recipientcertindex);

char* ipworkssmime_smime_getrecipientcertsubject(void* lpObj, int recipientcertindex);
int ipworkssmime_smime_setrecipientcertsubject(void* lpObj, int recipientcertindex, const char* lpszRecipientCertSubject);

int ipworkssmime_smime_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworkssmime_smime_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

QString GetRecipientCertEffectiveDate(int iRecipientCertIndex);

QString GetRecipientCertExpirationDate(int iRecipientCertIndex);

QString GetRecipientCertExtendedKeyUsage(int iRecipientCertIndex);

QString GetRecipientCertFingerprint(int iRecipientCertIndex);

QString GetRecipientCertFingerprintSHA1(int iRecipientCertIndex);

QString GetRecipientCertFingerprintSHA256(int iRecipientCertIndex);

QString GetRecipientCertIssuer(int iRecipientCertIndex);

QString GetRecipientCertPrivateKey(int iRecipientCertIndex);

bool GetRecipientCertPrivateKeyAvailable(int iRecipientCertIndex);

QString GetRecipientCertPrivateKeyContainer(int iRecipientCertIndex);

QString GetRecipientCertPublicKey(int iRecipientCertIndex);

QString GetRecipientCertPublicKeyAlgorithm(int iRecipientCertIndex);

int GetRecipientCertPublicKeyLength(int iRecipientCertIndex);

QString GetRecipientCertSerialNumber(int iRecipientCertIndex);

QString GetRecipientCertSignatureAlgorithm(int iRecipientCertIndex);

QByteArray GetRecipientCertStore(int iRecipientCertIndex);
int SetRecipientCertStore(int iRecipientCertIndex, QByteArray qbaRecipientCertStore);

QString GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, QString qsRecipientCertStorePassword);

int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);

QString GetRecipientCertSubjectAltNames(int iRecipientCertIndex);

QString GetRecipientCertThumbprintMD5(int iRecipientCertIndex);

QString GetRecipientCertThumbprintSHA1(int iRecipientCertIndex);

QString GetRecipientCertThumbprintSHA256(int iRecipientCertIndex);

QString GetRecipientCertUsage(int iRecipientCertIndex);

int GetRecipientCertUsageFlags(int iRecipientCertIndex);

QString GetRecipientCertVersion(int iRecipientCertIndex);

QString GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, QString qsRecipientCertSubject);

QByteArray GetRecipientCertEncoded(int iRecipientCertIndex);
int SetRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);

Remarks

This property is used to specify the certificates of the intended recipients of the encrypted message. This property must be set before calling Encrypt or SignAndEncrypt methods.

This property's collection must be filled out with valid public key Certificate type objects. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

This property is not available at design time.

Data Type

IPWorksSMIMECertificate

SignerCert Property (SMIME Class)

This property contains the certificate of the message signer.

Syntax

• C++
• C
• Qt

IPWorksSMIMECertificate* GetSignerCert();
int SetSignerCert(IPWorksSMIMECertificate* val);

char* ipworkssmime_smime_getsignercerteffectivedate(void* lpObj);

char* ipworkssmime_smime_getsignercertexpirationdate(void* lpObj);

char* ipworkssmime_smime_getsignercertextendedkeyusage(void* lpObj);

char* ipworkssmime_smime_getsignercertfingerprint(void* lpObj);

char* ipworkssmime_smime_getsignercertfingerprintsha1(void* lpObj);

char* ipworkssmime_smime_getsignercertfingerprintsha256(void* lpObj);

char* ipworkssmime_smime_getsignercertissuer(void* lpObj);

char* ipworkssmime_smime_getsignercertprivatekey(void* lpObj);

int ipworkssmime_smime_getsignercertprivatekeyavailable(void* lpObj);

char* ipworkssmime_smime_getsignercertprivatekeycontainer(void* lpObj);

char* ipworkssmime_smime_getsignercertpublickey(void* lpObj);

char* ipworkssmime_smime_getsignercertpublickeyalgorithm(void* lpObj);

int ipworkssmime_smime_getsignercertpublickeylength(void* lpObj);

char* ipworkssmime_smime_getsignercertserialnumber(void* lpObj);

char* ipworkssmime_smime_getsignercertsignaturealgorithm(void* lpObj);

int ipworkssmime_smime_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworkssmime_smime_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

char* ipworkssmime_smime_getsignercertstorepassword(void* lpObj);
int ipworkssmime_smime_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

int ipworkssmime_smime_getsignercertstoretype(void* lpObj);
int ipworkssmime_smime_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

char* ipworkssmime_smime_getsignercertsubjectaltnames(void* lpObj);

char* ipworkssmime_smime_getsignercertthumbprintmd5(void* lpObj);

char* ipworkssmime_smime_getsignercertthumbprintsha1(void* lpObj);

char* ipworkssmime_smime_getsignercertthumbprintsha256(void* lpObj);

char* ipworkssmime_smime_getsignercertusage(void* lpObj);

int ipworkssmime_smime_getsignercertusageflags(void* lpObj);

char* ipworkssmime_smime_getsignercertversion(void* lpObj);

char* ipworkssmime_smime_getsignercertsubject(void* lpObj);
int ipworkssmime_smime_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

int ipworkssmime_smime_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworkssmime_smime_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QString GetSignerCertEffectiveDate();

QString GetSignerCertExpirationDate();

QString GetSignerCertExtendedKeyUsage();

QString GetSignerCertFingerprint();

QString GetSignerCertFingerprintSHA1();

QString GetSignerCertFingerprintSHA256();

QString GetSignerCertIssuer();

QString GetSignerCertPrivateKey();

bool GetSignerCertPrivateKeyAvailable();

QString GetSignerCertPrivateKeyContainer();

QString GetSignerCertPublicKey();

QString GetSignerCertPublicKeyAlgorithm();

int GetSignerCertPublicKeyLength();

QString GetSignerCertSerialNumber();

QString GetSignerCertSignatureAlgorithm();

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

QString GetSignerCertSubjectAltNames();

QString GetSignerCertThumbprintMD5();

QString GetSignerCertThumbprintSHA1();

QString GetSignerCertThumbprintSHA256();

QString GetSignerCertUsage();

int GetSignerCertUsageFlags();

QString GetSignerCertVersion();

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Remarks

This property contains the certificate of the message signer. When calling VerifySignature or DecryptAndVerifySignature, this property will contain the certificate of the sender, if attached.

To verify messages without an attached certificate, set this property before calling VerifySignature or DecryptAndVerifySignature.

Data Type

IPWorksSMIMECertificate

SignerCertChain Property (SMIME Class)

This property includes the certificate chain of the signing certificate.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMECertificate>* GetSignerCertChain();

int ipworkssmime_smime_getsignercertchaincount(void* lpObj);

char* ipworkssmime_smime_getsignercertchaineffectivedate(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainexpirationdate(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainextendedkeyusage(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainfingerprint(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainfingerprintsha1(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainfingerprintsha256(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainissuer(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainprivatekey(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainprivatekeyavailable(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainprivatekeycontainer(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainpublickey(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainpublickeyalgorithm(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainpublickeylength(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainserialnumber(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainsignaturealgorithm(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainstore(void* lpObj, int signercertchainindex, char** lpSignerCertChainStore, int* lenSignerCertChainStore);

char* ipworkssmime_smime_getsignercertchainstorepassword(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainstoretype(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainsubjectaltnames(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainthumbprintmd5(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainthumbprintsha1(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainthumbprintsha256(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainusage(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainusageflags(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainversion(void* lpObj, int signercertchainindex);

char* ipworkssmime_smime_getsignercertchainsubject(void* lpObj, int signercertchainindex);

int ipworkssmime_smime_getsignercertchainencoded(void* lpObj, int signercertchainindex, char** lpSignerCertChainEncoded, int* lenSignerCertChainEncoded);

int GetSignerCertChainCount();

QString GetSignerCertChainEffectiveDate(int iSignerCertChainIndex);

QString GetSignerCertChainExpirationDate(int iSignerCertChainIndex);

QString GetSignerCertChainExtendedKeyUsage(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprint(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprintSHA1(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprintSHA256(int iSignerCertChainIndex);

QString GetSignerCertChainIssuer(int iSignerCertChainIndex);

QString GetSignerCertChainPrivateKey(int iSignerCertChainIndex);

bool GetSignerCertChainPrivateKeyAvailable(int iSignerCertChainIndex);

QString GetSignerCertChainPrivateKeyContainer(int iSignerCertChainIndex);

QString GetSignerCertChainPublicKey(int iSignerCertChainIndex);

QString GetSignerCertChainPublicKeyAlgorithm(int iSignerCertChainIndex);

int GetSignerCertChainPublicKeyLength(int iSignerCertChainIndex);

QString GetSignerCertChainSerialNumber(int iSignerCertChainIndex);

QString GetSignerCertChainSignatureAlgorithm(int iSignerCertChainIndex);

QByteArray GetSignerCertChainStore(int iSignerCertChainIndex);

QString GetSignerCertChainStorePassword(int iSignerCertChainIndex);

int GetSignerCertChainStoreType(int iSignerCertChainIndex);

QString GetSignerCertChainSubjectAltNames(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintMD5(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintSHA1(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintSHA256(int iSignerCertChainIndex);

QString GetSignerCertChainUsage(int iSignerCertChainIndex);

int GetSignerCertChainUsageFlags(int iSignerCertChainIndex);

QString GetSignerCertChainVersion(int iSignerCertChainIndex);

QString GetSignerCertChainSubject(int iSignerCertChainIndex);

QByteArray GetSignerCertChainEncoded(int iSignerCertChainIndex);

Remarks

This property contains the certificate chain of the signing certificate. When calling VerifySignature or DecryptAndVerifySignature, this property will be populated with the certificate chain of the sender if attached.

Note: The SignerCert property will contain the signing certificate. The certificates in the signing certificate's chain will be placed in this property's collection.

This property is read-only and not available at design time.

Data Type

IPWorksSMIMECertificate

SigningAlgorithm Property (SMIME Class)

This property includes a textual description of the signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm);

Unicode (Windows)
LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);

char* ipworkssmime_smime_getsigningalgorithm(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseOAEP();
int SetUseOAEP(int bUseOAEP);

Unicode (Windows)
BOOL GetUseOAEP();
INT SetUseOAEP(BOOL bUseOAEP);

int ipworkssmime_smime_getuseoaep(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUsePSS();
int SetUsePSS(int bUsePSS);

Unicode (Windows)
BOOL GetUsePSS();
INT SetUsePSS(BOOL bUsePSS);

int ipworkssmime_smime_getusepss(void* lpObj);
int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRecipientCert(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT AddRecipientCert(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckMessageEncrypted();

Unicode (Windows)
INT CheckMessageEncrypted();

bool ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckMessageSigned();

Unicode (Windows)
INT CheckMessageSigned();

bool ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientInfo();

Unicode (Windows)
INT GetRecipientInfo();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertInfo();

Unicode (Windows)
INT GetSignerCertInfo();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int SignAndEncrypt();

Unicode (Windows)
INT SignAndEncrypt();

int ipworkssmime_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

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworkssmime_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

• C++
• C
• Qt

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 IPWORKSSMIME_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

• C++
• C
• Qt

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 IPWORKSSMIME_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

• C++
• C
• Qt

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 IPWORKSSMIME_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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSMIMECertificate (declared in ipworkssmime.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Header Type

This is an HTTP header as it is received from the server.

Syntax

IPWorksSMIMEHeader (declared in ipworkssmime.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

IPWorksSMIMEList Type

Syntax

IPWorksSMIMEList<T> (declared in ipworkssmime.h)

Remarks

IPWorksSMIMEList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SMIME class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SMIME Class)

SMIME Config Settings

Base Config Settings

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