Procedimiento para comprobar las firmas digitales de documentos XML

Artículo
05/10/2023

Puede usar las clases del espacio de nombres System.Security.Cryptography.Xml para comprobar datos XML firmados con una firma digital. Las firmas XML digitales (XMLDSIG) permiten comprobar que los datos no se modificaron después de firmarlos. Para más información sobre el estándar XMLDSIG, consulte la especificación de World Wide Web Consortium (W3C) en https://www.w3.org/TR/xmldsig-core/.

Nota

El código de este artículo se aplica a Windows.

En el ejemplo de código de este procedimiento se muestra cómo comprobar una firma digital XML que se encuentra en un elemento <Signature>. En el ejemplo se recupera una clave pública RSA de un contenedor de claves y se usa la clave para comprobar la firma.

Para obtener información sobre cómo crear una firma digital que se pueda comprobar mediante esta técnica, consulte Cómo: Firmar documentos XML con firmas digitales.

Para comprobar la firma digital de un documento XML

Para comprobar el documento, debe usar la misma clave asimétrica que se empleó para la firma. Cree un objeto CspParameters y especifique el nombre del contenedor de claves usado para la firma.
```
CspParameters cspParams = new()
{
    KeyContainerName = "XML_DSIG_RSA_KEY"
};
```
```
Dim cspParams As New CspParameters()
cspParams.KeyContainerName = "XML_DSIG_RSA_KEY"
```
Recupere la clave pública mediante la clase RSACryptoServiceProvider. La clave se carga automáticamente desde el contenedor de claves por nombre al pasar el objeto CspParameters al constructor de la clase RSACryptoServiceProvider.
```
RSACryptoServiceProvider rsaKey = new(cspParams);
```
```
Dim rsaKey As New RSACryptoServiceProvider(cspParams)
```

Cree un objeto XmlDocument cargando un archivo XML del disco. El objeto XmlDocument contiene el documento XML firmado que se va a comprobar.

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

Dim xmlDoc As New XmlDocument()

' Load an XML file into the XmlDocument object.
xmlDoc.PreserveWhitespace = True
xmlDoc.Load("test.xml")

Cree un nuevo objeto SignedXml y pásele el objeto XmlDocument.

SignedXml signedXml = new(xmlDoc);

Dim signedXml As New SignedXml(xmlDoc)

Busque el elemento <signature> y cree un nuevo objeto XmlNodeList.

XmlNodeList nodeList = xmlDoc.GetElementsByTagName("Signature");

Dim nodeList As XmlNodeList = xmlDoc.GetElementsByTagName("Signature")

Cargue el archivo XML del primer elemento <signature> en el objeto SignedXml.

signedXml.LoadXml((XmlElement?)nodeList[0]);

signedXml.LoadXml(CType(nodeList(0), XmlElement))

Compruebe la firma con el método CheckSignature y la clave pública RSA. Este método devuelve un valor booleano que indica éxito o error.
```
return signedXml.CheckSignature(key);
```
```
Return signedXml.CheckSignature(key)
```

Ejemplo

En este ejemplo se supone que un archivo llamado "test.xml" se encuentra en el mismo directorio que el programa compilado. El archivo "test.xml" debe firmarse mediante las técnicas que se indican en Firmar un documento XML con una firma digital.

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

[SupportedOSPlatform("Windows")]
public class VerifyXML
{
    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");

            // Verify the signature of the signed XML.
            Console.WriteLine("Verifying signature...");
            bool result = VerifyXml(xmlDoc, rsaKey);

            // Display the results of the signature verification to
            // the console.
            if (result)
            {
                Console.WriteLine("The XML signature is valid.");
            }
            else
            {
                Console.WriteLine("The XML signature is not valid.");
            }
        }
        catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }
    }

    // Verify the signature of an XML file against an asymmetric
    // algorithm and return the result.
    public static bool VerifyXml(XmlDocument xmlDoc, RSA key)
    {
        // Check arguments.
        if (xmlDoc == null)
             throw new ArgumentException(null, nameof(xmlDoc));
        if (key == null)
            throw new ArgumentException(null, nameof(key));

        // Create a new SignedXml object and pass it
        // the XML document class.
        SignedXml signedXml = new(xmlDoc);

        // Find the "Signature" node and create a new
        // XmlNodeList object.
        XmlNodeList nodeList = xmlDoc.GetElementsByTagName("Signature");

        // Throw an exception if no signature was found.
        if (nodeList.Count <= 0)
        {
            throw new CryptographicException("Verification failed: No Signature was found in the document.");
        }

        // This example only supports one signature for
        // the entire XML document.  Throw an exception
        // if more than one signature was found.
        if (nodeList.Count >= 2)
        {
            throw new CryptographicException("Verification failed: More that one signature was found for the document.");
        }

        // Load the first <signature> node.
        signedXml.LoadXml((XmlElement?)nodeList[0]);

        // Check the signature and return the result.
        return signedXml.CheckSignature(key);
    }
}

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

Module VerifyXML
    Sub Main(ByVal args() As String)
        Try
            ' Create a new CspParameters object to specify
            ' a key container.
            Dim cspParams As New CspParameters()
            cspParams.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.
            Dim xmlDoc As New XmlDocument()

            ' Load an XML file into the XmlDocument object.
            xmlDoc.PreserveWhitespace = True
            xmlDoc.Load("test.xml")
            ' Verify the signature of the signed XML.
            Console.WriteLine("Verifying signature...")
            Dim result As Boolean = VerifyXml(xmlDoc, rsaKey)

            ' Display the results of the signature verification to 
            ' the console.
            If result Then
                Console.WriteLine("The XML signature is valid.")
            Else
                Console.WriteLine("The XML signature is not valid.")
            End If

        Catch e As Exception
            Console.WriteLine(e.Message)
        End Try
    End Sub

    ' Verify the signature of an XML file against an asymmetric 
    ' algorithm and return the result.
    Function VerifyXml(ByVal xmlDoc As XmlDocument, ByVal key As RSA) As [Boolean]
        ' Check arguments.
        If xmlDoc Is Nothing Then
            Throw New ArgumentException(
                "The XML doc cannot be nothing.", NameOf(xmlDoc))
        End If
        If key Is Nothing Then
            Throw New ArgumentException(
                "The key cannot be nothing.", NameOf(key))
        End If
        ' Create a new SignedXml object and pass it
        ' the XML document class.
        Dim signedXml As New SignedXml(xmlDoc)
        ' Find the "Signature" node and create a new
        ' XmlNodeList object.
        Dim nodeList As XmlNodeList = xmlDoc.GetElementsByTagName("Signature")
        ' Throw an exception if no signature was found.
        If nodeList.Count <= 0 Then
            Throw New CryptographicException("Verification failed: No Signature was found in the document.")
        End If

        ' This example only supports one signature for
        ' the entire XML document.  Throw an exception 
        ' if more than one signature was found.
        If nodeList.Count >= 2 Then
            Throw New CryptographicException("Verification failed: More that one signature was found for the document.")
        End If

        ' Load the first <signature> node.  
        signedXml.LoadXml(CType(nodeList(0), XmlElement))
        ' Check the signature and return the result.
        Return signedXml.CheckSignature(key)
    End Function
End Module

Compilar el código

En un proyecto destinado a .NET Framework, incluya una referencia a System.Security.dll.
En un proyecto destinado a .NET Core o .NET 5, instale el paquete NuGet System.Security.Cryptography.Xml.
Incluya los siguientes espacios de nombres: System.Xml, System.Security.Cryptography y System.Security.Cryptography.Xml.

Seguridad de .NET

Nunca almacene ni transfiera la clave privada de un par de claves asimétricas en texto sin formato. Para más información sobre claves criptográficas simétricas y asimétricas, consulte Generar claves para cifrado y descifrado.

No inserte nunca una clave privada directamente en el código fuente. Las claves insertadas se pueden leer fácilmente desde un ensamblado con Ildasm.exe (desensamblador de IL) o si se abre el ensamblado en un editor de texto, como el Bloc de notas.

Procedimiento para comprobar las firmas digitales de documentos XML

Para comprobar la firma digital de un documento XML

Ejemplo

Compilar el código

Seguridad de .NET

Consulte también

Comentarios

Recursos adicionales