SMIME Component

Properties   Methods   Events   Config Settings   Errors  

The S/MIME component implements the S/MIME standard for encryption and decryption with public key cryptography and X.509 digital certificates.

Syntax

TipmSMIME

Remarks

The S/MIME component implements the S/MIME V3 standard for encryption and decryption using Public Key Cryptography Standards (PKCS). In addition, the component can be used to both generate and verify RSA digital signatures. Using this component 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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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 component can also generate PKCS #7 formatted detached digital signatures and envelopes by specifying DetachedSignature.

Encrypting

To encrypt a message with the component 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 component 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

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

CertEncoded Property (SMIME Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded };
__property DynamicArray<Byte> CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB };

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

Byte Array

CertStore Property (SMIME Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String CertStore = { read=FCertStore, write=FSetCertStore };
__property DynamicArray<Byte> CertStoreB = { read=FCertStoreB, write=FSetCertStoreB };

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:

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

Byte Array

CertStorePassword Property (SMIME Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String CertStorePassword = { read=FCertStorePassword, write=FSetCertStorePassword };

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 Component)

This is the type of certificate store for this certificate.

Syntax

__property TipmSMIMECertStoreTypes CertStoreType = { read=FCertStoreType, write=FSetCertStoreType };

enum TipmSMIMECertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubject Property (SMIME Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String CertSubject = { read=FCertSubject, write=FSetCertSubject };

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:

If a field value contains a comma, it must be quoted.

Data Type

String

DetachedSignature Property (SMIME Component)

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

Syntax

__property bool DetachedSignature = { read=FDetachedSignature, write=FSetDetachedSignature };

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 Component)

The property includes textual description of the encrypting algorithm.

Syntax

__property String EncryptingAlgorithm = { read=FEncryptingAlgorithm, write=FSetEncryptingAlgorithm };

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 Component)

This property specifies whether to include the signer's certificate with the signed message.

Syntax

__property bool IncludeCertificate = { read=FIncludeCertificate, write=FSetIncludeCertificate };

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 Component)

This property specifies whether to include the signer's certificate chain with the signed message.

Syntax

__property bool IncludeChain = { read=FIncludeChain, write=FSetIncludeChain };

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 Component)

This property tells the component whether to include the headers when encoding the message.

Syntax

__property bool IncludeHeaders = { read=FIncludeHeaders, write=FSetIncludeHeaders };

Default Value

false

Remarks

If True, the component will include the headers when Sign, Encrypt, or SignAndEncrypt are called. If False, only the message will be encoded.

The default value for IncludeHeaders is False.

Data Type

Boolean

InputFile Property (SMIME Component)

This property includes the file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

Data Type

String

InputMessage Property (SMIME Component)

This property includes the message to process.

Syntax

__property String InputMessage = { read=FInputMessage, write=FSetInputMessage };
__property DynamicArray<Byte> InputMessageB = { read=FInputMessageB, write=FSetInputMessageB };

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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

Data Type

Byte Array

InputMessageHeaderCount Property (SMIME Component)

The number of records in the InputMessageHeader arrays.

Syntax

__property int InputMessageHeaderCount = { read=FInputMessageHeaderCount, write=FSetInputMessageHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• InputMessageHeaderField
• InputMessageHeaderValue

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 Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String InputMessageHeaderField[int InputMessageHeaderIndex] = { read=FInputMessageHeaderField, write=FSetInputMessageHeaderField };

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 Component)

This property contains the header contents.

Syntax

__property String InputMessageHeaderValue[int InputMessageHeaderIndex] = { read=FInputMessageHeaderValue, write=FSetInputMessageHeaderValue };

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 Component)

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

Syntax

__property String InputMessageHeadersString = { read=FInputMessageHeadersString, write=FSetInputMessageHeadersString };

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 Component)

This property includes the headers of the MIME entity inside the encrypted or signed message.

Syntax

__property String InternalHeaders = { read=FInternalHeaders, write=FSetInternalHeaders };

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 Component)

This property specifies whether or not the current message is encrypted.

Syntax

__property bool MessageEncrypted = { read=FMessageEncrypted };

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 Component)

This property specifies whether or not the current message is signed.

Syntax

__property bool MessageSigned = { read=FMessageSigned };

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 Component)

This property specifies the output file.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.

Data Type

String

OutputMessage Property (SMIME Component)

This property includes the output message after processing.

Syntax

__property String OutputMessage = { read=FOutputMessage };
__property DynamicArray<Byte> OutputMessageB = { read=FOutputMessageB };

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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.

This property is read-only.

Data Type

Byte Array

OutputMessageHeaderCount Property (SMIME Component)

The number of records in the OutputMessageHeader arrays.

Syntax

__property int OutputMessageHeaderCount = { read=FOutputMessageHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• OutputMessageHeaderField
• OutputMessageHeaderValue

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 Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String OutputMessageHeaderField[int OutputMessageHeaderIndex] = { read=FOutputMessageHeaderField };

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 Component)

This property contains the header contents.

Syntax

__property String OutputMessageHeaderValue[int OutputMessageHeaderIndex] = { read=FOutputMessageHeaderValue };

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 Component)

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

Syntax

__property String OutputMessageHeadersString = { read=FOutputMessageHeadersString };

Default Value

""

Remarks

This property contains the string version of headers from the S/MIME message. The component 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 component 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 Component)

This property indicates whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

true

Remarks

This property indicates whether or not the component 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 Component)

The number of records in the RecipientCert arrays.

Syntax

__property int RecipientCertCount = { read=FRecipientCertCount, write=FSetRecipientCertCount };

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 Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String RecipientCertEncoded[int RecipientCertIndex] = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded };
__property DynamicArray<Byte> RecipientCertEncodedB[int RecipientCertIndex] = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB };

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

Byte Array

RecipientCertStore Property (SMIME Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String RecipientCertStore[int RecipientCertIndex] = { read=FRecipientCertStore, write=FSetRecipientCertStore };
__property DynamicArray<Byte> RecipientCertStoreB[int RecipientCertIndex] = { read=FRecipientCertStoreB, write=FSetRecipientCertStoreB };

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:

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

Byte Array

RecipientCertStorePassword Property (SMIME Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String RecipientCertStorePassword[int RecipientCertIndex] = { read=FRecipientCertStorePassword, write=FSetRecipientCertStorePassword };

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 Component)

This is the type of certificate store for this certificate.

Syntax

__property TipmSMIMERecipientCertStoreTypes RecipientCertStoreType[int RecipientCertIndex] = { read=FRecipientCertStoreType, write=FSetRecipientCertStoreType };

enum TipmSMIMERecipientCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

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 Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String RecipientCertSubject[int RecipientCertIndex] = { read=FRecipientCertSubject, write=FSetRecipientCertSubject };

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:

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 Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded };
__property DynamicArray<Byte> SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB };

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

Byte Array

SignerCertIssuer Property (SMIME Component)

This is the issuer of the certificate.

Syntax

__property String SignerCertIssuer = { read=FSignerCertIssuer };

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 Component)

This is the serial number of the certificate encoded as a string.

Syntax

__property String SignerCertSerialNumber = { read=FSignerCertSerialNumber };

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 Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore };
__property DynamicArray<Byte> SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };

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:

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

Byte Array

SignerCertStorePassword Property (SMIME Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SignerCertStorePassword = { read=FSignerCertStorePassword, write=FSetSignerCertStorePassword };

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 Component)

This is the type of certificate store for this certificate.

Syntax

__property TipmSMIMESignerCertStoreTypes SignerCertStoreType = { read=FSignerCertStoreType, write=FSetSignerCertStoreType };

enum TipmSMIMESignerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubject Property (SMIME Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject };

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:

If a field value contains a comma, it must be quoted.

Data Type

String

SignerCertChainCount Property (SMIME Component)

The number of records in the SignerCertChain arrays.

Syntax

__property int SignerCertChainCount = { read=FSignerCertChainCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerCertChainEncoded

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 Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SignerCertChainEncoded[int SignerCertChainIndex] = { read=FSignerCertChainEncoded };
__property DynamicArray<Byte> SignerCertChainEncodedB[int SignerCertChainIndex] = { read=FSignerCertChainEncodedB };

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

Byte Array

SigningAlgorithm Property (SMIME Component)

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

Syntax

__property String SigningAlgorithm = { read=FSigningAlgorithm, write=FSetSigningAlgorithm };

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 Component)

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

__property bool UseOAEP = { read=FUseOAEP, write=FSetUseOAEP };

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 component will use PKCS1.

To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams

Data Type

Boolean

UsePSS Property (SMIME Component)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Syntax

__property bool UsePSS = { read=FUsePSS, write=FSetUsePSS };

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 Component)

This method is used to add recipient certificates used to encrypt messages.

Syntax

void __fastcall AddRecipientCert(DynamicArray<Byte> CertEncoded);

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 component may be used to retrieve the appropriate certificate from the system.

CheckMessageEncrypted Method (SMIME Component)

This method checks whether or not the current message is encrypted.

Syntax

bool __fastcall 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.

CheckMessageSigned Method (SMIME Component)

This method checks whether or not the current message is signed.

Syntax

bool __fastcall 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.

Config Method (SMIME Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

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.

Decrypt Method (SMIME Component)

This method decrypts the current Message .

Syntax

void __fastcall Decrypt();

Remarks

This method takes attempts to decrypt the encrypted message using the certificate in Certificate.

Input and Output Properties

The component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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.

DecryptAndVerifySignature Method (SMIME Component)

This method decrypts and verifies the signature of the current message.

Syntax

void __fastcall 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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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.

Encrypt Method (SMIME Component)

This method encrypts the message.

Syntax

void __fastcall 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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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.

GetRecipientInfo Method (SMIME Component)

This method gets the recipient information for an encrypted message.

Syntax

void __fastcall 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.

GetSignerCertInfo Method (SMIME Component)

This method gets the signature information for an signed message.

Syntax

void __fastcall 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 component will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).

Reset Method (SMIME Component)

This method resets the component properties.

Syntax

void __fastcall Reset();

Remarks

This method resets the values of all message and certificate properties. It is an easy way to reset the component properties before starting to populate with new values.

Sign Method (SMIME Component)

This method signs the current message.

Syntax

void __fastcall 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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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.

SignAndEncrypt Method (SMIME Component)

This method signs and encrypts the current message.

Syntax

void __fastcall SignAndEncrypt();

Remarks

This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in DetachedSignature is ignored: the component 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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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.

VerifySignature Method (SMIME Component)

This method verifies the signature of the current message.

Syntax

void __fastcall VerifySignature();

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the component will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the component raises an exception.

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 component 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:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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 Event (SMIME Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipmSMIMEErrorEventParams;
typedef void __fastcall (__closure *TipmSMIMEErrorEvent)(System::TObject* Sender, TipmSMIMEErrorEventParams *e);
__property TipmSMIMEErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 Component)

This event is fired for each recipient certificate of the encrypted message.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  String EncryptionAlgorithm;
} TipmSMIMERecipientInfoEventParams;
typedef void __fastcall (__closure *TipmSMIMERecipientInfoEvent)(System::TObject* Sender, TipmSMIMERecipientInfoEventParams *e);
__property TipmSMIMERecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo };

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 Component)

This event is fired during verification of the signed message.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
} TipmSMIMESignerCertInfoEventParams;
typedef void __fastcall (__closure *TipmSMIMESignerCertInfoEvent)(System::TObject* Sender, TipmSMIMESignerCertInfoEventParams *e);
__property TipmSMIMESignerCertInfoEvent OnSignerCertInfo = { read=FOnSignerCertInfo, write=FOnSignerCertInfo };

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 component 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 Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

SMIME Config Settings

Base Config Settings

Trappable Errors (SMIME Component)

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.