# CMS Class

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

## Class Name

**IPWorksEncrypt_CMS**

## Procedural Interface

```text
 ipworksencrypt_cms_open();
 ipworksencrypt_cms_close($res);
 ipworksencrypt_cms_register_callback($res, $id, $function);
 ipworksencrypt_cms_get_last_error($res);
 ipworksencrypt_cms_get_last_error_code($res);
 ipworksencrypt_cms_set($res, $id, $index, $value);
 ipworksencrypt_cms_get($res, $id, $index);
 ipworksencrypt_cms_do_addcertificate($res, $certstoretype, $certstore, $certstorepassword, $certsubject);
 ipworksencrypt_cms_do_addrecipientcert($res, $certencoded);
 ipworksencrypt_cms_do_config($res, $configurationstring);
 ipworksencrypt_cms_do_decrypt($res);
 ipworksencrypt_cms_do_decryptandverifysignature($res);
 ipworksencrypt_cms_do_encrypt($res);
 ipworksencrypt_cms_do_getrecipientinfo($res);
 ipworksencrypt_cms_do_getsignercertinfo($res);
 ipworksencrypt_cms_do_reset($res);
 ipworksencrypt_cms_do_sign($res);
 ipworksencrypt_cms_do_signandencrypt($res);
 ipworksencrypt_cms_do_verifysignature($res);
```

## Remarks

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

- [Sign](#sign-method-ipworksencrypt_cms-class)
- [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class)
- [Encrypt](#encrypt-method-ipworksencrypt_cms-class)
- [Decrypt](#decrypt-method-ipworksencrypt_cms-class)
- [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class)
- [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworksencrypt_cms-class)

The class can generate and consume message in a variety of formats including *PEM*, *DER* (Binary), and *SMIME*. The [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_cms-class) and [SignatureHashAlgorithm](#signaturehashalgorithm-property-ipworksencrypt_cms-class) 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](#getrecipientinfo-method-ipworksencrypt_cms-class) and [GetSignerCertInfo](#getsignercertinfo-method-ipworksencrypt_cms-class) methods as well as the [RecipientInfo](#recipientinfo-event-ipworksencrypt_cms-class) and [SignerCertInfo](#signercertinfo-event-ipworksencrypt_cms-class) events allow for a dynamic and flexible approach to message processing. Certificate may be loaded ahead of time or as-needed from the events.

### Signing Notes

 [Sign](#sign-method-ipworksencrypt_cms-class) digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or setting the Certificates property.

[OutputFormat](#outputformat-property-ipworksencrypt_cms-class) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class) specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:

- Certificates (required)
- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- [GenerateSignatureTimestamp](#GenerateSignatureTimestamp)
- [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class)
- [OutputFormat](#outputformat-property-ipworksencrypt_cms-class)
- [SignatureHashAlgorithm](#signaturehashalgorithm-property-ipworksencrypt_cms-class)
- [UsePSS](#usepss-property-ipworksencrypt_cms-class)

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Sign and Verify a message**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();

byte[] signedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - Detached Signature**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();

string signature = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
```

 **Sign and Verify a message - Multiple Signatures**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - No Included Certificate**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
  Console.WriteLine(e.Issuer);
  Console.WriteLine(e.SerialNumber);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    //Load the correct signer certificate.
    cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
  }
};
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

### Encryption Notes

 [Encrypt](#encrypt-method-ipworksencrypt_cms-class) encrypts the input data with the the specified certificate(s). Certificates are specified by calling [AddRecipientCert](#addrecipientcert-method-ipworksencrypt_cms-class) or setting the RecipientCerts property.

[OutputFormat](#outputformat-property-ipworksencrypt_cms-class) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. The following properties are applicable when calling this method:

- RecipientCerts (required)
- [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_cms-class)
- [OutputFormat](#outputformat-property-ipworksencrypt_cms-class)
- [UseOAEP](#useoaep-property-ipworksencrypt_cms-class)

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Encrypt and Decrypt a message**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();

byte[] encryptedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Multiple Recipients**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Get Recipient Info**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
  Console.WriteLine(e.SerialNumber);
  Console.WriteLine(e.Issuer);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
  }
};

cms.GetRecipientInfo();
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

### Signature Verification Notes

 [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class) verifies the signature of the input message.

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

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

The following property are applicable when calling this method:

- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class). In addition the [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) 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](#enablecompression-property-ipworksencrypt_cms-class) 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:

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Sign and Verify a message**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();

byte[] signedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - Detached Signature**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();

string signature = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
```

 **Sign and Verify a message - Multiple Signatures**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - No Included Certificate**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
  Console.WriteLine(e.Issuer);
  Console.WriteLine(e.SerialNumber);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    //Load the correct signer certificate.
    cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
  }
};
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

### Decryption Notes

[Decrypt](#decrypt-method-ipworksencrypt_cms-class) decrypts the input data with the specified certificate. Certificates are specified by calling [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or setting the Certificates property.

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

The following properties are applicable when calling this method:

- Certificates (Required)

 **Input and Output Properties**

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Encrypt and Decrypt a message**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();

byte[] encryptedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Multiple Recipients**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Get Recipient Info**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
  Console.WriteLine(e.SerialNumber);
  Console.WriteLine(e.Issuer);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
  }
};

cms.GetRecipientInfo();
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

## Property List

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

|  |  |
| --- | --- |
| [CertCount](#certcount-property-ipworksencrypt_cms-class) | The number of records in the Cert arrays. |
| [CertEffectiveDate](#certeffectivedate-property-ipworksencrypt_cms-class) | The date on which this certificate becomes valid. |
| [CertExpirationDate](#certexpirationdate-property-ipworksencrypt_cms-class) | The date on which the certificate expires. |
| [CertExtendedKeyUsage](#certextendedkeyusage-property-ipworksencrypt_cms-class) | A comma-delimited list of extended key usage identifiers. |
| [CertFingerprint](#certfingerprint-property-ipworksencrypt_cms-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [CertFingerprintSHA1](#certfingerprintsha1-property-ipworksencrypt_cms-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [CertFingerprintSHA256](#certfingerprintsha256-property-ipworksencrypt_cms-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [CertIssuer](#certissuer-property-ipworksencrypt_cms-class) | The issuer of the certificate. |
| [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class) | The private key of the certificate (if available). |
| [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_cms-class) | Whether a PrivateKey is available for the selected certificate. |
| [CertPrivateKeyContainer](#certprivatekeycontainer-property-ipworksencrypt_cms-class) | The name of the PrivateKey container for the certificate (if available). |
| [CertPublicKey](#certpublickey-property-ipworksencrypt_cms-class) | The public key of the certificate. |
| [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ipworksencrypt_cms-class) | The textual description of the certificate's public key algorithm. |
| [CertPublicKeyLength](#certpublickeylength-property-ipworksencrypt_cms-class) | The length of the certificate's public key (in bits). |
| [CertSerialNumber](#certserialnumber-property-ipworksencrypt_cms-class) | The serial number of the certificate encoded as a string. |
| [CertSignatureAlgorithm](#certsignaturealgorithm-property-ipworksencrypt_cms-class) | The text description of the certificate's signature algorithm. |
| [CertStore](#certstore-property-ipworksencrypt_cms-class) | The name of the certificate store for the client certificate. |
| [CertStorePassword](#certstorepassword-property-ipworksencrypt_cms-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [CertStoreType](#certstoretype-property-ipworksencrypt_cms-class) | The type of certificate store for this certificate. |
| [CertSubjectAltNames](#certsubjectaltnames-property-ipworksencrypt_cms-class) | Comma-separated lists of alternative subject names for the certificate. |
| [CertThumbprintMD5](#certthumbprintmd5-property-ipworksencrypt_cms-class) | The MD5 hash of the certificate. |
| [CertThumbprintSHA1](#certthumbprintsha1-property-ipworksencrypt_cms-class) | The SHA-1 hash of the certificate. |
| [CertThumbprintSHA256](#certthumbprintsha256-property-ipworksencrypt_cms-class) | The SHA-256 hash of the certificate. |
| [CertUsage](#certusage-property-ipworksencrypt_cms-class) | The text description of UsageFlags . |
| [CertUsageFlags](#certusageflags-property-ipworksencrypt_cms-class) | The flags that show intended use for the certificate. |
| [CertVersion](#certversion-property-ipworksencrypt_cms-class) | The certificate's version number. |
| [CertSubject](#certsubject-property-ipworksencrypt_cms-class) | The subject of the certificate used for client authentication. |
| [CertEncoded](#certencoded-property-ipworksencrypt_cms-class) | The certificate (PEM/Base64 encoded). |
| [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) | Specifies whether to include a detached signature when signing a message. |
| [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class) | The detached signature. |
| [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class) | Specifies whether to compress the message. |
| [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_cms-class) | The algorithm used for encryption. |
| [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class) | Specifies whether to include the signer's certificate with the signed message. |
| [InputFile](#inputfile-property-ipworksencrypt_cms-class) | The file to process. |
| [InputMessage](#inputmessage-property-ipworksencrypt_cms-class) | The message to process. |
| [OutputFile](#outputfile-property-ipworksencrypt_cms-class) | The output file. |
| [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) | Specifies the output format. |
| [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class) | The output message after processing. |
| [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) | The number of records in the RecipientCert arrays. |
| [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-ipworksencrypt_cms-class) | The date on which this certificate becomes valid. |
| [RecipientCertExpirationDate](#recipientcertexpirationdate-property-ipworksencrypt_cms-class) | The date on which the certificate expires. |
| [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-ipworksencrypt_cms-class) | A comma-delimited list of extended key usage identifiers. |
| [RecipientCertFingerprint](#recipientcertfingerprint-property-ipworksencrypt_cms-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-ipworksencrypt_cms-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-ipworksencrypt_cms-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [RecipientCertIssuer](#recipientcertissuer-property-ipworksencrypt_cms-class) | The issuer of the certificate. |
| [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class) | The private key of the certificate (if available). |
| [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworksencrypt_cms-class) | Whether a PrivateKey is available for the selected certificate. |
| [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-ipworksencrypt_cms-class) | The name of the PrivateKey container for the certificate (if available). |
| [RecipientCertPublicKey](#recipientcertpublickey-property-ipworksencrypt_cms-class) | The public key of the certificate. |
| [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-ipworksencrypt_cms-class) | The textual description of the certificate's public key algorithm. |
| [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-ipworksencrypt_cms-class) | The length of the certificate's public key (in bits). |
| [RecipientCertSerialNumber](#recipientcertserialnumber-property-ipworksencrypt_cms-class) | The serial number of the certificate encoded as a string. |
| [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-ipworksencrypt_cms-class) | The text description of the certificate's signature algorithm. |
| [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) | The name of the certificate store for the client certificate. |
| [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworksencrypt_cms-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [RecipientCertStoreType](#recipientcertstoretype-property-ipworksencrypt_cms-class) | The type of certificate store for this certificate. |
| [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-ipworksencrypt_cms-class) | Comma-separated lists of alternative subject names for the certificate. |
| [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-ipworksencrypt_cms-class) | The MD5 hash of the certificate. |
| [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-ipworksencrypt_cms-class) | The SHA-1 hash of the certificate. |
| [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-ipworksencrypt_cms-class) | The SHA-256 hash of the certificate. |
| [RecipientCertUsage](#recipientcertusage-property-ipworksencrypt_cms-class) | The text description of UsageFlags . |
| [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworksencrypt_cms-class) | The flags that show intended use for the certificate. |
| [RecipientCertVersion](#recipientcertversion-property-ipworksencrypt_cms-class) | The certificate's version number. |
| [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) | The subject of the certificate used for client authentication. |
| [RecipientCertEncoded](#recipientcertencoded-property-ipworksencrypt_cms-class) | The certificate (PEM/Base64 encoded). |
| [SignatureHashAlgorithm](#signaturehashalgorithm-property-ipworksencrypt_cms-class) | The signature hash algorithm used during signing. |
| [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) | The number of records in the SignerCert arrays. |
| [SignerCertEffectiveDate](#signercerteffectivedate-property-ipworksencrypt_cms-class) | The date on which this certificate becomes valid. |
| [SignerCertExpirationDate](#signercertexpirationdate-property-ipworksencrypt_cms-class) | The date on which the certificate expires. |
| [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-ipworksencrypt_cms-class) | A comma-delimited list of extended key usage identifiers. |
| [SignerCertFingerprint](#signercertfingerprint-property-ipworksencrypt_cms-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-ipworksencrypt_cms-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-ipworksencrypt_cms-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SignerCertIssuer](#signercertissuer-property-ipworksencrypt_cms-class) | The issuer of the certificate. |
| [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class) | The private key of the certificate (if available). |
| [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworksencrypt_cms-class) | Whether a PrivateKey is available for the selected certificate. |
| [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-ipworksencrypt_cms-class) | The name of the PrivateKey container for the certificate (if available). |
| [SignerCertPublicKey](#signercertpublickey-property-ipworksencrypt_cms-class) | The public key of the certificate. |
| [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-ipworksencrypt_cms-class) | The textual description of the certificate's public key algorithm. |
| [SignerCertPublicKeyLength](#signercertpublickeylength-property-ipworksencrypt_cms-class) | The length of the certificate's public key (in bits). |
| [SignerCertSerialNumber](#signercertserialnumber-property-ipworksencrypt_cms-class) | The serial number of the certificate encoded as a string. |
| [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-ipworksencrypt_cms-class) | The text description of the certificate's signature algorithm. |
| [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) | The name of the certificate store for the client certificate. |
| [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_cms-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_cms-class) | The type of certificate store for this certificate. |
| [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-ipworksencrypt_cms-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-ipworksencrypt_cms-class) | The MD5 hash of the certificate. |
| [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-ipworksencrypt_cms-class) | The SHA-1 hash of the certificate. |
| [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-ipworksencrypt_cms-class) | The SHA-256 hash of the certificate. |
| [SignerCertUsage](#signercertusage-property-ipworksencrypt_cms-class) | The text description of UsageFlags . |
| [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_cms-class) | The flags that show intended use for the certificate. |
| [SignerCertVersion](#signercertversion-property-ipworksencrypt_cms-class) | The certificate's version number. |
| [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) | The subject of the certificate used for client authentication. |
| [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_cms-class) | The certificate (PEM/Base64 encoded). |
| [UseOAEP](#useoaep-property-ipworksencrypt_cms-class) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). |
| [UsePSS](#usepss-property-ipworksencrypt_cms-class) | Whether to use RSA-PSS during signing and verification. |

## Method List

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

|  |  |
| --- | --- |
| [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) | Used to add certificates for signing. |
| [AddRecipientCert](#addrecipientcert-method-ipworksencrypt_cms-class) | Used to add recipient certificates used to encrypt messages. |
| [Config](#config-method-ipworksencrypt_cms-class) | Sets or retrieves a configuration setting. |
| [Decrypt](#decrypt-method-ipworksencrypt_cms-class) | Decrypts the current message. |
| [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworksencrypt_cms-class) | Decrypts and verifies the signature of the current message. |
| [Encrypt](#encrypt-method-ipworksencrypt_cms-class) | Encrypts the current message. |
| [GetRecipientInfo](#getrecipientinfo-method-ipworksencrypt_cms-class) | Gets the recipient certificate information for an encrypted message. |
| [GetSignerCertInfo](#getsignercertinfo-method-ipworksencrypt_cms-class) | This method gets the signature information for an signed message. |
| [Reset](#reset-method-ipworksencrypt_cms-class) | This method resets the class properties. |
| [Sign](#sign-method-ipworksencrypt_cms-class) | Signs the current message. |
| [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) | Signs and encrypts the current message. |
| [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class) | Verifies the signature of the current message. |

## 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.*

|  |  |
| --- | --- |
| [Error](#error-event-ipworksencrypt_cms-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-ipworksencrypt_cms-class) | Fires with log information during processing. |
| [RecipientInfo](#recipientinfo-event-ipworksencrypt_cms-class) | This event is fired for each recipient certificate of the encrypted message. |
| [SignerCertInfo](#signercertinfo-event-ipworksencrypt_cms-class) | Fired during verification of the signed message. |

## Config Settings

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

|  |  |
| --- | --- |
| [CompressBeforeSign](#CompressBeforeSign) | Specifies whether to compress before signing. |
| [ContentTypeOID](#ContentTypeOID) | Specifies the oid for content type. |
| [CSP](#CSP) | The Cryptographic Service Provider. |
| [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) | Whether to generate timestamps in signatures. |
| [IncludeHeaders](#IncludeHeaders) | Tells the class whether to include the headers when encoding the message. |
| [IncludeInternalHeaders](#IncludeInternalHeaders) | Tells the class whether or not to include the internal headers when encoding the message. |
| [InputContentTransferEncoding](#InputContentTransferEncoding) | Sets the Content-Transfer-Encoding for the signed message. |
| [InputContentType](#InputContentType) | Sets the Content-Type for the signed message. |
| [InputMessageHeaders](#InputMessageHeaders) | Message headers. |
| [LogDirectory](#LogDirectory) | The directory on disk where debug logs are written. |
| [LogFileName](#LogFileName) | The base filename to use with LogDirectory. |
| [LogLevel](#LogLevel) | The level of detail for log messages. |
| [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. |
| [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters. |
| [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used with OAEP. |
| [OutputMessageHeaders](#OutputMessageHeaders) | The SMIME headers of the output message. |
| [RecipientInfoType](#RecipientInfoType) | The type of signer information to include in the signed message. |
| [SignatureTimestamp](#SignatureTimestamp) | The signature timestamp in the signed message. |
| [SignerInfoType](#SignerInfoType) | The type of signer information to include in the signed message. |
| [UseAlgorithmOIDs](#UseAlgorithmOIDs) | Whether OIDs are used when providing information about the algorithms. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# CertCount Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The number of records in the Cert arrays.

## Object Oriented Interface

```text
public function getCertCount();
public function setCertCount($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 1 );
ipworksencrypt_cms_set($res, 1, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CertEffectiveDate](#certeffectivedate-property-ipworksencrypt_cms-class)
- [CertEncoded](#certencoded-property-ipworksencrypt_cms-class)
- [CertExpirationDate](#certexpirationdate-property-ipworksencrypt_cms-class)
- [CertExtendedKeyUsage](#certextendedkeyusage-property-ipworksencrypt_cms-class)
- [CertFingerprint](#certfingerprint-property-ipworksencrypt_cms-class)
- [CertFingerprintSHA1](#certfingerprintsha1-property-ipworksencrypt_cms-class)
- [CertFingerprintSHA256](#certfingerprintsha256-property-ipworksencrypt_cms-class)
- [CertIssuer](#certissuer-property-ipworksencrypt_cms-class)
- [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class)
- [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_cms-class)
- [CertPrivateKeyContainer](#certprivatekeycontainer-property-ipworksencrypt_cms-class)
- [CertPublicKey](#certpublickey-property-ipworksencrypt_cms-class)
- [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ipworksencrypt_cms-class)
- [CertPublicKeyLength](#certpublickeylength-property-ipworksencrypt_cms-class)
- [CertSerialNumber](#certserialnumber-property-ipworksencrypt_cms-class)
- [CertSignatureAlgorithm](#certsignaturealgorithm-property-ipworksencrypt_cms-class)
- [CertStore](#certstore-property-ipworksencrypt_cms-class)
- [CertStorePassword](#certstorepassword-property-ipworksencrypt_cms-class)
- [CertStoreType](#certstoretype-property-ipworksencrypt_cms-class)
- [CertSubject](#certsubject-property-ipworksencrypt_cms-class)
- [CertSubjectAltNames](#certsubjectaltnames-property-ipworksencrypt_cms-class)
- [CertThumbprintMD5](#certthumbprintmd5-property-ipworksencrypt_cms-class)
- [CertThumbprintSHA1](#certthumbprintsha1-property-ipworksencrypt_cms-class)
- [CertThumbprintSHA256](#certthumbprintsha256-property-ipworksencrypt_cms-class)
- [CertUsage](#certusage-property-ipworksencrypt_cms-class)
- [CertUsageFlags](#certusageflags-property-ipworksencrypt_cms-class)
- [CertVersion](#certversion-property-ipworksencrypt_cms-class)

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

This property is not available at design time.

## Data Type

Integer

# CertEffectiveDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getCertEffectiveDate($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 2 , $certindex);
```

## Default Value

''

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertExpirationDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getCertExpirationDate($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 3 , $certindex);
```

## Default Value

''

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertExtendedKeyUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getCertExtendedKeyUsage($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 4 , $certindex);
```

## Default Value

''

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertFingerprint Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprint($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 5 , $certindex);
```

## Default Value

''

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertFingerprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA1($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 6 , $certindex);
```

## Default Value

''

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertFingerprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA256($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 7 , $certindex);
```

## Default Value

''

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertIssuer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getCertIssuer($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 8 , $certindex);
```

## Default Value

''

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertPrivateKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKey($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 9 , $certindex);
```

## Default Value

''

## Remarks

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

NOTE: The [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class) returns an empty string.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertPrivateKeyAvailable Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getCertPrivateKeyAvailable($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 10 , $certindex);
```

## Default Value

false

## Remarks

Whether a [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_cms-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# CertPrivateKeyContainer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKeyContainer($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 11 , $certindex);
```

## Default Value

''

## Remarks

The name of the [CertPrivateKey](#certprivatekey-property-ipworksencrypt_cms-class) container for the certificate (if available). This functionality is available only on Windows platforms.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertPublicKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getCertPublicKey($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 12 , $certindex);
```

## Default Value

''

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertPublicKeyAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getCertPublicKeyAlgorithm($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 13 , $certindex);
```

## Default Value

''

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertPublicKeyLength Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getCertPublicKeyLength($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 14 , $certindex);
```

## Default Value

0

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# CertSerialNumber Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getCertSerialNumber($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 15 , $certindex);
```

## Default Value

''

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertSignatureAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getCertSignatureAlgorithm($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 16 , $certindex);
```

## Default Value

''

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertStore Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getCertStore($certindex);
public function setCertStore($certindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 17 , $certindex);
ipworksencrypt_cms_set($res, 17, $value , $certindex);
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [CertStoreType](#certstoretype-property-ipworksencrypt_cms-class) property denotes the type of the certificate store specified by [CertStore](#certstore-property-ipworksencrypt_cms-class). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-ipworksencrypt_cms-class).

[CertStore](#certstore-property-ipworksencrypt_cms-class) is used in conjunction with the [CertSubject](#certsubject-property-ipworksencrypt_cms-class) property to specify client certificates. If [CertStore](#certstore-property-ipworksencrypt_cms-class) has a value, and [CertSubject](#certsubject-property-ipworksencrypt_cms-class) or [CertEncoded](#certencoded-property-ipworksencrypt_cms-class) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-ipworksencrypt_cms-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# CertStorePassword Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getCertStorePassword($certindex);
public function setCertStorePassword($certindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 18 , $certindex);
ipworksencrypt_cms_set($res, 18, $value , $certindex);
```

## Default Value

''

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# CertStoreType Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getCertStoreType($certindex);
public function setCertStoreType($certindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 19 , $certindex);
ipworksencrypt_cms_set($res, 19, $value , $certindex);
```

## Possible Values

```text
CMS_CERTSTORETYPE_USER(0), CMS_CERTSTORETYPE_MACHINE(1), CMS_CERTSTORETYPE_PFXFILE(2), CMS_CERTSTORETYPE_PFXBLOB(3), CMS_CERTSTORETYPE_JKSFILE(4), CMS_CERTSTORETYPE_JKSBLOB(5), CMS_CERTSTORETYPE_PEMKEY_FILE(6), CMS_CERTSTORETYPE_PEMKEY_BLOB(7), CMS_CERTSTORETYPE_PUBLIC_KEY_FILE(8), CMS_CERTSTORETYPE_PUBLIC_KEY_BLOB(9), CMS_CERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), CMS_CERTSTORETYPE_P7BFILE(11), CMS_CERTSTORETYPE_P7BBLOB(12), CMS_CERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), CMS_CERTSTORETYPE_PPKFILE(14), CMS_CERTSTORETYPE_PPKBLOB(15), CMS_CERTSTORETYPE_XMLFILE(16), CMS_CERTSTORETYPE_XMLBLOB(17), CMS_CERTSTORETYPE_JWKFILE(18), CMS_CERTSTORETYPE_JWKBLOB(19), CMS_CERTSTORETYPE_SECURITY_KEY(20), CMS_CERTSTORETYPE_BCFKSFILE(21), CMS_CERTSTORETYPE_BCFKSBLOB(22), CMS_CERTSTORETYPE_PKCS11(23), CMS_CERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 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 property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-ipworksencrypt_cms-class), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-ipworksencrypt_cms-class), and the PIN as the [CertStorePassword](#certstorepassword-property-ipworksencrypt_cms-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CertStore](#certstore-property-ipworksencrypt_cms-class) and set [CertStorePassword](#certstorepassword-property-ipworksencrypt_cms-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Integer

# CertSubjectAltNames Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Comma-separated lists of alternative subject names for the certificate.

## Object Oriented Interface

```text
public function getCertSubjectAltNames($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 20 , $certindex);
```

## Default Value

''

## Remarks

Comma-separated lists of alternative subject names for the certificate.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertThumbprintMD5 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintMD5($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 21 , $certindex);
```

## Default Value

''

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertThumbprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA1($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 22 , $certindex);
```

## Default Value

''

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertThumbprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA256($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 23 , $certindex);
```

## Default Value

''

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getCertUsage($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 24 , $certindex);
```

## Default Value

''

## Remarks

The text description of [CertUsageFlags](#certusageflags-property-ipworksencrypt_cms-class).

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

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertUsageFlags Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getCertUsageFlags($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 25 , $certindex);
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-ipworksencrypt_cms-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [CertUsage](#certusage-property-ipworksencrypt_cms-class) property for a text representation of [CertUsageFlags](#certusageflags-property-ipworksencrypt_cms-class).

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# CertVersion Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getCertVersion($certindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 26 , $certindex);
```

## Default Value

''

## Remarks

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# CertSubject Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getCertSubject($certindex);
public function setCertSubject($certindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 27 , $certindex);
ipworksencrypt_cms_set($res, 27, $value , $certindex);
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# CertEncoded Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getCertEncoded($certindex);
public function setCertEncoded($certindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 28 , $certindex);
ipworksencrypt_cms_set($res, 28, $value , $certindex);
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-ipworksencrypt_cms-class) and [CertSubject](#certsubject-property-ipworksencrypt_cms-class) properties also may be used to specify a certificate.

When [CertEncoded](#certencoded-property-ipworksencrypt_cms-class) is set, a search is initiated in the current [CertStore](#certstore-property-ipworksencrypt_cms-class) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-ipworksencrypt_cms-class) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-ipworksencrypt_cms-class) is set to an empty string.

The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# DetachedSignature Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getDetachedSignature();
public function setDetachedSignature($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 29 );
ipworksencrypt_cms_set($res, 29, $value );
```

## Default Value

false

## Remarks

This property specifies whether the [Sign](#sign-method-ipworksencrypt_cms-class) operation products a message that includes both a signature and the message data, or just a signature.

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

When set to *True* the output message holds only a signature in the CMS message. Both the original input data and the signature in the output message produced by the [Sign](#sign-method-ipworksencrypt_cms-class) operation must be passed to the receiving party for signature verification.

## Data Type

Boolean

# DetachedSignatureData Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The detached signature.

## Object Oriented Interface

```text
public function getDetachedSignatureData();
public function setDetachedSignatureData($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 30 );
ipworksencrypt_cms_set($res, 30, $value );
```

## Default Value

''

## Remarks

This setting is used to specify the detached signature before calling [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class). The message data should be specified normally and this property should be set to the detached signature data. This may be set to the PEM, DER, or SMIME encoded signature message.

## Data Type

Binary String

# EnableCompression Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Specifies whether to compress the message.

## Object Oriented Interface

```text
public function getEnableCompression();
public function setEnableCompression($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 31 );
ipworksencrypt_cms_set($res, 31, $value );
```

## Default Value

false

## Remarks

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

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

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

## Data Type

Boolean

# EncryptionAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The algorithm used for encryption.

## Object Oriented Interface

```text
public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 32 );
ipworksencrypt_cms_set($res, 32, $value );
```

## Default Value

'3DES'

## Remarks

This property specifies the encryption algorithm used when [Encrypt](#encrypt-method-ipworksencrypt_cms-class) is called.

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

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

## Data Type

String

# IncludeCertificates Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getIncludeCertificates();
public function setIncludeCertificates($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 33 );
ipworksencrypt_cms_set($res, 33, $value );
```

## Possible Values

```text
CMS_INCLUDECERTIFICATES_NONE(0), CMS_INCLUDECERTIFICATES_SIGNER_CERTS(1), CMS_INCLUDECERTIFICATES_SIGNER_CERTS_AND_CHAIN(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:

| Value | Description |
| --- | --- |
| 0 (icsNone) | No signer certificates are included. |
| 1 (icsSignerCerts - default) | The certificates specified in Certificates are included. |
| 2 (icsSignerCertsAndChain) | The certificates specified in Certificates and the full chain of each certificate are included. |

## Data Type

Integer

# InputFile Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The file to process.

## Object Oriented Interface

```text
public function getInputFile();
public function setInputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 34 );
ipworksencrypt_cms_set($res, 34, $value );
```

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

- InputFile
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

## Data Type

String

# InputMessage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The message to process.

## Object Oriented Interface

```text
public function getInputMessage();
public function setInputMessage($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 35 );
ipworksencrypt_cms_set($res, 35, $value );
```

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- InputMessage

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

## Data Type

Binary String

# OutputFile Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The output file.

## Object Oriented Interface

```text
public function getOutputFile();
public function setOutputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 36 );
ipworksencrypt_cms_set($res, 36, $value );
```

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- OutputFile
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

## Data Type

String

# OutputFormat Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Specifies the output format.

## Object Oriented Interface

```text
public function getOutputFormat();
public function setOutputFormat($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 37 );
ipworksencrypt_cms_set($res, 37, $value );
```

## Default Value

'PEM'

## Remarks

This property specifies the format of the output message created when calling [Sign](#sign-method-ipworksencrypt_cms-class), [Encrypt](#encrypt-method-ipworksencrypt_cms-class), or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class).

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

Possible values are:

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

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

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

| Value | Description |
| --- | --- |
| PEM (default) | A PEM formatted message. For instance: |
| DER | The message is binary (raw bytes). |
| SMIME | The message is S/MIME encoded. For instance: |

## Data Type

String

# OutputMessage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The output message after processing.

## Object Oriented Interface

```text
public function getOutputMessage();
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 38 );
```

## Default Value

''

## Remarks

This property will be populated with the output of the operation if [OutputFile](#outputfile-property-ipworksencrypt_cms-class) is not set.

**Encrypt and/or Sign**

When encrypting or signing this will hold the fully encoded message.

**Decrypt and/or Verify**

When decrypting or verifying a signature this will hold the decrypted/verified content.

**Input and Output Properties**

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only.

## Data Type

Binary String

# RecipientCertCount Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The number of records in the RecipientCert arrays.

## Object Oriented Interface

```text
public function getRecipientCertCount();
public function setRecipientCertCount($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 39 );
ipworksencrypt_cms_set($res, 39, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-ipworksencrypt_cms-class)
- [RecipientCertEncoded](#recipientcertencoded-property-ipworksencrypt_cms-class)
- [RecipientCertExpirationDate](#recipientcertexpirationdate-property-ipworksencrypt_cms-class)
- [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-ipworksencrypt_cms-class)
- [RecipientCertFingerprint](#recipientcertfingerprint-property-ipworksencrypt_cms-class)
- [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-ipworksencrypt_cms-class)
- [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-ipworksencrypt_cms-class)
- [RecipientCertIssuer](#recipientcertissuer-property-ipworksencrypt_cms-class)
- [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class)
- [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworksencrypt_cms-class)
- [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-ipworksencrypt_cms-class)
- [RecipientCertPublicKey](#recipientcertpublickey-property-ipworksencrypt_cms-class)
- [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-ipworksencrypt_cms-class)
- [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-ipworksencrypt_cms-class)
- [RecipientCertSerialNumber](#recipientcertserialnumber-property-ipworksencrypt_cms-class)
- [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-ipworksencrypt_cms-class)
- [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class)
- [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworksencrypt_cms-class)
- [RecipientCertStoreType](#recipientcertstoretype-property-ipworksencrypt_cms-class)
- [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class)
- [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-ipworksencrypt_cms-class)
- [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-ipworksencrypt_cms-class)
- [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-ipworksencrypt_cms-class)
- [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-ipworksencrypt_cms-class)
- [RecipientCertUsage](#recipientcertusage-property-ipworksencrypt_cms-class)
- [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworksencrypt_cms-class)
- [RecipientCertVersion](#recipientcertversion-property-ipworksencrypt_cms-class)

The array indices start at *0* and end at *RecipientCertCount - 1*.

This property is not available at design time.

## Data Type

Integer

# RecipientCertEffectiveDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getRecipientCertEffectiveDate($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 40 , $recipientcertindex);
```

## Default Value

''

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertExpirationDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getRecipientCertExpirationDate($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 41 , $recipientcertindex);
```

## Default Value

''

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertExtendedKeyUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getRecipientCertExtendedKeyUsage($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 42 , $recipientcertindex);
```

## Default Value

''

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertFingerprint Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertFingerprint($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 43 , $recipientcertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertFingerprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertFingerprintSHA1($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 44 , $recipientcertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertFingerprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertFingerprintSHA256($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 45 , $recipientcertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertIssuer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertIssuer($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 46 , $recipientcertindex);
```

## Default Value

''

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertPrivateKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getRecipientCertPrivateKey($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 47 , $recipientcertindex);
```

## Default Value

''

## Remarks

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

NOTE: The [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class) may be available but not exportable. In this case, [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class) returns an empty string.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertPrivateKeyAvailable Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getRecipientCertPrivateKeyAvailable($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 48 , $recipientcertindex);
```

## Default Value

false

## Remarks

Whether a [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class) is available for the selected certificate. If [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworksencrypt_cms-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# RecipientCertPrivateKeyContainer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getRecipientCertPrivateKeyContainer($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 49 , $recipientcertindex);
```

## Default Value

''

## Remarks

The name of the [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworksencrypt_cms-class) container for the certificate (if available). This functionality is available only on Windows platforms.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertPublicKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertPublicKey($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 50 , $recipientcertindex);
```

## Default Value

''

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertPublicKeyAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getRecipientCertPublicKeyAlgorithm($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 51 , $recipientcertindex);
```

## Default Value

''

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertPublicKeyLength Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getRecipientCertPublicKeyLength($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 52 , $recipientcertindex);
```

## Default Value

0

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# RecipientCertSerialNumber Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getRecipientCertSerialNumber($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 53 , $recipientcertindex);
```

## Default Value

''

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertSignatureAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getRecipientCertSignatureAlgorithm($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 54 , $recipientcertindex);
```

## Default Value

''

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertStore Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getRecipientCertStore($recipientcertindex);
public function setRecipientCertStore($recipientcertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 55 , $recipientcertindex);
ipworksencrypt_cms_set($res, 55, $value , $recipientcertindex);
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [RecipientCertStoreType](#recipientcertstoretype-property-ipworksencrypt_cms-class) property denotes the type of the certificate store specified by [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class). If the store is password-protected, specify the password in [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworksencrypt_cms-class).

[RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) is used in conjunction with the [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) property to specify client certificates. If [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) has a value, and [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) or [RecipientCertEncoded](#recipientcertencoded-property-ipworksencrypt_cms-class) is set, a search for a certificate is initiated. Please see the [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# RecipientCertStorePassword Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getRecipientCertStorePassword($recipientcertindex);
public function setRecipientCertStorePassword($recipientcertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 56 , $recipientcertindex);
ipworksencrypt_cms_set($res, 56, $value , $recipientcertindex);
```

## Default Value

''

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# RecipientCertStoreType Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getRecipientCertStoreType($recipientcertindex);
public function setRecipientCertStoreType($recipientcertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 57 , $recipientcertindex);
ipworksencrypt_cms_set($res, 57, $value , $recipientcertindex);
```

## Possible Values

```text
CMS_RECIPIENTCERTSTORETYPE_USER(0), CMS_RECIPIENTCERTSTORETYPE_MACHINE(1), CMS_RECIPIENTCERTSTORETYPE_PFXFILE(2), CMS_RECIPIENTCERTSTORETYPE_PFXBLOB(3), CMS_RECIPIENTCERTSTORETYPE_JKSFILE(4), CMS_RECIPIENTCERTSTORETYPE_JKSBLOB(5), CMS_RECIPIENTCERTSTORETYPE_PEMKEY_FILE(6), CMS_RECIPIENTCERTSTORETYPE_PEMKEY_BLOB(7), CMS_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_FILE(8), CMS_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_BLOB(9), CMS_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), CMS_RECIPIENTCERTSTORETYPE_P7BFILE(11), CMS_RECIPIENTCERTSTORETYPE_P7BBLOB(12), CMS_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), CMS_RECIPIENTCERTSTORETYPE_PPKFILE(14), CMS_RECIPIENTCERTSTORETYPE_PPKBLOB(15), CMS_RECIPIENTCERTSTORETYPE_XMLFILE(16), CMS_RECIPIENTCERTSTORETYPE_XMLBLOB(17), CMS_RECIPIENTCERTSTORETYPE_JWKFILE(18), CMS_RECIPIENTCERTSTORETYPE_JWKBLOB(19), CMS_RECIPIENTCERTSTORETYPE_SECURITY_KEY(20), CMS_RECIPIENTCERTSTORETYPE_BCFKSFILE(21), CMS_RECIPIENTCERTSTORETYPE_BCFKSBLOB(22), CMS_RECIPIENTCERTSTORETYPE_PKCS11(23), CMS_RECIPIENTCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 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 property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [RecipientCertStoreType](#recipientcertstoretype-property-ipworksencrypt_cms-class), the full path of the PKCS#11 DLL as the [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class), and the PIN as the [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworksencrypt_cms-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) and set [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworksencrypt_cms-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Integer

# RecipientCertSubjectAltNames Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Comma-separated lists of alternative subject names for the certificate.

## Object Oriented Interface

```text
public function getRecipientCertSubjectAltNames($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 58 , $recipientcertindex);
```

## Default Value

''

## Remarks

Comma-separated lists of alternative subject names for the certificate.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertThumbprintMD5 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertThumbprintMD5($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 59 , $recipientcertindex);
```

## Default Value

''

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertThumbprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertThumbprintSHA1($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 60 , $recipientcertindex);
```

## Default Value

''

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertThumbprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getRecipientCertThumbprintSHA256($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 61 , $recipientcertindex);
```

## Default Value

''

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getRecipientCertUsage($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 62 , $recipientcertindex);
```

## Default Value

''

## Remarks

The text description of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworksencrypt_cms-class).

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

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertUsageFlags Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getRecipientCertUsageFlags($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 63 , $recipientcertindex);
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworksencrypt_cms-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [RecipientCertUsage](#recipientcertusage-property-ipworksencrypt_cms-class) property for a text representation of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworksencrypt_cms-class).

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# RecipientCertVersion Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getRecipientCertVersion($recipientcertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 64 , $recipientcertindex);
```

## Default Value

''

## Remarks

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# RecipientCertSubject Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getRecipientCertSubject($recipientcertindex);
public function setRecipientCertSubject($recipientcertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 65 , $recipientcertindex);
ipworksencrypt_cms_set($res, 65, $value , $recipientcertindex);
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# RecipientCertEncoded Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getRecipientCertEncoded($recipientcertindex);
public function setRecipientCertEncoded($recipientcertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 66 , $recipientcertindex);
ipworksencrypt_cms_set($res, 66, $value , $recipientcertindex);
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) and [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) properties also may be used to specify a certificate.

When [RecipientCertEncoded](#recipientcertencoded-property-ipworksencrypt_cms-class) is set, a search is initiated in the current [RecipientCertStore](#recipientcertstore-property-ipworksencrypt_cms-class) for the private key of the certificate. If the key is found, [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) is updated to reflect the full subject of the selected certificate; otherwise, [RecipientCertSubject](#recipientcertsubject-property-ipworksencrypt_cms-class) is set to an empty string.

The *$recipientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# SignatureHashAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The signature hash algorithm used during signing.

## Object Oriented Interface

```text
public function getSignatureHashAlgorithm();
public function setSignatureHashAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 67 );
ipworksencrypt_cms_set($res, 67, $value );
```

## Default Value

'SHA256'

## Remarks

This property specifies the signature hash algorithm used when [Sign](#sign-method-ipworksencrypt_cms-class) is called.

When [Sign](#sign-method-ipworksencrypt_cms-class) is called the input data is first hashed with the algorithm specified by this property to produce a message digest. The computed digest is then digitally signed with the certificates specified in Certificates.

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

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

## Data Type

String

# SignerCertCount Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The number of records in the SignerCert arrays.

## Object Oriented Interface

```text
public function getSignerCertCount();
public function setSignerCertCount($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 68 );
ipworksencrypt_cms_set($res, 68, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SignerCertEffectiveDate](#signercerteffectivedate-property-ipworksencrypt_cms-class)
- [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_cms-class)
- [SignerCertExpirationDate](#signercertexpirationdate-property-ipworksencrypt_cms-class)
- [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-ipworksencrypt_cms-class)
- [SignerCertFingerprint](#signercertfingerprint-property-ipworksencrypt_cms-class)
- [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-ipworksencrypt_cms-class)
- [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-ipworksencrypt_cms-class)
- [SignerCertIssuer](#signercertissuer-property-ipworksencrypt_cms-class)
- [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class)
- [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworksencrypt_cms-class)
- [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-ipworksencrypt_cms-class)
- [SignerCertPublicKey](#signercertpublickey-property-ipworksencrypt_cms-class)
- [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-ipworksencrypt_cms-class)
- [SignerCertPublicKeyLength](#signercertpublickeylength-property-ipworksencrypt_cms-class)
- [SignerCertSerialNumber](#signercertserialnumber-property-ipworksencrypt_cms-class)
- [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-ipworksencrypt_cms-class)
- [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class)
- [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_cms-class)
- [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_cms-class)
- [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class)
- [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-ipworksencrypt_cms-class)
- [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-ipworksencrypt_cms-class)
- [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-ipworksencrypt_cms-class)
- [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-ipworksencrypt_cms-class)
- [SignerCertUsage](#signercertusage-property-ipworksencrypt_cms-class)
- [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_cms-class)
- [SignerCertVersion](#signercertversion-property-ipworksencrypt_cms-class)

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

This property is not available at design time.

## Data Type

Integer

# SignerCertEffectiveDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSignerCertEffectiveDate($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 69 , $signercertindex);
```

## Default Value

''

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertExpirationDate Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSignerCertExpirationDate($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 70 , $signercertindex);
```

## Default Value

''

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertExtendedKeyUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSignerCertExtendedKeyUsage($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 71 , $signercertindex);
```

## Default Value

''

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertFingerprint Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprint($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 72 , $signercertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertFingerprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprintSHA1($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 73 , $signercertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertFingerprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprintSHA256($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 74 , $signercertindex);
```

## Default Value

''

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertIssuer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSignerCertIssuer($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 75 , $signercertindex);
```

## Default Value

''

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertPrivateKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSignerCertPrivateKey($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 76 , $signercertindex);
```

## Default Value

''

## Remarks

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

NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class) returns an empty string.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertPrivateKeyAvailable Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSignerCertPrivateKeyAvailable($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 77 , $signercertindex);
```

## Default Value

false

## Remarks

Whether a [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworksencrypt_cms-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# SignerCertPrivateKeyContainer Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getSignerCertPrivateKeyContainer($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 78 , $signercertindex);
```

## Default Value

''

## Remarks

The name of the [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_cms-class) container for the certificate (if available). This functionality is available only on Windows platforms.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertPublicKey Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSignerCertPublicKey($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 79 , $signercertindex);
```

## Default Value

''

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertPublicKeyAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getSignerCertPublicKeyAlgorithm($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 80 , $signercertindex);
```

## Default Value

''

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertPublicKeyLength Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getSignerCertPublicKeyLength($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 81 , $signercertindex);
```

## Default Value

0

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SignerCertSerialNumber Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSignerCertSerialNumber($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 82 , $signercertindex);
```

## Default Value

''

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertSignatureAlgorithm Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSignerCertSignatureAlgorithm($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 83 , $signercertindex);
```

## Default Value

''

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertStore Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSignerCertStore($signercertindex);
public function setSignerCertStore($signercertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 84 , $signercertindex);
ipworksencrypt_cms_set($res, 84, $value , $signercertindex);
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_cms-class) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_cms-class).

[SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) property to specify client certificates. If [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) has a value, and [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) or [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_cms-class) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# SignerCertStorePassword Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getSignerCertStorePassword($signercertindex);
public function setSignerCertStorePassword($signercertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 85 , $signercertindex);
ipworksencrypt_cms_set($res, 85, $value , $signercertindex);
```

## Default Value

''

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# SignerCertStoreType Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSignerCertStoreType($signercertindex);
public function setSignerCertStoreType($signercertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 86 , $signercertindex);
ipworksencrypt_cms_set($res, 86, $value , $signercertindex);
```

## Possible Values

```text
CMS_SIGNERCERTSTORETYPE_USER(0), CMS_SIGNERCERTSTORETYPE_MACHINE(1), CMS_SIGNERCERTSTORETYPE_PFXFILE(2), CMS_SIGNERCERTSTORETYPE_PFXBLOB(3), CMS_SIGNERCERTSTORETYPE_JKSFILE(4), CMS_SIGNERCERTSTORETYPE_JKSBLOB(5), CMS_SIGNERCERTSTORETYPE_PEMKEY_FILE(6), CMS_SIGNERCERTSTORETYPE_PEMKEY_BLOB(7), CMS_SIGNERCERTSTORETYPE_PUBLIC_KEY_FILE(8), CMS_SIGNERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), CMS_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), CMS_SIGNERCERTSTORETYPE_P7BFILE(11), CMS_SIGNERCERTSTORETYPE_P7BBLOB(12), CMS_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), CMS_SIGNERCERTSTORETYPE_PPKFILE(14), CMS_SIGNERCERTSTORETYPE_PPKBLOB(15), CMS_SIGNERCERTSTORETYPE_XMLFILE(16), CMS_SIGNERCERTSTORETYPE_XMLBLOB(17), CMS_SIGNERCERTSTORETYPE_JWKFILE(18), CMS_SIGNERCERTSTORETYPE_JWKBLOB(19), CMS_SIGNERCERTSTORETYPE_SECURITY_KEY(20), CMS_SIGNERCERTSTORETYPE_BCFKSFILE(21), CMS_SIGNERCERTSTORETYPE_BCFKSBLOB(22), CMS_SIGNERCERTSTORETYPE_PKCS11(23), CMS_SIGNERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 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 property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_cms-class), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_cms-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) and set [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_cms-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Integer

# SignerCertSubjectAltNames Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Comma-separated lists of alternative subject names for the certificate.

## Object Oriented Interface

```text
public function getSignerCertSubjectAltNames($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 87 , $signercertindex);
```

## Default Value

''

## Remarks

Comma-separated lists of alternative subject names for the certificate.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertThumbprintMD5 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintMD5($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 88 , $signercertindex);
```

## Default Value

''

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertThumbprintSHA1 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintSHA1($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 89 , $signercertindex);
```

## Default Value

''

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertThumbprintSHA256 Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintSHA256($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 90 , $signercertindex);
```

## Default Value

''

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertUsage Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSignerCertUsage($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 91 , $signercertindex);
```

## Default Value

''

## Remarks

The text description of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_cms-class).

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

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertUsageFlags Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSignerCertUsageFlags($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 92 , $signercertindex);
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_cms-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SignerCertUsage](#signercertusage-property-ipworksencrypt_cms-class) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_cms-class).

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# SignerCertVersion Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSignerCertVersion($signercertindex);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 93 , $signercertindex);
```

## Default Value

''

## Remarks

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is read-only and not available at design time.

## Data Type

String

# SignerCertSubject Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSignerCertSubject($signercertindex);
public function setSignerCertSubject($signercertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 94 , $signercertindex);
ipworksencrypt_cms_set($res, 94, $value , $signercertindex);
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

String

# SignerCertEncoded Property ([IPWorksEncrypt_CMS](#cms-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSignerCertEncoded($signercertindex);
public function setSignerCertEncoded($signercertindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 95 , $signercertindex);
ipworksencrypt_cms_set($res, 95, $value , $signercertindex);
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) and [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) properties also may be used to specify a certificate.

When [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_cms-class) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-ipworksencrypt_cms-class) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-ipworksencrypt_cms-class) is set to an empty string.

The *$signercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signercertcount-property-ipworksencrypt_cms-class) property.

This property is not available at design time.

## Data Type

Binary String

# UseOAEP Property ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function getUseOAEP();
public function setUseOAEP($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 96 );
ipworksencrypt_cms_set($res, 96, $value );
```

## 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](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams)

## Data Type

Boolean

# UsePSS Property ([IPWorksEncrypt_CMS](#cms-class) Class)

Whether to use RSA-PSS during signing and verification.

## Object Oriented Interface

```text
public function getUsePSS();
public function setUsePSS($value);
```

## Procedural Interface

```text
ipworksencrypt_cms_get($res, 97 );
ipworksencrypt_cms_set($res, 97, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# AddCertificate Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Used to add certificates for signing.

## Object Oriented Interface

```text
public function doAddCertificate($certstoretype, $certstore, $certstorepassword, $certsubject);
```

## Procedural Interface

```text
ipworksencrypt_cms_do_addcertificate($res, $certstoretype, $certstore, $certstorepassword, $certsubject);
```

## Remarks

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

The added certificate(s) will be used to sign the message when [Sign](#sign-method-ipworksencrypt_cms-class) 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 property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

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

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

*CertSubject* specified the subject of the certificate to load. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

# AddRecipientCert Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Used to add recipient certificates used to encrypt messages.

## Object Oriented Interface

```text
public function doAddRecipientCert($certencoded);
```

## Procedural Interface

```text
ipworksencrypt_cms_do_addrecipientcert($res, $certencoded);
```

## Remarks

This method adds a public certificate used when [Encrypt](#encrypt-method-ipworksencrypt_cms-class) 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 ([IPWorksEncrypt_CMS](#cms-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworksencrypt_cms_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-cms-class) 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](#config-settings-cms-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Decrypt Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Decrypts the current message.

## Object Oriented Interface

```text
public function doDecrypt();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_decrypt($res);
```

## Remarks

Decrypt decrypts the input data with the specified certificate. Certificates are specified by calling [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or setting the Certificates property.

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

The following properties are applicable when calling this method:

- Certificates (Required)

 **Input and Output Properties**

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Encrypt and Decrypt a message**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();

byte[] encryptedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Multiple Recipients**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Get Recipient Info**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
  Console.WriteLine(e.SerialNumber);
  Console.WriteLine(e.Issuer);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
  }
};

cms.GetRecipientInfo();
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

# DecryptAndVerifySignature Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Decrypts and verifies the signature of the current message.

## Object Oriented Interface

```text
public function doDecryptAndVerifySignature();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_decryptandverifysignature($res);
```

## Remarks

This method decrypts the input data and verifies the signature. Decryption certificates are specified by calling [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or setting the Certificates property. Certificates used to verify the signature will be taken from the message itself if included, or from the SignerCerts property.

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

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

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

The following properties are applicable when calling this method:

- Certificates (Required)
- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class). In addition the [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) 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](#enablecompression-property-ipworksencrypt_cms-class) 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:

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

# Encrypt Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Encrypts the current message.

## Object Oriented Interface

```text
public function doEncrypt();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_encrypt($res);
```

## Remarks

Encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling [AddRecipientCert](#addrecipientcert-method-ipworksencrypt_cms-class) or setting the RecipientCerts property.

[OutputFormat](#outputformat-property-ipworksencrypt_cms-class) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. The following properties are applicable when calling this method:

- RecipientCerts (required)
- [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_cms-class)
- [OutputFormat](#outputformat-property-ipworksencrypt_cms-class)
- [UseOAEP](#useoaep-property-ipworksencrypt_cms-class)

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Encrypt and Decrypt a message**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Encrypt();

byte[] encryptedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Multiple Recipients**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

 **Encrypt and Decrypt - Get Recipient Info**

```csharp
Cms cms = new Cms();
cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
cms.InputMessage = "My Data";
cms.Encrypt();

string encryptedMessage = cms.OutputMessage;

//If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called
//to find information about the certificate.
cms = new Cms();
cms.InputMessage = encryptedMessage;
cms.OnRecipientInfo += (s, e) => {
  Console.WriteLine(e.SerialNumber);
  Console.WriteLine(e.Issuer);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
  }
};

cms.GetRecipientInfo();
cms.Decrypt();

string plaintextMessage = cms.OutputMessage;
```

# GetRecipientInfo Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Gets the recipient certificate information for an encrypted message.

## Object Oriented Interface

```text
public function doGetRecipientInfo();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_getrecipientinfo($res);
```

## Remarks

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

When this method is called the [RecipientInfo](#recipientinfo-event-ipworksencrypt_cms-class) event fires once for each recipient found within the message. Use the parameters of the [RecipientInfo](#recipientinfo-event-ipworksencrypt_cms-class) to determine which certificate to specify via [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or Certificates before calling [Decrypt](#decrypt-method-ipworksencrypt_cms-class).

# GetSignerCertInfo Method ([IPWorksEncrypt_CMS](#cms-class) Class)

This method gets the signature information for an signed message.

## Object Oriented Interface

```text
public function doGetSignerCertInfo();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_getsignercertinfo($res);
```

## Remarks

This method retrieves information about the certificate used to sign the message. This may be called before calling [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class) to determine which certificate should be loaded for verification.

When this method is called, the [SignerCertInfo](#signercertinfo-event-ipworksencrypt_cms-class) event fires once for each signer of the message. Use the parameters of the [SignerCertInfo](#signercertinfo-event-ipworksencrypt_cms-class) to determine which certificate to specify before calling [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class).

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

# Reset Method ([IPWorksEncrypt_CMS](#cms-class) Class)

This method resets the class properties.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_reset($res);
```

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

# Sign Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Signs the current message.

## Object Oriented Interface

```text
public function doSign();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_sign($res);
```

## Remarks

Sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [AddCertificate](#addcertificate-method-ipworksencrypt_cms-class) or setting the Certificates property.

[OutputFormat](#outputformat-property-ipworksencrypt_cms-class) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class) specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method:

- Certificates (required)
- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- [GenerateSignatureTimestamp](#GenerateSignatureTimestamp)
- [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class)
- [OutputFormat](#outputformat-property-ipworksencrypt_cms-class)
- [SignatureHashAlgorithm](#signaturehashalgorithm-property-ipworksencrypt_cms-class)
- [UsePSS](#usepss-property-ipworksencrypt_cms-class)

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Sign and Verify a message**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();

byte[] signedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - Detached Signature**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();

string signature = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
```

 **Sign and Verify a message - Multiple Signatures**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - No Included Certificate**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
  Console.WriteLine(e.Issuer);
  Console.WriteLine(e.SerialNumber);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    //Load the correct signer certificate.
    cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
  }
};
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

# SignAndEncrypt Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Signs and encrypts the current message.

## Object Oriented Interface

```text
public function doSignAndEncrypt();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_signandencrypt($res);
```

## Remarks

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

[OutputFormat](#outputformat-property-ipworksencrypt_cms-class) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class) specifies whether the public certificate is included in the signed message. The following properties are applicable when calling this method:

- Certificates (required)
- RecipientCerts (required)
- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_cms-class)
- [GenerateSignatureTimestamp](#GenerateSignatureTimestamp)
- [IncludeCertificates](#includecertificates-property-ipworksencrypt_cms-class)
- [OutputFormat](#outputformat-property-ipworksencrypt_cms-class)
- [SignatureHashAlgorithm](#signaturehashalgorithm-property-ipworksencrypt_cms-class)
- [UseOAEP](#useoaep-property-ipworksencrypt_cms-class)
- [UsePSS](#usepss-property-ipworksencrypt_cms-class)

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

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

# VerifySignature Method ([IPWorksEncrypt_CMS](#cms-class) Class)

Verifies the signature of the current message.

## Object Oriented Interface

```text
public function doVerifySignature();
```

## Procedural Interface

```text
ipworksencrypt_cms_do_verifysignature($res);
```

## Remarks

VerifySignature verifies the signature of the input message.

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

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

The following property are applicable when calling this method:

- [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class)
- [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class)
- [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class)
- SignerCerts

If the input message is a detached signature, the original data that was signed must be specified in [DetachedSignatureData](#detachedsignaturedata-property-ipworksencrypt_cms-class). In addition the [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) 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](#enablecompression-property-ipworksencrypt_cms-class) 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:

- [InputFile](#inputfile-property-ipworksencrypt_cms-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_cms-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_cms-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_cms-class): The output data is written to this property if no other destination is specified.

**Sign and Verify a message**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - DER Output Format**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.OutputFormat = "DER";
cms.Sign();

byte[] signedMessage = cms.OutputMessageB; //Binary output

cms = new Cms();
cms.InputMessageB = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - Detached Signature**

```csharp
Cms cms = new Cms();
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.InputMessage = "My Data";
cms.DetachedSignature = true;
cms.Sign();

string signature = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = "My Data";
cms.DetachedSignatureData = signature;
cms.DetachedSignature = true;
cms.VerifySignature();
```

 **Sign and Verify a message - Multiple Signatures**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*"));
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

 **Sign and Verify a message - No Included Certificate**

```csharp
Cms cms = new Cms();
cms.InputMessage = "My Data";
cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*"));
cms.IncludeCertificates = CmsIncludeCertificates.icsNone;
cms.Sign();

string signedMessage = cms.OutputMessage;

cms = new Cms();
cms.OnSignerCertInfo += (s, e) => {
  Console.WriteLine(e.Issuer);
  Console.WriteLine(e.SerialNumber);
  if (e.Issuer == "CN=100") //Identify the certificate to load based on event params
  {
    //Load the correct signer certificate.
    cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*"));
  }
};
cms.InputMessage = signedMessage;
cms.VerifySignature();

string plaintextMessage = cms.OutputMessage;
```

# Error Event ([IPWorksEncrypt_CMS](#cms-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworksencrypt_cms_register_callback($res, 1, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-cms-class) section.

# Log Event ([IPWorksEncrypt_CMS](#cms-class) Class)

Fires with log information during processing.

## Object Oriented Interface

```text
public function fireLog($param);
```

## Procedural Interface

```text
ipworksencrypt_cms_register_callback($res, 2, array($this, 'fireLog'));
```

## Parameter List

```text
 'loglevel' 'message' 'logtype'
```

## Remarks

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

*LogLevel* indicates the level of message. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

*LogMessage* is the log entry.

*LogType* indicates the type of log. Possible values are:

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

# RecipientInfo Event ([IPWorksEncrypt_CMS](#cms-class) Class)

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

## Object Oriented Interface

```text
public function fireRecipientInfo($param);
```

## Procedural Interface

```text
ipworksencrypt_cms_register_callback($res, 3, array($this, 'fireRecipientInfo'));
```

## Parameter List

```text
 'issuer' 'serialnumber' 'subjectkeyidentifier' 'encryptionalgorithm'
```

## Remarks

When [GetRecipientInfo](#getrecipientinfo-method-ipworksencrypt_cms-class) 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 ([IPWorksEncrypt_CMS](#cms-class) Class)

Fired during verification of the signed message.

## Object Oriented Interface

```text
public function fireSignerCertInfo($param);
```

## Procedural Interface

```text
ipworksencrypt_cms_register_callback($res, 4, array($this, 'fireSignerCertInfo'));
```

## Parameter List

```text
 'issuer' 'serialnumber' 'subjectkeyidentifier' '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.

# Config Settings ([CMS](#cms-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-ipworksencrypt_cms-class) method.

### CMS Config Settings

**CompressBeforeSign**: Specifies whether to compress before signing.When [EnableCompression](#enablecompression-property-ipworksencrypt_cms-class) is set to *True* this property controls whether compression happens before or after signing. If set to *True* the input data will be compressed before signing. If set to *False* (default) the input data will be signed and then compressed.

**ContentTypeOID**: Specifies the oid for content type.This setting optionally specifies an OID defining the data content type for the data being processed. This may be set before calling [Encrypt](#encrypt-method-ipworksencrypt_cms-class), [Sign](#sign-method-ipworksencrypt_cms-class), or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class).

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

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

NOTE: This config may only be used when the [UseCryptoAPI](#UseCryptoAPI) is true.

**GenerateSignatureTimestamp**: Whether to generate timestamps in signatures.If [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) is True, a timestamp will be generated and added to all signatures created by the class.

The default value is *True*.

**IncludeHeaders**: Tells the class whether to include the headers when encoding the message.If True (default), the class will include MIME headers when [Sign](#sign-method-ipworksencrypt_cms-class), [Encrypt](#encrypt-method-ipworksencrypt_cms-class), or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) are called. If False, only the message will be encoded.

The default value for [IncludeHeaders](#IncludeHeaders) is true.

Note: This setting is only applicable to when [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) is set to *SMIME*.

**IncludeInternalHeaders**: Tells the class whether or not to include the internal headers when encoding the message.If True, the class will generate and include MIME part headers when [Sign](#sign-method-ipworksencrypt_cms-class), [Encrypt](#encrypt-method-ipworksencrypt_cms-class), or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) are called. When [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class), [Decrypt](#decrypt-method-ipworksencrypt_cms-class), or [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworksencrypt_cms-class) are called the MIME part headers will be stripped.

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

The default value for [IncludeInternalHeaders](#IncludeInternalHeaders) is False.

Note: This setting is only applicable to when [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) 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 class will automatically determine the Content-Transfer-Encoding based on the file extension set in [InputFile](#inputfile-property-ipworksencrypt_cms-class), however this setting may be set to override the determined value or to specify a value if data is read from [InputMessage](#inputmessage-property-ipworksencrypt_cms-class).

If no value is specified and a value cannot be automatically determined the default value *7bit* will be used.

Note: This setting is only applicable when [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) is set to *SMIME* and when calling [Sign](#sign-method-ipworksencrypt_cms-class) or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) and [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) 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 class will automatically determine the Content-Type based on the file extension set in [InputFile](#inputfile-property-ipworksencrypt_cms-class), however this setting may be set to override the determined value or to specify a value if data is read from [InputMessage](#inputmessage-property-ipworksencrypt_cms-class).

If no value is specified and a value cannot be automatically determined the default value *text/plain; charset="iso-8859-1"* will be used.

Note: This setting is only applicable when [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) is set to *SMIME* and when calling [Sign](#sign-method-ipworksencrypt_cms-class) or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) and [DetachedSignature](#detachedsignature-property-ipworksencrypt_cms-class) is True.

**InputMessageHeaders**: Message headers.This setting specifies the headers of the SMIME message if they are not already present in the input message. In most cases the input message itself will contain the necessary headers, however if the headers are and body of the SMIME message are separate, the headers may be specified in this setting before calling [Decrypt](#decrypt-method-ipworksencrypt_cms-class), [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworksencrypt_cms-class), or [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class).

**LogDirectory**: The directory on disk where debug logs are written.This setting specifies a directory on disk to which debug logs will be written during operation. This should only be set for debugging purposes. Files with various extensions will be written to disk at the location specified with debug data for the operation being performed. If [LogFileName](#LogFileName) is not specified the filenames will be in the format *yyyy-MM-dd-HH-mm-ss-fff*.

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

**LogLevel**: The level of detail for log messages.This setting specifies the level of detail that is logged via the [Log](#log-event-ipworksencrypt_cms-class) event. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

**OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [UseOAEP](#useoaep-property-ipworksencrypt_cms-class) is set to True. The default value is *SHA256*. Possible values are as follows:

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

Note: This setting is not applicable when [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is set to *true* or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) and [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) values. In this case the [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is also used for MGF1.

**OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [UseOAEP](#useoaep-property-ipworksencrypt_cms-class) is set to True. The specified value should be hex encoded.

**OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [UseOAEP](#useoaep-property-ipworksencrypt_cms-class) is set to True. The default value is *SHA256*. Possible values are as follows:

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

**OutputMessageHeaders**: The SMIME headers of the output message.When [IncludeHeaders](#IncludeHeaders) is set to *False* the SMIME headers are not included in the output message itself when [Sign](#sign-method-ipworksencrypt_cms-class), [Encrypt](#encrypt-method-ipworksencrypt_cms-class), or [SignAndEncrypt](#signandencrypt-method-ipworksencrypt_cms-class) are called. This setting may be used to obtain the SMIME headers separately. This setting is only applicable when [OutputFormat](#outputformat-property-ipworksencrypt_cms-class) is set to *SMIME*.

**RecipientInfoType**: The type of signer information to include in the signed message.This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows:

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

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

**SignatureTimestamp**: The signature timestamp in the signed message.This setting holds the timestamp of the signature. After calling [VerifySignature](#verifysignature-method-ipworksencrypt_cms-class) this setting will hold the timestamp identifying when the signature was created. The timestamp is in UTC time with the format *yyyyMMddHHmmss*. For instance *20181130223821*.

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

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

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

**UseAlgorithmOIDs**: Whether OIDs are used when providing information about the algorithms.This configuration setting controls whether the *EncryptionAlgorithm* parameter of the [RecipientInfo](#recipientinfo-event-ipworksencrypt_cms-class) event is populated with the name of the algorithm, such as *3DES* or the corresponding OID such as *1.2.840.113549.3.7*.

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

### Base Config Settings

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

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

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

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class 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.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([CMS](#cms-class) Class)

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