CMS Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksencrypt.Cms

Remarks

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

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

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

Signing Notes

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

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

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

Encryption Notes

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

• RecipientCerts (required)
• EncryptionAlgorithm
• OutputFormat
• UseOAEP

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

Signature Verification Notes

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

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

The following property are applicable when calling this method:

• DetachedSignature
• DetachedSignatureData
• EnableCompression
• SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the class 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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

Decryption Notes

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

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

The following properties are applicable when calling this method:

• Certificates (Required)

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Certificates Property (CMS Class)

A collection of certificates used for signing and decryption.

Syntax

public CertificateList getCertificates();


public void setCertificates(CertificateList certificates);

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.

DetachedSignature Property (CMS Class)

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

Syntax

public boolean isDetachedSignature();


public void setDetachedSignature(boolean detachedSignature);

Default Value

False

Remarks

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

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

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

DetachedSignatureData Property (CMS Class)

The detached signature.

Syntax

public byte[] getDetachedSignatureData();


public void setDetachedSignatureData(byte[] detachedSignatureData);

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

Specifies whether to compress the message.

Syntax

public boolean isEnableCompression();


public void setEnableCompression(boolean enableCompression);

Default Value

False

Remarks

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

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

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

EncryptionAlgorithm Property (CMS Class)

The algorithm used for encryption.

Syntax

public String getEncryptionAlgorithm();


public void setEncryptionAlgorithm(String encryptionAlgorithm);

Default Value

"3DES"

Remarks

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

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

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

IncludeCertificates Property (CMS Class)

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

Syntax

public int getIncludeCertificates();


public void setIncludeCertificates(int includeCertificates);


Enumerated values:
  public final static int icsNone = 0;
  public final static int icsSignerCerts = 1;
  public final static int icsSignerCertsAndChain = 2;

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:

InputFile Property (CMS Class)

The file to process.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Encrypt and/or Sign

When encrypting or signing this may be set to a file containing content that will be encrypted and/or signed.

Decrypt and/or Verify

When decrypting or verifying a signature this may be set to a file containing the PEM, DER, or SMIME encoded message.

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

InputMessage Property (CMS Class)

The message to process.

Syntax

public byte[] getInputMessage();


public void setInputMessage(byte[] inputMessage);

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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

OutputFile Property (CMS Class)

The output file.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Encrypt and/or Sign

When encrypting or signing this specifies a file where the message will be written.

Decrypt and/or Verify

When decrypting or verifying a signature this specifies a file where the decrypted/verified content will be written.

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

OutputFormat Property (CMS Class)

Specifies the output format.

Syntax

public String getOutputFormat();


public void setOutputFormat(String outputFormat);

Default Value

"PEM"

Remarks

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

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

Possible values are:

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

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

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

OutputMessage Property (CMS Class)

The output message after processing.

Syntax

public byte[] getOutputMessage();

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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

This property is read-only.

RecipientCerts Property (CMS Class)

The collection of recipient certificates.

Syntax

public CertificateList getRecipientCerts();


public void setRecipientCerts(CertificateList recipientCerts);

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.

SignatureHashAlgorithm Property (CMS Class)

The signature hash algorithm used during signing.

Syntax

public String getSignatureHashAlgorithm();


public void setSignatureHashAlgorithm(String signatureHashAlgorithm);

Default Value

"SHA256"

Remarks

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

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

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

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

SignerCerts Property (CMS Class)

The collection of signer certificates.

Syntax

public CertificateList getSignerCerts();


public void setSignerCerts(CertificateList signerCerts);

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.

UseOAEP Property (CMS Class)

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

Syntax

public boolean isUseOAEP();


public void setUseOAEP(boolean useOAEP);

Default Value

False

Remarks

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

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

UsePSS Property (CMS Class)

Whether to use RSA-PSS during signing and verification.

Syntax

public boolean isUsePSS();


public void setUsePSS(boolean usePSS);

Default Value

False

Remarks

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

AddCertificate Method (Cms Class)

Used to add certificates for signing.

Syntax

public void addCertificate(int certStoreType, String certStore, String certStorePassword, String certSubject);

Remarks

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

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

CertStoreType specifies the type of certificate store. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This field can take one of the following values:

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

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

CertSubject specified the subject of the certificate to load. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

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

AddRecipientCert Method (Cms Class)

Used to add recipient certificates used to encrypt messages.

Syntax

public void addRecipientCert(byte[] certEncoded);

Remarks

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

CertEncoded must contain the PEM or Base64 encoded public certificate.

Config Method (Cms Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

Decrypts the current message.

Syntax

public void decrypt();

Remarks

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

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

The following properties are applicable when calling this method:

• Certificates (Required)

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

DecryptAndVerifySignature Method (Cms Class)

Decrypts and verifies the signature of the current message.

Syntax

public void decryptAndVerifySignature();

Remarks

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

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

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

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

The following properties are applicable when calling this method:

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

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the class 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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

Encrypt Method (Cms Class)

Encrypts the current message.

Syntax

public void encrypt();

Remarks

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

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

• RecipientCerts (required)
• EncryptionAlgorithm
• OutputFormat
• UseOAEP

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

GetRecipientInfo Method (Cms Class)

Gets the recipient certificate information for an encrypted message.

Syntax

public void getRecipientInfo();

Remarks

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

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

GetSignerCertInfo Method (Cms Class)

This method gets the signature information for an signed message.

Syntax

public void getSignerCertInfo();

Remarks

This method retrieves information about the certificate used to sign the message. This may be called before calling VerifySignature to determine which certificate should be loaded for verification.

When this method is called, the SignerCertInfo event fires once for each signer of the message. Use the parameters of the SignerCertInfo to determine which certificate to specify before calling VerifySignature.

Note: Use of this method is optional. If no certificate is specified before calling VerifySignature, the class will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).

Reset Method (Cms Class)

This method resets the class properties.

Syntax

public void reset();

Remarks

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

SetInputStream Method (Cms Class)

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

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method sets the stream from which the class 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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

SetOutputStream Method (Cms Class)

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

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method sets the stream to which the class 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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

Sign Method (Cms Class)

Signs the current message.

Syntax

public void sign();

Remarks

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

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

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

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

SignAndEncrypt Method (Cms Class)

Signs and encrypts the current message.

Syntax

public void signAndEncrypt();

Remarks

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

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

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

Input and Output Properties

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

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

VerifySignature Method (Cms Class)

Verifies the signature of the current message.

Syntax

public void verifySignature();

Remarks

VerifySignature verifies the signature of the input message.

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

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

The following property are applicable when calling this method:

• DetachedSignature
• DetachedSignatureData
• EnableCompression
• SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in DetachedSignatureData. In addition the DetachedSignature property must be set to True to instruct the class 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 class will determine the source and destination of the input and output based on which properties are set.

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

• SetInputStream
• InputFile
• InputMessage

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

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

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

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

Error Event (Cms Class)

Information about errors during data delivery.

Syntax

public class DefaultCmsEventListener implements CmsEventListener {
  ...
  public void error(CmsErrorEvent e) {}
  ...
}

public class CmsErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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

Log Event (Cms Class)

Fires with log information during processing.

Syntax

public class DefaultCmsEventListener implements CmsEventListener {
  ...
  public void log(CmsLogEvent e) {}
  ...
}

public class CmsLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

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

LogLevel indicates the level of message. Possible values are:

LogMessage is the log entry.

LogType indicates the type of log. Possible values are:

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

RecipientInfo Event (Cms Class)

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

Syntax

public class DefaultCmsEventListener implements CmsEventListener {
  ...
  public void recipientInfo(CmsRecipientInfoEvent e) {}
  ...
}

public class CmsRecipientInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public String encryptionAlgorithm;
}

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

Fired during verification of the signed message.

Syntax

public class DefaultCmsEventListener implements CmsEventListener {
  ...
  public void signerCertInfo(CmsSignerCertInfoEvent e) {}
  ...
}

public class CmsSignerCertInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public byte[] certEncoded;
}

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

Constructors

public Certificate();

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

public Certificate( certificateFile);

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

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

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 class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

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 CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 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 class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

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 class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

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 class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

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 class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

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 class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Config Settings (Cms Class)

CMS Config Settings

Base Config Settings

Trappable Errors (Cms Class)

CMS Errors