Ler em inglês

Partilhar via


XmlDsigC14NTransform Classe

Definição

Representa a transformação de conversão em formato canônico do XML C14N para uma assinatura digital conforme definido pelo W3C (World Wide Web Consortium), sem comentários.

public class XmlDsigC14NTransform : System.Security.Cryptography.Xml.Transform
Herança
XmlDsigC14NTransform
Derivado

Exemplos

Esta seção contém dois exemplos de código. O primeiro exemplo demonstra como assinar dados não XML usando uma assinatura desanexada. O exemplo nº 1 cria uma assinatura de www.microsoft.com em um arquivo XML e, em seguida, verifica o arquivo. O segundo exemplo demonstra como chamar membros da XmlDsigC14NTransform classe .

Exemplo nº 1

//
// This example signs a file specified by a URI 
// using a detached signature. It then verifies  
// the signed XML.
//

using System;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Text;
using System.Xml;

class XMLDSIGDetached
{
    
    [STAThread]
    static void Main(string[] args)
    {
    // The URI to sign.
        string resourceToSign = "http://www.microsoft.com";
        
        // The name of the file to which to save the XML signature.
        string XmlFileName = "xmldsig.xml";

        try
        {

            // Generate a signing key.
            RSA Key = RSA.Create();

            Console.WriteLine("Signing: {0}", resourceToSign);

            // Sign the detached resourceand save the signature in an XML file.
            SignDetachedResource(resourceToSign, XmlFileName, Key);

            Console.WriteLine("XML signature was successfully computed and saved to {0}.", XmlFileName);

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

            //Verify the XML signature in the XML file.
            bool result = VerifyDetachedSignature(XmlFileName);

            // 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 SignDetachedResource(string URIString, string XmlSigFileName, RSA Key)
    {
        // Create a SignedXml object.
        SignedXml signedXml = new SignedXml();

        // Assign the key to the SignedXml object.
        signedXml.SigningKey = Key;

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

        // Add the passed URI to the reference object.
        reference.Uri = URIString;
        
        // 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();

        // Save the signed XML document to a file specified
        // using the passed string.
        XmlTextWriter xmltw = new XmlTextWriter(XmlSigFileName, new UTF8Encoding(false));
        xmlDigitalSignature.WriteTo(xmltw);
        xmltw.Close();
    }
    // Verify the signature of an XML file and return the result.
    public static Boolean VerifyDetachedSignature(string XmlSigFileName)
    {	
        // Create a new XML document.
        XmlDocument xmlDocument = new XmlDocument();

        // Load the passed XML file into the document.
        xmlDocument.Load(XmlSigFileName);
    
        // Create a new SignedXMl object.
        SignedXml signedXml = new SignedXml();

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

Exemplo nº 2

using System;
using System.IO;
using System.Xml;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Security.Cryptography.X509Certificates;

class Class1
{
    private static string Certificate =  "..\\..\\my509.cer";

    [STAThread]
    static void Main(string[] args)
    {
        // Encrypt an XML message
        XmlDocument productsXml = LoadProducts();
        ShowTransformProperties(productsXml);

        SignDocument(ref productsXml);
        ShowTransformProperties(productsXml);

        // Use XmlDsigC14NTransform to resolve a Uri.
        Uri baseUri = new Uri("http://www.contoso.com");
        string relativeUri = "xml";
        Uri absoluteUri = ResolveUris(baseUri, relativeUri);

        Console.WriteLine("This sample completed successfully; " +
            "press Enter to exit.");
        Console.ReadLine();
    }

    // Encrypt the text in the specified XmlDocument.
    private static void ShowTransformProperties(XmlDocument xmlDoc)
    {
        XmlDsigC14NTransform xmlTransform = 
            new XmlDsigC14NTransform(true);

        // Ensure the transform is using the appropriate algorithm.
        xmlTransform.Algorithm =
            SignedXml.XmlDsigExcC14NTransformUrl;

        // Retrieve the XML representation of the current transform.
        XmlElement xmlInTransform = xmlTransform.GetXml();

        Console.WriteLine("\nXml representation of the current transform: ");
        Console.WriteLine(xmlInTransform.OuterXml);

        // Retrieve the valid input types for the current transform.
        Type[] validInTypes = xmlTransform.InputTypes;

        // Verify the xmlTransform can accept the XMLDocument as an
        // input type.
        for (int i=0; i<validInTypes.Length; i++)
        {
            if (validInTypes[i] == xmlDoc.GetType())
            {
                // Load the document into the transfrom.
                xmlTransform.LoadInput(xmlDoc);

                XmlDsigC14NTransform secondTransform = 
                    new XmlDsigC14NTransform();

                string classDescription = secondTransform.ToString();

                // This call does not perform as expected.
                // This transform does not contain inner XML elements
                secondTransform.LoadInnerXml(xmlDoc.SelectNodes("//."));

                break;
            }
        }

        Type[] validOutTypes = xmlTransform.OutputTypes;

        for (int i=0; i<validOutTypes.Length;i++)
        {
            if (validOutTypes[i] == typeof(System.IO.Stream))
            {
                try 
                {
                    Type streamType = typeof(System.IO.Stream);
                    MemoryStream outputStream = (MemoryStream) 
                        xmlTransform.GetOutput(streamType);

                    // Read the CryptoStream into a stream reader.
                    StreamReader streamReader =
                        new StreamReader(outputStream);

                    // Read the stream into a string.
                    string outputMessage = streamReader.ReadToEnd();

                    // Close the streams.
                    outputStream.Close();
                    streamReader.Close();

                    // Display to the console the Xml before and after
                    // encryption.
                    Console.WriteLine("Encoding the following xml: " +
                        xmlDoc.OuterXml);
                    Console.WriteLine("Message encoded: " + outputMessage);
                }
                catch (Exception ex)
                {
                    Console.WriteLine("Unexpected exception caught: " +
                        ex.ToString());
                }

                break;
            }
            else
            {
                object outputObject = xmlTransform.GetOutput();
            }
        }
    }

    // Create an XML document describing various products.
    private static XmlDocument LoadProducts()
    {
        XmlDocument xmlDoc = new XmlDocument();

        string contosoProducts = "<PRODUCTS>";
        contosoProducts += "<PRODUCT><ID>123</ID>";
        contosoProducts += "<DESCRIPTION>Router</DESCRIPTION></PRODUCT>";
        contosoProducts += "<PRODUCT><ID>456</ID>";
        contosoProducts += "<DESCRIPTION>Keyboard</DESCRIPTION></PRODUCT>";

        // Include a comment to test the comments feature of the transform.
        contosoProducts += "<!--Comments are included in the transform-->";

        // Include the CDATA tag to test the transform results.
        contosoProducts += "<PARTNER_URL><![CDATA['http:\\\\www.contoso.com";
        contosoProducts += "\\partner.asp?h1=en&h2=cr']]></PARTNER_URL>";
        contosoProducts += "</PRODUCTS>";

        xmlDoc.LoadXml(contosoProducts);
        return xmlDoc;
    }

    // Create a signature and add it to the specified document.
    private static void SignDocument(ref XmlDocument xmlDoc)
    {
        // Generate a signing key.
        RSA Key = RSA.Create();

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

        // 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.
        reference.AddTransform(new XmlDsigC14NTransform());

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

        try 
        {
            // Create a new KeyInfo object.
            KeyInfo keyInfo = new KeyInfo();

            // Load the X509 certificate.
            X509Certificate MSCert =
                X509Certificate.CreateFromCertFile(Certificate);

            // Load the certificate into a KeyInfoX509Data object
            // and add it to the KeyInfo object.
            keyInfo.AddClause(new KeyInfoX509Data(MSCert));

            // Add the KeyInfo object to the SignedXml object.
            signedXml.KeyInfo = keyInfo;
        }
        catch (FileNotFoundException)
        {
            Console.WriteLine("Unable to locate the following file: " + 
                Certificate);
        }
        catch (CryptographicException ex)
        {
            Console.WriteLine("Unexpected exception caught whild creating " +
                "the certificate:" + ex.ToString());
        }

        // Compute the signature.
        signedXml.ComputeSignature();

        // Add the signature branch to the original tree so it is enveloped.
        xmlDoc.DocumentElement.AppendChild(signedXml.GetXml());
    }

    // Resolve the specified base and relative Uri's .
    private static Uri ResolveUris(Uri baseUri, string relativeUri)
    {
        XmlUrlResolver xmlResolver = new XmlUrlResolver();
        xmlResolver.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        XmlDsigC14NTransform xmlTransform =
            new XmlDsigC14NTransform();
        xmlTransform.Resolver = xmlResolver;

        Uri absoluteUri = xmlResolver.ResolveUri(baseUri, relativeUri);

        if (absoluteUri != null)
        {
            Console.WriteLine(
                "\nResolved the base Uri and relative Uri to the following:");
            Console.WriteLine(absoluteUri.ToString());
        }
        else
        {
            Console.WriteLine(
                "Unable to resolve the base Uri and relative Uri");
        }
        return absoluteUri;
    }
}
//
// This sample produces the following output:
//
// Xml representation of the current transform:
// <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" xmln
// s="http://www.w3.org/2000/09/xmldsig#" />
// Encoding the following xml: <PRODUCTS><PRODUCT><ID>123</ID><DESCRIPTION>Rou
// ter</DESCRIPTION></PRODUCT><PRODUCT><ID>456</ID><DESCRIPTION>Keyboard</DESC
// RIPTION></PRODUCT><!--Comments are included in the transform--><PARTNER_URL
// ><![CDATA['http:\\www.contoso.com\partner.asp?h1=en&h2=cr']]></PARTNER_URL>
// </PRODUCTS>Message encoded: <PRODUCTS><PRODUCT><ID>123</ID><DESCRIPTION>Rou
// ter</DESCRIPTION></PRODUCT><PRODUCT><ID>456</ID><DESCRIPTION>Keyboard</DESC
// RIPTION></PRODUCT><!--Comments are included in the transform--><PARTNER_URL
// >'http:\\www.contoso.com\partner.asp?h1=en&h2=cr'</PARTNER_URL></PRODUC
// TS>

// Xml representation of the current transform:
// <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" xmln
// s="http://www.w3.org/2000/09/xmldsig#" />
// Encoding the following xml: <PRODUCTS><PRODUCT><ID>123</ID><DESCRIPTION>Rou
// ter</DESCRIPTION></PRODUCT><PRODUCT><ID>456</ID><DESCRIPTION>Keyboard</DESC
// RIPTION></PRODUCT><!--Comments are included in the transform--><PARTNER_URL
// ><![CDATA['http:\\www.contoso.com\partner.asp?h1=en&h2=cr']]></PARTNER_URL>
// <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><Canonica
// lizationMethod 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/TR/2
// 001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://w
// ww.w3.org/2000/09/xmldsig#sha1" /><DigestValue>BFN2s0/NA2NGgb/R0mvfnNM0Ito=
// </DigestValue></Reference></SignedInfo><SignatureValue>vSfZUG5xHuNxzOSEbQjN
// dtEt1D+O7I1LTJ13RrwLaJSfQPrdT/s8IeaA+idw2f2WGuGrdqMJUddpE4GxfK61HmPQ6S7lBG+
// +ND+YaUYf2AtTRs3SnToXQQrARa/pHVjsKxYHR/9tjy6maHBwxjgjFQABvYZu0gZHYRuXvvfxv0
// 8=</SignatureValue><KeyInfo><X509Data xmlns="http://www.w3.org/2000/09/xmld
// sig#"><X509Certificate>MIICCzCCAXSgAwIBAgIQ5eVQY8pRZ5xBF2WLkYPjijANBgkqhkiG
// 9w0BAQQFADAbMRkwFwYDVQQDExBHcmVnc0NlcnRpZmljYXRlMB4XDTAzMDkxNzIzMzU0N1oXDTM
// 5MTIzMTIzNTk1OVowGzEZMBcGA1UEAxMQR3JlZ3NDZXJ0aWZpY2F0ZTCBnzANBgkqhkiG9w0BAQ
// EFAAOBjQAwgYkCgYEAmFJ4v7rS3BYTXgVW9PgBFfTYAcB/m9mOFCmUrrChcBpoEtu/tSESlNfEH
// pECIdqg9vUrCNSkY08HRn3ueNeBSnSpssWd8/XoOboWLh1nd+79Y5uZd1WOJI4s0XM0MegZgCoJ
// cEEhpxCd/HOPIQvEsbpN/DuFiovZLo+Ek3hHoxMCAwEAAaNQME4wTAYDVR0BBEUwQ4AQaCb19dl
// yf/zSxPVYQZY9AKEdMBsxGTAXBgNVBAMTEEdyZWdzQ2VydGlmaWNhdGWCEOXlUGPKUWecQRdli5
// GD44owDQYJKoZIhvcNAQEEBQADgYEAZuZaFDGDJogh7FuT0hfaMAVlRONv6wWVBJVV++eUo38Xu
// RfJ5nNJ0UnhiV2sEtLobYBPEIrNhuk8skdU0AHgx4ILiA4rR96ifWwxtrFQF+h+DL2ZB7xhwcOJ
// +Pa7IC4wIaEp/oBmmX+JHSzfQt6/If4ohwikfxfljKMyIcMlwl4=</X509Certificate></X50
// 9Data></KeyInfo></Signature></PRODUCTS>
//
// Message encoded: <PRODUCTS><PRODUCT><ID>123</ID><DESCRIPTION>Router</DESCRI
// PTION></PRODUCT><PRODUCT><ID>456</ID><DESCRIPTION>Keyboard</DESCRIPTION></P
// RODUCT><!--Comments are included in the transform--><PARTNER_URL>'http:\\ww
// w.contoso.com\partner.asp?h1=en&h2=cr'</PARTNER_URL><Signature><SignedI
// nfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c1
// 4n-20010315"></CanonicalizationMethod><SignatureMethod Algorithm="http://ww
// w.w3.org/2000/09/xmldsig#rsa-sha1"></SignatureMethod><Reference URI=""><Tra
// nsforms><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-200103
// 15"></Transform></Transforms><DigestMethod Algorithm="http://www.w3.org/200
// 0/09/xmldsig#sha1"></DigestMethod><DigestValue>BFN2s0/NA2NGgb/R0mvfnNM0Ito=
// </DigestValue></Reference></SignedInfo><SignatureValue>vSfZUG5xHuNxzOSEbQjN
// dtEt1D+O7I1LTJ13RrwLaJSfQPrdT/s8IeaA+idw2f2WGuGrdqMJUddpE4GxfK61HmPQ6S7lBG+
// +ND+YaUYf2AtTRs3SnToXQQrARa/pHVjsKxYHR/9tjy6maHBwxjgjFQABvYZu0gZHYRuXvvfxv0
// 8=</SignatureValue><KeyInfo><X509Data xmlns="http://www.w3.org/2000/09/xmld
// sig#"><X509Certificate>MIICCzCCAXSgAwIBAgIQ5eVQY8pRZ5xBF2WLkYPjijANBgkqhkiG
// 9w0BAQQFADAbMRkwFwYDVQQDExBHcmVnc0NlcnRpZmljYXRlMB4XDTAzMDkxNzIzMzU0N1oXDTM
// 5MTIzMTIzNTk1OVowGzEZMBcGA1UEAxMQR3JlZ3NDZXJ0aWZpY2F0ZTCBnzANBgkqhkiG9w0BAQ
// EFAAOBjQAwgYkCgYEAmFJ4v7rS3BYTXgVW9PgBFfTYAcB/m9mOFCmUrrChcBpoEtu/tSESlNfEH
// pECIdqg9vUrCNSkY08HRn3ueNeBSnSpssWd8/XoOboWLh1nd+79Y5uZd1WOJI4s0XM0MegZgCoJ
// cEEhpxCd/HOPIQvEsbpN/DuFiovZLo+Ek3hHoxMCAwEAAaNQME4wTAYDVR0BBEUwQ4AQaCb19dl
// yf/zSxPVYQZY9AKEdMBsxGTAXBgNVBAMTEEdyZWdzQ2VydGlmaWNhdGWCEOXlUGPKUWecQRdli5
// GD44owDQYJKoZIhvcNAQEEBQADgYEAZuZaFDGDJogh7FuT0hfaMAVlRONv6wWVBJVV++eUo38Xu
// RfJ5nNJ0UnhiV2sEtLobYBPEIrNhuk8skdU0AHgx4ILiA4rR96ifWwxtrFQF+h+DL2ZB7xhwcOJ
// +Pa7IC4wIaEp/oBmmX+JHSzfQt6/If4ohwikfxfljKMyIcMlwl4=</X509Certificate></X50
// 9Data></KeyInfo></Signature></PRODUCTS>
//
// Resolved the base Uri and relative Uri to the following:
// http://www.contoso.com/xml
// This sample completed successfully; press Enter to exit.

Comentários

A XmlDsigC14NTransform classe representa a transformação de canonização XML C14N que descreve a forma canônica de um documento XML. Essa transformação permite que um signatário crie um resumo (usado para criar uma assinatura digital) usando a forma canônica de um documento XML. Um destinatário pode verificar a assinatura digital XML usando a mesma forma canônica do documento XML com a mesma transformação.

Use a XmlDsigC14NTransform classe quando precisar assinar um documento XML que não contenha comentários.

Na maioria dos casos, uma nova instância de uma classe de transformação de canonicalização não é necessária. Para especificar uma transformação de canonicalização, passe o URI (Uniform Resource Identifier) que descreve a transformação para a CanonicalizationMethod propriedade , que pode ser acessada pela SignedInfo propriedade . Para adquirir uma referência à transformação de canonicalização, use a CanonicalizationMethodObject propriedade , que pode ser acessada pela SignedInfo propriedade .

O URI que descreve a XmlDsigC14NTransform classe é definido pelo XmlDsigC14NTransformUrl campo e pelo XmlDsigCanonicalizationUrl campo .

Você só precisaria criar uma nova instância de uma classe de transformação de canonicalização para fazer hash manual de um documento XML ou para usar seu próprio algoritmo de canonicalização.

Para obter mais informações sobre a transformação C14N, consulte As seções 6.5 e 6.6.1 da especificação XMLDSIG do W3C. O algoritmo de canonicalização é definido na especificação XML canônica do W3C.

Construtores

XmlDsigC14NTransform()

Inicializa uma nova instância da classe XmlDsigC14NTransform.

XmlDsigC14NTransform(Boolean)

Inicializa uma nova instância da classe XmlDsigC14NTransform com comentários, se especificado.

Propriedades

Algorithm

Obtém ou define o URI (Uniform Resource Identifier) que identifica o algoritmo executado pela transformação atual.

(Herdado de Transform)
Context

Obtém ou define um objeto XmlElement que representa o contexto do documento em que o objeto Transform atual está em execução.

(Herdado de Transform)
InputTypes

Obtém uma matriz de tipos que são entradas válidas para o método LoadInput(Object) do objeto XmlDsigC14NTransform atual.

OutputTypes

Obtém uma matriz de tipos que são possíveis saídas provenientes de métodos GetOutput() do objeto XmlDsigC14NTransform atual.

PropagatedNamespaces

Obtém ou define um objeto Hashtable que contém os namespaces propagados na assinatura.

(Herdado de Transform)
Resolver

Define o objeto XmlResolver atual.

(Herdado de Transform)

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetDigestedOutput(HashAlgorithm)

Retorna o resumo associado a um objeto XmlDsigC14NTransform.

GetDigestedOutput(HashAlgorithm)

Quando substituído em uma classe derivada, retorna o resumo da mensagem associado a um objeto Transform.

(Herdado de Transform)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetInnerXml()

Retorna uma representação XML dos parâmetros de um objeto XmlDsigC14NTransform adequados para serem incluídos como subelementos de um elemento <Transform> XMLDSIG.

GetOutput()

Retorna a saída do objeto XmlDsigC14NTransform atual.

GetOutput(Type)

Retorna a saída do objeto XmlDsigC14NTransform atual do tipo Stream.

GetType()

Obtém o Type da instância atual.

(Herdado de Object)
GetXml()

Retorna a representação XML do objeto Transform atual.

(Herdado de Transform)
LoadInnerXml(XmlNodeList)

Analisa o objeto XmlNodeList especificado como conteúdo específico de transformação de um elemento <Transform>; este método não tem suporte porque esse elemento não tem nenhum elemento XML interno.

LoadInput(Object)

Carrega a entrada especificada no objeto XmlDsigC14NTransform atual.

MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Produto Versões
.NET 8 (package-provided), 9 (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 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9