Практическое руководство. Проверка цифровых подписей XML-документов

Статья
11/05/2008

Обновлен: Ноябрь 2007

Для проверки XML-данных, подписанных с помощью цифровой подписи, могут использоваться классы, принадлежащие пространству имен System.Security.Cryptography.Xml. Цифровая подпись XML (XMLDSIG) позволяет устанавливать неизменность данных после подписания. Дополнительные сведения о стандарте XMLDSIG см. в спецификации консорциума W3C, расположенной на веб-узле по адресу: http://www.w3.org/TR/xmldsig-core/.

В следующем примере кода демонстрируется способ проверки цифровой подписи XML, содержащейся в элементе Signature. В этом примере производится извлечение открытого ключа RSA из контейнера ключа, который затем используется для проверки подписи.

Сведения о создании цифровой подписи, которая может быть проверена с применением данного метода, см. в разделе Практическое руководство. Подписание XML-документов с помощью цифровых подписей.

Проверка цифровой подписи XML-документа

Чтобы проверить документ, необходимо использовать тот же асимметричный ключ, который использовался при подписывании. Создайте объект CspParameters и укажите имя контейнера ключа, который использовался при подписывании.
```
Dim cspParams As New CspParameters()
cspParams.KeyContainerName = "XML_DSIG_RSA_KEY"
```
```
CspParameters cspParams = new CspParameters();
cspParams.KeyContainerName = "XML_DSIG_RSA_KEY";
```
Извлеките открытый ключ, используя класс RSACryptoServiceProvider. Ключ автоматически загружается из контейнера ключа с указанным именем при передаче объекта CspParameters конструктору класса RSACryptoServiceProvider.
```
Dim rsaKey As New RSACryptoServiceProvider(cspParams)
```
```
RSACryptoServiceProvider rsaKey = new RSACryptoServiceProvider(cspParams);
```

Создайте объект XmlDocument путем загрузки XML-файла с диска. Объект XmlDocument содержит подписанный XML-документ, подлежащий проверке.

Dim xmlDoc As New XmlDocument()

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

XmlDocument xmlDoc = new XmlDocument();

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

Создайте новый объект SignedXml и передайте ему объект XmlDocument.
```
Dim signedXml As New SignedXml(Doc)
```
```
SignedXml signedXml = new SignedXml(Doc);
```

Найдите элемент signature и создайте новый объект XmlNodeList.

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

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

Загрузите XML-данные первого элемента signature в объект SignedXml.
```
signedXml.LoadXml(CType(nodeList(0), XmlElement))
```
```
signedXml.LoadXml((XmlElement)nodeList[0]);
```
Проверьте подпись с помощью метода CheckSignature и открытого ключа RSA. Метод возвращает логическое значение, указывающее на успешность выполнения операции.
```
Return signedXml.CheckSignature(Key)
```
```
return signedXml.CheckSignature(Key);
```

Пример

Imports System
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 Doc As XmlDocument, ByVal Key As RSA) As [Boolean]
        ' Check arguments.
        If Doc Is Nothing Then
            Throw New ArgumentException("Doc")
        End If
        If Key Is Nothing Then
            Throw New ArgumentException("Key")
        End If
        ' Create a new SignedXml object and pass it
        ' the XML document class.
        Dim signedXml As New SignedXml(Doc)
        ' Find the "Signature" node and create a new
        ' XmlNodeList object.
        Dim nodeList As XmlNodeList = Doc.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

using System;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Xml;

public class VerifyXML
{

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

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

            // Create a new XML document.
            XmlDocument xmlDoc = 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...");
            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 Boolean VerifyXml(XmlDocument Doc, RSA Key)
    {
        // Check arguments.
        if (Doc == null)
            throw new ArgumentException("Doc");
        if (Key == null)
            throw new ArgumentException("Key");

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

        // Find the "Signature" node and create a new
        // XmlNodeList object.
        XmlNodeList nodeList = Doc.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);
    }
}

В этом примере предполагается, что файл с именем "test.xml" существует в том же каталоге, что и скомпилированная программа. Файл "test.xml" должен быть подписан с применением метода, описанного в разделе Практическое руководство. Подписание XML-документов с помощью цифровых подписей.

Компиляция кода

Для компиляции этого примера может потребоваться включить ссылку на System.Security.dll.
Включите следующие пространства имен: System.Xml, System.Security.Cryptography и System.Security.Cryptography.Xml.

Безопасность

Не следует хранить или передавать закрытый ключ асимметричной пары ключей в виде простого текста. Дополнительные сведения о симметричных и асимметричных криптографических ключах см. в разделе Создание ключей для шифрования и расшифровки.

Не следует внедрять закрытый ключ непосредственно в исходный код. Внедренные ключи могут быть легко прочитаны из сборки с помощью программы Дизассемблер MSIL (Ildasm.exe) или шестнадцатеричного редактора, либо путем открытия сборки в текстовом редакторе, таком как "Блокнот".

См. также

Поделиться через

Практическое руководство. Проверка цифровых подписей XML-документов

Проверка цифровой подписи XML-документа

Пример

Компиляция кода

Безопасность

См. также

Задачи

Ссылки

Другие ресурсы

Дополнительные ресурсы