Como: verificar as assinaturas digitais de documentos XML

Artigo
05/10/2023

Você pode usar as classes no namespace System.Security.Cryptography.Xml para verificar os dados XML assinados com uma assinatura digital. As XMLDSIG (assinaturas digitais XML) permitem verificar se os dados não foram alterados após a assinatura. Para saber mais sobre o padrão XMLDSIG, veja a especificação de do W3C (World Wide Web Consortium) em https://www.w3.org/TR/xmldsig-core/.

Observação

O código neste artigo se aplica ao Windows.

O exemplo de código neste procedimento demonstra como verificar uma assinatura digital XML contida em um elemento <Signature>. O exemplo recupera uma chave pública RSA de um contêiner de chave e usa a chave para verificar a assinatura.

Para informações sobre como criar uma assinatura digital que pode ser verificada usando essa técnica, confira Como assinar documentos XML com assinaturas digitais.

Para verificar a assinatura digital de um documento XML

Para verificar o documento, use a mesma chave assimétrica usada para assinatura. Crie um objeto CspParameters e especifique o nome do contêiner de chaves que foi usado para assinatura.
```
CspParameters cspParams = new()
{
    KeyContainerName = "XML_DSIG_RSA_KEY"
};
```
```
Dim cspParams As New CspParameters()
cspParams.KeyContainerName = "XML_DSIG_RSA_KEY"
```
Recupere a chave pública usando a classe RSACryptoServiceProvider. A chave é carregada automaticamente do contêiner de chaves pelo nome quando você passa o objeto CspParameters para o construtor da classe RSACryptoServiceProvider.
```
RSACryptoServiceProvider rsaKey = new(cspParams);
```
```
Dim rsaKey As New RSACryptoServiceProvider(cspParams)
```

Crie um objeto XmlDocument carregando um arquivo XML do disco. O objeto XmlDocument contém o documento XML assinado para verificar.

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")

Crie um objeto SignedXml e passe o objeto XmlDocument para ele.

SignedXml signedXml = new(xmlDoc);

Dim signedXml As New SignedXml(xmlDoc)

Localize o elemento <signature> e crie um objeto XmlNodeList.

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

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

Carregue o XML do primeiro elemento <signature> no objeto SignedXml.

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

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

Verifique a assinatura usando o método CheckSignature e a chave pública RSA. Esse método retorna um valor booliano que indica êxito ou falha.
```
return signedXml.CheckSignature(key);
```
```
Return signedXml.CheckSignature(key)
```

Exemplo

Este exemplo pressupõe que um arquivo nomeado "test.xml" exista no mesmo diretório que o programa compilado. O arquivo "test.xml" deve ser assinado usando as técnicas descritas em Como: Assinar documentos XML com assinaturas digitais.

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

Compilando o código

Em um projeto que tem como destino o .NET Framework, inclua uma referência a System.Security.dll.
Em um projeto direcionado ao .NET Core ou ao .NET 5, instale o pacote NuGet System.Security.Cryptography.Xml.
Inclua os seguintes namespaces: System.Xml, System.Security.Cryptography e System.Security.Cryptography.Xml.

Segurança do .NET

Nunca armazene nem transfira a chave privada de um par de chaves assimétricas em texto sem formatação. Para mais informações sobre chaves criptográficas simétricas e assimétricas, confira Como gerar chaves para criptografia e descriptografia.

Nunca insira uma chave privada diretamente no código-fonte. As chaves inseridas podem ser facilmente lidas de um assembly usando Ildasm.exe (Desmontador IL) ou abrindo o assembly em um editor de texto, como o Bloco de Notas.

Compartilhar via

Como: verificar as assinaturas digitais de documentos XML

Para verificar a assinatura digital de um documento XML

Exemplo

Compilando o código

Segurança do .NET

Confira também

Comentários

Recursos adicionais