Xades.Components 2.0.4

dotnet add package Xades.Components --version 2.0.4
                    
NuGet\Install-Package Xades.Components -Version 2.0.4
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Xades.Components" Version="2.0.4" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Xades.Components" Version="2.0.4" />
                    
Directory.Packages.props
<PackageReference Include="Xades.Components" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Xades.Components --version 2.0.4
                    
#r "nuget: Xades.Components, 2.0.4"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Xades.Components@2.0.4
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Xades.Components&version=2.0.4
                    
Install as a Cake Addin
#tool nuget:?package=Xades.Components&version=2.0.4
                    
Install as a Cake Tool

Xades.Components

.NET library for creating XAdES-BES XML signatures (Enveloped, Enveloping, detached) with an X.509 certificate. Built for Polish e-government gateways such as e-Deklaracje, KSeF and PUESC.

dotnet add package Xades.Components

Requirements

Platform Minimum Tested on
.NET Framework 4.6.2 (4.7.2+ recommended) 4.8
.NET 8.0 10.0

The library targets netstandard2.0; the minimum versions above come from its dependency System.Security.Cryptography.Xml, which supports only these platforms.

Certificate: X.509 with an RSA private key. Keys in a classic CSP and in a CNG KSP (Key Storage Provider), including smart cards and tokens, are supported (since 2.0.3).

Quick start

using System;
using System.Security.Cryptography.X509Certificates;
using System.Xml;
using Xades.Components;        // CryptType, EnvelopeType
using Xades.Components.Xades;  // XadesDocument

// Certificate with a private key: from a PFX file or from the Windows certificate store.
// On .NET 9+ prefer X509CertificateLoader.LoadPkcs12FromFile(path, password).
var cert = new X509Certificate2("certificate.pfx", "password");

var xml = new XmlDocument { PreserveWhitespace = true };
xml.Load("document.xml");

var xades = new XadesDocument(CryptType.SHA256, EnvelopeType.Enveloped)
{
    SerialNumber = "YOUR-SERIAL-NUMBER" // see Licensing
};

XmlDocument signed = xades.SignXades(xml, cert);
signed.Save("document.xades.xml");

SignXades returns a new document; the input XmlDocument is not modified.

Dependency injection (ASP.NET Core, Worker Service, …)

Register the signer once, with the serial number from configuration or code, and inject IXadesSigner wherever you sign.

From appsettings.json:

{
  "XadesComponents": {
    "SerialNumber": "YOUR-SERIAL-NUMBER",
    "CryptType": "SHA256",
    "EnvelopeType": "Enveloped"
  }
}
builder.Services.AddXadesComponents(builder.Configuration.GetSection(XadesOptions.SectionName));

Or in code:

builder.Services.AddXadesComponents(options =>
{
    options.SerialNumber = "YOUR-SERIAL-NUMBER";
    options.CryptType = CryptType.SHA256;          // default
    options.EnvelopeType = EnvelopeType.Enveloped; // default
});

Usage:

public class DeclarationService
{
    private readonly IXadesSigner _signer;

    public DeclarationService(IXadesSigner signer) => _signer = signer;

    public XmlDocument Sign(XmlDocument declaration, X509Certificate2 cert) =>
        _signer.Sign(declaration, cert);   // CryptType and EnvelopeType from options
}

IXadesSigner is registered as a singleton. An invalid serial number is reported when the signer is first resolved from the container (InvalidOperationException), not on the first signature. Sign(document, cert, cryptType, envelopeType) overrides the configured defaults for a single call.

Supported modes

EnvelopeType Input SHA-1 SHA-256 Result
Enveloped XmlDocument (SignXades) ✔ ✔ the input document with ds:Signature appended to the root element
Enveloped Base64 data (SignXadesBase64File) ✔ ✔ <body> containing ds:Signature with the data in ds:Object
Enveloping XmlDocument (SignXades) – ✔ ds:Signature as the root element with the document inside ds:Object
Internal Base64 data (SignXadesBase64File) ✔ ✔ ds:Signature with the data in ds:Object
External Base64 data (SignXadesBase64File) ✔ ✔ detached ds:Signature; the reference URI is the fileToSignName argument

Combinations not listed (e.g. Enveloping with SHA-1 or with Base64 input) are not supported and throw an exception.

Signature details: RSA-SHA1 / RSA-SHA256 (http://www.w3.org/2001/04/xmldsig-more#rsa-sha256), exclusive canonicalization, XAdES 1.3.2 SignedProperties with SigningTime and SigningCertificate.

Signing Base64 data

string base64 = Convert.ToBase64String(File.ReadAllBytes("invoice.pdf"));

var xades = new XadesDocument(CryptType.SHA256, EnvelopeType.External);
XmlDocument signedXml = null;
byte[] signature = xades.SignXadesBase64File(base64, cert, ref signedXml, "invoice.pdf");

File.WriteAllBytes("invoice.pdf.xades", signature);

Behaviour worth knowing (Enveloped)

  • Comments are kept in the signed document. As required by XMLDSig, the signature does not cover them, so comments can change without invalidating the signature.
  • Whitespace is preserved. Load the input with PreserveWhitespace = true if its formatting matters to you; the returned document can be saved with Save() without breaking the signature.
  • Verifying with .NET SignedXml: it computes the whole-document reference incorrectly when the document contains comments inside the root element and reports such signatures (from any signing tool) as invalid. Java-based verifiers (Apache Santuario) validate them correctly. To verify in .NET, remove the comments and call Normalize() on a copy first; this does not change what is signed.

Licensing

The library is not open source. Without a valid SerialNumber:

  • every signature writes a notice to standard error,
  • only 4 signatures per process are allowed; the 5th call throws InvalidOperationException.

An invalid SerialNumber throws an exception. To obtain a serial number, contact the author.

Serial numbers issued for versions up to 2.0.1 are not accepted by 2.0.2 and later; contact the author for a new one.

Changelog

2.0.4

  • services.AddXadesComponents(...) registers IXadesSigner with options from appsettings.json or code.
  • Malformed serial numbers are reported as "Serial number is not valid" instead of an internal exception.
  • System.Security.Cryptography.Xml updated to 10.0.15 (fixes CVE-2026-96958, CVE-2026-96959, CVE-2026-96960).
  • New dependencies: Microsoft.Extensions.DependencyInjection.Abstractions and Microsoft.Extensions.Options.ConfigurationExtensions (8.0).

2.0.3

  • Certificates with keys in a CNG KSP no longer fail with "Invalid provider type specified".
  • Enveloped: XmlDocument.Save() no longer invalidates the signature when the input was loaded without PreserveWhitespace; comments are kept; the input document is no longer modified.
  • Signatures produced by the library can be verified with SignedXml.CheckSignature() on .NET 8+.

Contact

Piotr Kobylski – kobylski.piotr@gmail.com (licensing and technical support)

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.4 0 11/18/2026
2.0.3 120 10/15/2026
2.0.2 1,029 11/18/2025
2.0.1 876 12/29/2022
2.0.0 463 11/9/2022