SignedXml Klasse

Definition

public ref class SignedXml

public class SignedXml

type SignedXml = class

Public Class SignedXml

Vererbung

Object

SignedXml

Beispiele

Im folgenden Codebeispiel wird gezeigt, wie Sie ein gesamtes XML-Dokument mithilfe einer umschlagierten Signatur signieren und überprüfen.

//
// This example signs an XML file using an
// envelope signature. It then verifies the 
// signed XML.
//
using System;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Security.Cryptography.Xml;
using System.Text;
using System.Xml;

public class SignVerifyEnvelope
{

    public static void Main(String[] args)
    {
        try
        {
           // Generate a signing key.
           RSA Key = RSA.Create();

           // Create an XML file to sign.
           CreateSomeXml("Example.xml");
           Console.WriteLine("New XML file created."); 

           // Sign the XML that was just created and save it in a 
           // new file.
           SignXmlFile("Example.xml", "signedExample.xml", Key);
           Console.WriteLine("XML file signed."); 

           // Verify the signature of the signed XML.
           Console.WriteLine("Verifying signature...");
           bool result = VerifyXmlFile("SignedExample.xml", Key);

           // 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(CryptographicException e)
        {
            Console.WriteLine(e.Message);
        }
    }

    // Sign an XML file and save the signature in a new file. This method does not  
    // save the public key within the XML file.  This file cannot be verified unless  
    // the verifying code has the key with which it was signed.
    public static void SignXmlFile(string FileName, string SignedFileName, RSA Key)
    {
        // Create a new XML document.
        XmlDocument doc = new XmlDocument();

        // Load the passed XML file using its name.
        doc.Load(new XmlTextReader(FileName));

        // Create a SignedXml object.
        SignedXml signedXml = new SignedXml(doc);

        // Add the key to the SignedXml document. 
        signedXml.SigningKey = Key;

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

        // Add an enveloped transformation to the reference.
        XmlDsigEnvelopedSignatureTransform env = 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.
        XmlElement xmlDigitalSignature = signedXml.GetXml();

        // Append the element to the XML document.
        doc.DocumentElement.AppendChild(doc.ImportNode(xmlDigitalSignature, true));
        
        if (doc.FirstChild is XmlDeclaration)  
        {
            doc.RemoveChild(doc.FirstChild);
        }

        // Save the signed XML document to a file specified
        // using the passed string.
        XmlTextWriter xmltw = new XmlTextWriter(SignedFileName, new UTF8Encoding(false));
        doc.WriteTo(xmltw);
        xmltw.Close();
    }

    // Verify the signature of an XML file against an asymmetric 
    // algorithm and return the result.
    public static Boolean VerifyXmlFile(String Name, RSA Key)
    {
        // Create a new XML document.
        XmlDocument xmlDocument = new XmlDocument();

        // Load the passed XML file into the document. 
        xmlDocument.Load(Name);

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

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

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

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

    // Create example data to sign.
    public static void CreateSomeXml(string FileName)
    {
        // Create a new XmlDocument object.
        XmlDocument document = new XmlDocument();

        // Create a new XmlNode object.
        XmlNode  node = document.CreateNode(XmlNodeType.Element, "", "MyElement", "samples");
        
        // Add some text to the node.
        node.InnerText = "Example text to be signed.";

        // Append the node to the document.
        document.AppendChild(node);

        // Save the XML document to the file name specified.
        XmlTextWriter xmltw = new XmlTextWriter(FileName, new UTF8Encoding(false));
        document.WriteTo(xmltw);
        xmltw.Close();
    }
}

'
' This example signs an XML file using an
' envelope signature. It then verifies the 
' signed XML.
'
Imports System.Security.Cryptography
Imports System.Security.Cryptography.X509Certificates
Imports System.Security.Cryptography.Xml
Imports System.Text
Imports System.Xml



Public Class SignVerifyEnvelope
   
   Overloads Public Shared Sub Main(args() As [String])
      Try
         ' Generate a signing key.
         Dim Key As RSA = RSA.Create()
         
         ' Create an XML file to sign.
         CreateSomeXml("Example.xml")
         Console.WriteLine("New XML file created.")
         
         ' Sign the XML that was just created and save it in a 
         ' new file.
         SignXmlFile("Example.xml", "signedExample.xml", Key)
         Console.WriteLine("XML file signed.")
         
         ' Verify the signature of the signed XML.
         Console.WriteLine("Verifying signature...")
         Dim result As Boolean = VerifyXmlFile("SignedExample.xml", Key)
         
         ' 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 CryptographicException
         Console.WriteLine(e.Message)
      End Try
   End Sub 
   
   
   
   ' Sign an XML file and save the signature in a new file. This method does not  
   ' save the public key within the XML file.  This file cannot be verified unless  
   ' the verifying code has the key with which it was signed.
   Public Shared Sub SignXmlFile(FileName As String, SignedFileName As String, Key As RSA)
      ' Create a new XML document.
      Dim doc As New XmlDocument()
      
      ' Load the passed XML file using its name.
      doc.Load(New XmlTextReader(FileName))
      
      ' Create a SignedXml object.
      Dim signedXml As New SignedXml(doc)
      
      ' Add the key to the SignedXml document. 
      signedXml.SigningKey = Key
      
      ' 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.
      doc.DocumentElement.AppendChild(doc.ImportNode(xmlDigitalSignature, True))
      
      If TypeOf doc.FirstChild Is XmlDeclaration Then
         doc.RemoveChild(doc.FirstChild)
      End If
      
      ' Save the signed XML document to a file specified
      ' using the passed string.
      Dim xmltw As New XmlTextWriter(SignedFileName, New UTF8Encoding(False))
      doc.WriteTo(xmltw)
      xmltw.Close()
   End Sub
   
   
   ' Verify the signature of an XML file against an asymmetric 
   ' algorithm and return the result.
   Public Shared Function VerifyXmlFile(Name As [String], Key As RSA) As [Boolean]
      ' Create a new XML document.
      Dim xmlDocument As New XmlDocument()
      
      ' Load the passed XML file into the document. 
      xmlDocument.Load(Name)
      
      ' Create a new SignedXml object and pass it
      ' the XML document class.
      Dim signedXml As New SignedXml(xmlDocument)
      
      ' Find the "Signature" node and create a new
      ' XmlNodeList object.
      Dim nodeList As XmlNodeList = xmlDocument.GetElementsByTagName("Signature")
      
      ' Load the signature node.
      signedXml.LoadXml(CType(nodeList(0), XmlElement))
      
      ' Check the signature and return the result.
      Return signedXml.CheckSignature(Key)
   End Function 
   
   
   
   ' Create example data to sign.
   Public Shared Sub CreateSomeXml(FileName As String)
      ' Create a new XmlDocument object.
      Dim document As New XmlDocument()
      
      ' Create a new XmlNode object.
      Dim node As XmlNode = document.CreateNode(XmlNodeType.Element, "", "MyElement", "samples")
      
      ' Add some text to the node.
      node.InnerText = "Example text to be signed."
      
      ' Append the node to the document.
      document.AppendChild(node)
      
      ' Save the XML document to the file name specified.
      Dim xmltw As New XmlTextWriter(FileName, New UTF8Encoding(False))
      document.WriteTo(xmltw)
      xmltw.Close()
   End Sub 
End Class

Im folgenden Codebeispiel wird gezeigt, wie sie ein einzelnes Element eines XML-Dokuments mithilfe einer abgeschrägten Signatur signieren und überprüfen.

//
// This example signs an XML file using an
// envelope signature. It then verifies the
// signed XML.
//
using System;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Text;
using System.Xml;

public class SignVerifyEnvelope
{

    public static void Main(String[] args)
    {
        // Generate a signing key.
       RSA Key = RSA.Create();

       try
       {
           // Specify an element to sign.
           string[] elements =  { "#tag1" };

           // Sign an XML file and save the signature to a
           // new file.
           SignXmlFile("Test.xml", "SignedExample.xml", Key, elements);
           Console.WriteLine("XML file signed.");

           // Verify the signature of the signed XML.
           Console.WriteLine("Verifying signature...");

           bool result = VerifyXmlFile("SignedExample.xml");

           // 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 (CryptographicException e)
       {
           Console.WriteLine(e.Message);
       }
       finally
       {
           // Clear resources associated with the
           // RSA instance.
           Key.Clear();
       }
   }

    // Sign an XML file and save the signature in a new file.
    public static void SignXmlFile(string FileName, string SignedFileName, RSA Key, string[] ElementsToSign)
    {
        // Check the arguments.
        if (FileName == null)
            throw new ArgumentNullException("FileName");
        if (SignedFileName == null)
            throw new ArgumentNullException("SignedFileName");
        if (Key == null)
            throw new ArgumentNullException("Key");
        if (ElementsToSign == null)
            throw new ArgumentNullException("ElementsToSign");

        // Create a new XML document.
        XmlDocument doc = new XmlDocument();

        // Format the document to ignore white spaces.
        doc.PreserveWhitespace = false;

        // Load the passed XML file using it's name.
        doc.Load(new XmlTextReader(FileName));

        // Create a SignedXml object.
        SignedXml signedXml = new SignedXml(doc);

        // Add the key to the SignedXml document.
        signedXml.SigningKey = Key;

        // Loop through each passed element to sign
        // and create a reference.
        foreach (string s in ElementsToSign)
        {
            // Create a reference to be signed.
            Reference reference = new Reference();
            reference.Uri = s;

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

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

        // Add an RSAKeyValue KeyInfo (optional; helps recipient find key to validate).
        KeyInfo keyInfo = new KeyInfo();
        keyInfo.AddClause(new RSAKeyValue((RSA)Key));
        signedXml.KeyInfo = keyInfo;

        // 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.
        doc.DocumentElement.AppendChild(doc.ImportNode(xmlDigitalSignature, true));

        if (doc.FirstChild is XmlDeclaration)
        {
            doc.RemoveChild(doc.FirstChild);
        }

        // Save the signed XML document to a file specified
        // using the passed string.
        XmlTextWriter xmltw = new XmlTextWriter(SignedFileName, new UTF8Encoding(false));
        doc.WriteTo(xmltw);
        xmltw.Close();
    }
    // Verify the signature of an XML file and return the result.
    public static Boolean VerifyXmlFile(String Name)
    {
        // Check the arguments.
        if (Name == null)
            throw new ArgumentNullException("Name");

        // Create a new XML document.
        XmlDocument xmlDocument = new XmlDocument();

        // Format using white spaces.
        xmlDocument.PreserveWhitespace = true;

        // Load the passed XML file into the document.
        xmlDocument.Load(Name);

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

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

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

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

' This example signs an XML file using an
' envelope signature. It then verifies the 
' signed XML.
'
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Imports System.Text
Imports System.Xml



Module SignVerifyEnvelope



    Sub Main(ByVal args() As String)
        ' Generate a signing key.
        Dim Key As RSA = RSA.Create()

        Try
            ' Specify an element to sign. 
            Dim elements As String() = New String() {"#tag1"}

            ' Sign an XML file and save the signature to a 
            ' new file.
            SignXmlFile("Test.xml", "SignedExample.xml", Key, elements)
            Console.WriteLine("XML file signed.")

            ' Verify the signature of the signed XML.
            Console.WriteLine("Verifying signature...")

            Dim result As Boolean = VerifyXmlFile("SignedExample.xml")

            ' 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 CryptographicException
            Console.WriteLine(e.Message)
        Finally
            ' Clear resources associated with the 
            ' RSA instance.
            Key.Clear()
        End Try

    End Sub


    ' Sign an XML file and save the signature in a new file.
    Sub SignXmlFile(ByVal FileName As String, ByVal SignedFileName As String, ByVal Key As RSA, ByVal ElementsToSign() As String)
        ' Check the arguments.  
        If FileName Is Nothing Then
            Throw New ArgumentNullException("FileName")
        End If
        If SignedFileName Is Nothing Then
            Throw New ArgumentNullException("SignedFileName")
        End If
        If Key Is Nothing Then
            Throw New ArgumentNullException("Key")
        End If
        If ElementsToSign Is Nothing Then
            Throw New ArgumentNullException("ElementsToSign")
        End If
        ' Create a new XML document.
        Dim doc As New XmlDocument()

        ' Format the document to ignore white spaces.
        doc.PreserveWhitespace = False

        ' Load the passed XML file using it's name.
        doc.Load(New XmlTextReader(FileName))

        ' Create a SignedXml object.
        Dim signedXml As New SignedXml(doc)

        ' Add the key to the SignedXml document. 
        signedXml.SigningKey = Key

        ' Loop through each passed element to sign 
        ' and create a reference.
        Dim s As String
        For Each s In ElementsToSign
            ' Create a reference to be signed.
            Dim reference As New Reference()
            reference.Uri = s

            ' 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)
        Next s

        ' Add an RSAKeyValue KeyInfo (optional; helps recipient find key to validate).
        Dim keyInfo As New KeyInfo()
        keyInfo.AddClause(New RSAKeyValue(CType(Key, RSA)))
        signedXml.KeyInfo = keyInfo

        ' 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.
        doc.DocumentElement.AppendChild(doc.ImportNode(xmlDigitalSignature, True))


        If TypeOf doc.FirstChild Is XmlDeclaration Then
            doc.RemoveChild(doc.FirstChild)
        End If

        ' Save the signed XML document to a file specified
        ' using the passed string.
        Dim xmltw As New XmlTextWriter(SignedFileName, New UTF8Encoding(False))
        doc.WriteTo(xmltw)
        xmltw.Close()

    End Sub

    ' Verify the signature of an XML file and return the result.
    Function VerifyXmlFile(ByVal Name As String) As [Boolean]
        ' Check the arguments.  
        If Name Is Nothing Then
            Throw New ArgumentNullException("Name")
        End If
        ' Create a new XML document.
        Dim xmlDocument As New XmlDocument()

        ' Format using white spaces.
        xmlDocument.PreserveWhitespace = True

        ' Load the passed XML file into the document. 
        xmlDocument.Load(Name)

        ' Create a new SignedXml object and pass it
        ' the XML document class.
        Dim signedXml As New SignedXml(xmlDocument)

        ' Find the "Signature" node and create a new
        ' XmlNodeList object.
        Dim nodeList As XmlNodeList = xmlDocument.GetElementsByTagName("Signature")

        ' Load the signature node.
        signedXml.LoadXml(CType(nodeList(0), XmlElement))

        ' Check the signature and return the result.
        Return signedXml.CheckSignature()

    End Function
End Module

Hinweise

Die SignedXml Klasse ist die .NET-Implementierung des World Wide Web Consortium (W3C) XML Signature Syntax and Processing Specification, auch als XMLDSIG (XML Digital Signature) bezeichnet. XMLDSIG ist eine standardsbasierte, interoperable Methode zum Signieren und Überprüfen aller oder eines Teils eines XML-Dokuments oder anderer Daten, die von einem Uniform Resource Identifier (URI) adressierbar sind.

Verwenden Sie die SignedXml Klasse, wenn Sie signierte XML-Daten zwischen Anwendungen oder Organisationen standardmäßig freigeben müssen. Alle mit dieser Klasse signierten Daten können von jeder konformen Implementierung der W3C-Spezifikation für XMLDSIG überprüft werden.

Mit der SignedXml Klasse können Sie die folgenden drei Arten digitaler XML-Signaturen erstellen:

Es gibt auch eine vierte Art von Signatur, die als externe getrennte Signatur bezeichnet wird, wenn sich die Daten und Signatur in separaten XML-Dokumenten befinden. Externe getrennte Signaturen werden von der SignedXml Klasse nicht unterstützt.

Struktur einer XML-Signatur

XMLDSIG erstellt ein <Signature> Element, das eine digitale Signatur eines XML-Dokuments oder anderer Daten enthält, die von einem URI adressierbar sind. Das <Signature> Element kann optional Informationen darüber enthalten, wo ein Schlüssel gefunden werden soll, der die Signatur überprüft und welcher kryptografische Algorithmus für die Signatur verwendet wurde. Die Grundstruktur lautet wie folgt:

<Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
      <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
      <Reference URI="">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
        <DigestValue>Base64EncodedValue==</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>AnotherBase64EncodedValue===</SignatureValue>
</Signature>

Die Hauptteile dieser Struktur sind:

• Das <CanonicalizationMethod>-Element

  Gibt die Regeln zum Umschreiben des Signature Elements aus XML/Text in Bytes für die Signaturüberprüfung an. Der Standardwert in .NET lautet http://www.w3.org/TR/2001/REC-xml-c14n-20010315, der einen vertrauenswürdigen Algorithmus identifiziert. Dieses Element wird durch die SignedInfo.CanonicalizationMethod Eigenschaft dargestellt.

• Das <SignatureMethod>-Element

  Gibt den Algorithmus an, der für die Signaturgenerierung und -validierung verwendet wird und auf das <Signature>-Element angewendet wurde, um den Wert in <SignatureValue> zu erzeugen. Im vorherigen Beispiel identifiziert der Wert http://www.w3.org/2000/09/xmldsig#rsa-sha1 eine RSA PKCS1 SHA-1-Signatur. Aufgrund von Kollisionsproblemen mit SHA-1 empfiehlt Microsoft ein Sicherheitsmodell, das auf SHA-256 oder höher basiert. Dieses Element wird durch die SignatureMethod Eigenschaft dargestellt.

• Das <SignatureValue>-Element

  Gibt die kryptografische Signatur für das <Signature> Element an. Wenn diese Signatur nicht überprüft wird, wurde ein Teil des <Signature> Blocks manipuliert, und das Dokument wird als ungültig angesehen. Solange der <CanonicalizationMethod> Wert vertrauenswürdig ist, ist dieser Wert sehr resistent gegen Manipulationen. Dieses Element wird durch die SignatureValue Eigenschaft dargestellt.

• Das URI Attribut des <Reference> Elements

  Gibt ein Datenobjekt mithilfe eines URI-Verweises an. Dieses Attribut wird durch die Reference.Uri Eigenschaft dargestellt.

  • Wenn Sie das URI-Attribut nicht angeben, das heißt, wenn Sie die Eigenschaft Reference.Uri auf null setzen, bedeutet dies, dass die empfangende Anwendung die Identität des Objekts kennen soll. In den meisten Fällen führt ein null URI zu einer Ausnahme, die ausgelöst wird. Verwenden Sie keinen null URI, es sei denn, Ihre Anwendung arbeitet mit einem Protokoll zusammen, das ihn erfordert.

  • Wenn Sie das URI Attribut auf eine leere Zeichenfolge festlegen, wird angegeben, dass das Stammelement des Dokuments signiert wird, eine Form der umschlagigen Signatur.

  • Wenn der Wert des Attributs URI mit #beginnt, muss der Wert in ein Element im aktuellen Dokument aufgelöst werden. Dieses Formular kann mit jedem der unterstützten Signaturtypen verwendet werden (Umhüllungssignatur, umschließende Signatur oder interne getrennte Signatur).

  • Alles andere gilt als getrennte externe Ressourcen-Signatur und wird von der SignedXml Klasse nicht unterstützt.

• Das <Transforms>-Element

  Enthält eine sortierte Liste von <Transform>-Elementen, die beschreiben, wie der Unterzeichner das Datenobjekt abgerufen hat, das verarbeitet wurde. Ein Transformationsalgorithmus ähnelt der kanonischen Methode, aber anstatt das <Signature> Element neu zu schreiben, wird der vom URI Attribut des <Reference> Elements identifizierte Inhalt neu geschrieben. Das <Transforms> Element wird durch die TransformChain Klasse dargestellt.

  • Jeder Transformations-Algorithmus ist so definiert, dass er entweder XML (ein XPath-Knoten-Set) oder Bytes als Eingabe akzeptiert. Wenn sich das Format der aktuellen Daten von den Transformationseingabeanforderungen unterscheidet, werden Konvertierungsregeln angewendet.

  • Jeder Transformationsalgorithmus wird entweder als XML- oder Byte-Code als Ausgabe definiert.

  • Wenn die Ausgabe des letzten Transformationsalgorithmus nicht in Bytes definiert ist (oder keine Transformationen angegeben wurden), wird die Kanonisierungsmethode als implizite Transformation verwendet (auch wenn ein anderer Algorithmus im <CanonicalizationMethod> Element angegeben wurde).

  • Ein Wert http://www.w3.org/2000/09/xmldsig#enveloped-signature für den Transformationsalgorithmus codiert eine Regel, die als Entfernen des <Signature> Elements aus dem Dokument interpretiert wird. Andernfalls wird ein Prüfer einer eingehüllten Signatur das Dokument einschließlich der Signatur verarbeiten, aber der Unterzeichner hätte das Dokument überprüft, bevor die Signatur angewendet wurde, was zu unterschiedlichen Ergebnissen führt.

• Das <DigestMethod>-Element

  Identifiziert die Digest- (kryptographischer Hash-) Methode, um auf den durch das Attribut URI des Elements <Reference> identifizierten transformierten Inhalt anzuwenden. Dies wird durch die Reference.DigestMethod Eigenschaft dargestellt.

Auswählen einer Kanonisierungsmethode

Sofern Sie nicht mit einer Spezifikation interagieren, die die Verwendung eines anderen Wertes vorschreibt, empfehlen wir Ihnen, die standardmäßige .NET Kanonisierungsmethode zu verwenden, d.h. den XML-C14N 1.0 Algorithmus, dessen Wert http://www.w3.org/TR/2001/REC-xml-c14n-20010315 ist. Der XML-C14N 1.0-Algorithmus muss von allen Implementierungen von XMLDSIG unterstützt werden, insbesondere da es sich um eine implizite endgültige Transformation handelt, die angewendet werden soll.

Es gibt Versionen von Kanonisierungsalgorithmen, die das Beibehalten von Kommentaren unterstützen. Kommentarerhaltende Kanonisierungsmethoden werden nicht empfohlen, da sie das Prinzip „signieren, was man sieht“ verletzen. Das heißt, die Kommentare in einem <Signature> Element ändern nicht die Verarbeitungslogik für die Ausführung der Signatur, sondern lediglich den Signaturwert. Wenn sie mit einem schwachen Signaturalgorithmus kombiniert werden, ermöglicht das Einfügen von Kommentaren einem Angreifer unnötigen Spielraum, um eine Hash-Kollision zu erzwingen, sodass ein manipuliertes Dokument legitim erscheint. In .NET Framework werden standardmäßig nur integrierte Kanonisierer unterstützt. Zur Unterstützung zusätzlicher oder angepasster Kanonisierer siehe die Eigenschaft SafeCanonicalizationMethods. Wenn das Dokument eine Kanonisierungsmethode verwendet, die nicht in der durch die SafeCanonicalizationMethods Eigenschaft dargestellten Sammlung enthalten ist, dann gibt die CheckSignature Methode false zurück.

Sind die Referenzwerte vor Manipulationen geschützt?

Ja, die <Reference> Werte sind vor Manipulationen geschützt. .NET überprüft die <SignatureValue> Berechnung vor der Verarbeitung der <Reference> Werte und der zugehörigen Transformationen und wird frühzeitig abbrechen, um potenziell schädliche Anweisungen zu vermeiden.

Auswählen der zu signierenden Elemente

Es wird empfohlen, den Wert "" für das URI Attribut zu verwenden (oder die Uri Eigenschaft auf eine leere Zeichenfolge festzulegen), falls möglich. Dies bedeutet, dass das gesamte Dokument für die Digestberechnung berücksichtigt wird, was bedeutet, dass das gesamte Dokument vor Manipulationen geschützt ist.

Es ist sehr üblich, Werte in Form von Ankern wie #foo zu sehen URI , wobei auf ein Element verwiesen wird, dessen ID-Attribut "foo" lautet. Leider ist es einfach, dass dies manipuliert wird, da dies nur den Inhalt des Zielelements und nicht den Kontext enthält. Der Missbrauch dieser Unterscheidung ist als XML Signature Wrapping (XSW) bekannt.

Wenn Ihre Anwendung Kommentare als semantisch betrachtet (was bei XML nicht üblich ist), sollten Sie "#xpointer(/)" anstelle von "" und "#xpointer(id('foo')))" anstelle von "#foo" verwenden. Die #xpointer-Versionen werden so interpretiert, dass sie Kommentare einschließen, während die Kurznamenformen Kommentare ausschließen.

Wenn Sie Dokumente akzeptieren müssen, die nur teilweise geschützt sind, und Sie sicherstellen möchten, dass Sie denselben Inhalt lesen, den die Signatur geschützt hat, verwenden Sie die GetIdElement Methode.

Sicherheitsüberlegungen zum KeyInfo-Element

Die Daten im optionalen <KeyInfo> Element (d. h. in der KeyInfo Eigenschaft), die einen Schlüssel zum Überprüfen der Signatur enthält, sollten nicht als vertrauenswürdig angesehen werden.

Insbesondere wenn der KeyInfo-Wert einen nackten RSA-, DSA- oder ECDSA-öffentlichen Schlüssel darstellt, könnte das Dokument manipuliert worden sein, obwohl die CheckSignature-Methode meldet, dass die Signatur gültig ist. Dies kann passieren, da die Entität, die die Manipulation durchführt, nur einen neuen Schlüssel generieren und das manipulierte Dokument mit diesem neuen Schlüssel erneut signieren muss. Es sei denn, Ihre Anwendung überprüft, ob der öffentliche Schlüssel ein erwarteter Wert ist, sollte das Dokument so behandelt werden, als ob es manipuliert wurde. Dies erfordert, dass Ihre Anwendung den im Dokument eingebetteten öffentlichen Schlüssel untersucht und anhand einer Liste bekannter Werte für den Dokumentkontext überprüft. Wenn das Dokument beispielsweise verstanden werden könnte, dass es von einem bekannten Benutzer ausgestellt wird, überprüfen Sie den Schlüssel anhand einer Liste bekannter Schlüssel, die von diesem Benutzer verwendet werden.

Sie können den Schlüssel auch nach der Verarbeitung des Dokuments überprüfen, indem Sie die CheckSignatureReturningKey Methode verwenden, anstatt die CheckSignature Methode zu verwenden. Für die optimale Sicherheit sollten Sie den Schlüssel jedoch vorher überprüfen.

Alternativ können Sie die registrierten öffentlichen Schlüssel des Benutzers ausprobieren, anstatt den Inhalt des <KeyInfo> Elements zu lesen.

Sicherheitsüberlegungen zum X509Data-Element

Das optionale <X509Data> Element ist ein untergeordnetes Element des <KeyInfo> Elements und enthält mindestens ein X509-Zertifikat oder einen Bezeichner für X509-Zertifikate. Die Daten im <X509Data> Element sollten ebenfalls nicht inhärent vertrauenswürdig sein.

Bei der Überprüfung eines Dokuments mit dem eingebetteten <X509Data> Element überprüft .NET nur, dass die Daten in ein X509-Zertifikat aufgelöst werden, dessen öffentlicher Schlüssel erfolgreich zum Überprüfen der Dokumentsignatur verwendet werden kann. Im Gegensatz zum Aufruf der CheckSignature-Methode mit dem verifySignatureOnly-Parameter, der auf false festgelegt ist, wird keine Widerrufsprüfung durchgeführt, kein verkettetes Vertrauen geprüft und kein Ablaufdatum verifiziert. Selbst wenn Ihre Anwendung das Zertifikat selbst extrahiert und es an die CheckSignature-Methode übergibt, wobei der verifySignatureOnly-Parameter auf false festgelegt ist, reicht dies dennoch nicht aus, um die Manipulation von Dokumenten zu verhindern. Das Zertifikat muss noch dahingehend überprüft werden, ob es für das zu signierende Dokument geeignet ist.

Die Verwendung eines eingebetteten Signaturzertifikats kann nützliche Schlüsselrotationsstrategien bieten, egal ob im <X509Data> Abschnitt oder im Dokumentinhalt. Bei Verwendung dieses Ansatzes sollte eine Anwendung das Zertifikat manuell extrahieren und eine Überprüfung wie folgt durchführen:

• Das Zertifikat wurde direkt oder über eine Kette von einer Zertifizierungsstelle ausgestellt, deren öffentliches Zertifikat in die Anwendung eingebettet ist.

  Die Verwendung der vom Betriebssystem bereitgestellten Vertrauensliste ohne zusätzliche Überprüfungen, wie etwa eines bekannten Subjektnamens, reicht nicht aus, um Manipulationen in SignedXml zu verhindern.

• Das Zertifikat wird daraufhin überprüft, dass es zum Zeitpunkt der Signierung des Dokuments (oder „jetzt“, wenn das Dokument nahezu in Echtzeit verarbeitet wird) noch nicht abgelaufen ist.

• Überprüfen Sie bei Zertifikaten mit langer Lebensdauer, die von einer Zertifizierungsstelle ausgestellt wurden, die den Widerruf unterstützt, ob das Zertifikat nicht widerrufen wurde.

• Der Betreff des Zertifikats wird als geeignet für das aktuelle Dokument verifiziert.

Auswählen des Transformationsalgorithmus

Wenn Sie mit einer Spezifikation zusammenarbeiten, die bestimmte Werte (z. B. XrML) diktieren, müssen Sie die Spezifikation befolgen. Wenn Sie über eine eingebettete Signatur verfügen (z. B. beim Signieren des gesamten Dokuments), müssen Sie http://www.w3.org/2000/09/xmldsig#enveloped-signature verwenden (dargestellt durch die XmlDsigEnvelopedSignatureTransform Klasse). Sie können auch die implizite XML-C14N Transformation angeben, aber es ist nicht erforderlich. Für eine umschließende oder getrennte Signatur sind keine Transformationen erforderlich. Die implizite XML-C14N Transformation kümmert sich um alles.

Mit dem Sicherheitsupdate, das vom Microsoft Security Bulletin MS16-035 eingeführt wurde, .NET eingeschränkt, welche Transformationen standardmäßig bei der Dokumentüberprüfung verwendet werden können. Nicht vertrauenswürdige Transformationen führen CheckSignature immer zur Rückgabe false. Insbesondere transformationen, die zusätzliche Eingaben erfordern (die als untergeordnete Elemente in der XML angegeben sind) sind aufgrund ihrer Gefährdung durch böswillige Benutzer nicht zulässig. W3C empfiehlt, die XPath- und XSLT-Transformationen zu vermeiden, d. h. die beiden haupttransformationen, die von diesen Einschränkungen betroffen sind.

Das Problem mit externen Verweisen

Wenn eine Anwendung nicht überprüft, ob externe Verweise für den aktuellen Kontext geeignet erscheinen, können sie auf eine Weise missbraucht werden, die für viele Sicherheitsrisiken (einschließlich Denial of Service, Distributed Reflection Denial of Service, Information Disclosure, Signature Bypass und Remote Code Execution) sorgt. Auch wenn eine Anwendung den externen Verweis-URI überprüfen würde, bleibt das Problem bestehen, dass die Ressource zweimal geladen wird: einmal, wenn Ihre Anwendung sie liest, und einmal, wenn SignedXml sie liest. Da es keine Garantie gibt, dass der Lese- und Dokumentationsvorgang denselben Inhalt aufweist, bietet die Signatur keine Vertrauenswürdigkeit.

Aufgrund der Risiken externer Verweise wird eine Ausnahme ausgelöst, SignedXml wenn ein externer Verweis auftritt. Weitere Informationen zu diesem Problem finden Sie unter .NET Anwendungen ausnahmefehler auftreten.

Weitere Informationen

• Bewährte Methoden für XML-Signaturen