Lire en anglais

Partager via


XmlDsigExcC14NTransform Classe

Définition

Représente la transformation, sans commentaires, selon les spécifications de canonisation (C14N) XML exclusive d'une signature numérique définies par le W3C (World Wide Web Consortium).

public class XmlDsigExcC14NTransform : System.Security.Cryptography.Xml.Transform
Héritage
XmlDsigExcC14NTransform
Dérivé

Exemples

L’exemple de code suivant montre comment signer un document XML avec la classe à l’aide XmlDsigExcC14NTransform d’une signature d’enveloppe.

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

        // Set the InclusiveNamespacesPrefixList property.
        XmlDsigExcC14NTransform canMethod = (XmlDsigExcC14NTransform)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();
    }
}

Remarques

La XmlDsigExcC14NTransform classe représente la transformation de canonisation XML C14N exclusive sans commentaires. Cette classe est similaire à la XmlDsigC14NTransform classe , qui permet à un signataire de créer un condensé à l’aide de la forme canonique d’un document XML. Toutefois, la classe exclut le XmlDsigExcC14NTransform contexte ancêtre d’un sous-document canonique.

Utilisez la XmlDsigC14NTransform classe lorsque vous devez canoniser un sous-document XML afin qu’il soit indépendant de son contexte XML. Par exemple, les applications telles que les services Web qui utilisent du code XML signé dans des protocoles de communication complexes doivent souvent canoniser le code XML de cette manière. Ces applications enveloppent souvent du code XML dans divers éléments construits dynamiquement, ce qui peut modifier considérablement le document et entraîner l’échec de la vérification de la signature XML. La XmlDsigExcC14NTransform classe résout ce problème en excluant ce contexte ancêtre du sous-document canonique.

En règle générale, vous ne créez pas de instance d’une classe de transformation de canonique. Pour spécifier une transformation de canonique, transmettez l’URI (Uniform Resource Identifier) qui décrit une transformation à la CanonicalizationMethod propriété, qui est accessible à partir de la SignedInfo propriété . Pour acquérir une référence à la transformation de canonisation, utilisez la CanonicalizationMethodObject propriété , qui est accessible à partir de la SignedInfo propriété .

Vous devez créer une nouvelle instance d’une classe de transformation de canonicalisation uniquement lorsque vous souhaitez hacher manuellement un document XML ou utiliser votre propre algorithme de canonique.

L’URI qui décrit la XmlDsigExcC14NWithCommentsTransform classe est défini par le XmlDsigExcC14NWithCommentsTransformUrl champ .

L’URI qui décrit la XmlDsigExcC14NTransform classe est défini par le XmlDsigExcC14NTransformUrl champ .

Pour plus d’informations sur la transformation C14N exclusive, consultez la spécification XMLDSIG du W3C. L’algorithme de canonisation est défini dans la spécification XML canonique du W3C.

Constructeurs

XmlDsigExcC14NTransform()

Initialise une nouvelle instance de la classe XmlDsigExcC14NTransform.

XmlDsigExcC14NTransform(Boolean)

Initialise une nouvelle instance de la classe XmlDsigExcC14NTransform en spécifiant une valeur qui détermine s'il faut inclure des commentaires.

XmlDsigExcC14NTransform(Boolean, String)

Initialise une nouvelle instance de la classe XmlDsigExcC14NTransform en spécifiant s'il faut inclure des commentaires, ainsi qu'une liste de préfixes d'espace de noms.

XmlDsigExcC14NTransform(String)

Initialise une nouvelle instance de la classe XmlDsigExcC14NTransform en spécifiant une liste de préfixes d'espace de noms à canoniser à l'aide de l'algorithme canonisation standard.

Propriétés

Algorithm

Obtient ou définit l'URI (Uniform Resource Identifier) qui identifie l'algorithme exécuté par la transformation actuelle.

(Hérité de Transform)
Context

Obtient ou définit un objet XmlElement qui représente le contexte de document dans lequel l'objet Transform actuel est exécuté.

(Hérité de Transform)
InclusiveNamespacesPrefixList

Obtient ou définit une chaîne qui contient des préfixes d'espace de noms à canoniser à l'aide de l'algorithme de canonisation standard.

InputTypes

Obtient un tableau de types qui constituent des entrées valides dans les méthodes LoadInput(Object) de l'objet XmlDsigExcC14NTransform en cours.

OutputTypes

Obtient un tableau de types qui constituent des sorties valides des méthodes GetOutput() de l'objet XmlDsigExcC14NTransform en cours.

PropagatedNamespaces

Obtient ou définit un objet Hashtable qui contient les espaces de noms qui sont propagés dans la signature.

(Hérité de Transform)
Resolver

Définit l'objet XmlResolver en cours.

(Hérité de Transform)

Méthodes

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
GetDigestedOutput(HashAlgorithm)

Retourne le Digest associé à un objet XmlDsigExcC14NTransform.

GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetInnerXml()

Retourne une représentation XML des paramètres d'un objet XmlDsigExcC14NTransform pouvant être inclus comme sous-éléments d'un élément <Transform> XMLDSIG.

GetOutput()

Retourne la sortie de l'objet XmlDsigExcC14NTransform en cours.

GetOutput(Type)

Retourne la sortie de l'objet XmlDsigExcC14NTransform en cours en tant qu'objet du type spécifié.

GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
GetXml()

Retourne la représentation XML de l'objet Transform en cours.

(Hérité de Transform)
LoadInnerXml(XmlNodeList)

Analyse l'objet XmlNodeList spécifié en tant que contenu propre à la transformation d'un élément <Transform> et configure l'état interne de l'objet XmlDsigExcC14NTransform en cours pour qu'il corresponde à l'élément <Transform>.

LoadInput(Object)

En cas de substitution dans une classe dérivée, charge l'entrée spécifiée dans l'objet XmlDsigExcC14NTransform en cours.

MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.

(Hérité de Object)

S’applique à

Produit Versions
.NET 6, 7, 8, 9
.NET Framework 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
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9