# XMLSig Class

The XMLSig class is used to sign XML and verify signed XML.

## Syntax

**ipworksencrypt.xmlsig()**

## Remarks

The XMLSig component provides an easy to use API for signing and verifying signed XML. The [Sign](#xmlsigsign-method) method will create signed XML with an enveloped signature. The [VerifySignature](#xmlsigverifysignature-method) method will attempt to verify the signature(s) within a XML document.

**Sign**

Before calling [Sign](#xmlsigsign-method) specify the XML to sign by setting [InputFile](#xmlsiginputfile-property), or [InputXML](#xmlsiginputxml-property).

The [References](#xmlsigreferences-property) property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set [Certificate](#xmlsigcertificate-property) to a certificate with private key.

Optionally set the [CanonicalizationMethod](#xmlsigcanonicalizationmethod-property). This determines how the signature itself is canonicalized. [SigningAlgorithm](#xmlsigsigningalgorithm-property) defines the algorithm used to sign. The [SignatureXPath](#xmlsigsignaturexpath-property) property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call [Sign](#xmlsigsign-method) to sign the XML.

The following properties are applicable when calling this method:

- [CanonicalizationMethod](#xmlsigcanonicalizationmethod-property)
- [Certificate](#xmlsigcertificate-property) (required)
- [References](#xmlsigreferences-property) (required)
- [SignatureXPath](#xmlsigsignaturexpath-property)
- [SigningAlgorithm](#xmlsigsigningalgorithm-property)

**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](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

**Verify a Signature**

When [VerifySignature](#xmlsigverifysignature-method) is called, the class will scan the XML document and fire the [SignatureInfo](#xmlsigsignatureinfo-event) event for each signature that is found. When the [SignatureInfo](#xmlsigsignatureinfo-event) event fires the [References](#xmlsigreferences-property) collection will be populated.

Within the [SignatureInfo](#xmlsigsignatureinfo-event) event the ReferencesXMLElement property must be set to the location of the XML element to which the signature applies. The ReferencesURI property may contain data helpful to locating the XML element.

The ReferencesXMLElement property specifies the XPath to the element. 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 |

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#xmlsigsignercert-property) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#xmlsigsignercert-property) property with the parsed value.

When [SignatureInfo](#xmlsigsignatureinfo-event) fires, if the *SignerCertParsed* parameter is True the [SignerCert](#xmlsigsignercert-property) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#xmlsigsignercert-property) property must be set to a valid certificate for signature verification to proceed.

When the [SignatureInfo](#xmlsigsignatureinfo-event) event finishes firing, the certificate present in the [SignerCert](#xmlsigsignercert-property) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method .

## Property List

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

|  |  |
| --- | --- |
| [CanonicalizationMethod](#xmlsigcanonicalizationmethod-property) | The canonicalization method applied to the signature. |
| [Certificate](#xmlsigcertificate-property) | The certificate used for signing. |
| [HMACKey](#xmlsighmackey-property) | The HMAC key used with the 'HMAC-SHA1' signing algorithm. |
| [InputFile](#xmlsiginputfile-property) | The XML file to process. |
| [InputXML](#xmlsiginputxml-property) | The XML to process. |
| [OutputFile](#xmlsigoutputfile-property) | The output file. |
| [OutputXML](#xmlsigoutputxml-property) | The output XML after processing. |
| [Overwrite](#xmlsigoverwrite-property) | Indicates whether or not the class should overwrite files. |
| [References](#xmlsigreferences-property) | A collection of references. |
| [SignatureXPath](#xmlsigsignaturexpath-property) | The XPath of the signature. |
| [SignerCert](#xmlsigsignercert-property) | The certificate used for signature verification. |
| [SigningAlgorithm](#xmlsigsigningalgorithm-property) | The signing algorithm. |

## 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](#xmlsigconfig-method) | Sets or retrieves a configuration setting. |
| [DoEvents](#xmlsigdoevents-method) | This method processes events from the internal message queue. |
| [Reset](#xmlsigreset-method) | Resets the class. |
| [SetInputStream](#xmlsigsetinputstream-method) | Sets the stream from which the class will read data to sign or verify. |
| [SetOutputStream](#xmlsigsetoutputstream-method) | The stream to which the class will write the signed or verified XML. |
| [Sign](#xmlsigsign-method) | Signs the XML. |
| [VerifySignature](#xmlsigverifysignature-method) | Verifies signed 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.*

|  |  |
| --- | --- |
| [Error](#xmlsigerror-event) | Fired when information is available about errors during data delivery. |
| [Progress](#xmlsigprogress-event) | Fired as progress is made. |
| [SignatureInfo](#xmlsigsignatureinfo-event) | Fired when a signature is found. |
| [Status](#xmlsigstatus-event) | 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.*

|  |  |
| --- | --- |
| [KeyName](#KeyName) | The name of the key used to sign the XML. |
| [LogLevel](#LogLevel) | Specifies the level of detail that is logged. |
| [NormalizeLineEndings](#NormalizeLineEndings) | Whether to normalize line endings when calculating the reference digest. |
| [PreserveWhitespace](#PreserveWhitespace) | Whether to preserve whitespace in the signature. |
| [ReadFromProgressEvent](#ReadFromProgressEvent) | Whether to read input data from inside the progress event. |
| [SignatureRelationship](#SignatureRelationship) | Whether the signature is a child or sibling of the SignatureXPath. |
| [SignerCertCount](#SignerCertCount) | The number of parsed signer certificates when verifying a signature. |
| [SignerCertEncoded\[i\]](#SignerCertEncoded[i]) | The parsed signer certificate. |
| [SignWithCryptoAPI](#SignWithCryptoAPI) | Whether to use the Crypto API for signing operations. |
| [WriteToProgressEvent](#WriteToProgressEvent) | Whether to write output data so it is accessible from inside the progress event. |
| [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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [XMLSig](#xmlsig-class).CanonicalizationMethod Property

The canonicalization method applied to the signature.

## Syntax

```text
getCanonicalizationMethod(): XMLSigCanonicalizationMethods;
setCanonicalizationMethod(canonicalizationMethod: XMLSigCanonicalizationMethods): void;
enum XMLSigCanonicalizationMethods {
  cmC14N,
  cmC14NComments,
  cmC14N11,
  cmC14N11Comments,
  cmExcC14N,
  cmExcC14NComments
}
```

## Default Value

0

## Remarks

This property specifies the canonicalization method that is applied to the signature. This may be set before calling [Sign](#xmlsigsign-method). This will be set automatically after calling [VerifySignature](#xmlsigverifysignature-method). Possible values are:

|  |  |
| --- | --- |
| 0 (cmC14N - default) | Canonical XML version 1.0 |
| 1 (cmC14NComments) | Canonical XML version 1.0 with comments |
| 2 (cmC14N11) | Canonical XML version 1.1 |
| 3 (cmC14N11) | Canonical XML version 1.1 with comments |
| 4 (cmExcC14N) | Exclusive XML canonicalization version 1.0 |
| 5 (cmExcC14NComments) | Exclusive XML canonicalization version 1.0 with comments |

This property is not available at design time.

# [XMLSig](#xmlsig-class).Certificate Property

The certificate used for signing.

## Syntax

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

## Default Value

## Remarks

This property specifies a certificate with private key.

This must be set before calling [Sign](#xmlsigsign-method).

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

# [XMLSig](#xmlsig-class).HMACKey Property

The HMAC key used with the 'HMAC-SHA1' signing algorithm.

## Syntax

```text
getHMACKey(): Uint8Array;
setHMACKey(HMACKey: Uint8Array): void;
```

## Default Value

""

## Remarks

This property defines the HMAC key to be used when [SigningAlgorithm](#xmlsigsigningalgorithm-property) is set to "HMAC-SHA1". This must be set before calling before calling [Sign](#xmlsigsign-method).

This property is also applicable when calling [VerifySignature](#xmlsigverifysignature-method). This may be set before calling [VerifySignature](#xmlsigverifysignature-method) or from within the [SignatureInfo](#xmlsigsignatureinfo-event) event.

This property is not available at design time.

# [XMLSig](#xmlsig-class).InputFile Property

The XML file to process.

## Syntax

```text
getInputFile(): string;
setInputFile(inputFile: string): void;
```

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

- InputFile
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# [XMLSig](#xmlsig-class).InputXML Property

The XML to process.

## Syntax

```text
getInputXML(): string;
setInputXML(inputXML: string): void;
```

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

- [InputFile](#xmlsiginputfile-property)
- InputXML

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# [XMLSig](#xmlsig-class).OutputFile Property

The output file.

## Syntax

```text
getOutputFile(): string;
setOutputFile(outputFile: string): void;
```

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

- [InputFile](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- OutputFile
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

This property is not available at design time.

# [XMLSig](#xmlsig-class).OutputXML Property

The output XML after processing.

## Syntax

```text
getOutputXML(): string;
setOutputXML(outputXML: string): void;
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [OutputFile](#xmlsigoutputfile-property) is 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:

- [InputFile](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- OutputXML: The output data is written to this property if no other destination is specified.

This property is not available at design time.

# [XMLSig](#xmlsig-class).Overwrite Property

Indicates whether or not the class should overwrite files.

## Syntax

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

## Default Value

FALSE

## Remarks

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

# [XMLSig](#xmlsig-class).References Property

A collection of references.

## Syntax

```text
getReferences(): XMLSigReferenceList;
```

## Default Value

## Remarks

This property holds a collection of reference to sign or verify. This must be populated before calling [Sign](#xmlsigsign-method). This will be populated by the class when calling [VerifySignature](#xmlsigverifysignature-method) and is accessible from within the [SignatureInfo](#xmlsigsignatureinfo-event) event.

This property is not available at design time.

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

# [XMLSig](#xmlsig-class).SignatureXPath Property

The XPath of the signature.

## Syntax

```text
getSignatureXPath(): string;
setSignatureXPath(signatureXPath: string): void;
```

## Default Value

"/"

## Remarks

This property specifies the XPath in the XML where the signature will be placed.

This may be set before calling [Sign](#xmlsigsign-method). This property will be populated when calling [VerifySignature](#xmlsigverifysignature-method).

The default value is "/".

This property is not available at design time.

# [XMLSig](#xmlsig-class).SignerCert Property

The certificate used for signature verification.

## Syntax

```text
getSignerCert(): Certificate;
setSignerCert(signerCert: Certificate): void;
```

## Default Value

## Remarks

This property specifies a certificate for signature verification.

This may be set from within the [SignatureInfo](#xmlsigsignatureinfo-event) event after calling [VerifySignature](#xmlsigverifysignature-method). If the signed XML already includes a public key to use for verification, then this property will be automatically populated and does not need to be set. Check the [SignatureInfo](#xmlsigsignatureinfo-event) event to determine if a public key was parsed from the signed XML. If a public key was not automatically parsed, set this property to the signer's certificate from within the event.

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

# [XMLSig](#xmlsig-class).SigningAlgorithm Property

The signing algorithm.

## Syntax

```text
getSigningAlgorithm(): string;
setSigningAlgorithm(signingAlgorithm: string): void;
```

## Default Value

""

## Remarks

This property specifies the signing algorithm.

This may be set before calling [Sign](#xmlsigsign-method). This value will be set after calling [VerifySignature](#xmlsigverifysignature-method). Possible values are:

- "RSA-SHA1" (default)
- "RSA-SHA256"
- "DSA-SHA1"
- "HMAC-SHA1"

 Note: When set to "HMAC-SHA1" [HMACKey](#xmlsighmackey-property) must also be set.

This property is not available at design time.

# [XMLSig](#xmlsig-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async xmlsig.config(configurationString : string): Promise< string>
```

## Remarks

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

# [XMLSig](#xmlsig-class).doEvents Method

This method processes events from the internal message queue.

## Syntax

```text
async xmlsig.doEvents(): Promise< void>
```

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

# [XMLSig](#xmlsig-class).reset Method

Resets the class.

## Syntax

```text
async xmlsig.reset(): Promise< void>
```

## Remarks

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

# [XMLSig](#xmlsig-class).setInputStream Method

Sets the stream from which the class will read data to sign or verify.

## Syntax

```text
async xmlsig.setInputStream(inputStream : ReadableStream): Promise< void>
```

## Remarks

This method sets the stream from which the class will read data to sign or verify. If an input stream is set before calling [Sign](#xmlsigsign-method) or [VerifySignature](#xmlsigverifysignature-method), the data is read from the input stream instead of from the [InputFile](#xmlsiginputfile-property) or [InputXML](#xmlsiginputxml-property) 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:

- [InputFile](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

# [XMLSig](#xmlsig-class).setOutputStream Method

The stream to which the class will write the signed or verified XML.

## Syntax

```text
async xmlsig.setOutputStream(outputStream : WriteableStream): Promise< void>
```

## Remarks

This method sets the stream to which the class will write the signed or verified XML. If an output stream is set before calling [Sign](#xmlsigsign-method) or [VerifySignature](#xmlsigverifysignature-method), the class will write the data to the output stream instead of populating [OutputXML](#xmlsigoutputxml-property) or writing to [OutputFile](#xmlsigoutputfile-property).

**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](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

# [XMLSig](#xmlsig-class).sign Method

Signs the XML.

## Syntax

```text
async xmlsig.sign(): Promise< void>
```

## Remarks

This methods signs the XML.

Before calling Sign specify the XML to sign by setting [InputFile](#xmlsiginputfile-property), or [InputXML](#xmlsiginputxml-property).

The [References](#xmlsigreferences-property) property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process.

Set [Certificate](#xmlsigcertificate-property) to a certificate with private key.

Optionally set the [CanonicalizationMethod](#xmlsigcanonicalizationmethod-property). This determines how the signature itself is canonicalized. [SigningAlgorithm](#xmlsigsigningalgorithm-property) defines the algorithm used to sign. The [SignatureXPath](#xmlsigsignaturexpath-property) property may be set to specify the location in the XML document where the signature will be placed.

Lastly, call Sign to sign the XML.

The following properties are applicable when calling this method:

- [CanonicalizationMethod](#xmlsigcanonicalizationmethod-property)
- [Certificate](#xmlsigcertificate-property) (required)
- [References](#xmlsigreferences-property) (required)
- [SignatureXPath](#xmlsigsignaturexpath-property)
- [SigningAlgorithm](#xmlsigsigningalgorithm-property)

**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](#xmlsiginputfile-property)
- [InputXML](#xmlsiginputxml-property)

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

- [OutputFile](#xmlsigoutputfile-property)
- [OutputXML](#xmlsigoutputxml-property): The output data is written to this property if no other destination is specified.

# [XMLSig](#xmlsig-class).verifySignature Method

Verifies signed XML.

## Syntax

```text
async xmlsig.verifySignature(): Promise< void>
```

## Remarks

This method verifies signatures contained in the XML.

When VerifySignature is called, the class will scan the XML document and fire the [SignatureInfo](#xmlsigsignatureinfo-event) event for each signature that is found. When the [SignatureInfo](#xmlsigsignatureinfo-event) event fires the [References](#xmlsigreferences-property) collection will be populated.

Within the [SignatureInfo](#xmlsigsignatureinfo-event) event the ReferencesXMLElement property must be set to the location of the XML element to which the signature applies. The ReferencesURI property may contain data helpful to locating the XML element.

The ReferencesXMLElement property specifies the XPath to the element. 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 |

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#xmlsigsignercert-property) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#xmlsigsignercert-property) property with the parsed value.

When [SignatureInfo](#xmlsigsignatureinfo-event) fires, if the *SignerCertParsed* parameter is True the [SignerCert](#xmlsigsignercert-property) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#xmlsigsignercert-property) property must be set to a valid certificate for signature verification to proceed.

When the [SignatureInfo](#xmlsigsignatureinfo-event) event finishes firing, the certificate present in the [SignerCert](#xmlsigsignercert-property) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method .

# [XMLSig](#xmlsig-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
xmlsig.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

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

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

# [XMLSig](#xmlsig-class).Progress Event

Fired as progress is made.

## Syntax

```text
xmlsig.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number, readonly operation: number, isEOF: boolean}) => void )
```

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

# [XMLSig](#xmlsig-class).SignatureInfo Event

Fired when a signature is found.

## Syntax

```text
xmlsig.on('SignatureInfo', listener: (e: {readonly signatureId: string, readonly signerCertParsed: boolean}) => void )
```

## Remarks

This event fires when calling [VerifySignature](#xmlsigverifysignature-method) for each signature found within the XML document.

*SignatureId* is the id of the signature.

*SignerCertParsed* indicates whether the signer's certificate was automatically parsed from the signed XML.

**Verification Notes**

When [VerifySignature](#xmlsigverifysignature-method) is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the [References](#xmlsigreferences-property) collection will be populated.

Within the SignatureInfo event the ReferencesXMLElement property must be set to the location of the XML element to which the signature applies. The ReferencesURI property may contain data helpful to locating the XML element.

The ReferencesXMLElement property specifies the XPath to the element. 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 |

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#xmlsigsignercert-property) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#xmlsigsignercert-property) property with the parsed value.

When SignatureInfo fires, if the *SignerCertParsed* parameter is True the [SignerCert](#xmlsigsignercert-property) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#xmlsigsignercert-property) property must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the [SignerCert](#xmlsigsignercert-property) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event.

If the signature was successfully verified the method will return without error. If the signature was not verified the method .

# [XMLSig](#xmlsig-class).Status Event

Provides information about the current operation.

## Syntax

```text
xmlsig.on('Status', listener: (e: {readonly message: string}) => void )
```

## 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 property 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 . This property can be used to read such password-protected private keys.

NOTE: This property defaults to the value of . 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** *string (read-only)*
*Default Value: ""*

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

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

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

Whether a  is available for the selected certificate. If  is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

The name of the  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** *number (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  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  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).

 **StoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  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).

 **StorePassword** *string*
*Default Value: ""*

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

 **StoreType** *CertStoreTypes*
*Default Value: 0*

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](#certificate-type) 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. |

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

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** *number (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of  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  property for a text representation of .

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

 **Encoded** *string*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

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

 **EncodedB** *Uint8Array*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

When  is set, a search is initiated in the current  for the private key of the certificate. If the key is found,  is updated to reflect the full subject of the selected certificate; otherwise,  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.

# XMLSigReference Type

This type defines information about the reference.

## Remarks

This type defines information about the reference including the location within the document (), , , and .

The following fields are available:

- [HashAlgorithm](#XMLSigReference_f_HashAlgorithm)

- [HashValue](#XMLSigReference_f_HashValue)

- [TransformAlgorithms](#XMLSigReference_f_TransformAlgorithms)

- [URI](#XMLSigReference_f_URI)

- [XMLElement](#XMLSigReference_f_XMLElement)

## Fields

 **HashAlgorithm** *string*
*Default Value: "SHA1"*

This property defines the hash algorithm to apply to the element specified by . Possible values are:

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

 **HashValue** *string (read-only)*
*Default Value: ""*

This property holds the calculated hash value for the specified .

 **TransformAlgorithms** *string*
*Default Value: "C14N"*

This property specifies a comma separated list of canonicalization algorithms to be applied to . The XML data specified by  will be transformed using the specified algorithm(s) before the  is applied. The default value is "C14N". Possible values are:

|  |  |
| --- | --- |
| "C14N" | Canonical XML version 1.0 |
| "C14N_COMMENTS" | Canonical XML version 1.0 with comments |
| "C14N11" | Canonical XML version 1.1 |
| "C14N11_COMMENTS" | Canonical XML version 1.1 with comments |
| "EXC_C14N" | Exclusive XML canonicalization version 1.0 |
| "EXC_C14N_COMMENTS" | Exclusive XML canonicalization version 1.0 with comments |

 **URI** *string*
*Default Value: ""*

This property is the URI of the reference. The value specified here identifies the data within the document.

When signing, this value may be set to a URI reference which identifies .  must be set separately.

When verifying, this value may be checked within the [SignatureInfo](#xmlsigsignatureinfo-event) event to identify the location of .  must be set separately.

 **XMLElement** *string*
*Default Value: "/"*

This property specifies XML element to sign or verify using XPath notation. When signing, this must be set before calling [Sign](#xmlsigsign-method). When verifying, this must be set from within the [SignatureInfo](#xmlsigsignatureinfo-event) event. The  property may be used to help identify the correct XML element.

|  |  |
| --- | --- |
| /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 XMLSigReference();
```

```text
public XMLSigReference(String XMLElement, String URI, String hashAlgorithm, String transformAlgorithms, String hashValue);
```

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The XMLSig class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the XMLSig class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The XMLSig class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the XMLSig class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworksencrypt.[xmlsig](#xmlsig-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](#xmlsigconfig-method) method.

### XMLSig Config Settings

**KeyName**: The name of the key used to sign the XML.This setting optionally holds the key name which may be useful to the recipient to help identify the key used to create the signature. This may be set before calling [Sign](#xmlsigsign-method). When calling [VerifySignature](#xmlsigverifysignature-method) this may be queried inside the [SignatureInfo](#xmlsigsignatureinfo-event) 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](#xmlsigstatus-event) 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. |

**NormalizeLineEndings**: Whether to normalize line endings when calculating the reference digest.This setting specifies whether to normalize line endings when calculating the reference digest. When set to True all line endings will be converted to LF. The default value is True.

**PreserveWhitespace**: Whether to preserve whitespace in the signature.This setting specifies whether whitespace is preserved when canonicalizing XML. The default value is False.

**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](#xmlsigprogress-event) event. The class will repeatedly fire the [Progress](#xmlsigprogress-event) event to ask for data. Inside the event set [InputXML](#xmlsiginputxml-property) 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.

**SignatureRelationship**: Whether the signature is a child or sibling of the SignatureXPath. This setting specifies whether the created signature is included as a child or sibling of the element specified by [SignatureXPath](#xmlsigsignaturexpath-property). If this is set to 0 (default), the signature is inserted as a child of the element. If this is set to 1, the signature is inserted as a sibling after the element. The default value is 0 (child).

Example: SignatureRelationship is set to 0 (child - default)

```text
xmlsig1.SignatureXPath = "/root/node1";
```

 Produces XML like:

```text
<root>
  <node1>
    <ds:Signature>...</ds:Signature>
  </node1>
  <node2></node2>
  <node3></node3>
</root>
```

Example: SignatureRelationship is set to 1 (sibling)

```text
xmlsig1.SignatureXPath = "/root/node1";
xmlsig1.Config("SignatureRelationship=1");
```

 Produces XML like:

```text
<root>
  <node1></node1>
  <ds:Signature>...</ds:Signature>
  <node2></node2>
  <node3></node3>
</root>
```

**SignerCertCount**: The number of parsed signer certificates when verifying a signature.This setting is populated when calling [VerifySignature](#xmlsigverifysignature-method). It holds the number of signer certificates that were parsed from the message. In most cases a single certificate is present and [SignerCert](#xmlsigsignercert-property) is populated. In some cases, multiple certificates in a chain may be present, in that case each parsed certificate can be accessed via this property and [SignerCertEncoded](#SignerCertEncoded). For instance:

```text
int certCount = Int32.Parse(xmlsig.Config("SignerCertCount"));
for(int i=0;i<certCount;i++)
{
  Console.WriteLine(xmlsig.Config("SignerCertEncoded[ " + i + "]"));
}
```

**SignerCertEncoded[i]**: The parsed signer certificate.This setting is used in conjunction with [SignerCertCount](#SignerCertCount) to retrieve the base64 encoded signer certificate parsed from the message. Valid values for the index are from 0 to [SignerCertCount](#SignerCertCount) - 1. SignerCertEncoded

**SignWithCryptoAPI**: Whether to use the Crypto API for signing operations.This setting determines whether to use the Microsoft Crypto API to sign. This is helpful in cases where the certificate is present in the Windows Certificate Store but the private key is not marked as exportable. For instance when using a USB security key. The default value is False.

Note: This functionality is only available on Windows.

**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](#xmlsigprogress-event) event. The class will repeatedly fire the [Progress](#xmlsigprogress-event) event to provide output data. Inside the event check [OutputXML](#xmlsigoutputxml-property) 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.

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

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

# Trappable Errors (*class *ipworksencrypt.[xmlsig](#xmlsig-class))

### XMLSig Errors

|  |  |
| --- | --- |
| 602 | Unsupported value. Check the description for details. |
| 603 | Failed to match the digest value during signature verification. |
| 604 | Signature verification failed. |
| 605 | Could not find the referenced element. |
| 606 | No valid signature was found in the document. |
| 607 | Failed to write output. |
| 608 | Invalid SignatureXPath value. |
| 611 | Failed parsing certificate data. |

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