CMS Component

Properties   Methods   Events   Config Settings   Errors  

The CMS component is used to digitally sign, encrypt, verify, and decrypt data.

Syntax

TipcCMS

Remarks

The CMS component implements the Cryptographic Message Syntax and allow for various cryptographic operations to be performed on data including:

• Sign
• VerifySignature
• Encrypt
• Decrypt
• SignAndEncrypt
• DecryptAndVerifySignature

The component can generate and consume message in a variety of formats including PEM, DER (Binary), and SMIME. The EncryptionAlgorithm and SignatureHashAlgorithm are fully configurable and support a variety of industry standard encryption and hash algorithms.

The component supports additional functionality such as Compression, OAEP, and PSS. The GetRecipientInfo and GetSignerCertInfo methods as well as the RecipientInfo and SignerCertInfo events allow for a dynamic and flexible approach to message processing. Certificate may be loaded ahead of time or as-needed from the events.

Signing Notes

OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. IncludeCertificates specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:

• Certificates (required)
• DetachedSignature
• EnableCompression
• GenerateSignatureTimestamp
• IncludeCertificates
• OutputFormat
• SignatureHashAlgorithm
• UsePSS

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:

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

Sign and Verify a message Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - DER Output Format Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - Detached Signature Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); Sign and Verify a message - Multiple Signatures Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - No Included Certificate Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage;

Encryption Notes

OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. The following properties are applicable when calling this method:

• RecipientCerts (required)
• EncryptionAlgorithm
• OutputFormat
• UseOAEP

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:

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

Encrypt and Decrypt a message Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt a message - DER Output Format Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Multiple Recipients Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Get Recipient Info Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage;

Signature Verification Notes

In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling AddRecipientCert or setting RecipientCerts.

When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.

The following property are applicable when calling this method:

• DetachedSignature
• DetachedSignatureData
• EnableCompression
• SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.

If the input message is compressed EnableCompression must be set to True before calling this method.

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:

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

Sign and Verify a message Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - DER Output Format Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - Detached Signature Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); Sign and Verify a message - Multiple Signatures Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - No Included Certificate Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage;

Decryption Notes

Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling AddCertificate or setting the Certificates property.

If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.

The following properties are applicable when calling this method:

• Certificates (Required)

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:

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

Encrypt and Decrypt a message Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt a message - DER Output Format Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Multiple Recipients Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Get Recipient Info Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage;

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.

CertCount Property (CMS Component)

The number of records in the Cert arrays.

Syntax

property CertCount: Integer read get_CertCount write set_CertCount;

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertEncoded
• CertStore
• CertStorePassword
• CertStoreType
• CertSubject

The array indices start at 0 and end at CertCount - 1.

This property is not available at design time.

CertEncoded Property (CMS Component)

This is the certificate (PEM/base64 encoded).

Syntax

property CertEncoded[CertIndex: Integer]: String read get_CertEncoded write set_CertEncoded;
property CertEncodedB[CertIndex: Integer]: TBytes read get_CertEncodedB write set_CertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

CertStore Property (CMS Component)

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

Syntax

property CertStore[CertIndex: Integer]: String read get_CertStore write set_CertStore;
property CertStoreB[CertIndex: Integer]: TBytes read get_CertStoreB write set_CertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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. PKCS12 certificate store).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

CertStorePassword Property (CMS 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 CertStorePassword[CertIndex: Integer]: String read get_CertStorePassword write set_CertStorePassword;

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

CertStoreType Property (CMS Component)

This is the type of certificate store for this certificate.

Syntax

property CertStoreType[CertIndex: Integer]: TipcCertStoreTypes read get_CertStoreType write set_CertStoreType;

TipcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

CertSubject Property (CMS Component)

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

Syntax

property CertSubject[CertIndex: Integer]: String read get_CertSubject write set_CertSubject;

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

DetachedSignature Property (CMS Component)

Specifies whether to include a detached signature when signing a message.

Syntax

property DetachedSignature: Boolean read get_DetachedSignature write set_DetachedSignature;

Default Value

false

Remarks

This property specifies whether the Sign operation products a message that includes both a signature and the message data, or just a signature.

When set to False default the output message holds the data and signature in one CMS message. This may be passed in its entirety to the receiving party for signature verification.

When set to True the output message holds only a signature in the CMS message. Both the original input data and the signature in the output message produced by the Sign operation must be passed to the receiving party for signature verification.

DetachedSignatureData Property (CMS Component)

The detached signature.

Syntax

property DetachedSignatureData: String read get_DetachedSignatureData write set_DetachedSignatureData;
property DetachedSignatureDataB: TBytes read get_DetachedSignatureDataB write set_DetachedSignatureDataB;

Default Value

''

Remarks

This setting is used to specify the detached signature before calling VerifySignature. The message data should be specified normally and this property should be set to the detached signature data. This may be set to the PEM, DER, or SMIME encoded signature message.

EnableCompression Property (CMS Component)

Specifies whether to compress the message.

Syntax

property EnableCompression: Boolean read get_EnableCompression write set_EnableCompression;

Default Value

false

Remarks

This property specifies whether the input data will be compressed during the signing process.

If set to True the data will be compressed. If set to False (default) the data will not be compressed.

When compression is enabled the input will first be signed, and then compressed. To compress the data before signing set CompressBeforeSign.

EncryptionAlgorithm Property (CMS Component)

The algorithm used for encryption.

Syntax

property EncryptionAlgorithm: String read get_EncryptionAlgorithm write set_EncryptionAlgorithm;

Default Value

'3DES'

Remarks

This property specifies the encryption algorithm used when Encrypt is called.

This may be the name of the algorithm, or the corresponding OID of the algorithm. The default value is 3DES. Possible values are:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

IncludeCertificates Property (CMS Component)

Specifies whether to include the signer's certificate with the signed message.

Syntax

property IncludeCertificates: TipcIncludeCertificates read get_IncludeCertificates write set_IncludeCertificates;

TipcIncludeCertificates = (
  icsNone,
  icsSignerCerts,
  icsSignerCertsAndChain
);

Default Value

icsSignerCerts

Remarks

This setting specifies which certificates (if any) are included in the signed message. By default the public certificate of the certificate used to sign the message is included. This allows the receiving party to verify the signature without any additional knowledge. If this is set to icsNone the recipient must obtain and specify the public certificate to be used for signature verification. Possible values are:

InputFile Property (CMS Component)

The file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which 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 PEM, DER, or SMIME encoded 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:

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

InputMessage Property (CMS Component)

The message to process.

Syntax

property InputMessage: String read get_InputMessage write set_InputMessage;
property InputMessageB: TBytes read get_InputMessageB write set_InputMessageB;

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 PEM, DER, or SMIME encoded 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:

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

OutputFile Property (CMS Component)

The output file.

Syntax

property OutputFile: String read get_OutputFile write set_OutputFile;

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

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

OutputFormat Property (CMS Component)

Specifies the output format.

Syntax

property OutputFormat: String read get_OutputFormat write set_OutputFormat;

Default Value

'PEM'

Remarks

This property specifies the format of the output message created when calling Sign, Encrypt, or SignAndEncrypt.

The various formats allow for easier transport of the signed or encrypted message, as well as interoperability with other utilities.

Possible values are:

-----BEGIN CMS-----
MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD
b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy
...
mlJLPoCw5pf3Cjae56oXs29IZMcDXKersNjFGYSaG0o9k3lAcj9llLFh54Xr1ljx7K0VpVvlrmgu
kNHAf7cUvvilW/KrDa+T2n+sOFAAAAAAAAA=
-----END CMS-----

Mime-Version: 1.0
Content-Type: application/pkcs7-mime; smime-type=signed-data; name="smime.p7m"
Content-Transfer-Encoding: base64
Content-Disposition: attachment; filename="smime.p7m"

MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD
b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy
...
Mpc/PtPNeHA3CCFGRFnHju/yb9CsQWpgf8TTWytjP7O1hFUecW0yiuGSDeeNlQ4ZcX0TOm6haRMT
lqYIrHUNMn4tYaREevNBL9CQB8MAAAAAAAA=

OutputMessage Property (CMS Component)

The output message after processing.

Syntax

property OutputMessage: String read get_OutputMessage;
property OutputMessageB: TBytes read get_OutputMessageB;

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

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

This property is read-only.

RecipientCertCount Property (CMS Component)

The number of records in the RecipientCert arrays.

Syntax

property RecipientCertCount: Integer read get_RecipientCertCount write set_RecipientCertCount;

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.

RecipientCertEncoded Property (CMS Component)

This is the certificate (PEM/base64 encoded).

Syntax

property RecipientCertEncoded[RecipientCertIndex: Integer]: String read get_RecipientCertEncoded write set_RecipientCertEncoded;
property RecipientCertEncodedB[RecipientCertIndex: Integer]: TBytes read get_RecipientCertEncodedB write set_RecipientCertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject 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.

RecipientCertStore Property (CMS Component)

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

Syntax

property RecipientCertStore[RecipientCertIndex: Integer]: String read get_RecipientCertStore write set_RecipientCertStore;
property RecipientCertStoreB[RecipientCertIndex: Integer]: TBytes read get_RecipientCertStoreB write set_RecipientCertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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. PKCS12 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.

RecipientCertStorePassword Property (CMS 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 RecipientCertStorePassword[RecipientCertIndex: Integer]: String read get_RecipientCertStorePassword write set_RecipientCertStorePassword;

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.

RecipientCertStoreType Property (CMS Component)

This is the type of certificate store for this certificate.

Syntax

property RecipientCertStoreType[RecipientCertIndex: Integer]: TipcCertStoreTypes read get_RecipientCertStoreType write set_RecipientCertStoreType;

TipcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

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.

RecipientCertSubject Property (CMS Component)

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

Syntax

property RecipientCertSubject[RecipientCertIndex: Integer]: String read get_RecipientCertSubject write set_RecipientCertSubject;

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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.

SignatureHashAlgorithm Property (CMS Component)

The signature hash algorithm used during signing.

Syntax

property SignatureHashAlgorithm: String read get_SignatureHashAlgorithm write set_SignatureHashAlgorithm;

Default Value

'SHA256'

Remarks

This property specifies the signature hash algorithm used when Sign is called.

When Sign is called the input data is first hashed with the algorithm specified by this property to produce a message digest. The computed digest is then digitally signed with the certificates specified in Certificates.

The value specified here may be the name of the algorithm or the corresponding OID. Possible values are:

• "SHA-256" (default)
• "SHA-384"
• "SHA-512"
• "SHA-224"
• "SHA1"
• "MD5"

SignerCertCount Property (CMS Component)

The number of records in the SignerCert arrays.

Syntax

property SignerCertCount: Integer read get_SignerCertCount write set_SignerCertCount;

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerCertEncoded
• SignerCertStore
• SignerCertStorePassword
• SignerCertStoreType
• SignerCertSubject

The array indices start at 0 and end at SignerCertCount - 1.

This property is not available at design time.

SignerCertEncoded Property (CMS Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SignerCertEncoded[SignerCertIndex: Integer]: String read get_SignerCertEncoded write set_SignerCertEncoded;
property SignerCertEncodedB[SignerCertIndex: Integer]: TBytes read get_SignerCertEncodedB write set_SignerCertEncodedB;

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

This property is not available at design time.

SignerCertStore Property (CMS Component)

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

Syntax

property SignerCertStore[SignerCertIndex: Integer]: String read get_SignerCertStore write set_SignerCertStore;
property SignerCertStoreB[SignerCertIndex: Integer]: TBytes read get_SignerCertStoreB write set_SignerCertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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. PKCS12 certificate store).

The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

This property is not available at design time.

SignerCertStorePassword Property (CMS 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 SignerCertStorePassword[SignerCertIndex: Integer]: String read get_SignerCertStorePassword write set_SignerCertStorePassword;

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 SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

This property is not available at design time.

SignerCertStoreType Property (CMS Component)

This is the type of certificate store for this certificate.

Syntax

property SignerCertStoreType[SignerCertIndex: Integer]: TipcCertStoreTypes read get_SignerCertStoreType write set_SignerCertStoreType;

TipcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

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 SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

This property is not available at design time.

SignerCertSubject Property (CMS Component)

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

Syntax

property SignerCertSubject[SignerCertIndex: Integer]: String read get_SignerCertSubject write set_SignerCertSubject;

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

This property is not available at design time.

UseOAEP Property (CMS Component)

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

Syntax

property UseOAEP: Boolean read get_UseOAEP write set_UseOAEP;

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

UsePSS Property (CMS Component)

Whether to use RSA-PSS during signing and verification.

Syntax

property UsePSS: Boolean read get_UsePSS write set_UsePSS;

Default Value

false

Remarks

This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False.

AddCertificate Method (CMS Component)

Used to add certificates for signing.

Syntax

procedure AddCertificate(CertStoreType: Integer; CertStore: String; CertStorePassword: String; CertSubject: String);

Remarks

This method adds a signing certificate. Signing certificates may be added using this method or by adding a certificate directly to Certificates.

The added certificate(s) will be used to sign the message when Sign is called.

CertStoreType specifies the type of certificate store. 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:

CertStore specifies the path to the certificate file. If the CertStoreType is a blob, this specifies the certificate content. See Certificates for details.

CertStorePassword is the password for the certificate (if any).

CertSubject specified the subject of the certificate to load. 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 displayed below.

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

AddRecipientCert Method (CMS Component)

Used to add recipient certificates used to encrypt messages.

Syntax

procedure AddRecipientCert(CertEncoded: TBytes);

Remarks

This method adds a public certificate used when Encrypt is called. Public certificates of recipients may be added using this method or by adding a certificate directly to the RecipientCerts property.

CertEncoded must contain the PEM or Base64 encoded public certificate.

Config Method (CMS Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

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

Decrypts the current message.

Syntax

procedure Decrypt();

Remarks

Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling AddCertificate or setting the Certificates property.

If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.

The following properties are applicable when calling this method:

• Certificates (Required)

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:

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

Encrypt and Decrypt a message Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt a message - DER Output Format Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Multiple Recipients Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Get Recipient Info Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage;

DecryptAndVerifySignature Method (CMS Component)

Decrypts and verifies the signature of the current message.

Syntax

procedure DecryptAndVerifySignature();

Remarks

This method decrypts the input data and verifies the signature. Decryption certificates are specified by calling AddCertificate or setting the Certificates property. Certificates used to verify the signature will be taken from the message itself if included, or from the SignerCerts property.

If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.

In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling AddRecipientCert or setting RecipientCerts.

When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.

The following properties are applicable when calling this method:

• Certificates (Required)
• DetachedSignature
• DetachedSignatureData
• EnableCompression
• SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.

If the input message is compressed EnableCompression must be set to True before calling this method.

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:

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

Encrypt Method (CMS Component)

Encrypts the current message.

Syntax

procedure Encrypt();

Remarks

Encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling AddRecipientCert or setting the RecipientCerts property.

OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. The following properties are applicable when calling this method:

• RecipientCerts (required)
• EncryptionAlgorithm
• OutputFormat
• UseOAEP

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:

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

Encrypt and Decrypt a message Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt a message - DER Output Format Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Multiple Recipients Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; Encrypt and Decrypt - Get Recipient Info Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage;

GetRecipientInfo Method (CMS Component)

Gets the recipient certificate information for an encrypted message.

Syntax

procedure GetRecipientInfo();

Remarks

This method retrieves information about the recipient(s) of the encrypted message. This may be called prior to calling Decrypt to determine which certificate should be loaded for decryption.

When this method is called the RecipientInfo event fires once for each recipient found within the message. Use the parameters of the RecipientInfo to determine which certificate to specify via AddCertificate or Certificates before calling Decrypt.

GetSignerCertInfo Method (CMS Component)

This method gets the signature information for an signed message.

Syntax

procedure 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 (CMS Component)

This method resets the component properties.

Syntax

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

SetInputStream Method (CMS Component)

Sets the stream from which the component will read data to encode or decode.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

This method sets the stream from which the component will read data to process.

Encrypt or Sign

When encrypting or signing this may be set to a stream with the content that will be encrypted and/or signed.

Decrypt or Verify

When decrypting or verifying a signature this may be set to a stream with the encrypted or signed 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:

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

SetOutputStream Method (CMS Component)

Sets the stream to which the component will read data to encode or decode.

Syntax

procedure SetOutputStream(OutputStream: TStream);

Remarks

This method sets the stream to which the component will write processed data.

Encrypt or Sign

When encrypting or signing this may be set to a stream where the signed/encrypted data will be written.

Decrypt or Verify

When decrypting or verifying a signature this may be set to a stream where the decrypted/verified data 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:

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

Sign Method (CMS Component)

Signs the current message.

Syntax

procedure Sign();

Remarks

Sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling AddCertificate or setting the Certificates property.

OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. IncludeCertificates specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:

• Certificates (required)
• DetachedSignature
• EnableCompression
• GenerateSignatureTimestamp
• IncludeCertificates
• OutputFormat
• SignatureHashAlgorithm
• UsePSS

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:

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

Sign and Verify a message Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - DER Output Format Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - Detached Signature Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); Sign and Verify a message - Multiple Signatures Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - No Included Certificate Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage;

SignAndEncrypt Method (CMS Component)

Signs and encrypts the current message.

Syntax

procedure SignAndEncrypt();

Remarks

This method signs encrypts the input data with the the specified certificate(s). Encryption certificates are specified by calling AddRecipientCert or setting the RecipientCerts property. Signing certificates are set via the Certificates property.

OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. IncludeCertificates specifies whether the public certificate is included in the signed message. The following properties are applicable when calling this method:

• Certificates (required)
• RecipientCerts (required)
• DetachedSignature
• EnableCompression
• EncryptionAlgorithm
• GenerateSignatureTimestamp
• IncludeCertificates
• OutputFormat
• SignatureHashAlgorithm
• UseOAEP
• UsePSS

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:

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

VerifySignature Method (CMS Component)

Verifies the signature of the current message.

Syntax

procedure VerifySignature();

Remarks

VerifySignature verifies the signature of the input message.

In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling AddRecipientCert or setting RecipientCerts.

When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.

The following property are applicable when calling this method:

• DetachedSignature
• DetachedSignatureData
• EnableCompression
• SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.

If the input message is compressed EnableCompression must be set to True before calling this method.

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:

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

Sign and Verify a message Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - DER Output Format Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - Detached Signature Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); Sign and Verify a message - Multiple Signatures Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; Sign and Verify a message - No Included Certificate Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage;

Error Event (CMS Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (CMS Component)

Fires with log information during processing.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

This event fires during processing with log information. The level of detail that is logged is controlled via the LogLevel.

LogLevel indicates the level of message. Possible values are:

LogMessage is the log entry.

LogType indicates the type of log. Possible values are:

• "INFO"
• "ENCRYPT"
• "COMPRESS"
• "SIGN"
• "DECRYPT"
• "DECOMPRESS"
• "VERIFY"
• "DEBUG"

RecipientInfo Event (CMS Component)

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

Syntax

type TRecipientInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  const EncryptionAlgorithm: String
) of Object;

property OnRecipientInfo: TRecipientInfoEvent 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 (CMS Component)

Fired during verification of the signed message.

Syntax

type TSignerCertInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  CertEncoded: String;
  CertEncodedB: TBytes
) of Object;

property OnSignerCertInfo: TSignerCertInfoEvent read FOnSignerCertInfo write FOnSignerCertInfo;

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters which are populated depends on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCerts in order 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 SignerCerts 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 (CMS Component)

Trappable Errors (CMS Component)

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