CMS Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksEncrypt.Cms

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Encryption Notes

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Signature Verification Notes

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Decryption Notes

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

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

The following properties are applicable when calling this method:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Property List


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

CertificatesA collection of certificates used for signing and decryption.
DetachedSignatureSpecifies whether to include a detached signature when signing a message.
DetachedSignatureDataThe detached signature.
EnableCompressionSpecifies whether to compress the message.
EncryptionAlgorithmThe algorithm used for encryption.
IncludeCertificatesSpecifies whether to include the signer's certificate with the signed message.
InputFileThe file to process.
InputMessageThe message to process.
OutputFileThe output file.
OutputFormatSpecifies the output format.
OutputMessageThe output message after processing.
RecipientCertsThe collection of recipient certificates.
SignatureHashAlgorithmThe signature hash algorithm used during signing.
SignerCertsThe collection of signer certificates.
UseOAEPThis property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
UsePSSWhether 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.

AddCertificateUsed to add certificates for signing.
AddRecipientCertUsed to add recipient certificates used to encrypt messages.
ConfigSets or retrieves a configuration setting.
DecryptDecrypts the current message.
DecryptAndVerifySignatureDecrypts and verifies the signature of the current message.
EncryptEncrypts the current message.
GetRecipientInfoGets the recipient certificate information for an encrypted message.
GetSignerCertInfoThis method gets the signature information for an signed message.
ResetThis method resets the component properties.
SetInputStreamSets the stream from which the component will read data to encode or decode.
SetOutputStreamSets the stream to which the component will read data to encode or decode.
SignSigns the current message.
SignAndEncryptSigns and encrypts the current message.
VerifySignatureVerifies 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.

ErrorFired when information is available about errors during data delivery.
LogFires with log information during processing.
RecipientInfoThis event is fired for each recipient certificate of the encrypted message.
SignerCertInfoFired 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.

CloseInputStreamAfterProcessDetermines whether or not the input stream is closed after processing.
CloseOutputStreamAfterProcessDetermines whether or not the output stream is closed after processing.
CompressBeforeSignSpecifies whether to compress before signing.
ContentTypeOIDSpecifies the oid for content type.
CSPThe Cryptographic Service Provider.
GenerateSignatureTimestampWhether to generate timestamps in signatures.
IncludeHeadersTells the component whether to include the headers when encoding the message.
IncludeInternalHeadersTells the component whether or not to include the internal headers when encoding the message.
InputContentTransferEncodingSets the Content-Transfer-Encoding for the signed message.
InputContentTypeSets the Content-Type for the signed message.
InputMessageHeadersMessage headers.
LogDirectoryThe directory on disk where debug logs are written.
LogFilenameThe base filename to use with LogDirectory.
LogLevelThe level of detail for log messages.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used with OAEP.
OAEPParamsThe hex encoded OAEP parameters.
OAEPRSAHashAlgorithmThe RSA hash algorithm used with OAEP.
OutputMessageHeadersThe SMIME headers of the output message.
RecipientInfoTypeThe type of signer information to include in the signed message.
SignatureTimestampThe signature timestamp in the signed message.
SignerInfoTypeThe type of signer information to include in the signed message.
UseAlgorithmOIDsWhether OIDs are used when providing information about the algorithms.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Certificates Property (CMS Component)

A collection of certificates used for signing and decryption.

Syntax

public CertificateList Certificates { get; }
Public Property Certificates As CertificateList

Remarks

This property hold a collection of certificates used when Sign is called. The input message will be signed with each certificate specified in this property. AddCertificate may also be used to add a certificate to this collection.

The certificate(s) specified here are also used to decrypt the message when Decrypt is called.

Please refer to the Certificate type for a complete list of fields.

DetachedSignature Property (CMS Component)

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

Syntax

public bool DetachedSignature { get; set; }
Public Property DetachedSignature As Boolean

Default Value

False

Remarks

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

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

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

DetachedSignatureData Property (CMS Component)

The detached signature.

Syntax

public string DetachedSignatureData { get; set; }
public byte[] DetachedSignatureDataB { get; set; }
Public Property DetachedSignatureData As String
Public Property DetachedSignatureDataB As Byte()

Default Value

""

Remarks

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

EnableCompression Property (CMS Component)

Specifies whether to compress the message.

Syntax

public bool EnableCompression { get; set; }
Public Property EnableCompression As Boolean

Default Value

False

Remarks

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

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

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

EncryptionAlgorithm Property (CMS Component)

The algorithm used for encryption.

Syntax

public string EncryptionAlgorithm { get; set; }
Public Property EncryptionAlgorithm As String

Default Value

"3DES"

Remarks

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

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

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

IncludeCertificates Property (CMS Component)

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

Syntax

public CmsIncludeCertificates IncludeCertificates { get; set; }

enum CmsIncludeCertificates { icsNone, icsSignerCerts, icsSignerCertsAndChain }
Public Property IncludeCertificates As CmsIncludeCertificates

Enum CmsIncludeCertificates icsNone icsSignerCerts icsSignerCertsAndChain End Enum

Default Value

1

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.

InputFile Property (CMS Component)

The file to process.

Syntax

public string InputFile { get; set; }
Public Property InputFile As String

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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (CMS Component)

The message to process.

Syntax

public string InputMessage { get; set; }
public byte[] InputMessageB { get; set; }
Public Property InputMessage As String
Public Property InputMessageB As Byte()

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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

OutputFile Property (CMS Component)

The output file.

Syntax

public string OutputFile { get; set; }
Public Property OutputFile As String

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

OutputFormat Property (CMS Component)

Specifies the output format.

Syntax

public string OutputFormat { get; set; }
Public Property OutputFormat As String

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=

OutputMessage Property (CMS Component)

The output message after processing.

Syntax

public string OutputMessage { get; }
public byte[] OutputMessageB { get; }
Public ReadOnly Property OutputMessage As String
Public ReadOnly Property OutputMessageB As Byte()

Default Value

""

Remarks

This property will be populated with the output of the operation if OutputFile and SetOutputStream are 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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

This property is read-only.

RecipientCerts Property (CMS Component)

The collection of recipient certificates.

Syntax

public CertificateList RecipientCerts { get; }
Public Property RecipientCerts As CertificateList

Remarks

This property is used to specify one or more public certificate used to encrypt the message. The certificates should be the public certificate of the recipient who will decrypt the message. The certificate(s) must be set before calling Encrypt or SignAndEncrypt methods.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SignatureHashAlgorithm Property (CMS Component)

The signature hash algorithm used during signing.

Syntax

public string SignatureHashAlgorithm { get; set; }
Public Property SignatureHashAlgorithm As String

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"

SignerCerts Property (CMS Component)

The collection of signer certificates.

Syntax

public CertificateList SignerCerts { get; }
Public Property SignerCerts As CertificateList

Remarks

This property is used to specify one or more public certificate used to verify the message. The certificates should be the public certificate of the recipient who will verify the message.

This property is only required if a certificate is not included in the signed message. The SignerCertInfo event fires during verification with information about the signer certificate. This property may be populated from within the SignerCertInfo.

This property will also be populated after VerifySignature or DecryptAndVerifySignature is called with the certificate(s) present within the signed message (if any).

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

UseOAEP Property (CMS Component)

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

Syntax

public bool UseOAEP { get; set; }
Public Property UseOAEP As Boolean

Default Value

False

Remarks

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the component will use PKCS1.

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

UsePSS Property (CMS Component)

Whether to use RSA-PSS during signing and verification.

Syntax

public bool UsePSS { get; set; }
Public Property UsePSS As Boolean

Default Value

False

Remarks

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

AddCertificate Method (CMS Component)

Used to add certificates for signing.

Syntax

public void AddCertificate(int certStoreType, string certStore, string certStorePassword, string certSubject);

Async Version
public async Task AddCertificate(int certStoreType, string certStore, string certStorePassword, string certSubject);
public async Task AddCertificate(int certStoreType, string certStore, string certStorePassword, string certSubject, CancellationToken cancellationToken);
Public Sub AddCertificate(ByVal CertStoreType As Integer, ByVal CertStore As String, ByVal CertStorePassword As String, ByVal CertSubject As String)

Async Version
Public Sub AddCertificate(ByVal CertStoreType As Integer, ByVal CertStore As String, ByVal CertStorePassword As String, ByVal CertSubject As String) As Task
Public Sub AddCertificate(ByVal CertStoreType As Integer, ByVal CertStore As String, ByVal CertStorePassword As String, ByVal CertSubject As String, cancellationToken As CancellationToken) As Task

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 field 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 Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail 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

public void AddRecipientCert(byte[] certEncoded);

Async Version
public async Task AddRecipientCert(byte[] certEncoded);
public async Task AddRecipientCert(byte[] certEncoded, CancellationToken cancellationToken);
Public Sub AddRecipientCert(ByVal CertEncoded As String)

Async Version
Public Sub AddRecipientCert(ByVal CertEncoded As String) As Task
Public Sub AddRecipientCert(ByVal CertEncoded As String, cancellationToken As CancellationToken) As Task

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

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (CMS Component)

Decrypts the current message.

Syntax

public void Decrypt();

Async Version
public async Task Decrypt();
public async Task Decrypt(CancellationToken cancellationToken);
Public Sub Decrypt()

Async Version
Public Sub Decrypt() As Task
Public Sub Decrypt(cancellationToken As CancellationToken) As Task

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

DecryptAndVerifySignature Method (CMS Component)

Decrypts and verifies the signature of the current message.

Syntax

public void DecryptAndVerifySignature();

Async Version
public async Task DecryptAndVerifySignature();
public async Task DecryptAndVerifySignature(CancellationToken cancellationToken);
Public Sub DecryptAndVerifySignature()

Async Version
Public Sub DecryptAndVerifySignature() As Task
Public Sub DecryptAndVerifySignature(cancellationToken As CancellationToken) As Task

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Encrypt Method (CMS Component)

Encrypts the current message.

Syntax

public void Encrypt();

Async Version
public async Task Encrypt();
public async Task Encrypt(CancellationToken cancellationToken);
Public Sub Encrypt()

Async Version
Public Sub Encrypt() As Task
Public Sub Encrypt(cancellationToken As CancellationToken) As Task

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

GetRecipientInfo Method (CMS Component)

Gets the recipient certificate information for an encrypted message.

Syntax

public void GetRecipientInfo();

Async Version
public async Task GetRecipientInfo();
public async Task GetRecipientInfo(CancellationToken cancellationToken);
Public Sub GetRecipientInfo()

Async Version
Public Sub GetRecipientInfo() As Task
Public Sub GetRecipientInfo(cancellationToken As CancellationToken) As Task

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

public void GetSignerCertInfo();

Async Version
public async Task GetSignerCertInfo();
public async Task GetSignerCertInfo(CancellationToken cancellationToken);
Public Sub GetSignerCertInfo()

Async Version
Public Sub GetSignerCertInfo() As Task
Public Sub GetSignerCertInfo(cancellationToken As CancellationToken) As Task

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

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SetInputStream Method (CMS Component)

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

Syntax

public void SetInputStream(System.IO.Stream inputStream);

Async Version
public async Task SetInputStream(System.IO.Stream inputStream);
public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken);
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

Encrypt or Sign

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

Decrypt or Verify

When decrypting or verifying a signature this may be set to a stream with the encrypted or signed message.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

SetOutputStream Method (CMS Component)

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

Syntax

public void SetOutputStream(System.IO.Stream outputStream);

Async Version
public async Task SetOutputStream(System.IO.Stream outputStream);
public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken);
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

Encrypt or Sign

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

Decrypt or Verify

When decrypting or verifying a signature this may be set to a stream where the decrypted/verified data will be written.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Sign Method (CMS Component)

Signs the current message.

Syntax

public void Sign();

Async Version
public async Task Sign();
public async Task Sign(CancellationToken cancellationToken);
Public Sub Sign()

Async Version
Public Sub Sign() As Task
Public Sub Sign(cancellationToken As CancellationToken) As Task

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

SignAndEncrypt Method (CMS Component)

Signs and encrypts the current message.

Syntax

public void SignAndEncrypt();

Async Version
public async Task SignAndEncrypt();
public async Task SignAndEncrypt(CancellationToken cancellationToken);
Public Sub SignAndEncrypt()

Async Version
Public Sub SignAndEncrypt() As Task
Public Sub SignAndEncrypt(cancellationToken As CancellationToken) As Task

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:

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

VerifySignature Method (CMS Component)

Verifies the signature of the current message.

Syntax

public void VerifySignature();

Async Version
public async Task VerifySignature();
public async Task VerifySignature(CancellationToken cancellationToken);
Public Sub VerifySignature()

Async Version
Public Sub VerifySignature() As Task
Public Sub VerifySignature(cancellationToken As CancellationToken) As Task

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Error Event (CMS Component)

Fired when information is available about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, CmsErrorEventArgs e);

public class CmsErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As CmsErrorEventArgs)

Public Class CmsErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws 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

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, CmsLogEventArgs e);

public class CmsLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}
Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As CmsLogEventArgs)

Public Class CmsLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

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

public event OnRecipientInfoHandler OnRecipientInfo;

public delegate void OnRecipientInfoHandler(object sender, CmsRecipientInfoEventArgs e);

public class CmsRecipientInfoEventArgs : EventArgs {
  public string Issuer { get; }
  public string SerialNumber { get; }
  public string SubjectKeyIdentifier { get; }
  public string EncryptionAlgorithm { get; }
}
Public Event OnRecipientInfo As OnRecipientInfoHandler

Public Delegate Sub OnRecipientInfoHandler(sender As Object, e As CmsRecipientInfoEventArgs)

Public Class CmsRecipientInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property SerialNumber As String
  Public ReadOnly Property SubjectKeyIdentifier As String
  Public ReadOnly Property EncryptionAlgorithm As String
End Class

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

public event OnSignerCertInfoHandler OnSignerCertInfo;

public delegate void OnSignerCertInfoHandler(object sender, CmsSignerCertInfoEventArgs e);

public class CmsSignerCertInfoEventArgs : EventArgs {
  public string Issuer { get; }
  public string SerialNumber { get; }
  public string SubjectKeyIdentifier { get; }
  public string CertEncoded { get; }
public byte[] CertEncodedB { get; } }
Public Event OnSignerCertInfo As OnSignerCertInfoHandler

Public Delegate Sub OnSignerCertInfoHandler(sender As Object, e As CmsSignerCertInfoEventArgs)

Public Class CmsSignerCertInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property SerialNumber As String
  Public ReadOnly Property SubjectKeyIdentifier As String
  Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

EffectiveDate
string (read-only)

Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
string

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

EncodedB
byte []

Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

ExpirationDate
string (read-only)

Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string

Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string (read-only)

Default Value: ""

This is 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

FingerprintSHA1
string (read-only)

Default Value: ""

This is 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

FingerprintSHA256
string (read-only)

Default Value: ""

This is 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

Issuer
string (read-only)

Default Value: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
string (read-only)

Default Value: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
bool (read-only)

Default Value: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default Value: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string (read-only)

Default Value: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string

Default Value: ""

This field contains 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.

PublicKeyLength
int (read-only)

Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string (read-only)

Default Value: ""

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
string (read-only)

Default Value: ""

The field contains 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.

Store
string

Default Value: "MY"

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

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

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

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte []

Default Value: "MY"

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

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

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

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
string

Default Value: ""

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

StoreType
CertStoreTypes

Default Value: 0

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field 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 Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

Subject
string

Default Value: ""

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

SubjectAltNames
string (read-only)

Default Value: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default Value: ""

This field contains 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.

ThumbprintSHA1
string (read-only)

Default Value: ""

This field contains 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.

ThumbprintSHA256
string (read-only)

Default Value: ""

This field contains 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.

Usage
string

Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int

Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication (Non-Repudiation)
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
string (read-only)

Default Value: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();
Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);
Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

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

CloseInputStreamAfterProcess:   Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is False.

CloseOutputStreamAfterProcess:   Determines whether or not the output stream is closed after processing.

Determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is False.

CompressBeforeSign:   Specifies whether to compress before signing.

When EnableCompression is set to True this property controls whether compression happens before or after signing. If set to True the input data will be compressed before signing. If set to False (default) the input data will be signed and then compressed.

ContentTypeOID:   Specifies the oid for content type.

This setting optionally specifies an OID defining the data content type for the data being processed. This may be set before calling Encrypt, Sign, or SignAndEncrypt.

The default value is 1.2.840.113549.1.7.1 which is the OID for id-data.

CSP:   The Cryptographic Service Provider.

For the Win32 editions, the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations.

NOTE: This config may only be used when the UseCryptoAPI is true.

GenerateSignatureTimestamp:   Whether to generate timestamps in signatures.

If GenerateSignatureTimestamp is True, a timestamp will be generated and added to all signatures created by the component.

The default value is True.

IncludeHeaders:   Tells the component whether to include the headers when encoding the message.

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

The default value for IncludeHeaders is true.

Note: This setting is only applicable to when OutputFormat is set to SMIME.

IncludeInternalHeaders:   Tells the component whether or not to include the internal headers when encoding the message.

If True, the component will generate and include MIME part headers when Sign, Encrypt, or SignAndEncrypt are called. When VerifySignature, Decrypt, or DecryptAndVerifySignature are called the MIME part headers will be stripped.

When set to False, only the message will be processed, MIME part headers will not be generated or stripped.

The default value for IncludeInternalHeaders is False.

Note: This setting is only applicable to when OutputFormat is set to SMIME.

InputContentTransferEncoding:   Sets the Content-Transfer-Encoding for the signed message.

This setting specifies the Content-Transfer-Encoding header value in signed messages. By default the component will automatically determine the Content-Transfer-Encoding based on the file extension set in InputFile, however this setting may be set to override the determined value or to specify a value if data is read from InputMessage.

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.

InputContentType:   Sets the Content-Type for the signed message.

This setting specifies the Content-Type header value in signed messages. By default the component will automatically determine the Content-Type based on the file extension set in InputFile, however this setting may be set to override the determined value or to specify a value if data is read from InputMessage.

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.

InputMessageHeaders:   Message headers.

This setting specifies the headers of the SMIME message if they are not already present in the input message. In most cases the input message itself will contain the necessary headers, however if the headers are and body of the SMIME message are separate, the headers may be specified in this setting before calling Decrypt, DecryptAndVerifySignature, or VerifySignature.

LogDirectory:   The directory on disk where debug logs are written.

This setting specifies a directory on disk to which debug logs will be written during operation. This should only be set for debugging purposes. Files with various extensions will be written to disk at the location specified with debug data for the operation being performed. If LogFilename is not specified the filenames will be in the format yyyy-MM-dd-HH-mm-ss-fff.

LogFilename:   The base filename to use with LogDirectory.

This setting specifies the base filename to use when LogDirectory is set. If specified the name should be a filename without extension. Various files will be logged with different extensions during operation. This setting defines only the base filename. If unspecified the files will be named with a timestamp in the format yyyy-MM-dd-HH-mm-ss-fff.

LogLevel:   The level of detail for log messages.

This setting specifies the level of detail that is logged via the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.
OAEPMGF1HashAlgorithm:   The MGF1 hash algorithm used with OAEP.

This configuration setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"

Note: This setting is not applicable when UseFIPSCompliantAPI 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.

OAEPParams:   The hex encoded OAEP parameters.

This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when UseOAEP is set to True. The specified value should be hex encoded.

OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP.

This configuration setting specifies that RSA hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
OutputMessageHeaders:   The SMIME headers of the output message.

When IncludeHeaders is set to False the SMIME headers are not included in the output message itself when Sign, Encrypt, or SignAndEncrypt are called. This setting may be used to obtain the SMIME headers separately. This setting is only applicable when OutputFormat is set to SMIME.

RecipientInfoType:   The type of signer information to include in the signed message.

This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension.

SignatureTimestamp:   The signature timestamp in the signed message.

This setting holds the timestamp of the signature. After calling VerifySignature this setting will hold the timestamp identifying when the signature was created. The timestamp is in UTC time with the format yyyyMMddHHmmss. For instance 20181130223821.

SignerInfoType:   The type of signer information to include in the signed message.

This configuration setting specifies which type of information about the signer certificate is included in the signed message. Possible values are as follows:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension.

UseAlgorithmOIDs:   Whether OIDs are used when providing information about the algorithms.

This configuration setting controls whether the EncryptionAlgorithm parameter of the RecipientInfo event is populated with the name of the algorithm, such as 3DES or the corresponding OID such as 1.2.840.113549.3.7.

The default value is False, and the name of the algorithm is used. Set this to True to use the object identifiers instead.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

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.