SignedXml Kelas

Definisi

Menyediakan pembungkus pada objek tanda tangan XML inti untuk memfasilitasi pembuatan tanda tangan XML.

C#
public class SignedXml
Warisan
SignedXml

Contoh

Contoh kode berikut menunjukkan cara menandatangani dan memverifikasi seluruh dokumen XML menggunakan tanda tangan yang diselimuti.

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

Contoh kode berikut menunjukkan cara menandatangani dan memverifikasi satu elemen dokumen XML menggunakan tanda tangan yang menyelimuti.

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

Keterangan

Untuk informasi selengkapnya tentang API ini, lihat Keterangan API Tambahan untuk SignedXml.

Konstruktor

SignedXml()

Menginisialisasi instans baru kelas SignedXml.

SignedXml(XmlDocument)

Menginisialisasi instans SignedXml baru kelas dari dokumen XML yang ditentukan.

SignedXml(XmlElement)

Menginisialisasi instans SignedXml baru kelas dari objek yang ditentukan XmlElement .

Bidang

m_signature

Signature Mewakili objek objek saat iniSignedXml.

m_strSigningKeyName

Mewakili nama kunci yang diinstal yang akan digunakan untuk menandatangani SignedXml objek.

XmlDecryptionTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi dekripsi mode XML. Bidang ini konstan.

XmlDsigBase64TransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi dasar 64. Bidang ini konstan.

XmlDsigC14NTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi XML Kanonis. Bidang ini konstan.

XmlDsigC14NWithCommentsTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi XML Kanonis, dengan komentar. Bidang ini konstan.

XmlDsigCanonicalizationUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma kanonisisasi standar untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigCanonicalizationWithCommentsUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma kanonisisasi standar untuk tanda tangan digital XML dan menyertakan komentar. Bidang ini konstan.

XmlDsigDSAUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma standar DSA untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigEnvelopedSignatureTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi tanda tangan yang diselimuti. Bidang ini konstan.

XmlDsigExcC14NTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk kanonisisasi XML eksklusif. Bidang ini konstan.

XmlDsigExcC14NWithCommentsTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk kanonisisasi XML eksklusif, dengan komentar. Bidang ini konstan.

XmlDsigHMACSHA1Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma standar HMACSHA1 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigMinimalCanonicalizationUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma kanonisisasi minimal standar untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigNamespaceUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk namespace standar untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigRSASHA1Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk metode tanda tangan standar RSA untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigRSASHA256Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk RSA variasi metode tanda tangan SHA-256 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigRSASHA384Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk RSA variasi metode tanda tangan SHA-384 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigRSASHA512Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk RSA variasi metode tanda tangan SHA-512 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigSHA1Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk metode hash standar SHA1 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigSHA256Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk metode hash standar SHA256 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigSHA384Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk metode hash standar SHA384 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigSHA512Url

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk metode hash standar SHA512 untuk tanda tangan digital XML. Bidang ini konstan.

XmlDsigXPathTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk Bahasa Jalur XML (JalurX). Bidang ini konstan.

XmlDsigXsltTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk transformasi XSLT. Bidang ini konstan.

XmlLicenseTransformUrl

Mewakili Pengidentifikasi Sumber Daya Seragam (URI) untuk algoritma transformasi lisensi yang digunakan untuk menormalkan lisensi XrML untuk tanda tangan.

Properti

EncryptedXml

Mendapatkan atau mengatur EncryptedXml objek yang menentukan aturan pemrosesan enkripsi XML.

KeyInfo

Mendapatkan atau mengatur KeyInfo objek objek saat ini SignedXml .

Resolver

Menyetel objek saat ini XmlResolver .

SafeCanonicalizationMethods

Mendapatkan nama metode yang algoritma kanonisisasinya diizinkan secara eksplisit.

Signature

Signature Mendapatkan objek objek saat iniSignedXml.

SignatureFormatValidator

Mendapatkan delegasi yang akan dipanggil untuk memvalidasi format (bukan keamanan kriptografi) tanda tangan XML.

SignatureLength

Mendapatkan panjang tanda tangan untuk objek saat ini SignedXml .

SignatureMethod

Mendapatkan metode tanda tangan objek saat ini SignedXml .

SignatureValue

Mendapatkan nilai tanda tangan objek saat ini SignedXml .

SignedInfo

SignedInfo Mendapatkan objek objek saat iniSignedXml.

SigningKey

Mendapatkan atau mengatur kunci algoritma asimetris yang digunakan untuk menandatangani SignedXml objek.

SigningKeyName

Mendapatkan atau mengatur nama kunci yang diinstal yang akan digunakan untuk menandatangani SignedXml objek.

Metode

AddObject(DataObject)

DataObject Menambahkan objek ke daftar objek yang akan ditandatangani.

AddReference(Reference)

Reference Menambahkan objek ke SignedXml objek yang menjelaskan metode hash, nilai hash, dan transformasi untuk digunakan untuk membuat tanda tangan digital XML.

CheckSignature()

Menentukan apakah Signature properti memverifikasi menggunakan kunci publik dalam tanda tangan.

CheckSignature(AsymmetricAlgorithm)

Menentukan apakah Signature properti memverifikasi untuk kunci yang ditentukan.

CheckSignature(KeyedHashAlgorithm)

Menentukan apakah Signature properti memverifikasi untuk algoritma kode autentikasi pesan (MAC) yang ditentukan.

CheckSignature(X509Certificate2, Boolean)

Menentukan apakah Signature properti memverifikasi untuk objek yang ditentukan X509Certificate2 dan, secara opsional, apakah sertifikat valid.

CheckSignatureReturningKey(AsymmetricAlgorithm)

Menentukan apakah Signature properti memverifikasi menggunakan kunci publik dalam tanda tangan.

ComputeSignature()

Menghitung tanda tangan digital XML.

ComputeSignature(KeyedHashAlgorithm)

Menghitung tanda tangan digital XML menggunakan algoritma kode autentikasi pesan (MAC) yang ditentukan.

Equals(Object)

Menentukan apakah objek yang ditentukan sama dengan objek saat ini.

(Diperoleh dari Object)
GetHashCode()

Berfungsi sebagai fungsi hash default.

(Diperoleh dari Object)
GetIdElement(XmlDocument, String)

Mengembalikan XmlElement objek dengan ID yang ditentukan dari objek yang ditentukan XmlDocument .

GetPublicKey()

Mengembalikan kunci umum tanda tangan.

GetType()

Mendapatkan instans Type saat ini.

(Diperoleh dari Object)
GetXml()

Mengembalikan representasi XML objek SignedXml .

LoadXml(XmlElement)

Memuat status SignedXml dari elemen XML.

MemberwiseClone()

Membuat salinan dangkal dari yang saat ini Object.

(Diperoleh dari Object)
ToString()

Mengembalikan string yang mewakili objek saat ini.

(Diperoleh dari Object)

Berlaku untuk

Produk Versi
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10

Lihat juga