# CMS Component The CMS component is used to digitally sign, encrypt, verify, and decrypt data. ## Syntax ```text TipcCMS ``` ## Remarks The CMS component implements the Cryptographic Message Syntax and allow for various cryptographic operations to be performed on data including: - [Sign](#sign-method-cms-component) - [VerifySignature](#verifysignature-method-cms-component) - [Encrypt](#encrypt-method-cms-component) - [Decrypt](#decrypt-method-cms-component) - [SignAndEncrypt](#signandencrypt-method-cms-component) - [DecryptAndVerifySignature](#decryptandverifysignature-method-cms-component) The component can generate and consume message in a variety of formats including *PEM*, *DER* (Binary), and *SMIME*. The [EncryptionAlgorithm](#encryptionalgorithm-property-cms-component) and [SignatureHashAlgorithm](#signaturehashalgorithm-property-cms-component) 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](#getrecipientinfo-method-cms-component) and [GetSignerCertInfo](#getsignercertinfo-method-cms-component) methods as well as the [RecipientInfo](#recipientinfo-event-cms-component) and [SignerCertInfo](#signercertinfo-event-cms-component) 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 [Sign](#sign-method-cms-component) digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [AddCertificate](#addcertificate-method-cms-component) or setting the Certificates property. [OutputFormat](#outputformat-property-cms-component) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [IncludeCertificates](#includecertificates-property-cms-component) 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](#detachedsignature-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [IncludeCertificates](#includecertificates-property-cms-component) - [OutputFormat](#outputformat-property-cms-component) - [SignatureHashAlgorithm](#signaturehashalgorithm-property-cms-component) - [UsePSS](#usepss-property-cms-component) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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 [Encrypt](#encrypt-method-cms-component) encrypts the input data with the the specified certificate(s). Certificates are specified by calling [AddRecipientCert](#addrecipientcert-method-cms-component) or setting the RecipientCerts property. [OutputFormat](#outputformat-property-cms-component) 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](#encryptionalgorithm-property-cms-component) - [OutputFormat](#outputformat-property-cms-component) - [UseOAEP](#useoaep-property-cms-component) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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 [VerifySignature](#verifysignature-method-cms-component) 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](#addrecipientcert-method-cms-component) or setting RecipientCerts. When this method is called the [SignerCertInfo](#signercertinfo-event-cms-component) 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](#signercertinfo-event-cms-component) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [SignerCertInfo](#signercertinfo-event-cms-component) is populated the certificate required for verification is already present in the message. The following property are applicable when calling this method: - [DetachedSignature](#detachedsignature-property-cms-component) - [DetachedSignatureData](#detachedsignaturedata-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - SignerCerts If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-cms-component). In addition the [DetachedSignature](#detachedsignature-property-cms-component) 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](#enablecompression-property-cms-component) 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: - [InputFile](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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](#decrypt-method-cms-component) decrypts the input data with the specified certificate. Certificates are specified by calling [AddCertificate](#addcertificate-method-cms-component) or setting the Certificates property. If the certificate used to encrypt the message is not known ahead of time [GetRecipientInfo](#getrecipientinfo-method-cms-component) may be called prior to calling [Decrypt](#decrypt-method-cms-component) to obtain information about the recipient (the entity the for which the message was encrypted). If [GetRecipientInfo](#getrecipientinfo-method-cms-component) is called, the [RecipientInfo](#recipientinfo-event-cms-component) 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) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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.* | | | | --- | --- | | [CertCount](#certcount-property-cms-component) | The number of records in the Cert arrays. | | [CertEffectiveDate](#certeffectivedate-property-cms-component) | The date on which this certificate becomes valid. | | [CertExpirationDate](#certexpirationdate-property-cms-component) | The date on which the certificate expires. | | [CertExtendedKeyUsage](#certextendedkeyusage-property-cms-component) | A comma-delimited list of extended key usage identifiers. | | [CertFingerprint](#certfingerprint-property-cms-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [CertFingerprintSHA1](#certfingerprintsha1-property-cms-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [CertFingerprintSHA256](#certfingerprintsha256-property-cms-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [CertIssuer](#certissuer-property-cms-component) | The issuer of the certificate. | | [CertPrivateKey](#certprivatekey-property-cms-component) | The private key of the certificate (if available). | | [CertPrivateKeyAvailable](#certprivatekeyavailable-property-cms-component) | Whether a PrivateKey is available for the selected certificate. | | [CertPrivateKeyContainer](#certprivatekeycontainer-property-cms-component) | The name of the PrivateKey container for the certificate (if available). | | [CertPublicKey](#certpublickey-property-cms-component) | The public key of the certificate. | | [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-cms-component) | The textual description of the certificate's public key algorithm. | | [CertPublicKeyLength](#certpublickeylength-property-cms-component) | The length of the certificate's public key (in bits). | | [CertSerialNumber](#certserialnumber-property-cms-component) | The serial number of the certificate encoded as a string. | | [CertSignatureAlgorithm](#certsignaturealgorithm-property-cms-component) | The text description of the certificate's signature algorithm. | | [CertStore](#certstore-property-cms-component) | The name of the certificate store for the client certificate. | | [CertStorePassword](#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. | | [CertStoreType](#certstoretype-property-cms-component) | The type of certificate store for this certificate. | | [CertSubjectAltNames](#certsubjectaltnames-property-cms-component) | Comma-separated lists of alternative subject names for the certificate. | | [CertThumbprintMD5](#certthumbprintmd5-property-cms-component) | The MD5 hash of the certificate. | | [CertThumbprintSHA1](#certthumbprintsha1-property-cms-component) | The SHA-1 hash of the certificate. | | [CertThumbprintSHA256](#certthumbprintsha256-property-cms-component) | The SHA-256 hash of the certificate. | | [CertUsage](#certusage-property-cms-component) | The text description of UsageFlags . | | [CertUsageFlags](#certusageflags-property-cms-component) | The flags that show intended use for the certificate. | | [CertVersion](#certversion-property-cms-component) | The certificate's version number. | | [CertSubject](#certsubject-property-cms-component) | The subject of the certificate used for client authentication. | | [CertEncoded](#certencoded-property-cms-component) | The certificate (PEM/Base64 encoded). | | [DetachedSignature](#detachedsignature-property-cms-component) | Specifies whether to include a detached signature when signing a message. | | [DetachedSignatureData](#detachedsignaturedata-property-cms-component) | The detached signature. | | [EnableCompression](#enablecompression-property-cms-component) | Specifies whether to compress the message. | | [EncryptionAlgorithm](#encryptionalgorithm-property-cms-component) | The algorithm used for encryption. | | [IncludeCertificates](#includecertificates-property-cms-component) | Specifies whether to include the signer's certificate with the signed message. | | [InputFile](#inputfile-property-cms-component) | The file to process. | | [InputMessage](#inputmessage-property-cms-component) | The message to process. | | [OutputFile](#outputfile-property-cms-component) | The output file. | | [OutputFormat](#outputformat-property-cms-component) | Specifies the output format. | | [OutputMessage](#outputmessage-property-cms-component) | The output message after processing. | | [RecipientCertCount](#recipientcertcount-property-cms-component) | The number of records in the RecipientCert arrays. | | [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-cms-component) | The date on which this certificate becomes valid. | | [RecipientCertExpirationDate](#recipientcertexpirationdate-property-cms-component) | The date on which the certificate expires. | | [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-cms-component) | A comma-delimited list of extended key usage identifiers. | | [RecipientCertFingerprint](#recipientcertfingerprint-property-cms-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-cms-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-cms-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [RecipientCertIssuer](#recipientcertissuer-property-cms-component) | The issuer of the certificate. | | [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) | The private key of the certificate (if available). | | [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-cms-component) | Whether a PrivateKey is available for the selected certificate. | | [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-cms-component) | The name of the PrivateKey container for the certificate (if available). | | [RecipientCertPublicKey](#recipientcertpublickey-property-cms-component) | The public key of the certificate. | | [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-cms-component) | The textual description of the certificate's public key algorithm. | | [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-cms-component) | The length of the certificate's public key (in bits). | | [RecipientCertSerialNumber](#recipientcertserialnumber-property-cms-component) | The serial number of the certificate encoded as a string. | | [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-cms-component) | The text description of the certificate's signature algorithm. | | [RecipientCertStore](#recipientcertstore-property-cms-component) | The name of the certificate store for the client certificate. | | [RecipientCertStorePassword](#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. | | [RecipientCertStoreType](#recipientcertstoretype-property-cms-component) | The type of certificate store for this certificate. | | [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-cms-component) | Comma-separated lists of alternative subject names for the certificate. | | [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-cms-component) | The MD5 hash of the certificate. | | [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-cms-component) | The SHA-1 hash of the certificate. | | [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-cms-component) | The SHA-256 hash of the certificate. | | [RecipientCertUsage](#recipientcertusage-property-cms-component) | The text description of UsageFlags . | | [RecipientCertUsageFlags](#recipientcertusageflags-property-cms-component) | The flags that show intended use for the certificate. | | [RecipientCertVersion](#recipientcertversion-property-cms-component) | The certificate's version number. | | [RecipientCertSubject](#recipientcertsubject-property-cms-component) | The subject of the certificate used for client authentication. | | [RecipientCertEncoded](#recipientcertencoded-property-cms-component) | The certificate (PEM/Base64 encoded). | | [SignatureHashAlgorithm](#signaturehashalgorithm-property-cms-component) | The signature hash algorithm used during signing. | | [SignerCertCount](#signercertcount-property-cms-component) | The number of records in the SignerCert arrays. | | [SignerCertEffectiveDate](#signercerteffectivedate-property-cms-component) | The date on which this certificate becomes valid. | | [SignerCertExpirationDate](#signercertexpirationdate-property-cms-component) | The date on which the certificate expires. | | [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-cms-component) | A comma-delimited list of extended key usage identifiers. | | [SignerCertFingerprint](#signercertfingerprint-property-cms-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-cms-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-cms-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertIssuer](#signercertissuer-property-cms-component) | The issuer of the certificate. | | [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) | The private key of the certificate (if available). | | [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-cms-component) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-cms-component) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertPublicKey](#signercertpublickey-property-cms-component) | The public key of the certificate. | | [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-cms-component) | The textual description of the certificate's public key algorithm. | | [SignerCertPublicKeyLength](#signercertpublickeylength-property-cms-component) | The length of the certificate's public key (in bits). | | [SignerCertSerialNumber](#signercertserialnumber-property-cms-component) | The serial number of the certificate encoded as a string. | | [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-cms-component) | The text description of the certificate's signature algorithm. | | [SignerCertStore](#signercertstore-property-cms-component) | The name of the certificate store for the client certificate. | | [SignerCertStorePassword](#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. | | [SignerCertStoreType](#signercertstoretype-property-cms-component) | The type of certificate store for this certificate. | | [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-cms-component) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-cms-component) | The MD5 hash of the certificate. | | [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-cms-component) | The SHA-1 hash of the certificate. | | [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-cms-component) | The SHA-256 hash of the certificate. | | [SignerCertUsage](#signercertusage-property-cms-component) | The text description of UsageFlags . | | [SignerCertUsageFlags](#signercertusageflags-property-cms-component) | The flags that show intended use for the certificate. | | [SignerCertVersion](#signercertversion-property-cms-component) | The certificate's version number. | | [SignerCertSubject](#signercertsubject-property-cms-component) | The subject of the certificate used for client authentication. | | [SignerCertEncoded](#signercertencoded-property-cms-component) | The certificate (PEM/Base64 encoded). | | [UseOAEP](#useoaep-property-cms-component) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). | | [UsePSS](#usepss-property-cms-component) | Whether to use RSA-PSS during signing and verification. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddCertificate](#addcertificate-method-cms-component) | Used to add certificates for signing. | | [AddRecipientCert](#addrecipientcert-method-cms-component) | Used to add recipient certificates used to encrypt messages. | | [Config](#config-method-cms-component) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-cms-component) | Decrypts the current message. | | [DecryptAndVerifySignature](#decryptandverifysignature-method-cms-component) | Decrypts and verifies the signature of the current message. | | [Encrypt](#encrypt-method-cms-component) | Encrypts the current message. | | [GetRecipientInfo](#getrecipientinfo-method-cms-component) | Gets the recipient certificate information for an encrypted message. | | [GetSignerCertInfo](#getsignercertinfo-method-cms-component) | This method gets the signature information for an signed message. | | [Reset](#reset-method-cms-component) | This method resets the component properties. | | [Sign](#sign-method-cms-component) | Signs the current message. | | [SignAndEncrypt](#signandencrypt-method-cms-component) | Signs and encrypts the current message. | | [VerifySignature](#verifysignature-method-cms-component) | Verifies the signature of the current message. | ## 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.* | | | | --- | --- | | [Error](#error-event-cms-component) | Fired when information is available about errors during data delivery. | | [Log](#log-event-cms-component) | Fires with log information during processing. | | [RecipientInfo](#recipientinfo-event-cms-component) | This event is fired for each recipient certificate of the encrypted message. | | [SignerCertInfo](#signercertinfo-event-cms-component) | Fired during verification of the signed message. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CompressBeforeSign](#CompressBeforeSign) | Specifies whether to compress before signing. | | [ContentTypeOID](#ContentTypeOID) | Specifies the oid for content type. | | [CSP](#CSP) | The Cryptographic Service Provider. | | [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) | Whether to generate timestamps in signatures. | | [IncludeHeaders](#IncludeHeaders) | Tells the component whether to include the headers when encoding the message. | | [IncludeInternalHeaders](#IncludeInternalHeaders) | Tells the component whether or not to include the internal headers when encoding the message. | | [InputContentTransferEncoding](#InputContentTransferEncoding) | Sets the Content-Transfer-Encoding for the signed message. | | [InputContentType](#InputContentType) | Sets the Content-Type for the signed message. | | [InputMessageHeaders](#InputMessageHeaders) | Message headers. | | [LogDirectory](#LogDirectory) | The directory on disk where debug logs are written. | | [LogFileName](#LogFileName) | The base filename to use with LogDirectory. | | [LogLevel](#LogLevel) | The level of detail for log messages. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used with OAEP. | | [OutputMessageHeaders](#OutputMessageHeaders) | The SMIME headers of the output message. | | [RecipientInfoType](#RecipientInfoType) | The type of signer information to include in the signed message. | | [SignatureTimestamp](#SignatureTimestamp) | The signature timestamp in the signed message. | | [SignerInfoType](#SignerInfoType) | The type of signer information to include in the signed message. | | [UseAlgorithmOIDs](#UseAlgorithmOIDs) | Whether OIDs are used when providing information about the algorithms. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # CertCount Property ([CMS](#cms-component) Component) The number of records in the Cert arrays. ## Syntax *C++ Builder Syntax* ```text __property int CertCount = { read=FCertCount, write=FSetCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CertEffectiveDate](#certeffectivedate-property-cms-component) - [CertEncoded](#certencoded-property-cms-component) - [CertExpirationDate](#certexpirationdate-property-cms-component) - [CertExtendedKeyUsage](#certextendedkeyusage-property-cms-component) - [CertFingerprint](#certfingerprint-property-cms-component) - [CertFingerprintSHA1](#certfingerprintsha1-property-cms-component) - [CertFingerprintSHA256](#certfingerprintsha256-property-cms-component) - [CertIssuer](#certissuer-property-cms-component) - [CertPrivateKey](#certprivatekey-property-cms-component) - [CertPrivateKeyAvailable](#certprivatekeyavailable-property-cms-component) - [CertPrivateKeyContainer](#certprivatekeycontainer-property-cms-component) - [CertPublicKey](#certpublickey-property-cms-component) - [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-cms-component) - [CertPublicKeyLength](#certpublickeylength-property-cms-component) - [CertSerialNumber](#certserialnumber-property-cms-component) - [CertSignatureAlgorithm](#certsignaturealgorithm-property-cms-component) - [CertStore](#certstore-property-cms-component) - [CertStorePassword](#certstorepassword-property-cms-component) - [CertStoreType](#certstoretype-property-cms-component) - [CertSubject](#certsubject-property-cms-component) - [CertSubjectAltNames](#certsubjectaltnames-property-cms-component) - [CertThumbprintMD5](#certthumbprintmd5-property-cms-component) - [CertThumbprintSHA1](#certthumbprintsha1-property-cms-component) - [CertThumbprintSHA256](#certthumbprintsha256-property-cms-component) - [CertUsage](#certusage-property-cms-component) - [CertUsageFlags](#certusageflags-property-cms-component) - [CertVersion](#certversion-property-cms-component) The array indices start at *0* and end at *CertCount - 1*. This property is not available at design time. ## Data Type Integer # CertEffectiveDate Property ([CMS](#cms-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String CertEffectiveDate[int CertIndex] = { read=FCertEffectiveDate }; ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertExpirationDate Property ([CMS](#cms-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String CertExpirationDate[int CertIndex] = { read=FCertExpirationDate }; ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertExtendedKeyUsage Property ([CMS](#cms-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String CertExtendedKeyUsage[int CertIndex] = { read=FCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertFingerprint Property ([CMS](#cms-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprint[int CertIndex] = { read=FCertFingerprint }; ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertFingerprintSHA1 Property ([CMS](#cms-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprintSHA1[int CertIndex] = { read=FCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertFingerprintSHA256 Property ([CMS](#cms-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprintSHA256[int CertIndex] = { read=FCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertIssuer Property ([CMS](#cms-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertIssuer[int CertIndex] = { read=FCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertPrivateKey Property ([CMS](#cms-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String CertPrivateKey[int CertIndex] = { read=FCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [CertPrivateKey](#certprivatekey-property-cms-component) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-cms-component) returns 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](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertPrivateKeyAvailable Property ([CMS](#cms-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool CertPrivateKeyAvailable[int CertIndex] = { read=FCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [CertPrivateKey](#certprivatekey-property-cms-component) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-cms-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Boolean # CertPrivateKeyContainer Property ([CMS](#cms-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String CertPrivateKeyContainer[int CertIndex] = { read=FCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [CertPrivateKey](#certprivatekey-property-cms-component) container for the certificate (if available). This functionality is available only on Windows platforms. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertPublicKey Property ([CMS](#cms-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertPublicKey[int CertIndex] = { read=FCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertPublicKeyAlgorithm Property ([CMS](#cms-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String CertPublicKeyAlgorithm[int CertIndex] = { read=FCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertPublicKeyLength Property ([CMS](#cms-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int CertPublicKeyLength[int CertIndex] = { read=FCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # CertSerialNumber Property ([CMS](#cms-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String CertSerialNumber[int CertIndex] = { read=FCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertSignatureAlgorithm Property ([CMS](#cms-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String CertSignatureAlgorithm[int CertIndex] = { read=FCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertStore Property ([CMS](#cms-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertStore[int CertIndex] = { read=FCertStore, write=FSetCertStore }; __property DynamicArray CertStoreB[int CertIndex] = { read=FCertStoreB, write=FSetCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [CertStoreType](#certstoretype-property-cms-component) property denotes the type of the certificate store specified by [CertStore](#certstore-property-cms-component). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-cms-component). [CertStore](#certstore-property-cms-component) is used in conjunction with the [CertSubject](#certsubject-property-cms-component) property to specify client certificates. If [CertStore](#certstore-property-cms-component) has a value, and [CertSubject](#certsubject-property-cms-component) or [CertEncoded](#certencoded-property-cms-component) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-cms-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # CertStorePassword Property ([CMS](#cms-component) 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 *C++ Builder Syntax* ```text __property String CertStorePassword[int CertIndex] = { 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. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is not available at design time. ## Data Type String # CertStoreType Property ([CMS](#cms-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TipcCMSCertStoreTypes CertStoreType[int CertIndex] = { read=FCertStoreType, write=FSetCertStoreType }; enum TipcCMSCertStoreTypes { 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-cms-component), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-cms-component), and the PIN as the [CertStorePassword](#certstorepassword-property-cms-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CertStore](#certstore-property-cms-component) and set [CertStorePassword](#certstorepassword-property-cms-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is not available at design time. ## Data Type Integer # CertSubjectAltNames Property ([CMS](#cms-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertSubjectAltNames[int CertIndex] = { read=FCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertThumbprintMD5 Property ([CMS](#cms-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintMD5[int CertIndex] = { read=FCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertThumbprintSHA1 Property ([CMS](#cms-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintSHA1[int CertIndex] = { read=FCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertThumbprintSHA256 Property ([CMS](#cms-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintSHA256[int CertIndex] = { read=FCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertUsage Property ([CMS](#cms-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String CertUsage[int CertIndex] = { read=FCertUsage }; ``` ## Default Value "" ## Remarks The text description of [CertUsageFlags](#certusageflags-property-cms-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertUsageFlags Property ([CMS](#cms-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int CertUsageFlags[int CertIndex] = { read=FCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-cms-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [CertUsage](#certusage-property-cms-component) property for a text representation of [CertUsageFlags](#certusageflags-property-cms-component). This functionality currently is not available when the provider is OpenSSL. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # CertVersion Property ([CMS](#cms-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String CertVersion[int CertIndex] = { read=FCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # CertSubject Property ([CMS](#cms-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String CertSubject[int CertIndex] = { read=FCertSubject, write=FSetCertSubject }; ``` ## Default Value "" ## Remarks 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-cms-component) property. This property is not available at design time. ## Data Type String # CertEncoded Property ([CMS](#cms-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String CertEncoded[int CertIndex] = { read=FCertEncoded, write=FSetCertEncoded }; __property DynamicArray CertEncodedB[int CertIndex] = { read=FCertEncodedB, write=FSetCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-cms-component) and [CertSubject](#certsubject-property-cms-component) properties also may be used to specify a certificate. When [CertEncoded](#certencoded-property-cms-component) is set, a search is initiated in the current [CertStore](#certstore-property-cms-component) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-cms-component) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-cms-component) 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](#certcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # DetachedSignature Property ([CMS](#cms-component) Component) Specifies whether to include a detached signature when signing a message. ## Syntax *C++ Builder Syntax* ```text __property bool DetachedSignature = { read=FDetachedSignature, write=FSetDetachedSignature }; ``` ## Default Value false ## Remarks This property specifies whether the [Sign](#sign-method-cms-component) 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](#sign-method-cms-component) operation must be passed to the receiving party for signature verification. ## Data Type Boolean # DetachedSignatureData Property ([CMS](#cms-component) Component) The detached signature. ## Syntax *C++ Builder Syntax* ```text __property String DetachedSignatureData = { read=FDetachedSignatureData, write=FSetDetachedSignatureData }; __property DynamicArray DetachedSignatureDataB = { read=FDetachedSignatureDataB, write=FSetDetachedSignatureDataB }; ``` ## Default Value "" ## Remarks This setting is used to specify the detached signature before calling [VerifySignature](#verifysignature-method-cms-component). 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. ## Data Type Byte Array # EnableCompression Property ([CMS](#cms-component) Component) Specifies whether to compress the message. ## Syntax *C++ Builder Syntax* ```text __property bool EnableCompression = { read=FEnableCompression, write=FSetEnableCompression }; ``` ## 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](#CompressBeforeSign). ## Data Type Boolean # EncryptionAlgorithm Property ([CMS](#cms-component) Component) The algorithm used for encryption. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm }; ``` ## Default Value "3DES" ## Remarks This property specifies the encryption algorithm used when [Encrypt](#encrypt-method-cms-component) 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" ## Data Type String # IncludeCertificates Property ([CMS](#cms-component) Component) Specifies whether to include the signer's certificate with the signed message. ## Syntax *C++ Builder Syntax* ```text __property TipcCMSIncludeCertificates IncludeCertificates = { read=FIncludeCertificates, write=FSetIncludeCertificates }; enum TipcCMSIncludeCertificates { icsNone=0, icsSignerCerts=1, icsSignerCertsAndChain=2 }; ``` ## 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: | Value | Description | | --- | --- | | 0 (icsNone) | No signer certificates are included. | | 1 (icsSignerCerts - default) | The certificates specified in Certificates are included. | | 2 (icsSignerCertsAndChain) | The certificates specified in Certificates and the full chain of each certificate are included. | ## Data Type Integer # InputFile Property ([CMS](#cms-component) Component) The file to process. ## Syntax *C++ Builder Syntax* ```text __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 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: - InputFile - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. ## Data Type String # InputMessage Property ([CMS](#cms-component) Component) The message to process. ## Syntax *C++ Builder Syntax* ```text __property String InputMessage = { read=FInputMessage, write=FSetInputMessage }; __property DynamicArray 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 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: - [InputFile](#inputfile-property-cms-component) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. ## Data Type Byte Array # OutputFile Property ([CMS](#cms-component) Component) The output file. ## Syntax *C++ Builder Syntax* ```text __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 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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - OutputFile - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. ## Data Type String # OutputFormat Property ([CMS](#cms-component) Component) Specifies the output format. ## Syntax *C++ Builder Syntax* ```text __property String OutputFormat = { read=FOutputFormat, write=FSetOutputFormat }; ``` ## Default Value "PEM" ## Remarks This property specifies the format of the output message created when calling [Sign](#sign-method-cms-component), [Encrypt](#encrypt-method-cms-component), or [SignAndEncrypt](#signandencrypt-method-cms-component). The various formats allow for easier transport of the signed or encrypted message, as well as interoperability with other utilities. Possible values are: ```text -----BEGIN CMS----- MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy ... mlJLPoCw5pf3Cjae56oXs29IZMcDXKersNjFGYSaG0o9k3lAcj9llLFh54Xr1ljx7K0VpVvlrmgu kNHAf7cUvvilW/KrDa+T2n+sOFAAAAAAAAA= -----END CMS----- ``` ```text 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= ``` | Value | Description | | --- | --- | | PEM (default) | A PEM formatted message. For instance: | | DER | The message is binary (raw bytes). | | SMIME | The message is S/MIME encoded. For instance: | ## Data Type String # OutputMessage Property ([CMS](#cms-component) Component) The output message after processing. ## Syntax *C++ Builder Syntax* ```text __property String OutputMessage = { read=FOutputMessage }; __property DynamicArray OutputMessageB = { read=FOutputMessageB }; ``` ## Default Value "" ## Remarks This property will be populated with the output of the operation if [OutputFile](#outputfile-property-cms-component) 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: - [InputFile](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - OutputMessage: The output data is written to this property if no other destination is specified. This property is read-only. ## Data Type Byte Array # RecipientCertCount Property ([CMS](#cms-component) Component) The number of records in the RecipientCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int RecipientCertCount = { read=FRecipientCertCount, write=FSetRecipientCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-cms-component) - [RecipientCertEncoded](#recipientcertencoded-property-cms-component) - [RecipientCertExpirationDate](#recipientcertexpirationdate-property-cms-component) - [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-cms-component) - [RecipientCertFingerprint](#recipientcertfingerprint-property-cms-component) - [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-cms-component) - [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-cms-component) - [RecipientCertIssuer](#recipientcertissuer-property-cms-component) - [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) - [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-cms-component) - [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-cms-component) - [RecipientCertPublicKey](#recipientcertpublickey-property-cms-component) - [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-cms-component) - [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-cms-component) - [RecipientCertSerialNumber](#recipientcertserialnumber-property-cms-component) - [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-cms-component) - [RecipientCertStore](#recipientcertstore-property-cms-component) - [RecipientCertStorePassword](#recipientcertstorepassword-property-cms-component) - [RecipientCertStoreType](#recipientcertstoretype-property-cms-component) - [RecipientCertSubject](#recipientcertsubject-property-cms-component) - [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-cms-component) - [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-cms-component) - [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-cms-component) - [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-cms-component) - [RecipientCertUsage](#recipientcertusage-property-cms-component) - [RecipientCertUsageFlags](#recipientcertusageflags-property-cms-component) - [RecipientCertVersion](#recipientcertversion-property-cms-component) The array indices start at *0* and end at *RecipientCertCount - 1*. This property is not available at design time. ## Data Type Integer # RecipientCertEffectiveDate Property ([CMS](#cms-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertEffectiveDate[int RecipientCertIndex] = { read=FRecipientCertEffectiveDate }; ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertExpirationDate Property ([CMS](#cms-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertExpirationDate[int RecipientCertIndex] = { read=FRecipientCertExpirationDate }; ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertExtendedKeyUsage Property ([CMS](#cms-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertExtendedKeyUsage[int RecipientCertIndex] = { read=FRecipientCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprint Property ([CMS](#cms-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertFingerprint[int RecipientCertIndex] = { read=FRecipientCertFingerprint }; ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA1 Property ([CMS](#cms-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertFingerprintSHA1[int RecipientCertIndex] = { read=FRecipientCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA256 Property ([CMS](#cms-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertFingerprintSHA256[int RecipientCertIndex] = { read=FRecipientCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertIssuer Property ([CMS](#cms-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertIssuer[int RecipientCertIndex] = { read=FRecipientCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKey Property ([CMS](#cms-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertPrivateKey[int RecipientCertIndex] = { read=FRecipientCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) may be available but not exportable. In this case, [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) returns 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](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKeyAvailable Property ([CMS](#cms-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool RecipientCertPrivateKeyAvailable[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) is available for the selected certificate. If [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-cms-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Boolean # RecipientCertPrivateKeyContainer Property ([CMS](#cms-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertPrivateKeyContainer[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [RecipientCertPrivateKey](#recipientcertprivatekey-property-cms-component) container for the certificate (if available). This functionality is available only on Windows platforms. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKey Property ([CMS](#cms-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertPublicKey[int RecipientCertIndex] = { read=FRecipientCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyAlgorithm Property ([CMS](#cms-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertPublicKeyAlgorithm[int RecipientCertIndex] = { read=FRecipientCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyLength Property ([CMS](#cms-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int RecipientCertPublicKeyLength[int RecipientCertIndex] = { read=FRecipientCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertSerialNumber Property ([CMS](#cms-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertSerialNumber[int RecipientCertIndex] = { read=FRecipientCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertSignatureAlgorithm Property ([CMS](#cms-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertSignatureAlgorithm[int RecipientCertIndex] = { read=FRecipientCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertStore Property ([CMS](#cms-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertStore[int RecipientCertIndex] = { read=FRecipientCertStore, write=FSetRecipientCertStore }; __property DynamicArray RecipientCertStoreB[int RecipientCertIndex] = { read=FRecipientCertStoreB, write=FSetRecipientCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [RecipientCertStoreType](#recipientcertstoretype-property-cms-component) property denotes the type of the certificate store specified by [RecipientCertStore](#recipientcertstore-property-cms-component). If the store is password-protected, specify the password in [RecipientCertStorePassword](#recipientcertstorepassword-property-cms-component). [RecipientCertStore](#recipientcertstore-property-cms-component) is used in conjunction with the [RecipientCertSubject](#recipientcertsubject-property-cms-component) property to specify client certificates. If [RecipientCertStore](#recipientcertstore-property-cms-component) has a value, and [RecipientCertSubject](#recipientcertsubject-property-cms-component) or [RecipientCertEncoded](#recipientcertencoded-property-cms-component) is set, a search for a certificate is initiated. Please see the [RecipientCertSubject](#recipientcertsubject-property-cms-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, 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](#recipientcertcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # RecipientCertStorePassword Property ([CMS](#cms-component) 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 *C++ Builder Syntax* ```text __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](#recipientcertcount-property-cms-component) property. This property is not available at design time. ## Data Type String # RecipientCertStoreType Property ([CMS](#cms-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TipcCMSRecipientCertStoreTypes RecipientCertStoreType[int RecipientCertIndex] = { read=FRecipientCertStoreType, write=FSetRecipientCertStoreType }; enum TipcCMSRecipientCertStoreTypes { 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [RecipientCertStoreType](#recipientcertstoretype-property-cms-component), the full path of the PKCS#11 DLL as the [RecipientCertStore](#recipientcertstore-property-cms-component), and the PIN as the [RecipientCertStorePassword](#recipientcertstorepassword-property-cms-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [RecipientCertStore](#recipientcertstore-property-cms-component) and set [RecipientCertStorePassword](#recipientcertstorepassword-property-cms-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is not available at design time. ## Data Type Integer # RecipientCertSubjectAltNames Property ([CMS](#cms-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertSubjectAltNames[int RecipientCertIndex] = { read=FRecipientCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintMD5 Property ([CMS](#cms-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertThumbprintMD5[int RecipientCertIndex] = { read=FRecipientCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA1 Property ([CMS](#cms-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertThumbprintSHA1[int RecipientCertIndex] = { read=FRecipientCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA256 Property ([CMS](#cms-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertThumbprintSHA256[int RecipientCertIndex] = { read=FRecipientCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsage Property ([CMS](#cms-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertUsage[int RecipientCertIndex] = { read=FRecipientCertUsage }; ``` ## Default Value "" ## Remarks The text description of [RecipientCertUsageFlags](#recipientcertusageflags-property-cms-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsageFlags Property ([CMS](#cms-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int RecipientCertUsageFlags[int RecipientCertIndex] = { read=FRecipientCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [RecipientCertUsageFlags](#recipientcertusageflags-property-cms-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [RecipientCertUsage](#recipientcertusage-property-cms-component) property for a text representation of [RecipientCertUsageFlags](#recipientcertusageflags-property-cms-component). This functionality currently is not available when the provider is OpenSSL. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertVersion Property ([CMS](#cms-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertVersion[int RecipientCertIndex] = { read=FRecipientCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertSubject Property ([CMS](#cms-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertSubject[int RecipientCertIndex] = { read=FRecipientCertSubject, write=FSetRecipientCertSubject }; ``` ## Default Value "" ## Remarks 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-cms-component) property. This property is not available at design time. ## Data Type String # RecipientCertEncoded Property ([CMS](#cms-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String RecipientCertEncoded[int RecipientCertIndex] = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded }; __property DynamicArray RecipientCertEncodedB[int RecipientCertIndex] = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RecipientCertStore](#recipientcertstore-property-cms-component) and [RecipientCertSubject](#recipientcertsubject-property-cms-component) properties also may be used to specify a certificate. When [RecipientCertEncoded](#recipientcertencoded-property-cms-component) is set, a search is initiated in the current [RecipientCertStore](#recipientcertstore-property-cms-component) for the private key of the certificate. If the key is found, [RecipientCertSubject](#recipientcertsubject-property-cms-component) is updated to reflect the full subject of the selected certificate; otherwise, [RecipientCertSubject](#recipientcertsubject-property-cms-component) 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](#recipientcertcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # SignatureHashAlgorithm Property ([CMS](#cms-component) Component) The signature hash algorithm used during signing. ## Syntax *C++ Builder Syntax* ```text __property String SignatureHashAlgorithm = { read=FSignatureHashAlgorithm, write=FSetSignatureHashAlgorithm }; ``` ## Default Value "SHA256" ## Remarks This property specifies the signature hash algorithm used when [Sign](#sign-method-cms-component) is called. When [Sign](#sign-method-cms-component) 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" ## Data Type String # SignerCertCount Property ([CMS](#cms-component) Component) The number of records in the SignerCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int SignerCertCount = { read=FSignerCertCount, write=FSetSignerCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SignerCertEffectiveDate](#signercerteffectivedate-property-cms-component) - [SignerCertEncoded](#signercertencoded-property-cms-component) - [SignerCertExpirationDate](#signercertexpirationdate-property-cms-component) - [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-cms-component) - [SignerCertFingerprint](#signercertfingerprint-property-cms-component) - [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-cms-component) - [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-cms-component) - [SignerCertIssuer](#signercertissuer-property-cms-component) - [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) - [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-cms-component) - [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-cms-component) - [SignerCertPublicKey](#signercertpublickey-property-cms-component) - [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-cms-component) - [SignerCertPublicKeyLength](#signercertpublickeylength-property-cms-component) - [SignerCertSerialNumber](#signercertserialnumber-property-cms-component) - [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-cms-component) - [SignerCertStore](#signercertstore-property-cms-component) - [SignerCertStorePassword](#signercertstorepassword-property-cms-component) - [SignerCertStoreType](#signercertstoretype-property-cms-component) - [SignerCertSubject](#signercertsubject-property-cms-component) - [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-cms-component) - [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-cms-component) - [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-cms-component) - [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-cms-component) - [SignerCertUsage](#signercertusage-property-cms-component) - [SignerCertUsageFlags](#signercertusageflags-property-cms-component) - [SignerCertVersion](#signercertversion-property-cms-component) The array indices start at *0* and end at *SignerCertCount - 1*. This property is not available at design time. ## Data Type Integer # SignerCertEffectiveDate Property ([CMS](#cms-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertEffectiveDate[int SignerCertIndex] = { read=FSignerCertEffectiveDate }; ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertExpirationDate Property ([CMS](#cms-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertExpirationDate[int SignerCertIndex] = { read=FSignerCertExpirationDate }; ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertExtendedKeyUsage Property ([CMS](#cms-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertExtendedKeyUsage[int SignerCertIndex] = { read=FSignerCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertFingerprint Property ([CMS](#cms-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprint[int SignerCertIndex] = { read=FSignerCertFingerprint }; ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertFingerprintSHA1 Property ([CMS](#cms-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprintSHA1[int SignerCertIndex] = { read=FSignerCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertFingerprintSHA256 Property ([CMS](#cms-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprintSHA256[int SignerCertIndex] = { read=FSignerCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertIssuer Property ([CMS](#cms-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertIssuer[int SignerCertIndex] = { read=FSignerCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertPrivateKey Property ([CMS](#cms-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPrivateKey[int SignerCertIndex] = { read=FSignerCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) returns 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](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertPrivateKeyAvailable Property ([CMS](#cms-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool SignerCertPrivateKeyAvailable[int SignerCertIndex] = { read=FSignerCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-cms-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Boolean # SignerCertPrivateKeyContainer Property ([CMS](#cms-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPrivateKeyContainer[int SignerCertIndex] = { read=FSignerCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [SignerCertPrivateKey](#signercertprivatekey-property-cms-component) container for the certificate (if available). This functionality is available only on Windows platforms. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertPublicKey Property ([CMS](#cms-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPublicKey[int SignerCertIndex] = { read=FSignerCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertPublicKeyAlgorithm Property ([CMS](#cms-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPublicKeyAlgorithm[int SignerCertIndex] = { read=FSignerCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertPublicKeyLength Property ([CMS](#cms-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int SignerCertPublicKeyLength[int SignerCertIndex] = { read=FSignerCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # SignerCertSerialNumber Property ([CMS](#cms-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSerialNumber[int SignerCertIndex] = { read=FSignerCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertSignatureAlgorithm Property ([CMS](#cms-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSignatureAlgorithm[int SignerCertIndex] = { read=FSignerCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertStore Property ([CMS](#cms-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertStore[int SignerCertIndex] = { read=FSignerCertStore, write=FSetSignerCertStore }; __property DynamicArray SignerCertStoreB[int SignerCertIndex] = { read=FSignerCertStoreB, write=FSetSignerCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SignerCertStoreType](#signercertstoretype-property-cms-component) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-cms-component). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-cms-component). [SignerCertStore](#signercertstore-property-cms-component) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-cms-component) property to specify client certificates. If [SignerCertStore](#signercertstore-property-cms-component) has a value, and [SignerCertSubject](#signercertsubject-property-cms-component) or [SignerCertEncoded](#signercertencoded-property-cms-component) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-cms-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # SignerCertStorePassword Property ([CMS](#cms-component) 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 *C++ Builder Syntax* ```text __property String SignerCertStorePassword[int SignerCertIndex] = { 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. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is not available at design time. ## Data Type String # SignerCertStoreType Property ([CMS](#cms-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TipcCMSSignerCertStoreTypes SignerCertStoreType[int SignerCertIndex] = { read=FSignerCertStoreType, write=FSetSignerCertStoreType }; enum TipcCMSSignerCertStoreTypes { 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-cms-component), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-cms-component), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-cms-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SignerCertStore](#signercertstore-property-cms-component) and set [SignerCertStorePassword](#signercertstorepassword-property-cms-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is not available at design time. ## Data Type Integer # SignerCertSubjectAltNames Property ([CMS](#cms-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSubjectAltNames[int SignerCertIndex] = { read=FSignerCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertThumbprintMD5 Property ([CMS](#cms-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintMD5[int SignerCertIndex] = { read=FSignerCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertThumbprintSHA1 Property ([CMS](#cms-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintSHA1[int SignerCertIndex] = { read=FSignerCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertThumbprintSHA256 Property ([CMS](#cms-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintSHA256[int SignerCertIndex] = { read=FSignerCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertUsage Property ([CMS](#cms-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String SignerCertUsage[int SignerCertIndex] = { read=FSignerCertUsage }; ``` ## Default Value "" ## Remarks The text description of [SignerCertUsageFlags](#signercertusageflags-property-cms-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertUsageFlags Property ([CMS](#cms-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int SignerCertUsageFlags[int SignerCertIndex] = { read=FSignerCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-cms-component) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SignerCertUsage](#signercertusage-property-cms-component) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-cms-component). This functionality currently is not available when the provider is OpenSSL. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type Integer # SignerCertVersion Property ([CMS](#cms-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertVersion[int SignerCertIndex] = { read=FSignerCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is read-only and not available at design time. ## Data Type String # SignerCertSubject Property ([CMS](#cms-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSubject[int SignerCertIndex] = { read=FSignerCertSubject, write=FSetSignerCertSubject }; ``` ## Default Value "" ## Remarks 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-cms-component) property. This property is not available at design time. ## Data Type String # SignerCertEncoded Property ([CMS](#cms-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertEncoded[int SignerCertIndex] = { read=FSignerCertEncoded, write=FSetSignerCertEncoded }; __property DynamicArray SignerCertEncodedB[int SignerCertIndex] = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-cms-component) and [SignerCertSubject](#signercertsubject-property-cms-component) properties also may be used to specify a certificate. When [SignerCertEncoded](#signercertencoded-property-cms-component) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-cms-component) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-cms-component) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-cms-component) 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](#signercertcount-property-cms-component) property. This property is not available at design time. ## Data Type Byte Array # UseOAEP Property ([CMS](#cms-component) Component) This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax *C++ Builder Syntax* ```text __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](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams) ## Data Type Boolean # UsePSS Property ([CMS](#cms-component) Component) Whether to use RSA-PSS during signing and verification. ## Syntax *C++ Builder Syntax* ```text __property bool UsePSS = { read=FUsePSS, write=FSetUsePSS }; ``` ## Default Value false ## Remarks This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False. ## Data Type Boolean # AddCertificate Method ([CMS](#cms-component) Component) Used to add certificates for signing. ## Syntax *C++ Builder Syntax* ```text void __fastcall AddCertificate(int CertStoreType, String CertStore, String CertStorePassword, String CertSubject); ``` ## 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](#sign-method-cms-component) 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | *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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # AddRecipientCert Method ([CMS](#cms-component) Component) Used to add recipient certificates used to encrypt messages. ## Syntax *C++ Builder Syntax* ```text void __fastcall AddRecipientCert(DynamicArray CertEncoded); ``` ## Remarks This method adds a public certificate used when [Encrypt](#encrypt-method-cms-component) 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](#cms-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-cms-component) 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](#config-settings-cms-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([CMS](#cms-component) Component) Decrypts the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall Decrypt(); ``` ## Remarks Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling [AddCertificate](#addcertificate-method-cms-component) or setting the Certificates property. If the certificate used to encrypt the message is not known ahead of time [GetRecipientInfo](#getrecipientinfo-method-cms-component) may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If [GetRecipientInfo](#getrecipientinfo-method-cms-component) is called, the [RecipientInfo](#recipientinfo-event-cms-component) 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) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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](#cms-component) Component) Decrypts and verifies the signature of the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall DecryptAndVerifySignature(); ``` ## Remarks This method decrypts the input data and verifies the signature. Decryption certificates are specified by calling [AddCertificate](#addcertificate-method-cms-component) 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](#getrecipientinfo-method-cms-component) may be called prior to calling [Decrypt](#decrypt-method-cms-component) to obtain information about the recipient (the entity the for which the message was encrypted). If [GetRecipientInfo](#getrecipientinfo-method-cms-component) is called, the [RecipientInfo](#recipientinfo-event-cms-component) 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](#addrecipientcert-method-cms-component) or setting RecipientCerts. When this method is called the [SignerCertInfo](#signercertinfo-event-cms-component) 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](#signercertinfo-event-cms-component) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [SignerCertInfo](#signercertinfo-event-cms-component) 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](#detachedsignature-property-cms-component) - [DetachedSignatureData](#detachedsignaturedata-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - SignerCerts If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-cms-component). In addition the [DetachedSignature](#detachedsignature-property-cms-component) 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](#enablecompression-property-cms-component) 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: - [InputFile](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. # Encrypt Method ([CMS](#cms-component) Component) Encrypts the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall Encrypt(); ``` ## Remarks Encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling [AddRecipientCert](#addrecipientcert-method-cms-component) or setting the RecipientCerts property. [OutputFormat](#outputformat-property-cms-component) 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](#encryptionalgorithm-property-cms-component) - [OutputFormat](#outputformat-property-cms-component) - [UseOAEP](#useoaep-property-cms-component) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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](#cms-component) Component) Gets the recipient certificate information for an encrypted message. ## Syntax *C++ Builder Syntax* ```text void __fastcall GetRecipientInfo(); ``` ## Remarks This method retrieves information about the recipient(s) of the encrypted message. This may be called prior to calling [Decrypt](#decrypt-method-cms-component) to determine which certificate should be loaded for decryption. When this method is called the [RecipientInfo](#recipientinfo-event-cms-component) event fires once for each recipient found within the message. Use the parameters of the [RecipientInfo](#recipientinfo-event-cms-component) to determine which certificate to specify via [AddCertificate](#addcertificate-method-cms-component) or Certificates before calling [Decrypt](#decrypt-method-cms-component). # GetSignerCertInfo Method ([CMS](#cms-component) Component) This method gets the signature information for an signed message. ## Syntax *C++ Builder Syntax* ```text void __fastcall GetSignerCertInfo(); ``` ## Remarks This method retrieves information about the certificate used to sign the message. This may be called before calling [VerifySignature](#verifysignature-method-cms-component) to determine which certificate should be loaded for verification. When this method is called, the [SignerCertInfo](#signercertinfo-event-cms-component) event fires once for each signer of the message. Use the parameters of the [SignerCertInfo](#signercertinfo-event-cms-component) to determine which certificate to specify before calling [VerifySignature](#verifysignature-method-cms-component). NOTE: Use of this method is optional. If no certificate is specified before calling [VerifySignature](#verifysignature-method-cms-component), the component will fire the [SignerCertInfo](#signercertinfo-event-cms-component) and a certificate may be loaded from within the event at that time (if necessary). # Reset Method ([CMS](#cms-component) Component) This method resets the component properties. ## Syntax *C++ Builder Syntax* ```text 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 ([CMS](#cms-component) Component) Signs the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall Sign(); ``` ## Remarks Sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [AddCertificate](#addcertificate-method-cms-component) or setting the Certificates property. [OutputFormat](#outputformat-property-cms-component) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [IncludeCertificates](#includecertificates-property-cms-component) 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](#detachedsignature-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [IncludeCertificates](#includecertificates-property-cms-component) - [OutputFormat](#outputformat-property-cms-component) - [SignatureHashAlgorithm](#signaturehashalgorithm-property-cms-component) - [UsePSS](#usepss-property-cms-component) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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](#cms-component) Component) Signs and encrypts the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall SignAndEncrypt(); ``` ## Remarks This method signs encrypts the input data with the the specified certificate(s). Encryption certificates are specified by calling [AddRecipientCert](#addrecipientcert-method-cms-component) or setting the RecipientCerts property. Signing certificates are set via the Certificates property. [OutputFormat](#outputformat-property-cms-component) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. [IncludeCertificates](#includecertificates-property-cms-component) 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](#detachedsignature-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - [EncryptionAlgorithm](#encryptionalgorithm-property-cms-component) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [IncludeCertificates](#includecertificates-property-cms-component) - [OutputFormat](#outputformat-property-cms-component) - [SignatureHashAlgorithm](#signaturehashalgorithm-property-cms-component) - [UseOAEP](#useoaep-property-cms-component) - [UsePSS](#usepss-property-cms-component) **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](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. # VerifySignature Method ([CMS](#cms-component) Component) Verifies the signature of the current message. ## Syntax *C++ Builder Syntax* ```text void __fastcall 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](#addrecipientcert-method-cms-component) or setting RecipientCerts. When this method is called the [SignerCertInfo](#signercertinfo-event-cms-component) 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](#signercertinfo-event-cms-component) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [SignerCertInfo](#signercertinfo-event-cms-component) is populated the certificate required for verification is already present in the message. The following property are applicable when calling this method: - [DetachedSignature](#detachedsignature-property-cms-component) - [DetachedSignatureData](#detachedsignaturedata-property-cms-component) - [EnableCompression](#enablecompression-property-cms-component) - SignerCerts If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-cms-component). In addition the [DetachedSignature](#detachedsignature-property-cms-component) 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](#enablecompression-property-cms-component) 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: - [InputFile](#inputfile-property-cms-component) - [InputMessage](#inputmessage-property-cms-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-cms-component) - [OutputMessage](#outputmessage-property-cms-component): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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** ```csharp 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](#cms-component) Component) Fired when information is available about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text typedef struct { int ErrorCode; String Description; } TipcCMSErrorEventParams; typedef void __fastcall (__closure *TipcCMSErrorEvent)(System::TObject* Sender, TipcCMSErrorEventParams *e); __property TipcCMSErrorEvent 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](#trappable-errors-cms-component) section. # Log Event ([CMS](#cms-component) Component) Fires with log information during processing. ## Syntax *C++ Builder Syntax* ```text typedef struct { int LogLevel; String Message; String LogType; } TipcCMSLogEventParams; typedef void __fastcall (__closure *TipcCMSLogEvent)(System::TObject* Sender, TipcCMSLogEventParams *e); __property TipcCMSLogEvent OnLog = { 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). *LogLevel* indicates the level of message. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *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](#cms-component) Component) This event is fired for each recipient certificate of the encrypted message. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Issuer; String SerialNumber; String SubjectKeyIdentifier; String EncryptionAlgorithm; } TipcCMSRecipientInfoEventParams; typedef void __fastcall (__closure *TipcCMSRecipientInfoEvent)(System::TObject* Sender, TipcCMSRecipientInfoEventParams *e); __property TipcCMSRecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo }; ``` ## Remarks When [GetRecipientInfo](#getrecipientinfo-method-cms-component) 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](#cms-component) Component) Fired during verification of the signed message. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Issuer; String SerialNumber; String SubjectKeyIdentifier; String CertEncoded; DynamicArray CertEncodedB; } TipcCMSSignerCertInfoEventParams; typedef void __fastcall (__closure *TipcCMSSignerCertInfoEvent)(System::TObject* Sender, TipcCMSSignerCertInfoEventParams *e); __property TipcCMSSignerCertInfoEvent OnSignerCertInfo = { 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](#cms-component) 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](#config-method-cms-component) method. ### CMS Config Settings **CompressBeforeSign**: Specifies whether to compress before signing.When [EnableCompression](#enablecompression-property-cms-component) is set to *True* this property controls whether compression happens before or after signing. If set to *True* the input data will be compressed before signing. If set to *False* (default) the input data will be signed and then compressed. **ContentTypeOID**: Specifies the oid for content type.This setting optionally specifies an OID defining the data content type for the data being processed. This may be set before calling [Encrypt](#encrypt-method-cms-component), [Sign](#sign-method-cms-component), or [SignAndEncrypt](#signandencrypt-method-cms-component). The default value is *1.2.840.113549.1.7.1* which is the OID for id-data. **CSP**: The Cryptographic Service Provider.For the Win32 editions, the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations. NOTE: This config may only be used when the [UseCryptoAPI](#UseCryptoAPI) is true. **GenerateSignatureTimestamp**: Whether to generate timestamps in signatures.If [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) is True, a timestamp will be generated and added to all signatures created by the component. The default value is *True*. **IncludeHeaders**: Tells the component whether to include the headers when encoding the message.If True (default), the component will include MIME headers when [Sign](#sign-method-cms-component), [Encrypt](#encrypt-method-cms-component), or [SignAndEncrypt](#signandencrypt-method-cms-component) are called. If False, only the message will be encoded. The default value for [IncludeHeaders](#IncludeHeaders) is true. Note: This setting is only applicable to when [OutputFormat](#outputformat-property-cms-component) is set to *SMIME*. **IncludeInternalHeaders**: Tells the component whether or not to include the internal headers when encoding the message.If True, the component will generate and include MIME part headers when [Sign](#sign-method-cms-component), [Encrypt](#encrypt-method-cms-component), or [SignAndEncrypt](#signandencrypt-method-cms-component) are called. When [VerifySignature](#verifysignature-method-cms-component), [Decrypt](#decrypt-method-cms-component), or [DecryptAndVerifySignature](#decryptandverifysignature-method-cms-component) are called the MIME part headers will be stripped. When set to *False*, only the message will be processed, MIME part headers will not be generated or stripped. The default value for [IncludeInternalHeaders](#IncludeInternalHeaders) is False. Note: This setting is only applicable to when [OutputFormat](#outputformat-property-cms-component) is set to *SMIME*. **InputContentTransferEncoding**: Sets the Content-Transfer-Encoding for the signed message.This setting specifies the Content-Transfer-Encoding header value in signed messages. By default the component will automatically determine the Content-Transfer-Encoding based on the file extension set in [InputFile](#inputfile-property-cms-component), however this setting may be set to override the determined value or to specify a value if data is read from [InputMessage](#inputmessage-property-cms-component). If no value is specified and a value cannot be automatically determined the default value *7bit* will be used. Note: This setting is only applicable when [OutputFormat](#outputformat-property-cms-component) is set to *SMIME* and when calling [Sign](#sign-method-cms-component) or [SignAndEncrypt](#signandencrypt-method-cms-component) and [DetachedSignature](#detachedsignature-property-cms-component) is True. **InputContentType**: Sets the Content-Type for the signed message.This setting specifies the Content-Type header value in signed messages. By default the component will automatically determine the Content-Type based on the file extension set in [InputFile](#inputfile-property-cms-component), however this setting may be set to override the determined value or to specify a value if data is read from [InputMessage](#inputmessage-property-cms-component). If no value is specified and a value cannot be automatically determined the default value *text/plain; charset="iso-8859-1"* will be used. Note: This setting is only applicable when [OutputFormat](#outputformat-property-cms-component) is set to *SMIME* and when calling [Sign](#sign-method-cms-component) or [SignAndEncrypt](#signandencrypt-method-cms-component) and [DetachedSignature](#detachedsignature-property-cms-component) is True. **InputMessageHeaders**: Message headers.This setting specifies the headers of the SMIME message if they are not already present in the input message. In most cases the input message itself will contain the necessary headers, however if the headers are and body of the SMIME message are separate, the headers may be specified in this setting before calling [Decrypt](#decrypt-method-cms-component), [DecryptAndVerifySignature](#decryptandverifysignature-method-cms-component), or [VerifySignature](#verifysignature-method-cms-component). **LogDirectory**: The directory on disk where debug logs are written.This setting specifies a directory on disk to which debug logs will be written during operation. This should only be set for debugging purposes. Files with various extensions will be written to disk at the location specified with debug data for the operation being performed. If [LogFileName](#LogFileName) is not specified the filenames will be in the format *yyyy-MM-dd-HH-mm-ss-fff*. **LogFileName**: The base filename to use with LogDirectory.This setting specifies the base filename to use when [LogDirectory](#LogDirectory) is set. If specified the name should be a filename without extension. Various files will be logged with different extensions during operation. This setting defines only the base filename. If unspecified the files will be named with a timestamp in the format *yyyy-MM-dd-HH-mm-ss-fff*. **LogLevel**: The level of detail for log messages.This setting specifies the level of detail that is logged via the [Log](#log-event-cms-component) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [UseOAEP](#useoaep-property-cms-component) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" Note: This setting is not applicable when [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is set to *true* or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) and [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) values. In this case the [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is also used for MGF1. **OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [UseOAEP](#useoaep-property-cms-component) is set to True. The specified value should be hex encoded. **OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [UseOAEP](#useoaep-property-cms-component) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" **OutputMessageHeaders**: The SMIME headers of the output message.When [IncludeHeaders](#IncludeHeaders) is set to *False* the SMIME headers are not included in the output message itself when [Sign](#sign-method-cms-component), [Encrypt](#encrypt-method-cms-component), or [SignAndEncrypt](#signandencrypt-method-cms-component) are called. This setting may be used to obtain the SMIME headers separately. This setting is only applicable when [OutputFormat](#outputformat-property-cms-component) is set to *SMIME*. **RecipientInfoType**: The type of signer information to include in the signed message.This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows: - 0 (issuerAndSerialNumber - default) - 1 (subjectKeyIdentifier) NOTE: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension. **SignatureTimestamp**: The signature timestamp in the signed message.This setting holds the timestamp of the signature. After calling [VerifySignature](#verifysignature-method-cms-component) this setting will hold the timestamp identifying when the signature was created. The timestamp is in UTC time with the format *yyyyMMddHHmmss*. For instance *20181130223821*. **SignerInfoType**: The type of signer information to include in the signed message.This configuration setting specifies which type of information about the signer certificate is included in the signed message. Possible values are as follows: - 0 (issuerAndSerialNumber - default) - 1 (subjectKeyIdentifier) NOTE: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension. **UseAlgorithmOIDs**: Whether OIDs are used when providing information about the algorithms.This configuration setting controls whether the *EncryptionAlgorithm* parameter of the [RecipientInfo](#recipientinfo-event-cms-component) event is populated with the name of the algorithm, such as *3DES* or the corresponding OID such as *1.2.840.113549.3.7*. The default value is *False*, and the name of the algorithm is used. Set this to *True* to use the object identifiers instead. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors ([CMS](#cms-component) 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. |