Procédure : signer des documents XML avec des signatures numériques

Article
06/05/2023

Vous pouvez utiliser les classes de l'espace de noms System.Security.Cryptography.Xml pour signer un document XML ou une partie d'un document XML avec une signature numérique. Les signatures numériques XML (XMLDSIG) vous permettent de vérifier que les données n'ont pas été modifiées après leur signature. Pour plus d’informations sur la norme XMLDSig, consultez la recommandation du W3C (World Wide Web Consortium) Syntaxe et traitement des signatures XML.

Notes

Le code de cet article s’applique à Windows.

L’exemple de code de cette procédure montre comment signer numériquement l’intégralité d’un document XML et joindre la signature au document dans un élément <Signature>. L'exemple crée une clé de signature RSA, ajoute la clé à un conteneur de clé sécurisé, puis utilise la clé pour signer numériquement un document XML. La clé peut ensuite être récupérée pour vérifier la signature numérique XML ou peut être utilisée pour signer un autre document XML.

Pour plus d’informations sur la vérification d’une signature numérique XML créée à l’aide de cette procédure, consultez Guide pratique pour vérifier les signatures numériques de documents XML.

Pour signer numériquement un document XML

Créez un objet CspParameters et spécifiez le nom du conteneur de clé.

CspParameters cspParams = new()
{
    KeyContainerName = "XML_DSIG_RSA_KEY"
};

Dim cspParams As New CspParameters With {
    .KeyContainerName = "XML_DSIG_RSA_KEY"
}

Générez une clé asymétrique à l'aide de la classe RSACryptoServiceProvider. La clé est automatiquement enregistrée dans le conteneur de clé quand vous passez l'objet CspParameters au constructeur de la classe RSACryptoServiceProvider. Cette clé sera utilisée pour signer le document XML.
```
RSACryptoServiceProvider rsaKey = new(cspParams);
```
```
Dim rsaKey As New RSACryptoServiceProvider(cspParams)
```

Créez un objet XmlDocument en chargeant un fichier XML à partir du disque. L'objet XmlDocument contient l'élément XML à chiffrer.

XmlDocument xmlDoc = new()
{
    // Load an XML file into the XmlDocument object.
    PreserveWhitespace = true
};
xmlDoc.Load("test.xml");

' Load an XML file into the XmlDocument object.
Dim xmlDoc As New XmlDocument With {
    .PreserveWhitespace = True
}
xmlDoc.Load("test.xml")

Créez un objet SignedXml et passez-lui l'objet XmlDocument.

SignedXml signedXml = new(xmlDoc)
{

Dim signedXml As New SignedXml(xmlDoc)

Ajoutez la clé de signature RSA à l'objet SignedXml.

    SigningKey = rsaKey
};

signedXml.SigningKey = rsaKey

Créez un objet Reference décrivant les éléments à signer. Pour signer l'intégralité du document, définissez la propriété Uri sur "".

// Create a reference to be signed.
Reference reference = new()
{
    Uri = ""
};

' Create a reference to be signed.
Dim reference As New Reference()
reference.Uri = ""

Ajoutez un objet XmlDsigEnvelopedSignatureTransform à l'objet Reference. Une transformation permet au vérificateur de représenter les données XML de la même manière que celle utilisée par le signataire. Les données XML peuvent être représentées de différentes façons, cette étape est donc vitale pour la vérification.
```
XmlDsigEnvelopedSignatureTransform env = new();
reference.AddTransform(env);
```
```
Dim env As New XmlDsigEnvelopedSignatureTransform()
reference.AddTransform(env)
```

Ajoutez l'objet Reference à l'objet SignedXml.

signedXml.AddReference(reference);

signedXml.AddReference(reference)

Calculez la signature en appelant la méthode ComputeSignature.
```
signedXml.ComputeSignature();
```
```
signedXml.ComputeSignature()
```
Récupérez la représentation XML de la signature (un élément <Signature>) et enregistrez-la dans un nouvel objet XmlElement.
```
XmlElement xmlDigitalSignature = signedXml.GetXml();
```
```
Dim xmlDigitalSignature As XmlElement = signedXml.GetXml()
```

Ajoutez l'élément à l'objet XmlDocument.

xmlDoc.DocumentElement?.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, true));

xmlDoc.DocumentElement.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, True))

Enregistrez le document.

xmlDoc.Save("test.xml");

xmlDoc.Save("test.xml")

Exemple

Cet exemple suppose qu'un fichier nommé test.xml se trouve dans le même répertoire que le programme compilé. Vous pouvez placer le code XML suivant dans un fichier appelé test.xml et l'utiliser avec cet exemple.

<root>  
    <creditcard>  
        <number>19834209</number>  
        <expiry>02/02/2002</expiry>  
    </creditcard>  
</root>

using System;
using System.Runtime.Versioning;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Xml;

[SupportedOSPlatform("Windows")]
public class SignXML
{
    public static void Main(String[] args)
    {
        try
        {
            // Create a new CspParameters object to specify
            // a key container.
            CspParameters cspParams = new()
            {
                KeyContainerName = "XML_DSIG_RSA_KEY"
            };

            // Create a new RSA signing key and save it in the container.
            RSACryptoServiceProvider rsaKey = new(cspParams);

            // Create a new XML document.
            XmlDocument xmlDoc = new()
            {
                // Load an XML file into the XmlDocument object.
                PreserveWhitespace = true
            };
            xmlDoc.Load("test.xml");

            // Sign the XML document.
            SignXml(xmlDoc, rsaKey);

            Console.WriteLine("XML file signed.");

            // Save the document.
            xmlDoc.Save("test.xml");
        }
        catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }
    }

    // Sign an XML file.
    // This document cannot be verified unless the verifying
    // code has the key with which it was signed.
    public static void SignXml(XmlDocument xmlDoc, RSA rsaKey)
    {
        // Check arguments.
        if (xmlDoc == null)
            throw new ArgumentException(null, nameof(xmlDoc));
        if (rsaKey == null)
            throw new ArgumentException(null, nameof(rsaKey));

        // Create a SignedXml object.
        SignedXml signedXml = new(xmlDoc)
        {

            // Add the key to the SignedXml document.
            SigningKey = rsaKey
        };

        // Create a reference to be signed.
        Reference reference = new()
        {
            Uri = ""
        };

        // Add an enveloped transformation to the reference.
        XmlDsigEnvelopedSignatureTransform env = new();
        reference.AddTransform(env);

        // Add the reference to the SignedXml object.
        signedXml.AddReference(reference);

        // Compute the signature.
        signedXml.ComputeSignature();

        // Get the XML representation of the signature and save
        // it to an XmlElement object.
        XmlElement xmlDigitalSignature = signedXml.GetXml();

        // Append the element to the XML document.
        xmlDoc.DocumentElement?.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, true));
    }
}

Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Imports System.Xml

Module SignXML
    Sub Main(ByVal args() As String)
        Try
            ' Create a new CspParameters object to specify
            ' a key container.
            Dim cspParams As New CspParameters With {
                .KeyContainerName = "XML_DSIG_RSA_KEY"
            }
            ' Create a new RSA signing key and save it in the container. 
            Dim rsaKey As New RSACryptoServiceProvider(cspParams)
            ' Create a new XML document.
            ' Load an XML file into the XmlDocument object.
            Dim xmlDoc As New XmlDocument With {
                .PreserveWhitespace = True
            }
            xmlDoc.Load("test.xml")
            ' Sign the XML document. 
            SignXml(xmlDoc, rsaKey)

            Console.WriteLine("XML file signed.")

            ' Save the document.
            xmlDoc.Save("test.xml")
        Catch e As Exception
            Console.WriteLine(e.Message)
        End Try
    End Sub

    ' Sign an XML file. 
    ' This document cannot be verified unless the verifying 
    ' code has the key with which it was signed.
    Sub SignXml(ByVal xmlDoc As XmlDocument, ByVal rsaKey As RSA)
        ' Check arguments.
        If xmlDoc Is Nothing Then
            Throw New ArgumentException(
                "The XML doc cannot be nothing.", NameOf(xmlDoc))
        End If
        If rsaKey Is Nothing Then
            Throw New ArgumentException(
                "The RSA key cannot be nothing.", NameOf(rsaKey))
        End If
        ' Create a SignedXml object.
        Dim signedXml As New SignedXml(xmlDoc)
        ' Add the key to the SignedXml document.
        signedXml.SigningKey = rsaKey
        ' Create a reference to be signed.
        Dim reference As New Reference()
        reference.Uri = ""
        ' Add an enveloped transformation to the reference.
        Dim env As New XmlDsigEnvelopedSignatureTransform()
        reference.AddTransform(env)
        ' Add the reference to the SignedXml object.
        signedXml.AddReference(reference)
        ' Compute the signature.
        signedXml.ComputeSignature()
        ' Get the XML representation of the signature and save
        ' it to an XmlElement object.
        Dim xmlDigitalSignature As XmlElement = signedXml.GetXml()
        ' Append the element to the XML document.
        xmlDoc.DocumentElement.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, True))
    End Sub
End Module

Compilation du code

Dans un projet qui cible .NET Framework, incluez une référence à System.Security.dll.
Dans un projet qui cible .NET Core ou .NET 5, installez le package NuGet System.Security.Cryptography.Xml.
Incluez les espaces de noms suivants : System.Xml, System.Security.Cryptography et System.Security.Cryptography.Xml.

Sécurité .NET

La clé privée d'une paire de clés asymétriques ne doit jamais être stockée ni transférée en texte brut. Pour plus d’informations sur les clés de chiffrement symétriques et asymétriques, consultez Génération de clés pour le chiffrement et le déchiffrement.

N'incorporez jamais une clé privée directement dans votre code source. Les clés incorporées peuvent être lues facilement à partir d’un assembly à l’aide du Désassembleur IL (Ildasm.exe). Vous pouvez également, pour cela, ouvrir l’assembly dans un éditeur de texte tel que le Bloc-notes.

Procédure : signer des documents XML avec des signatures numériques

Pour signer numériquement un document XML

Exemple

Compilation du code

Sécurité .NET

Voir aussi

Commentaires

Ressources supplémentaires