> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/xml/signxml.md). # SignXml Sign an XML document. Task version: 1.3.0 Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | XmlInputType : `XmlParamType` |

Input type.

Possible types are File and XmlString.

Possible values:


Default: -
Example: File

| | XmlFilePath : `String` |

Path to XML document to sign.


Default: c:\temp\document.xml
Example: c:\temp\document.xml

| | Xml : `String` |

Input type.

Possible types are File and XmlString.


Default: 123
Example: File

| | XmlEnvelopingType : `XmlEnvelopingType` |

XML signing technique to use.

Possible values:


Default: -
Example: XmlEnvelopedSignature

| | SigningStrategy : `SigningStrategyType` |

How to sign the document.

Possible values:


Default: -
Example: PrivateKeyCertificate

| | CertificatePath : `String` |

Path to certificate with private key.


Default: c:\certificates\signingcertificate.pfx
Example: c:\certificates\signingcertificate.pfx

| | 🗝PrivateKeyPassword : `String` |

Private key password.


Default: -
Example: password123

| | {% endtab %} | | {% tab title="Output" %} | Name | Description | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | OutputType : `XmlParamType` |

Output to file or XML string?

Possible values:


Default: -
Example: File

| | OutputFilePath : `String` |

A filepath for the output XML.


Default: c:\temp\signedOutput.xml
Example: c:\temp\signedOutput.xml

| | OutputEncoding : `String` |

The encoding for the output file.


Default: UTF-8
Example: UTF-8

| | AddSignatureToSourceFile : `Boolean` |

If source is file, then you can add signature to it.


Default: -
Example: true

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | IncludeComments : `Boolean` |

Switch to include comments.


Default: -
Example: true

| | PreserveWhitespace : `Boolean` |

Should whitespace be preserved when loading the XML?


Default: -
Example: false

| | XmlSignatureMethod : `XmlSignatureMethod` |

Signature methods to be used with signing.

Possible values:


Default: -
Example: RSASHA1

| | DigestMethod : `DigestMethod` |

Digest methods to be used.

Possible values:


Default: -
Example: SHA1

| | TransformMethods : `TransformMethod[]` |

Transform methods to be used.


Default: -
Example: \[DsigC14, DsigC14WithComments]

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Result : `String` |

If output type is file, this will be a filepath. Otherwise, this will be the signed XML as string.
Example: c:\temp\signedDocument.xml

| ## Task Changelog Changelog for Task Frends.XML.SignXml. ### \[1.3.0] - 2026-07-14 #### Changed * Updated outdated repository URLs ### \[1.2.0] - 2025-07-10 #### Changed * Update documentation link ### \[1.1.0] - 2025-03-25 #### Changed * Update packages: System.ComponentModel.Annotations 4.7.0 -> 5.0.0 System.Security.Cryptography.Xml 8.0.1 -> 9.0.3 coverlet.collector 3.1.2 -> 6.0.4 Microsoft.NET.Test.Sdk 16.6.1 -> 17.13.0 nunit 3.12.0 -> 4.3.2 NUnit3TestAdapter 3.17.0 -> 5.0.0 ### \[1.0.0] - 2024-06-13 #### Changed * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.frends.com/tasks/tasks/xml/signxml.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.