SignedXml Sınıf

Tanım

XML imzaları oluşturmayı kolaylaştırmak için çekirdek XML imza nesnesinde bir sarmalayıcı sağlar.

public class SignedXml
Devralma
SignedXml

Örnekler

Aşağıdaki kod örneğinde, zarflı imza kullanarak xml belgesinin tamamının nasıl imzalanıp doğrulanması gösterilmektedir.

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

Aşağıdaki kod örneği, bir XML belgesinin tek bir öğesinin zarflama imzası kullanılarak nasıl imzalanıp doğrulandığını gösterir.

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

Açıklamalar

Bu API hakkında daha fazla bilgi için bkz . SignedXml için ek API açıklamaları.

Oluşturucular

SignedXml()

SignedXml sınıfının yeni bir örneğini başlatır.

SignedXml(XmlDocument)

Belirtilen XML belgesinden sınıfın SignedXml yeni bir örneğini başlatır.

SignedXml(XmlElement)

Belirtilen XmlElement nesneden sınıfının yeni bir örneğini SignedXml başlatır.

Alanlar

m_signature

Signature Geçerli SignedXml nesnenin nesnesini temsil eder.

m_strSigningKeyName

Nesneyi imzalamak için kullanılacak yüklü anahtarın SignedXml adını temsil eder.

XmlDecryptionTransformUrl

XML modu şifre çözme dönüşümü için Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigBase64TransformUrl

Temel 64 dönüşümü için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigC14NTransformUrl

Kurallı XML dönüşümü için Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigC14NWithCommentsTransformUrl

Kurallı XML dönüşümü için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) açıklamalarla birlikte temsil eder. Bu alan sabittir.

XmlDsigCanonicalizationUrl

XML dijital imzaları için standart kurallılaştırma algoritmasının Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigCanonicalizationWithCommentsUrl

XML dijital imzaları için standart kurallılaştırma algoritması için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder ve açıklamalar içerir. Bu alan sabittir.

XmlDsigDSAUrl

XML dijital imzaları için standart DSA algoritmanın Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigEnvelopedSignatureTransformUrl

Zarflı imza dönüşümü için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigExcC14NTransformUrl

Özel XML kurallı hale getirme için Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigExcC14NWithCommentsTransformUrl

Açıklamalarla, özel XML kurallı hale getirme için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigHMACSHA1Url

XML dijital imzaları için standart HMACSHA1 algoritmanın Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigMinimalCanonicalizationUrl

XML dijital imzaları için standart en düşük kurallı hale getirme algoritması için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigNamespaceUrl

XML dijital imzaları için standart ad alanının Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigRSASHA1Url

XML dijital imzaları için standart RSA imza yöntemi için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigRSASHA256Url

XML dijital imzaları için RSA SHA-256 imza yöntemi varyasyonunun Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigRSASHA384Url

XML dijital imzaları için RSA SHA-384 imza yöntemi varyasyonunun Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigRSASHA512Url

XML dijital imzaları için RSA SHA-512 imza yöntemi varyasyonunun Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigSHA1Url

XML dijital imzaları için standart SHA1 özet yöntemi için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigSHA256Url

XML dijital imzaları için standart SHA256 özet yöntemi için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigSHA384Url

XML dijital imzaları için standart SHA384 özet yöntemi için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigSHA512Url

XML dijital imzaları için standart SHA512 özet yöntemi için Tekdüzen Kaynak Tanımlayıcısı'nı (URI) temsil eder. Bu alan sabittir.

XmlDsigXPathTransformUrl

XML Yol Dili (XPath) için Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlDsigXsltTransformUrl

XSLT dönüşümleri için Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder. Bu alan sabittir.

XmlLicenseTransformUrl

İmzalar için XrML lisanslarını normalleştirmek için kullanılan lisans dönüştürme algoritmasının Tekdüzen Kaynak Tanımlayıcısını (URI) temsil eder.

Özellikler

EncryptedXml

XML şifreleme işleme kurallarını tanımlayan bir EncryptedXml nesneyi alır veya ayarlar.

KeyInfo

Geçerli SignedXml nesnenin KeyInfo nesnesini alır veya ayarlar.

Resolver

Geçerli XmlResolver nesneyi ayarlar.

SafeCanonicalizationMethods

Kurallılaştırma algoritmalarına açıkça izin verilen yöntemlerin adlarını alır.

Signature

Signature Geçerli SignedXml nesnenin nesnesini alır.

SignatureFormatValidator

XML imzasının biçimini (şifreleme güvenliğini değil) doğrulamak için çağrılacak bir temsilci alır.

SignatureLength

Geçerli SignedXml nesnenin imza uzunluğunu alır.

SignatureMethod

Geçerli SignedXml nesnenin imza yöntemini alır.

SignatureValue

Geçerli SignedXml nesnenin imza değerini alır.

SignedInfo

SignedInfo Geçerli SignedXml nesnenin nesnesini alır.

SigningKey

Bir nesneyi imzalamak SignedXml için kullanılan asimetrik algoritma anahtarını alır veya ayarlar.

SigningKeyName

Nesneyi imzalamak için kullanılacak yüklü anahtarın SignedXml adını alır veya ayarlar.

Yöntemler

AddObject(DataObject)

İmzalanacak nesneler listesine bir DataObject nesne ekler.

AddReference(Reference)

Reference SignedXml Xml dijital imzası oluşturmak için kullanılacak özet yöntemini, özet değerini ve dönüştürmeyi açıklayan nesneye bir nesne ekler.

CheckSignature()

özelliğin Signature imzadaki ortak anahtarı kullanarak doğrulayıp doğrulamadığını belirler.

CheckSignature(AsymmetricAlgorithm)

Özelliğin Signature belirtilen anahtar için doğrulanıp doğrulanmamış olduğunu belirler.

CheckSignature(KeyedHashAlgorithm)

Özelliğin Signature belirtilen ileti kimlik doğrulama kodu (MAC) algoritması için doğrulanıp doğrulamayacağını belirler.

CheckSignature(X509Certificate2, Boolean)

Özelliğin Signature belirtilen X509Certificate2 nesne için doğrulayıp doğrulamadığını ve isteğe bağlı olarak sertifikanın geçerli olup olmadığını belirler.

CheckSignatureReturningKey(AsymmetricAlgorithm)

özelliğin Signature imzadaki ortak anahtarı kullanarak doğrulayıp doğrulamadığını belirler.

ComputeSignature()

XML dijital imzayı hesaplar.

ComputeSignature(KeyedHashAlgorithm)

Belirtilen ileti kimlik doğrulama kodu (MAC) algoritmasını kullanarak bir XML dijital imzasını hesaplar.

Equals(Object)

Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler.

(Devralındığı yer: Object)
GetHashCode()

Varsayılan karma işlevi işlevi görür.

(Devralındığı yer: Object)
GetIdElement(XmlDocument, String)

XmlElement Belirtilen nesneden belirtilen kimliği içeren XmlDocument nesneyi döndürür.

GetPublicKey()

İmzanın ortak anahtarını döndürür.

GetType()

Type Geçerli örneğini alır.

(Devralındığı yer: Object)
GetXml()

Bir SignedXml nesnenin XML gösterimini döndürür.

LoadXml(XmlElement)

XML SignedXml öğesinden bir durum yükler.

MemberwiseClone()

Geçerli Objectöğesinin sığ bir kopyasını oluşturur.

(Devralındığı yer: Object)
ToString()

Geçerli nesneyi temsil eden dizeyi döndürür.

(Devralındığı yer: Object)

Şunlara uygulanır

Ürün Sürümler
.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

Ayrıca bkz.