XmlDsigExcC14NWithCommentsTransform Klasse

Definition

Namespace:

System.Security.Cryptography.Xml

Assembly:

System.Security.Cryptography.Xml.dll

Stellt die vom W3C (World Wide Web Consortium) definierte exklusive C14N-XML-Kanonisierungstransformation für eine digitale Signatur mit Kommentaren dar.

public ref class XmlDsigExcC14NWithCommentsTransform : System::Security::Cryptography::Xml::XmlDsigExcC14NTransform

public class XmlDsigExcC14NWithCommentsTransform : System.Security.Cryptography.Xml.XmlDsigExcC14NTransform

type XmlDsigExcC14NWithCommentsTransform = class
    inherit XmlDsigExcC14NTransform

Public Class XmlDsigExcC14NWithCommentsTransform
Inherits XmlDsigExcC14NTransform

Vererbung

Object

Transform

XmlDsigExcC14NTransform

XmlDsigExcC14NWithCommentsTransform

Beispiele

Im folgenden Codebeispiel wird gezeigt, wie Sie ein XML-Dokument mit der XmlDsigExcC14NWithCommentsTransform -Klasse signieren und überprüfen. In diesem Beispiel wird eine Umschlagsignatur erstellt.

//
// This example signs an XML file using an
// envelope signature. It then verifies the 
// signed XML.
//
#using <System.Xml.dll>
#using <System.Security.dll>
#using <System.dll>

using namespace System;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::X509Certificates;
using namespace System::Security::Cryptography::Xml;
using namespace System::Text;
using namespace System::Xml;

// Sign an XML file and save the signature in a new file.
static void SignXmlFile( String^ FileName, String^ SignedFileName, RSA^ Key )
{
   
   // Create a new XML document.
   XmlDocument^ doc = gcnew XmlDocument;
   
   // Format the document to ignore white spaces.
   doc->PreserveWhitespace = false;
   
   // Load the passed XML file using it's name.
   doc->Load( gcnew XmlTextReader( FileName ) );
   
   // Create a SignedXml object.
   SignedXml^ signedXml = gcnew SignedXml( doc );
   
   // Add the key to the SignedXml document. 
   signedXml->SigningKey = Key;
   
   // Specify a canonicalization method.
   signedXml->SignedInfo->CanonicalizationMethod = SignedXml::XmlDsigExcC14NWithCommentsTransformUrl;
   
   // Set the InclusiveNamespacesPrefixList property.
   XmlDsigExcC14NWithCommentsTransform^ canMethod = dynamic_cast<XmlDsigExcC14NWithCommentsTransform^>(signedXml->SignedInfo->CanonicalizationMethodObject);
   canMethod->InclusiveNamespacesPrefixList = L"Sign";
   
   // Create a reference to be signed.
   Reference^ reference = gcnew Reference;
   reference->Uri = L"";
   
   // Add an enveloped transformation to the reference.
   XmlDsigEnvelopedSignatureTransform^ env = gcnew 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 = gcnew KeyInfo;
   keyInfo->AddClause( gcnew RSAKeyValue( dynamic_cast<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 ( dynamic_cast<XmlDeclaration^>(doc->FirstChild) )
   {
      doc->RemoveChild( doc->FirstChild );
   }

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


// Verify the signature of an XML file and return the result.
static Boolean VerifyXmlFile( String^ Name )
{
   
   // Create a new XML document.
   XmlDocument^ xmlDocument = gcnew 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 = gcnew SignedXml( xmlDocument );
   
   // Find the "Signature" node and create a new
   // XmlNodeList object.
   XmlNodeList^ nodeList = xmlDocument->GetElementsByTagName( L"Signature" );
   
   // Load the signature node.
   signedXml->LoadXml( dynamic_cast<XmlElement^>(nodeList->Item( 0 )) );
   
   // Check the signature and return the result.
   return signedXml->CheckSignature();
}


// Create example data to sign.
static void CreateSomeXml( String^ FileName )
{
   
   // Create a new XmlDocument object.
   XmlDocument^ document = gcnew XmlDocument;
   
   // Create a new XmlNode object.
   XmlNode^ node = document->CreateNode( XmlNodeType::Element, L"", L"MyXML", L"Don't_Sign" );
   
   // Append the node to the document.
   document->AppendChild( node );
   
   // Create a new XmlNode object.
   XmlNode^ subnode = document->CreateNode( XmlNodeType::Element, L"", L"TempElement", L"Sign" );
   
   // Add some text to the node.
   subnode->InnerText = L"Here is some data to sign.";
   
   // Append the node to the document.
   document->DocumentElement->AppendChild( subnode );
   
   // Save the XML document to the file name specified.
   XmlTextWriter^ xmltw = gcnew XmlTextWriter( FileName,gcnew UTF8Encoding( false ) );
   document->WriteTo( xmltw );
   xmltw->Close();
}

int main()
{
   try
   {
      
      // Create an XML file to sign.
      CreateSomeXml( L"Example.xml" );
      Console::WriteLine( L"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( L"XML file signed." );
      
      // Verify the signature of the signed XML.
      Console::WriteLine( L"Verifying signature..." );
      bool result = VerifyXmlFile( L"SignedExample.xml" );
      
      // Display the results of the signature verification to 
      // the console.
      if ( result )
      {
         Console::WriteLine( L"The XML signature is valid." );
      }
      else
      {
         Console::WriteLine( L"The XML signature is not valid." );
      }
   }
   catch ( CryptographicException^ e ) 
   {
      Console::WriteLine( e->Message );
   }

   return 1;
}

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

            // 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.
    public static void SignXmlFile(string FileName, string SignedFileName, RSA Key)
    {
        // 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;

        // Specify a canonicalization method.
        signedXml.SignedInfo.CanonicalizationMethod = SignedXml.XmlDsigExcC14NWithCommentsTransformUrl;

        // Set the InclusiveNamespacesPrefixList property.
        XmlDsigExcC14NWithCommentsTransform canMethod = (XmlDsigExcC14NWithCommentsTransform)signedXml.SignedInfo.CanonicalizationMethodObject;
        canMethod.InclusiveNamespacesPrefixList = "Sign";

        // 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);

        // 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)
    {
        // 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();
    }

    // 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, "", "MyXML", "Don't_Sign");

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

        // Create a new XmlNode object.
        XmlNode subnode = document.CreateNode(XmlNodeType.Element, "", "TempElement", "Sign");

        // Add some text to the node.
        subnode.InnerText = "Here is some data to sign.";

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

        // 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



Module SignVerifyEnvelope


    Sub Main(ByVal 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")

            ' 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.
    Sub SignXmlFile(ByVal FileName As String, ByVal SignedFileName As String, ByVal Key As RSA)
        ' 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

        ' Specify a canonicalization method.
        signedXml.SignedInfo.CanonicalizationMethod = signedXml.XmlDsigExcC14NWithCommentsTransformUrl

        ' Set the InclusiveNamespacesPrefixList property.
        Dim canMethod As XmlDsigExcC14NWithCommentsTransform = CType(signedXml.SignedInfo.CanonicalizationMethodObject, XmlDsigExcC14NWithCommentsTransform)
        canMethod.InclusiveNamespacesPrefixList = "Sign"

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


        ' 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]
        ' 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


    ' Create example data to sign.
    Sub CreateSomeXml(ByVal 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, "", "MyXML", "Don't_Sign")

        ' Append the node to the document.
        document.AppendChild(node)

        ' Create a new XmlNode object.
        Dim subnode As XmlNode = document.CreateNode(XmlNodeType.Element, "", "TempElement", "Sign")

        ' Add some text to the node.
        subnode.InnerText = "Here is some data to sign."

        ' Append the node to the document.
        document.DocumentElement.AppendChild(subnode)

        ' 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 Module

Hinweise

Die XmlDsigExcC14NWithCommentsTransform -Klasse stellt die exklusive C14N-XML-Kanonisierungstransformation mit Kommentaren dar. Diese Klasse ähnelt der XmlDsigExcC14NTransform -Klasse, die es einem Signierer ermöglicht, einen Digest mithilfe der kanonischen Form eines XML-Dokuments zu erstellen. Die -Klasse schließt jedoch den XmlDsigExcC14NWithCommentsTransform Vorgängerkontext aus einem kanonischen Unterdokument aus.

Verwenden Sie die XmlDsigExcC14NWithCommentsTransform -Klasse, wenn Sie ein XML-Unterdokument so kanonisieren müssen, dass es unabhängig vom XML-Kontext ist. Beispielsweise müssen Anwendungen wie Webdienste, die signiertes XML in komplexen Kommunikationsprotokollen verwenden, xml häufig auf diese Weise kanonisieren. Solche Anwendungen umhüllen häufig XML in verschiedene dynamisch erstellte Elemente, was das Dokument erheblich verändern und zu einem Fehler bei der XML-Signaturüberprüfung führen kann. Die XmlDsigExcC14NWithCommentsTransform -Klasse löst dieses Problem, indem sie einen solchen Vorgängerkontext aus dem kanonischen Unterdokument ausschließt.

Beachten Sie, dass Sie keine neue instance einer Kanonisierungstransformationsklasse direkt erstellen können. Um eine Kanonisierungstransformation anzugeben, übergeben Sie den URI (Uniform Resource Identifier), der die Transformation beschreibt, an die CanonicalizationMethod -Eigenschaft, auf die über die SignedInfo -Eigenschaft zugegriffen werden kann. Um einen Verweis auf die Kanonisierungstransformation zu erhalten, verwenden Sie die CanonicalizationMethodObject -Eigenschaft, auf die über die SignedInfo -Eigenschaft zugegriffen werden kann.

Der URI, der die XmlDsigExcC14NWithCommentsTransform -Klasse beschreibt, wird durch das XmlDsigExcC14NWithCommentsTransformUrl -Feld definiert.

Weitere Informationen zur exklusiven C14N-Transformation finden Sie in der XMLDSIG-Spezifikation, die auf der W3C-Website verfügbar ist. Der Kanonisierungsalgorithmus ist in der kanonischen XML-Spezifikation von W3C definiert.

Konstruktoren

XmlDsigExcC14NWithCommentsTransform()	Initialisiert eine neue Instanz der XmlDsigExcC14NWithCommentsTransform-Klasse.
XmlDsigExcC14NWithCommentsTransform(String)	Initialisiert eine neue Instanz der XmlDsigExcC14NWithCommentsTransform-Klasse, die eine Liste von Namespacepräfixen angibt, die mit dem Standardkanonisierungsalgorithmus kanonisiert werden sollen.

Eigenschaften

Algorithm	Ruft einen URI (Uniform Resource Identifier) ab, der den durch die aktuelle Transformation ausgeführten Algorithmus bezeichnet, oder legt diesen fest. (Geerbt von Transform)
Context	Ruft ein XmlElement-Objekt ab, das den Dokumentenkontext darstellt, unter dem das aktuelle Transform-Objekt ausgeführt wird, oder legt dieses fest. (Geerbt von Transform)
InclusiveNamespacesPrefixList	Ruft eine Zeichenfolge ab, die mit dem Standardkanonisierungsalgorithmus zu kanonisierende Namespacepräfixe enthält oder legt diese fest. (Geerbt von XmlDsigExcC14NTransform)
InputTypes	Ruft ein Array von Typen ab, die gültige Eingaben der LoadInput(Object)-Methode des aktuellen XmlDsigExcC14NTransform-Objekts sind. (Geerbt von XmlDsigExcC14NTransform)
OutputTypes	Ruft ein Array von Typen ab, die mögliche Ausgaben der GetOutput()-Methoden des aktuellen XmlDsigExcC14NTransform-Objekts sind. (Geerbt von XmlDsigExcC14NTransform)
PropagatedNamespaces	Ruft ein Hashtable-Objekt mit den Namespaces ab, die in die Signatur weitergegeben werden, oder legt dieses Objekt fest. (Geerbt von Transform)
Resolver	Legt das aktuelle XmlResolver-Objekt fest. (Geerbt von Transform)

Methoden

Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetDigestedOutput(HashAlgorithm)	Gibt den einem XmlDsigExcC14NTransform-Objekt zugeordneten Digest zurück. (Geerbt von XmlDsigExcC14NTransform)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetInnerXml()	Gibt eine XML-Darstellung der Parameter eines XmlDsigExcC14NTransform-Objekts zurück, die als Unterelemente eines XMLDSIG-<Transform>-Elements eingefügt werden können. (Geerbt von XmlDsigExcC14NTransform)
GetOutput()	Gibt die Ausgabe des aktuellen XmlDsigExcC14NTransform-Objekts zurück. (Geerbt von XmlDsigExcC14NTransform)
GetOutput(Type)	Gibt die Ausgabe des aktuellen XmlDsigExcC14NTransform-Objekts als ein Objekt vom angegebenen Typ zurück. (Geerbt von XmlDsigExcC14NTransform)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
GetXml()	Gibt die XML-Darstellung des aktuellen Transform-Objekts zurück. (Geerbt von Transform)
LoadInnerXml(XmlNodeList)	Analysiert das angegebene XmlNodeList-Objekt als transformationsspezifischen Inhalt eines <Transform>-Elements und konfiguriert den internen Zustand des aktuellen XmlDsigExcC14NTransform-Objekts für die Übereinstimmung mit dem <Transform>-Element. (Geerbt von XmlDsigExcC14NTransform)
LoadInput(Object)	Lädt beim Überschreiben in einer abgeleiteten Klasse die angegebene Eingabe in das aktuelle XmlDsigExcC14NTransform-Objekt. (Geerbt von XmlDsigExcC14NTransform)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)