Reference Třída

Definice

Obor názvů:

System.Security.Cryptography.Xml

Sestavení:

System.Security.Cryptography.Xml.dll

Sestavení:

System.Security.dll

<reference> Představuje prvek podpisu XML.

public class Reference

Dědičnost

Object

Reference

Příklady

Následující příklad kódu ukazuje, jak pomocí objektu Reference vygenerovat a ověřit obálek podpis XML.

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

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

Poznámky

Objekt Reference představuje <reference> prvek digitálního podpisu XML definovaného specifikací digitálního podpisu XML.

Pomocí objektu Reference zadejte následující informace:

• Algoritmus digest použitý k podepsání datového objektu. Tato hodnota se vyžaduje.

• Identifikátor URI (Uniform Resource Identifier) datového objektu, který se má podepsat. Identifikátor URI může zadat cestu k souboru nebo konkrétní prvky v dokumentu XML. Tato hodnota se vyžaduje.

• Řetězec transformací, které se mají použít před generováním hodnot digest. Tato hodnota je volitelná.

• Typ objektu, který se má podepsat. Tato hodnota je volitelná.

• Jedinečný identifikátor použitý k odkazu na aktuální <reference> prvek. Tato hodnota je volitelná.

Další informace o <reference> prvku naleznete ve specifikaci W3C.

Konstruktory

Reference()	Inicializuje novou instanci Reference třídy s výchozími vlastnostmi.
Reference(Stream)	Inicializuje novou instanci Reference třídy s hodnotou hash zadané Stream.
Reference(String)	Inicializuje novou instanci Reference třídy se zadaným Uri.

Vlastnosti

DigestMethod	Získá nebo nastaví metodu digest Uniform Resource Identifier (URI) aktuálního Reference.
DigestValue	Získá nebo nastaví hodnotu digest aktuálního Reference.
Id	Získá nebo nastaví ID aktuálního Reference.
TransformChain	Získá transformační řetězec aktuálního Reference.
Type	Získá nebo nastaví typ podepsaného objektu.
Uri	Získá nebo nastaví Uri aktuální Reference.

Metody

AddTransform(Transform)	Transform Přidá objekt do seznamu transformací, které se mají provést u dat před předáním algoritmu digest.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Type Získá aktuální instanci. (Zděděno od Object)
GetXml()	Vrátí reprezentaci XML .Reference
LoadXml(XmlElement)	Reference Načte stav z elementu XML.
MemberwiseClone()	Vytvoří použádnou kopii aktuálního souboru Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Platí pro