# XMLEncrypt Class

The XMLEncrypt class is used to encrypt and decrypt XML.

## Syntax

```text
ipworksencrypt.XMLEncrypt
```

## Remarks

The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The [Encrypt](#encrypt-method-xmlencrypt-class) method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class). The [Decrypt](#decrypt-method-xmlencrypt-class) method will decrypt the XML document.

The class supports encrypting and decrypting with a shared [SymmetricKey](#symmetrickey-property-xmlencrypt-class), and also using asymmetric encryption to encrypt the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) (session key) via the [RecipientCert](#recipientcert-property-xmlencrypt-class) and [Certificate](#certificate-property-xmlencrypt-class) properties.

**Encrypt**

To begin first specify a XML document by calling [SetInputStream](#setinputstream-method-xmlencrypt-class) or setting [InputFile](#inputfile-property-xmlencrypt-class), or [InputXML](#inputxml-property-xmlencrypt-class).

The [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class) property specify the XML element to encrypt. By default the entire XML document is encrypted.

The [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property specifies the key which will be used to encrypt the data.

If the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is set, then the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key ([SymmetricKey](#symmetrickey-property-xmlencrypt-class)) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, [RecipientCert](#recipientcert-property-xmlencrypt-class) MUST have a RSA key, not a DSA key.

If the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is not set, then the recipient must know the value of [SymmetricKey](#symmetrickey-property-xmlencrypt-class) before decrypting the XML. The [KeyName](#KeyName) setting may be set to provide a key identifier to the recipient.

Optionally set [EncryptingAlgorithm](#encryptingalgorithm-property-xmlencrypt-class), and then call [Encrypt](#encrypt-method-xmlencrypt-class) to encrypt the XML.

The following properties are applicable when calling this method:

- [SymmetricKey](#symmetrickey-property-xmlencrypt-class) (required)
- [EncryptingAlgorithm](#encryptingalgorithm-property-xmlencrypt-class)
- [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class)
- [RecipientCert](#recipientcert-property-xmlencrypt-class)
- [KeyName](#KeyName)

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

**Decrypt**

To begin first specify a XML document by calling [SetInputStream](#setinputstream-method-xmlencrypt-class) or setting [InputFile](#inputfile-property-xmlencrypt-class), or [InputXML](#inputxml-property-xmlencrypt-class).

The [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property specifies the key used to decrypt the data. This may be set before calling [Decrypt](#decrypt-method-xmlencrypt-class) or inside the [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event. The [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event fires once for each encrypted element when [Decrypt](#decrypt-method-xmlencrypt-class) is called.

If the data was encrypted using an session key, set the [Certificate](#certificate-property-xmlencrypt-class) property to the certificate with private key before calling [Decrypt](#decrypt-method-xmlencrypt-class). The certificate will be used to decrypt the encrypted session key. In this case the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property is ignored.

The following properties are applicable when calling this method:

- [SymmetricKey](#symmetrickey-property-xmlencrypt-class)
- [Certificate](#certificate-property-xmlencrypt-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:

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

## Property List

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

|  |  |
| --- | --- |
| [Certificate](#certificate-property-xmlencrypt-class) | The certificate used for decryption. |
| [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class) | A collection of encrypted data details. |
| [EncryptingAlgorithm](#encryptingalgorithm-property-xmlencrypt-class) | Then encryption algorithm used when encrypting. |
| [InputFile](#inputfile-property-xmlencrypt-class) | The XML file to process. |
| [InputXML](#inputxml-property-xmlencrypt-class) | The XML to process. |
| [OutputFile](#outputfile-property-xmlencrypt-class) | The output file. |
| [OutputXML](#outputxml-property-xmlencrypt-class) | The output XML after processing. |
| [Overwrite](#overwrite-property-xmlencrypt-class) | Indicates whether or not the class should overwrite files. |
| [RecipientCert](#recipientcert-property-xmlencrypt-class) | The certificate used for encryption. |
| [SymmetricKey](#symmetrickey-property-xmlencrypt-class) | The symmetric key used to encrypt and decrypt the XML. |
| [UseOAEP](#useoaep-property-xmlencrypt-class) | Whether to use Optimal Asymmetric Encryption Padding (OAEP). |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-xmlencrypt-class) | Sets or retrieves a configuration setting. |
| [Decrypt](#decrypt-method-xmlencrypt-class) | Decrypts the XML. |
| [DoEvents](#doevents-method-xmlencrypt-class) | This method processes events from the internal message queue. |
| [Encrypt](#encrypt-method-xmlencrypt-class) | Encrypts the XML. |
| [Reset](#reset-method-xmlencrypt-class) | Resets the class. |
| [SetInputStream](#setinputstream-method-xmlencrypt-class) | Sets the stream from which the class will read data to encrypt or decrypt. |
| [SetOutputStream](#setoutputstream-method-xmlencrypt-class) | The stream to which the class will write the encrypted or decrypted XML. |

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

|  |  |
| --- | --- |
| [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) | Fired once for each encrypted element when Decrypt is called. |
| [Error](#error-event-xmlencrypt-class) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-xmlencrypt-class) | Fired as progress is made. |
| [Status](#status-event-xmlencrypt-class) | Provides information about the current operation. |

## Config Settings

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

|  |  |
| --- | --- |
| [EncryptedKeyXPath](#EncryptedKeyXPath) | The XPath of the EncryptedKey element. |
| [KeyName](#KeyName) | The name of the key used to encrypt the XML. |
| [LogLevel](#LogLevel) | Specifies the level of detail that is logged. |
| [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. |
| [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used when encrypting a key. |
| [ReadFromProgressEvent](#ReadFromProgressEvent) | Whether to read input data from inside the progress event. |
| [WriteToProgressEvent](#WriteToProgressEvent) | Whether to write output data so it is accessible from inside the progress event. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [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. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# Certificate Property ([XMLEncrypt](#xmlencrypt-class) Class)

The certificate used for decryption.

## Syntax

```text
public Certificate getCertificate();
public void setCertificate(Certificate certificate);
```

## Remarks

This property specifies a certificate with private key.

If the encrypted XML contains an encrypted key this property specifies the certificate with private key to be used to decrypt the key. This is applicable when calling [Decrypt](#decrypt-method-xmlencrypt-class).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# EncryptedDataDetails Property ([XMLEncrypt](#xmlencrypt-class) Class)

A collection of encrypted data details.

## Syntax

```text
public XMLEncryptedDataDetailList getEncryptedDataDetails();
```

## Remarks

This property holds a collection of details about the XML elements to be encrypted. This may be populated before calling [Encrypt](#encrypt-method-xmlencrypt-class). If this is not populated, then the entire XML document will be encrypted.

This property is not available at design time.

 Please refer to the [XMLEncryptedDataDetail](#xmlencrypteddatadetail-type) type for a complete list of fields.

# EncryptingAlgorithm Property ([XMLEncrypt](#xmlencrypt-class) Class)

Then encryption algorithm used when encrypting.

## Syntax

```text
public String getEncryptingAlgorithm();
public void setEncryptingAlgorithm(String encryptingAlgorithm);
```

## Default Value

"3DES"

## Remarks

This property specifies the encryption algorithm to use when encrypting. Possible values are:

- "3DES" (default)
- "DES"
- "AES128"
- "AES192"
- "AES256"

# InputFile Property ([XMLEncrypt](#xmlencrypt-class) Class)

The XML file to process.

## Syntax

```text
public String getInputFile();
public void setInputFile(String inputFile);
```

## Default Value

""

## Remarks

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

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- InputFile
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# InputXML Property ([XMLEncrypt](#xmlencrypt-class) Class)

The XML to process.

## Syntax

```text
public String getInputXML();
public void setInputXML(String inputXML);
```

## Default Value

""

## Remarks

This property specifies the XML to be processed.

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- InputXML

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# OutputFile Property ([XMLEncrypt](#xmlencrypt-class) Class)

The output file.

## Syntax

```text
public String getOutputFile();
public void setOutputFile(String outputFile);
```

## Default Value

""

## Remarks

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

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- OutputFile
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# OutputXML Property ([XMLEncrypt](#xmlencrypt-class) Class)

The output XML after processing.

## Syntax

```text
public String getOutputXML();
public void setOutputXML(String outputXML);
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [OutputFile](#outputfile-property-xmlencrypt-class) and [SetOutputStream](#setoutputstream-method-xmlencrypt-class) are not set.

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

# Overwrite Property ([XMLEncrypt](#xmlencrypt-class) Class)

Indicates whether or not the class should overwrite files.

## Syntax

```text
public boolean isOverwrite();
public void setOverwrite(boolean overwrite);
```

## Default Value

False

## Remarks

This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-xmlencrypt-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-xmlencrypt-class) exists before an operation. The default value is False.

# RecipientCert Property ([XMLEncrypt](#xmlencrypt-class) Class)

The certificate used for encryption.

## Syntax

```text
public Certificate getRecipientCert();
public void setRecipientCert(Certificate recipientCert);
```

## Remarks

This property specifies a certificate for encryption.

If specified, the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) will be encrypted and included as an encrypted key in the XML. This is applicable when calling [Encrypt](#encrypt-method-xmlencrypt-class).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SymmetricKey Property ([XMLEncrypt](#xmlencrypt-class) Class)

The symmetric key used to encrypt and decrypt the XML.

## Syntax

```text
public byte[] getSymmetricKey();
public void setSymmetricKey(byte[] symmetricKey);
```

## Default Value

""

## Remarks

This property specifies the symmetric key used to encrypt and decrypt the XML.

**Encrypt Notes**

When calling [Encrypt](#encrypt-method-xmlencrypt-class) if the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is set, then the SymmetricKey will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the SymmetricKey allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the SymmetricKey is required by the recipient.

If the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is set and SymmetricKey is left empty, then a SymmetricKey value will automatically be generated by the class when [Encrypt](#encrypt-method-xmlencrypt-class) is called.

When calling [Encrypt](#encrypt-method-xmlencrypt-class) if the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is are not set, then the SymmetricKey value must be known by the recipient before the message can be decrypted.

**Decrypt Notes**

When calling [Decrypt](#decrypt-method-xmlencrypt-class) if the data contains an encrypted key the class will attempt to use the certificate specified by the [Certificate](#certificate-property-xmlencrypt-class) property to decrypt the encrypted key and this property is ignored.

When calling [Decrypt](#decrypt-method-xmlencrypt-class) if the data does not contain an encrypted key then SymmetricKey must be set either before calling [Decrypt](#decrypt-method-xmlencrypt-class), or within the [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event.

**Legal Key and Block Sizes (in bits)**

|  |  |  |  |
| --- | --- | --- | --- |
|  | AES | DES | 3DES |
| Minimum Key Size | 128 | 64 | 128 |
| Maximum Key Size | 256 | 64 | 192 |
| Key Size Step | 64 | 0 | 64 |
| Block Size | 128 | 64 | 64 |

This property is not available at design time.

# UseOAEP Property ([XMLEncrypt](#xmlencrypt-class) Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

## Syntax

```text
public boolean isUseOAEP();
public void setUseOAEP(boolean useOAEP);
```

## Default Value

False

## Remarks

This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) with the certificate specified by [RecipientCert](#recipientcert-property-xmlencrypt-class). It is only applicable when calling [Encrypt](#encrypt-method-xmlencrypt-class) and [RecipientCert](#recipientcert-property-xmlencrypt-class) is specified.

By default this value is False and the class will use PKCS1.

# Config Method ([XMLEncrypt](#xmlencrypt-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

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

# Decrypt Method ([XMLEncrypt](#xmlencrypt-class) Class)

Decrypts the XML.

## Syntax

```text
public void decrypt();
```

## Remarks

This method decrypts the specified XML.

To begin first specify a XML document by calling [SetInputStream](#setinputstream-method-xmlencrypt-class) or setting [InputFile](#inputfile-property-xmlencrypt-class), or [InputXML](#inputxml-property-xmlencrypt-class).

The [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event. The [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event fires once for each encrypted element when Decrypt is called.

If the data was encrypted using an session key, set the [Certificate](#certificate-property-xmlencrypt-class) property to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property is ignored.

The following properties are applicable when calling this method:

- [SymmetricKey](#symmetrickey-property-xmlencrypt-class)
- [Certificate](#certificate-property-xmlencrypt-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:

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

# DoEvents Method ([XMLEncrypt](#xmlencrypt-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
public void doEvents();
```

## Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

# Encrypt Method ([XMLEncrypt](#xmlencrypt-class) Class)

Encrypts the XML.

## Syntax

```text
public void encrypt();
```

## Remarks

This method encrypts the specified XML.

To begin first specify a XML document by calling [SetInputStream](#setinputstream-method-xmlencrypt-class) or setting [InputFile](#inputfile-property-xmlencrypt-class), or [InputXML](#inputxml-property-xmlencrypt-class).

The [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class) property specify the XML element to encrypt. By default the entire XML document is encrypted.

The [SymmetricKey](#symmetrickey-property-xmlencrypt-class) property specifies the key which will be used to encrypt the data.

If the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is set, then the [SymmetricKey](#symmetrickey-property-xmlencrypt-class) will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key ([SymmetricKey](#symmetrickey-property-xmlencrypt-class)) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, [RecipientCert](#recipientcert-property-xmlencrypt-class) MUST have a RSA key, not a DSA key.

If the [RecipientCert](#recipientcert-property-xmlencrypt-class) property is not set, then the recipient must know the value of [SymmetricKey](#symmetrickey-property-xmlencrypt-class) before decrypting the XML. The [KeyName](#KeyName) setting may be set to provide a key identifier to the recipient.

Optionally set [EncryptingAlgorithm](#encryptingalgorithm-property-xmlencrypt-class), and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

- [SymmetricKey](#symmetrickey-property-xmlencrypt-class) (required)
- [EncryptingAlgorithm](#encryptingalgorithm-property-xmlencrypt-class)
- [EncryptedDataDetails](#encrypteddatadetails-property-xmlencrypt-class)
- [RecipientCert](#recipientcert-property-xmlencrypt-class)
- [KeyName](#KeyName)

**Input and Output Properties**

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

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

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

# Reset Method ([XMLEncrypt](#xmlencrypt-class) Class)

Resets the class.

## Syntax

```text
public void reset();
```

## Remarks

When called, the component will reset all of its properties to their default values.

# SetInputStream Method ([XMLEncrypt](#xmlencrypt-class) Class)

Sets the stream from which the class will read data to encrypt or decrypt.

## Syntax

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

## Remarks

This method sets the stream from which the class will read data to encrypt or decrypt. If an input stream is set before calling [Encrypt](#encrypt-method-xmlencrypt-class) or [Decrypt](#decrypt-method-xmlencrypt-class), the data is read from the input stream instead of from the [InputFile](#inputfile-property-xmlencrypt-class) or [InputXML](#inputxml-property-xmlencrypt-class) properties.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

**Input and Output Properties**

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

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

- SetInputStream
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

- [SetOutputStream](#setoutputstream-method-xmlencrypt-class)
- [OutputFile](#outputfile-property-xmlencrypt-class)
- [OutputXML](#outputxml-property-xmlencrypt-class): The output data is written to this property if no other destination is specified.

# SetOutputStream Method ([XMLEncrypt](#xmlencrypt-class) Class)

The stream to which the class will write the encrypted or decrypted XML.

## Syntax

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

## Remarks

This method sets the stream to which the class will write the encrypted or decrypted XML. If an output stream is set before calling [Encrypt](#encrypt-method-xmlencrypt-class) or [Decrypt](#decrypt-method-xmlencrypt-class), the class will write the data to the output stream instead of populating [OutputXML](#outputxml-property-xmlencrypt-class) or writing to [OutputFile](#outputfile-property-xmlencrypt-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:

- [SetInputStream](#setinputstream-method-xmlencrypt-class)
- [InputFile](#inputfile-property-xmlencrypt-class)
- [InputXML](#inputxml-property-xmlencrypt-class)

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

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

# EncryptedDataInfo Event ([XMLEncrypt](#xmlencrypt-class) Class)

Fired once for each encrypted element when Decrypt is called.

## Syntax

```text
public class DefaultXMLEncryptEventListener implements XMLEncryptEventListener {
  ...
  public void encryptedDataInfo(XMLEncryptEncryptedDataInfoEvent e) {}
  ...
}

public class XMLEncryptEncryptedDataInfoEvent {
  public String encryptedDataId;
  public int scope;
  public String MIMEType;
}
```

## Remarks

This event fires once for each encrypted element in the XML document when [Decrypt](#decrypt-method-xmlencrypt-class) is called. The parameters of this event provide information about the encrypted data. Additionally, the [KeyName](#KeyName) setting may be queried to identify the encryption key. [SymmetricKey](#symmetrickey-property-xmlencrypt-class) may be set from within this event.

*EncryptedDataId* is the Id of the encrypted data (if any).

*Scope* indicates the scope of the encrypted data. This defines whether the entire XML element was encrypted, or only the content. Possible values are:

|  |  |
| --- | --- |
| 0 | Element |
| 1 | Content |

*MIMEType* holds the MIME type of the encrypted data (if any). For example: "image/png".

# Error Event ([XMLEncrypt](#xmlencrypt-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
public class DefaultXMLEncryptEventListener implements XMLEncryptEventListener {
  ...
  public void error(XMLEncryptErrorEvent e) {}
  ...
}

public class XMLEncryptErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

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

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-xmlencrypt-class) section.

# Progress Event ([XMLEncrypt](#xmlencrypt-class) Class)

Fired as progress is made.

## Syntax

```text
public class DefaultXMLEncryptEventListener implements XMLEncryptEventListener {
  ...
  public void progress(XMLEncryptProgressEvent e) {}
  ...
}

public class XMLEncryptProgressEvent {
  public long bytesProcessed;
  public int percentProcessed;
  public int operation;
  public boolean isEOF; //read-write
}
```

## Remarks

This event is fired automatically as data is processed by the class.

The *PercentProcessed* parameter indicates the current status of the operation.

The *BytesProcessed* parameter holds the total number of bytes processed so far.

The *Operation* parameter is only applicable when either [ReadFromProgressEvent](#ReadFromProgressEvent) or [WriteToProgressEvent](#WriteToProgressEvent) is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

|  |  |
| --- | --- |
| 0 | None |
| 1 | Read |
| 2 | Write |

The *IsEOF* parameter is only applicable when either [ReadFromProgressEvent](#ReadFromProgressEvent) or [WriteToProgressEvent](#WriteToProgressEvent) is set to True. This parameter defines whether the Read or Write operation is complete. When the *Operation* is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the *Operation* is Write (2) this value may be queried to determine when all data has been processed.

# Status Event ([XMLEncrypt](#xmlencrypt-class) Class)

Provides information about the current operation.

## Syntax

```text
public class DefaultXMLEncryptEventListener implements XMLEncryptEventListener {
  ...
  public void status(XMLEncryptStatusEvent e) {}
  ...
}

public class XMLEncryptStatusEvent {
  public String message;
}
```

## Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the [LogLevel](#LogLevel) setting.

# Certificate Type

This is the digital certificate being used.

## Remarks

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

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *String (read-only)*
*Default Value: ""*

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.

 **ExpirationDate** *String (read-only)*
*Default Value: ""*

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.

 **ExtendedKeyUsage** *String (read-only)*
*Default Value: ""*

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

 **Fingerprint** *String (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA1** *String (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA256** *String (read-only)*
*Default Value: ""*

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

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

 **Issuer** *String (read-only)*
*Default Value: ""*

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

 **KeyPassword** *String*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey).

 **PrivateKey** *String (read-only)*
*Default Value: ""*

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *String (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *String (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *String (read-only)*
*Default Value: ""*

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

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

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

 **SerialNumber** *String (read-only)*
*Default Value: ""*

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

 **SignatureAlgorithm** *String (read-only)*
*Default Value: ""*

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

 **Store** *String*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

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

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

 **StoreB** *byte[]*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

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

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

 **StorePassword** *String*
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

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 field 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](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_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 [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_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. |

 **SubjectAltNames** *String (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *String (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA1** *String (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA256** *String (read-only)*
*Default Value: ""*

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

 **Usage** *String (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

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.

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

 **Version** *String (read-only)*
*Default Value: ""*

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

 **Subject** *String*
*Default Value: ""*

The subject of the certificate used for client authentication.

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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.

 **Encoded** *String*
*Default Value: ""*

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

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

 **EncodedB** *byte[]*
*Default Value: ""*

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

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

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

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

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# XMLEncryptedDataDetail Type

This type defines details about the data to be encrypted.

## Remarks

This type defines details about the data to be encrypted. The element to encrypt is defined by [XMLElement](#XMLEncryptedDataDetail_f_XMLElement).

The following fields are available:

- [Id](#XMLEncryptedDataDetail_f_Id)

- [MIMEType](#XMLEncryptedDataDetail_f_MIMEType)

- [Scope](#XMLEncryptedDataDetail_f_Scope)

- [XMLElement](#XMLEncryptedDataDetail_f_XMLElement)

## Fields

 **Id** *String*
*Default Value: ""*

This field is an optional identifier for the encrypted data.

 **MIMEType** *String*
*Default Value: ""*

This field specifies the MIME type of the encrypted data. For example: "image/png". This field is optional.

 **Scope** *int*
*Default Value: 0*

This field specifies the scope of the encryption. When calling Encrypt the entire XML element specified by [XMLElement](#XMLEncryptedDataDetail_f_XMLElement) may be encrypted, or only the content may be encrypted. This setting controls the scope of the encryption. Possible values are:

|  |  |
| --- | --- |
| 0 (sElement - default) | The entire XML element is encrypted. |
| 1 (sContent) | Only the content of the XML element is encrypted. |

 **XMLElement** *String*
*Default Value: "/"*

This field specifies the XPath to the element which will be encrypted. For instance:

|  |  |
| --- | --- |
| /root/myElement | XPath syntax |
| /root/[1] | XPath syntax using an index |
| /root/ns:myElement | XPath syntax where the element has a namespace |
| myElement | Just the element name |
| @id=myid | Attribute selector: This will select an element with an attribute "id" whose value is "myid". |
| /root/myElement[1]/ns:name2[@attr=attrValue] | XPath syntax using an index and attribute selector |

## Constructors

```text
public XMLEncryptedDataDetail();
```

```text
public XMLEncryptedDataDetail(String id, String XMLElement, int scope, String MIMEType);
```

# Config Settings ([XMLEncrypt](#xmlencrypt-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-xmlencrypt-class) method.

### XMLEnc Config Settings

**EncryptedKeyXPath**: The XPath of the EncryptedKey element.This setting specifies the XPath where the EncryptedKey element will be written. In most cases this does not need to be changed. By default it is included in the EncryptedData element.

**KeyName**: The name of the key used to encrypt the XML.This setting optionally holds the key name which may be useful to the recipient to help identify the key used to encrypt the data. This may be set before calling [Encrypt](#encrypt-method-xmlencrypt-class). When calling [Decrypt](#decrypt-method-xmlencrypt-class) this may be queried inside the [EncryptedDataInfo](#encrypteddatainfo-event-xmlencrypt-class) event.

Note that this value is only informative, it does not affect processing.

**LogLevel**: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the [Status](#status-event-xmlencrypt-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-xmlencrypt-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"

**OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [UseOAEP](#useoaep-property-xmlencrypt-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-xmlencrypt-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"

 The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are:

- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"

**OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [UseOAEP](#useoaep-property-xmlencrypt-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"

 The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are:

- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"

**ReadFromProgressEvent**: Whether to read input data from inside the progress event.When set to True this setting allows input data to be specified from within the [Progress](#progress-event-xmlencrypt-class) event. The class will repeatedly fire the [Progress](#progress-event-xmlencrypt-class) event to ask for data. Inside the event set [InputXML](#inputxml-property-xmlencrypt-class) when the *Operation* parameter of the event is 1 (Read). When all data has been provided set the *IsEOF* parameter of the event to True. This allows input data to be chunked and provided piece by piece. The default value is False.

**WriteToProgressEvent**: Whether to write output data so it is accessible from inside the progress event.When set to True this setting allows output data to be obtained from within the [Progress](#progress-event-xmlencrypt-class) event. The class will repeatedly fire the [Progress](#progress-event-xmlencrypt-class) event to provide output data. Inside the event check [OutputXML](#outputxml-property-xmlencrypt-class) when the *Operation* parameter of the event is 2 (Write). The *IsEOF* parameter should be checked inside the event to determine when all output data has been provided. This allows output data to be chunked and obtained piece by piece. The default value is False.

### Base Config Settings

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

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

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

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a 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*.

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

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

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;
```

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());
```

When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

//required to use BCJSSE when SSLProvider is set to sslpPlatform
import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;
```

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());

//required to use BCJSSE when SSLProvider is set to sslpPlatform
Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS"));

//optional - configure logging level of BCJSSE
Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF);

//configure the class to use BCJSSE
component.setSSLProvider(1); //platform
component.config("UseFIPSCompliantAPI=true");
```

 NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

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

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([XMLEncrypt](#xmlencrypt-class) Class)

### XMLEnc Errors

|  |  |
| --- | --- |
| 607 | Failed to write output. |
| 609 | Could not find encrypted data. |
| 610 | Invalid encrypted data. |
| 611 | Failed parsing certificate data. |
| 612 | SymmetricKey or RecipientCert must be set. |

### XML Errors

|  |  |
| --- | --- |
| 101 | Invalid attribute index. |
| 102 | No attributes available. |
| 103 | Invalid namespace index. |
| 104 | No namespaces available. |
| 105 | Invalid element index. |
| 106 | No elements available. |
| 107 | Attribute does not exist. |
| 201 | Unbalanced element tag. |
| 202 | Unknown element prefix (cannot find namespace). |
| 203 | Unknown attribute prefix (cannot find namespace). |
| 204 | Invalid XML markup. |
| 205 | Invalid end state for parser. |
| 206 | Document contains unbalanced elements. |
| 207 | Invalid XPath. |
| 208 | No such child. |
| 209 | Top element does not match start of path. |
| 210 | DOM tree unavailable (set BuildDOM to true and reparse). |
| 302 | Cannot open file. |
| 401 | Invalid XML would be generated. |
| 402 | An invalid XML name has been specified. |