CMS Component
Properties Methods Events Config Settings Errors
The CMS component is used to digitally sign, encrypt, verify, and decrypt data.
Syntax
TipcCMS
Remarks
The CMS component implements the Cryptographic Message Syntax and allow for various cryptographic operations to be performed on data including:
The component can generate and consume message in a variety of formats including PEM, DER (Binary), and SMIME. The EncryptionAlgorithm and SignatureHashAlgorithm are fully configurable and support a variety of industry standard encryption and hash algorithms.
The component supports additional functionality such as Compression, OAEP, and PSS. The GetRecipientInfo and GetSignerCertInfo methods as well as the RecipientInfo and SignerCertInfo events allow for a dynamic and flexible approach to message processing. Certificate may be loaded ahead of time or as-needed from the events.
Signing Notes
Sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling AddCertificate or setting the Certificates property.OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. IncludeCertificates specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:
- Certificates (required)
- DetachedSignature
- EnableCompression
- GenerateSignatureTimestamp
- IncludeCertificates
- OutputFormat
- SignatureHashAlgorithm
- UsePSS
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Sign and Verify a message
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - DER Output Format
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();
byte[] signedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - Detached Signature
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();
string signature = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
Sign and Verify a message - Multiple Signatures
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - No Included Certificate
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
Console.WriteLine(e.Issuer);
Console.WriteLine(e.SerialNumber);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
//Load the correct signer certificate.
cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
}
};
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Encryption Notes
Encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling AddRecipientCert or setting the RecipientCerts property.OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. The following properties are applicable when calling this method:
- RecipientCerts (required)
- EncryptionAlgorithm
- OutputFormat
- UseOAEP
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt a message
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt a message - DER Output Format
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();
byte[] encryptedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Multiple Recipients
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Get Recipient Info
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
Console.WriteLine(e.SerialNumber);
Console.WriteLine(e.Issuer);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
}
};
cms.GetRecipientInfo();
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Signature Verification Notes
VerifySignature verifies the signature of the input message.In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling AddRecipientCert or setting RecipientCerts.
When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.
The following property are applicable when calling this method:
If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.
If the input message is compressed EnableCompression must be set to True before calling this method.
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Sign and Verify a message
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - DER Output Format
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();
byte[] signedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - Detached Signature
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();
string signature = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
Sign and Verify a message - Multiple Signatures
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - No Included Certificate
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
Console.WriteLine(e.Issuer);
Console.WriteLine(e.SerialNumber);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
//Load the correct signer certificate.
cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
}
};
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Decryption Notes
Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling AddCertificate or setting the Certificates property.
If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.
The following properties are applicable when calling this method:
- Certificates (Required)
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt a message
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt a message - DER Output Format
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();
byte[] encryptedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Multiple Recipients
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Get Recipient Info
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
Console.WriteLine(e.SerialNumber);
Console.WriteLine(e.Issuer);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
}
};
cms.GetRecipientInfo();
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| CertCount | The number of records in the Cert arrays. |
| CertEffectiveDate | The date on which this certificate becomes valid. |
| CertExpirationDate | The date on which the certificate expires. |
| CertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| CertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| CertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| CertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| CertIssuer | The issuer of the certificate. |
| CertPrivateKey | The private key of the certificate (if available). |
| CertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| CertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| CertPublicKey | The public key of the certificate. |
| CertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| CertPublicKeyLength | The length of the certificate's public key (in bits). |
| CertSerialNumber | The serial number of the certificate encoded as a string. |
| CertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| CertStore | The name of the certificate store for the client certificate. |
| CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| CertStoreType | The type of certificate store for this certificate. |
| CertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| CertThumbprintMD5 | The MD5 hash of the certificate. |
| CertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| CertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| CertUsage | The text description of UsageFlags . |
| CertUsageFlags | The flags that show intended use for the certificate. |
| CertVersion | The certificate's version number. |
| CertSubject | The subject of the certificate used for client authentication. |
| CertEncoded | The certificate (PEM/Base64 encoded). |
| DetachedSignature | Specifies whether to include a detached signature when signing a message. |
| DetachedSignatureData | The detached signature. |
| EnableCompression | Specifies whether to compress the message. |
| EncryptionAlgorithm | The algorithm used for encryption. |
| IncludeCertificates | Specifies whether to include the signer's certificate with the signed message. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| OutputFile | The output file. |
| OutputFormat | Specifies the output format. |
| OutputMessage | The output message after processing. |
| RecipientCertCount | The number of records in the RecipientCert arrays. |
| RecipientCertEffectiveDate | The date on which this certificate becomes valid. |
| RecipientCertExpirationDate | The date on which the certificate expires. |
| RecipientCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| RecipientCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| RecipientCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| RecipientCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| RecipientCertIssuer | The issuer of the certificate. |
| RecipientCertPrivateKey | The private key of the certificate (if available). |
| RecipientCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| RecipientCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| RecipientCertPublicKey | The public key of the certificate. |
| RecipientCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| RecipientCertPublicKeyLength | The length of the certificate's public key (in bits). |
| RecipientCertSerialNumber | The serial number of the certificate encoded as a string. |
| RecipientCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| RecipientCertStore | The name of the certificate store for the client certificate. |
| RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| RecipientCertStoreType | The type of certificate store for this certificate. |
| RecipientCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| RecipientCertThumbprintMD5 | The MD5 hash of the certificate. |
| RecipientCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| RecipientCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| RecipientCertUsage | The text description of UsageFlags . |
| RecipientCertUsageFlags | The flags that show intended use for the certificate. |
| RecipientCertVersion | The certificate's version number. |
| RecipientCertSubject | The subject of the certificate used for client authentication. |
| RecipientCertEncoded | The certificate (PEM/Base64 encoded). |
| SignatureHashAlgorithm | The signature hash algorithm used during signing. |
| SignerCertCount | The number of records in the SignerCert arrays. |
| SignerCertEffectiveDate | The date on which this certificate becomes valid. |
| SignerCertExpirationDate | The date on which the certificate expires. |
| SignerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SignerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SignerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SignerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SignerCertIssuer | The issuer of the certificate. |
| SignerCertPrivateKey | The private key of the certificate (if available). |
| SignerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SignerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SignerCertPublicKey | The public key of the certificate. |
| SignerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SignerCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SignerCertSerialNumber | The serial number of the certificate encoded as a string. |
| SignerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SignerCertStore | The name of the certificate store for the client certificate. |
| SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SignerCertStoreType | The type of certificate store for this certificate. |
| SignerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SignerCertThumbprintMD5 | The MD5 hash of the certificate. |
| SignerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SignerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SignerCertUsage | The text description of UsageFlags . |
| SignerCertUsageFlags | The flags that show intended use for the certificate. |
| SignerCertVersion | The certificate's version number. |
| SignerCertSubject | The subject of the certificate used for client authentication. |
| SignerCertEncoded | The certificate (PEM/Base64 encoded). |
| UseOAEP | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). |
| UsePSS | 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 | Used to add certificates for signing. |
| AddRecipientCert | Used to add recipient certificates used to encrypt messages. |
| Config | Sets or retrieves a configuration setting. |
| Decrypt | Decrypts the current message. |
| DecryptAndVerifySignature | Decrypts and verifies the signature of the current message. |
| Encrypt | Encrypts the current message. |
| GetRecipientInfo | Gets the recipient certificate information for an encrypted message. |
| GetSignerCertInfo | This method gets the signature information for an signed message. |
| Reset | This method resets the component properties. |
| Sign | Signs the current message. |
| SignAndEncrypt | Signs and encrypts the current message. |
| VerifySignature | 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 | Fired when information is available about errors during data delivery. |
| Log | Fires with log information during processing. |
| RecipientInfo | This event is fired for each recipient certificate of the encrypted message. |
| SignerCertInfo | 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 | Specifies whether to compress before signing. |
| ContentTypeOID | Specifies the oid for content type. |
| CSP | The Cryptographic Service Provider. |
| GenerateSignatureTimestamp | Whether to generate timestamps in signatures. |
| IncludeHeaders | Tells the component whether to include the headers when encoding the message. |
| IncludeInternalHeaders | Tells the component whether or not to include the internal headers when encoding the message. |
| InputContentTransferEncoding | Sets the Content-Transfer-Encoding for the signed message. |
| InputContentType | Sets the Content-Type for the signed message. |
| InputMessageHeaders | Message headers. |
| LogDirectory | The directory on disk where debug logs are written. |
| LogFileName | The base filename to use with LogDirectory. |
| LogLevel | The level of detail for log messages. |
| OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used with OAEP. |
| OAEPParams | The hex encoded OAEP parameters. |
| OAEPRSAHashAlgorithm | The RSA hash algorithm used with OAEP. |
| OutputMessageHeaders | The SMIME headers of the output message. |
| RecipientInfoType | The type of signer information to include in the signed message. |
| SignatureTimestamp | The signature timestamp in the signed message. |
| SignerInfoType | The type of signer information to include in the signed message. |
| UseAlgorithmOIDs | Whether OIDs are used when providing information about the algorithms. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CertCount Property (CMS Component)
The number of records in the Cert arrays.
Syntax
__property int CertCount = { read=FCertCount, write=FSetCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- CertEffectiveDate
- CertEncoded
- CertExpirationDate
- CertExtendedKeyUsage
- CertFingerprint
- CertFingerprintSHA1
- CertFingerprintSHA256
- CertIssuer
- CertPrivateKey
- CertPrivateKeyAvailable
- CertPrivateKeyContainer
- CertPublicKey
- CertPublicKeyAlgorithm
- CertPublicKeyLength
- CertSerialNumber
- CertSignatureAlgorithm
- CertStore
- CertStorePassword
- CertStoreType
- CertSubject
- CertSubjectAltNames
- CertThumbprintMD5
- CertThumbprintSHA1
- CertThumbprintSHA256
- CertUsage
- CertUsageFlags
- CertVersion
This property is not available at design time.
Data Type
Integer
CertEffectiveDate Property (CMS Component)
The date on which this certificate becomes valid.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertExpirationDate Property (CMS Component)
The date on which the certificate expires.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertExtendedKeyUsage Property (CMS Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprint Property (CMS Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprintSHA1 Property (CMS Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertFingerprintSHA256 Property (CMS Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertIssuer Property (CMS Component)
The issuer of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertPrivateKey Property (CMS Component)
The private key of the certificate (if available).
Syntax
__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 may be available but not exportable. In this case, CertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
CertPrivateKeyAvailable Property (CMS Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool CertPrivateKeyAvailable[int CertIndex] = { read=FCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable 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 property.
This property is read-only and not available at design time.
Data Type
Boolean
CertPrivateKeyContainer Property (CMS Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String CertPrivateKeyContainer[int CertIndex] = { read=FCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the CertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKey Property (CMS Component)
The public key of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKeyAlgorithm Property (CMS Component)
The textual description of the certificate's public key algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertPublicKeyLength Property (CMS Component)
The length of the certificate's public key (in bits).
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
Integer
CertSerialNumber Property (CMS Component)
The serial number of the certificate encoded as a string.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertSignatureAlgorithm Property (CMS Component)
The text description of the certificate's signature algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertStore Property (CMS Component)
The name of the certificate store for the client certificate.
Syntax
__property String CertStore[int CertIndex] = { read=FCertStore, write=FSetCertStore };
__property DynamicArray<Byte> CertStoreB[int CertIndex] = { read=FCertStoreB, write=FSetCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is 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 property.
This property is not available at design time.
Data Type
Byte Array
CertStorePassword Property (CMS Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property 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 property.
This property is not available at design time.
Data Type
String
CertStoreType Property (CMS Component)
The type of certificate store for this certificate.
Syntax
__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:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is not available at design time.
Data Type
Integer
CertSubjectAltNames Property (CMS Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertThumbprintMD5 Property (CMS Component)
The MD5 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertThumbprintSHA1 Property (CMS Component)
The SHA-1 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertThumbprintSHA256 Property (CMS Component)
The SHA-256 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertUsage Property (CMS Component)
The text description of UsageFlags .
Syntax
__property String CertUsage[int CertIndex] = { read=FCertUsage };
Default Value
""
Remarks
The text description of CertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
String
CertUsageFlags Property (CMS Component)
The flags that show intended use for the certificate.
Syntax
__property int CertUsageFlags[int CertIndex] = { read=FCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of CertUsageFlags 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 property for a text representation of CertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
Integer
CertVersion Property (CMS Component)
The certificate's version number.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
CertSubject Property (CMS Component)
The subject of the certificate used for client authentication.
Syntax
__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=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is not available at design time.
Data Type
String
CertEncoded Property (CMS Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String CertEncoded[int CertIndex] = { read=FCertEncoded, write=FSetCertEncoded };
__property DynamicArray<Byte> 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 and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is not available at design time.
Data Type
Byte Array
DetachedSignature Property (CMS Component)
Specifies whether to include a detached signature when signing a message.
Syntax
__property bool DetachedSignature = { read=FDetachedSignature, write=FSetDetachedSignature };
Default Value
false
Remarks
This property specifies whether the Sign operation products a message that includes both a signature and the message data, or just a signature.
When set to False default the output message holds the data and signature in one CMS message. This may be passed in its entirety to the receiving party for signature verification.
When set to True the output message holds only a signature in the CMS message. Both the original input data and the signature in the output message produced by the Sign operation must be passed to the receiving party for signature verification.
Data Type
Boolean
DetachedSignatureData Property (CMS Component)
The detached signature.
Syntax
__property String DetachedSignatureData = { read=FDetachedSignatureData, write=FSetDetachedSignatureData };
__property DynamicArray<Byte> DetachedSignatureDataB = { read=FDetachedSignatureDataB, write=FSetDetachedSignatureDataB };
Default Value
""
Remarks
This setting is used to specify the detached signature before calling VerifySignature. The message data should be specified normally and this property should be set to the detached signature data. This may be set to the PEM, DER, or SMIME encoded signature message.
Data Type
Byte Array
EnableCompression Property (CMS Component)
Specifies whether to compress the message.
Syntax
__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.
Data Type
Boolean
EncryptionAlgorithm Property (CMS Component)
The algorithm used for encryption.
Syntax
__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };
Default Value
"3DES"
Remarks
This property specifies the encryption algorithm used when Encrypt is called.
This may be the name of the algorithm, or the corresponding OID of the algorithm. The default value is 3DES. Possible values are:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
Data Type
String
IncludeCertificates Property (CMS Component)
Specifies whether to include the signer's certificate with the signed message.
Syntax
__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 Component)
The file to process.
Syntax
__property String InputFile = { read=FInputFile, write=FSetInputFile };
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file 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
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
InputMessage Property (CMS Component)
The message to process.
Syntax
__property String InputMessage = { read=FInputMessage, write=FSetInputMessage };
__property DynamicArray<Byte> InputMessageB = { read=FInputMessageB, write=FSetInputMessageB };
Default Value
""
Remarks
This property specifies the message to be processed.
Encrypt and/or Sign
When encrypting or signing this may be set to the content that will be encrypted and/or signed.
Decrypt and/or Verify
When decrypting or verifying a signature this may be set to the 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
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
Byte Array
OutputFile Property (CMS Component)
The output file.
Syntax
__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };
Default Value
""
Remarks
This property specifies the file to which the output will be written. This may be set to an absolute or relative path.
Encrypt and/or Sign
When encrypting or signing this specifies a file where the 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:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
OutputFormat Property (CMS Component)
Specifies the output format.
Syntax
__property String OutputFormat = { read=FOutputFormat, write=FSetOutputFormat };
Default Value
"PEM"
Remarks
This property specifies the format of the output message created when calling Sign, Encrypt, or SignAndEncrypt.
The various formats allow for easier transport of the signed or encrypted message, as well as interoperability with other utilities.
Possible values are:
| Value | Description |
| PEM (default) | A PEM formatted message. For instance:
-----BEGIN CMS----- MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy ... mlJLPoCw5pf3Cjae56oXs29IZMcDXKersNjFGYSaG0o9k3lAcj9llLFh54Xr1ljx7K0VpVvlrmgu kNHAf7cUvvilW/KrDa+T2n+sOFAAAAAAAAA= -----END CMS----- |
| DER | The message is binary (raw bytes). |
| SMIME | The message is S/MIME encoded. For instance:
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= |
Data Type
String
OutputMessage Property (CMS Component)
The output message after processing.
Syntax
__property String OutputMessage = { read=FOutputMessage };
__property DynamicArray<Byte> OutputMessageB = { read=FOutputMessageB };
Default Value
""
Remarks
This property will be populated with the output of the operation if OutputFile is not set.
Encrypt and/or Sign
When encrypting or signing this will hold the fully encoded 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:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
This property is read-only.
Data Type
Byte Array
RecipientCertCount Property (CMS Component)
The number of records in the RecipientCert arrays.
Syntax
__property int RecipientCertCount = { read=FRecipientCertCount, write=FSetRecipientCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- RecipientCertEffectiveDate
- RecipientCertEncoded
- RecipientCertExpirationDate
- RecipientCertExtendedKeyUsage
- RecipientCertFingerprint
- RecipientCertFingerprintSHA1
- RecipientCertFingerprintSHA256
- RecipientCertIssuer
- RecipientCertPrivateKey
- RecipientCertPrivateKeyAvailable
- RecipientCertPrivateKeyContainer
- RecipientCertPublicKey
- RecipientCertPublicKeyAlgorithm
- RecipientCertPublicKeyLength
- RecipientCertSerialNumber
- RecipientCertSignatureAlgorithm
- RecipientCertStore
- RecipientCertStorePassword
- RecipientCertStoreType
- RecipientCertSubject
- RecipientCertSubjectAltNames
- RecipientCertThumbprintMD5
- RecipientCertThumbprintSHA1
- RecipientCertThumbprintSHA256
- RecipientCertUsage
- RecipientCertUsageFlags
- RecipientCertVersion
This property is not available at design time.
Data Type
Integer
RecipientCertEffectiveDate Property (CMS Component)
The date on which this certificate becomes valid.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertExpirationDate Property (CMS Component)
The date on which the certificate expires.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertExtendedKeyUsage Property (CMS Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertFingerprint Property (CMS Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertFingerprintSHA1 Property (CMS Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertFingerprintSHA256 Property (CMS Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertIssuer Property (CMS Component)
The issuer of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertPrivateKey Property (CMS Component)
The private key of the certificate (if available).
Syntax
__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 may be available but not exportable. In this case, RecipientCertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertPrivateKeyAvailable Property (CMS Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool RecipientCertPrivateKeyAvailable[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable 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 property.
This property is read-only and not available at design time.
Data Type
Boolean
RecipientCertPrivateKeyContainer Property (CMS Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String RecipientCertPrivateKeyContainer[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the RecipientCertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertPublicKey Property (CMS Component)
The public key of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertPublicKeyAlgorithm Property (CMS Component)
The textual description of the certificate's public key algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertPublicKeyLength Property (CMS Component)
The length of the certificate's public key (in bits).
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
Integer
RecipientCertSerialNumber Property (CMS Component)
The serial number of the certificate encoded as a string.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertSignatureAlgorithm Property (CMS Component)
The text description of the certificate's signature algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertStore Property (CMS Component)
The name of the certificate store for the client certificate.
Syntax
__property String RecipientCertStore[int RecipientCertIndex] = { read=FRecipientCertStore, write=FSetRecipientCertStore };
__property DynamicArray<Byte> RecipientCertStoreB[int RecipientCertIndex] = { read=FRecipientCertStoreB, write=FSetRecipientCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is 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 property.
This property is not available at design time.
Data Type
Byte Array
RecipientCertStorePassword Property (CMS Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String RecipientCertStorePassword[int RecipientCertIndex] = { read=FRecipientCertStorePassword, write=FSetRecipientCertStorePassword };
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
String
RecipientCertStoreType Property (CMS Component)
The type of certificate store for this certificate.
Syntax
__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:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Integer
RecipientCertSubjectAltNames Property (CMS Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertThumbprintMD5 Property (CMS Component)
The MD5 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertThumbprintSHA1 Property (CMS Component)
The SHA-1 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertThumbprintSHA256 Property (CMS Component)
The SHA-256 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertUsage Property (CMS Component)
The text description of UsageFlags .
Syntax
__property String RecipientCertUsage[int RecipientCertIndex] = { read=FRecipientCertUsage };
Default Value
""
Remarks
The text description of RecipientCertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertUsageFlags Property (CMS Component)
The flags that show intended use for the certificate.
Syntax
__property int RecipientCertUsageFlags[int RecipientCertIndex] = { read=FRecipientCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of RecipientCertUsageFlags 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 property for a text representation of RecipientCertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
Integer
RecipientCertVersion Property (CMS Component)
The certificate's version number.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
RecipientCertSubject Property (CMS Component)
The subject of the certificate used for client authentication.
Syntax
__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=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
String
RecipientCertEncoded Property (CMS Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String RecipientCertEncoded[int RecipientCertIndex] = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded };
__property DynamicArray<Byte> RecipientCertEncodedB[int RecipientCertIndex] = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.
When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Byte Array
SignatureHashAlgorithm Property (CMS Component)
The signature hash algorithm used during signing.
Syntax
__property String SignatureHashAlgorithm = { read=FSignatureHashAlgorithm, write=FSetSignatureHashAlgorithm };
Default Value
"SHA256"
Remarks
This property specifies the signature hash algorithm used when Sign is called.
When Sign is called the input data is first hashed with the algorithm specified by this property to produce a message digest. The computed digest is then digitally signed with the certificates specified in Certificates.
The value specified here may be the name of the algorithm or the corresponding OID. Possible values are:
- "SHA-256" (default)
- "SHA-384"
- "SHA-512"
- "SHA-224"
- "SHA1"
- "MD5"
Data Type
String
SignerCertCount Property (CMS Component)
The number of records in the SignerCert arrays.
Syntax
__property int SignerCertCount = { read=FSignerCertCount, write=FSetSignerCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignerCertEffectiveDate
- SignerCertEncoded
- SignerCertExpirationDate
- SignerCertExtendedKeyUsage
- SignerCertFingerprint
- SignerCertFingerprintSHA1
- SignerCertFingerprintSHA256
- SignerCertIssuer
- SignerCertPrivateKey
- SignerCertPrivateKeyAvailable
- SignerCertPrivateKeyContainer
- SignerCertPublicKey
- SignerCertPublicKeyAlgorithm
- SignerCertPublicKeyLength
- SignerCertSerialNumber
- SignerCertSignatureAlgorithm
- SignerCertStore
- SignerCertStorePassword
- SignerCertStoreType
- SignerCertSubject
- SignerCertSubjectAltNames
- SignerCertThumbprintMD5
- SignerCertThumbprintSHA1
- SignerCertThumbprintSHA256
- SignerCertUsage
- SignerCertUsageFlags
- SignerCertVersion
This property is not available at design time.
Data Type
Integer
SignerCertEffectiveDate Property (CMS Component)
The date on which this certificate becomes valid.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertExpirationDate Property (CMS Component)
The date on which the certificate expires.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertExtendedKeyUsage Property (CMS Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprint Property (CMS Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprintSHA1 Property (CMS Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprintSHA256 Property (CMS Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertIssuer Property (CMS Component)
The issuer of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertPrivateKey Property (CMS Component)
The private key of the certificate (if available).
Syntax
__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 may be available but not exportable. In this case, SignerCertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertPrivateKeyAvailable Property (CMS Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SignerCertPrivateKeyAvailable[int SignerCertIndex] = { read=FSignerCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable 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 property.
This property is read-only and not available at design time.
Data Type
Boolean
SignerCertPrivateKeyContainer Property (CMS Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SignerCertPrivateKeyContainer[int SignerCertIndex] = { read=FSignerCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the SignerCertPrivateKey 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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKey Property (CMS Component)
The public key of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKeyAlgorithm Property (CMS Component)
The textual description of the certificate's public key algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKeyLength Property (CMS Component)
The length of the certificate's public key (in bits).
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
Integer
SignerCertSerialNumber Property (CMS Component)
The serial number of the certificate encoded as a string.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertSignatureAlgorithm Property (CMS Component)
The text description of the certificate's signature algorithm.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertStore Property (CMS Component)
The name of the certificate store for the client certificate.
Syntax
__property String SignerCertStore[int SignerCertIndex] = { read=FSignerCertStore, write=FSetSignerCertStore };
__property DynamicArray<Byte> SignerCertStoreB[int SignerCertIndex] = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is 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 property.
This property is not available at design time.
Data Type
Byte Array
SignerCertStorePassword Property (CMS Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property 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 property.
This property is not available at design time.
Data Type
String
SignerCertStoreType Property (CMS Component)
The type of certificate store for this certificate.
Syntax
__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:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.
This property is not available at design time.
Data Type
Integer
SignerCertSubjectAltNames Property (CMS Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintMD5 Property (CMS Component)
The MD5 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintSHA1 Property (CMS Component)
The SHA-1 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintSHA256 Property (CMS Component)
The SHA-256 hash of the certificate.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertUsage Property (CMS Component)
The text description of UsageFlags .
Syntax
__property String SignerCertUsage[int SignerCertIndex] = { read=FSignerCertUsage };
Default Value
""
Remarks
The text description of SignerCertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertUsageFlags Property (CMS Component)
The flags that show intended use for the certificate.
Syntax
__property int SignerCertUsageFlags[int SignerCertIndex] = { read=FSignerCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SignerCertUsageFlags 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 property for a text representation of SignerCertUsageFlags.
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 property.
This property is read-only and not available at design time.
Data Type
Integer
SignerCertVersion Property (CMS Component)
The certificate's version number.
Syntax
__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 property.
This property is read-only and not available at design time.
Data Type
String
SignerCertSubject Property (CMS Component)
The subject of the certificate used for client authentication.
Syntax
__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=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.
This property is not available at design time.
Data Type
String
SignerCertEncoded Property (CMS Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SignerCertEncoded[int SignerCertIndex] = { read=FSignerCertEncoded, write=FSetSignerCertEncoded };
__property DynamicArray<Byte> 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 and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.
This property is not available at design time.
Data Type
Byte Array
UseOAEP Property (CMS Component)
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
__property bool UseOAEP = { read=FUseOAEP, write=FSetUseOAEP };
Default Value
false
Remarks
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the component will use PKCS1.
To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams
Data Type
Boolean
UsePSS Property (CMS Component)
Whether to use RSA-PSS during signing and verification.
Syntax
__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 Component)
Used to add certificates for signing.
Syntax
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 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:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertStore specifies the path to the certificate file. If the CertStoreType is a blob, this specifies the certificate content. See Certificates for details.
CertStorePassword is the password for the certificate (if any).
CertSubject specified the subject of the certificate to load. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are 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 Component)
Used to add recipient certificates used to encrypt messages.
Syntax
void __fastcall AddRecipientCert(DynamicArray<Byte> CertEncoded);
Remarks
This method adds a public certificate used when Encrypt is called. Public certificates of recipients may be added using this method or by adding a certificate directly to the RecipientCerts property.
CertEncoded must contain the PEM or Base64 encoded public certificate.
Config Method (CMS Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (CMS Component)
Decrypts the current message.
Syntax
void __fastcall Decrypt();
Remarks
Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling AddCertificate or setting the Certificates property.
If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.
The following properties are applicable when calling this method:
- Certificates (Required)
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt a message
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt a message - DER Output Format
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();
byte[] encryptedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Multiple Recipients
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Get Recipient Info
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
Console.WriteLine(e.SerialNumber);
Console.WriteLine(e.Issuer);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
}
};
cms.GetRecipientInfo();
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
DecryptAndVerifySignature Method (CMS Component)
Decrypts and verifies the signature of the current message.
Syntax
void __fastcall DecryptAndVerifySignature();
Remarks
This method decrypts the input data and verifies the signature. Decryption certificates are specified by calling AddCertificate or setting the Certificates property. Certificates used to verify the signature will be taken from the message itself if included, or from the SignerCerts property.
If the certificate used to encrypt the message is not known ahead of time GetRecipientInfo may be called prior to calling Decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If GetRecipientInfo is called, the RecipientInfo event is fired with information about the recipient which may be used to load an appropriate decryption certificate.
In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling AddRecipientCert or setting RecipientCerts.
When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.
The following properties are applicable when calling this method:
- Certificates (Required)
- DetachedSignature
- DetachedSignatureData
- EnableCompression
- SignerCerts
If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.
If the input message is compressed EnableCompression must be set to True before calling this method.
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt Method (CMS Component)
Encrypts the current message.
Syntax
void __fastcall Encrypt();
Remarks
Encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling AddRecipientCert or setting the RecipientCerts property.
OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. The following properties are applicable when calling this method:
- RecipientCerts (required)
- EncryptionAlgorithm
- OutputFormat
- UseOAEP
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt a message
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt a message - DER Output Format
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();
byte[] encryptedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Multiple Recipients
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
Encrypt and Decrypt - Get Recipient Info
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();
string encryptedMessage = cms.OutputMessage;
//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
Console.WriteLine(e.SerialNumber);
Console.WriteLine(e.Issuer);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
}
};
cms.GetRecipientInfo();
cms.Decrypt();
string plaintextMessage = cms.OutputMessage;
GetRecipientInfo Method (CMS Component)
Gets the recipient certificate information for an encrypted message.
Syntax
void __fastcall GetRecipientInfo();
Remarks
This method retrieves information about the recipient(s) of the encrypted message. This may be called prior to calling Decrypt to determine which certificate should be loaded for decryption.
When this method is called the RecipientInfo event fires once for each recipient found within the message. Use the parameters of the RecipientInfo to determine which certificate to specify via AddCertificate or Certificates before calling Decrypt.
GetSignerCertInfo Method (CMS Component)
This method gets the signature information for an signed message.
Syntax
void __fastcall GetSignerCertInfo();
Remarks
This method retrieves information about the certificate used to sign the message. This may be called before calling VerifySignature to determine which certificate should be loaded for verification.
When this method is called, the SignerCertInfo event fires once for each signer of the message. Use the parameters of the SignerCertInfo to determine which certificate to specify before calling VerifySignature.
Note: Use of this method is optional. If no certificate is specified before calling VerifySignature, the component will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).
Reset Method (CMS Component)
This method resets the component properties.
Syntax
void __fastcall Reset();
Remarks
This method resets the values of all message and certificate properties. It is an easy way to reset the component properties before starting to populate with new values.
Sign Method (CMS Component)
Signs the current message.
Syntax
void __fastcall Sign();
Remarks
Sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling AddCertificate or setting the Certificates property.
OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. IncludeCertificates specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:
- Certificates (required)
- DetachedSignature
- EnableCompression
- GenerateSignatureTimestamp
- IncludeCertificates
- OutputFormat
- SignatureHashAlgorithm
- UsePSS
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Sign and Verify a message
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - DER Output Format
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();
byte[] signedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - Detached Signature
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();
string signature = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
Sign and Verify a message - Multiple Signatures
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - No Included Certificate
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
Console.WriteLine(e.Issuer);
Console.WriteLine(e.SerialNumber);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
//Load the correct signer certificate.
cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
}
};
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
SignAndEncrypt Method (CMS Component)
Signs and encrypts the current message.
Syntax
void __fastcall SignAndEncrypt();
Remarks
This method signs encrypts the input data with the the specified certificate(s). Encryption certificates are specified by calling AddRecipientCert or setting the RecipientCerts property. Signing certificates are set via the Certificates property.
OutputFormat specifies the encoding of the output message. Valid values are PEM, DER, and SMIME. Additional settings allow further configuration. IncludeCertificates specifies whether the public certificate is included in the signed message. The following properties are applicable when calling this method:
- Certificates (required)
- RecipientCerts (required)
- DetachedSignature
- EnableCompression
- EncryptionAlgorithm
- GenerateSignatureTimestamp
- IncludeCertificates
- OutputFormat
- SignatureHashAlgorithm
- UseOAEP
- UsePSS
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
VerifySignature Method (CMS Component)
Verifies the signature of the current message.
Syntax
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 or setting RecipientCerts.
When this method is called the SignerCertInfo event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via SignerCertInfo may be used to load an appropriate certificate for verification from within the event. If the CertEncoded parameter of SignerCertInfo is populated the certificate required for verification is already present in the message.
The following property are applicable when calling this method:
If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the component to treat the input message as a detached signature.
If the input message is compressed EnableCompression must be set to True before calling this method.
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Sign and Verify a message
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - DER Output Format
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();
byte[] signedMessage = cms.OutputMessageB; //Binary output
cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - Detached Signature
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();
string signature = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
Sign and Verify a message - Multiple Signatures
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Sign and Verify a message - No Included Certificate
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();
string signedMessage = cms.OutputMessage;
cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
Console.WriteLine(e.Issuer);
Console.WriteLine(e.SerialNumber);
if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
{
//Load the correct signer certificate.
cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
}
};
cms.InputMessage = signedMessage;
cms.VerifySignature();
string plaintextMessage = cms.OutputMessage;
Error Event (CMS Component)
Fired when information is available about errors during data delivery.
Syntax
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 section.
Log Event (CMS Component)
Fires with log information during processing.
Syntax
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 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 Component)
This event is fired for each recipient certificate of the encrypted message.
Syntax
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 is called on a valid encrypted message, this event will fire once for each recipient certificate that the message has been encrypted for. This may be used to identify the certificate to load.
Issuer is the subject of the issuer certificate.
SerialNumber is the serial number of the encryption certificate.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
SignerCertInfo Event (CMS Component)
Fired during verification of the signed message.
Syntax
typedef struct {
String Issuer;
String SerialNumber;
String SubjectKeyIdentifier;
String CertEncoded;
DynamicArray<Byte> 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 Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.CMS Config Settings
The default value is 1.2.840.113549.1.7.1 which is the OID for id-data.
NOTE: This config may only be used when the UseCryptoAPI is true.
The default value is True.
The default value for IncludeHeaders is true.
Note: This setting is only applicable to when OutputFormat is set to SMIME.
When set to False, only the message will be processed, MIME part headers will not be generated or stripped.
The default value for IncludeInternalHeaders is False.
Note: This setting is only applicable to when OutputFormat is set to SMIME.
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 is set to SMIME and when calling Sign or SignAndEncrypt and DetachedSignature is True.
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 is set to SMIME and when calling Sign or SignAndEncrypt and DetachedSignature is True.
| 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. |
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
Note: This setting is not applicable when UseFIPSCompliantAPI is set to true or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate OAEPRSAHashAlgorithm and OAEPMGF1HashAlgorithm values. In this case the OAEPRSAHashAlgorithm is also used for MGF1.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
Note: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension.
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
Note: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension.
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
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
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 article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
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 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. |