SignXml
Sign an XML document.
Task version: 1.3.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Task Parameters
XmlInputType : XmlParamType
Input type.
Possible types are File and XmlString.
Possible values:
File: Represents a file.XmlString: Represents an XML string.
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:
XmlEnvelopedSignature: Uses an enveloped XML signature.
Default: -
Example: XmlEnvelopedSignature
SigningStrategy : SigningStrategyType
How to sign the document.
Possible values:
PrivateKeyCertificate: Uses a private key certificate for signing.
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
OutputType : XmlParamType
Output to file or XML string?
Possible values:
File: Represents a file.XmlString: Represents an XML string.
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
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:
RSASHA1: RSA with SHA-1.RSASHA256: RSA with SHA-256.RSASHA384: RSA with SHA-384.RSASHA512: RSA with SHA-512.
Default: -
Example: RSASHA1
DigestMethod : DigestMethod
Digest methods to be used.
Possible values:
SHA1: SHA-1 hashing algorithm.SHA256: SHA-256 hashing algorithm.SHA384: SHA-384 hashing algorithm.SHA512: SHA-512 hashing algorithm.
Default: -
Example: SHA1
TransformMethods : TransformMethod[]
Transform methods to be used.
Default: -
Example: [DsigC14, DsigC14WithComments]
Task Result
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
Last updated
Was this helpful?