EncryptionPropertyCollection Classe

Definizione

Spazio dei nomi:

System.Security.Cryptography.Xml

Assembly:

System.Security.Cryptography.Xml.dll

Pacchetto:

System.Security.Cryptography.Xml v8.0.0

Origine:

EncryptionPropertyCollection.cs

Rappresenta un insieme delle classi EncryptionProperty utilizzate nella crittografia XML. La classe non può essere ereditata.

public sealed class EncryptionPropertyCollection : System.Collections.IList

Ereditarietà

Object

EncryptionPropertyCollection

Implementazioni

ICollection IEnumerable IList

Esempio

Nell'esempio di codice seguente viene crittografato e decrittografato un documento XML. In questo esempio di codice viene creato un EncryptionProperty oggetto contenente informazioni personalizzate sull'elemento EncryptedKey e viene aggiunto l'oggetto EncryptionProperty all'insieme EncryptionPropertyCollection della EncryptedXml classe . In questo esempio di codice vengono infine visualizzate informazioni sull'oggetto EncryptionProperty e sulla EncryptionPropertyCollection raccolta.

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

class Program
{
    static void Main(string[] args)
    {

        // Create an XmlDocument object.
        XmlDocument xmlDoc = new XmlDocument();

        // Load an XML file into the XmlDocument object.
        try
        {
            xmlDoc.PreserveWhitespace = true;
            xmlDoc.Load("test.xml");
        }
        catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }

        // Create a new RSA key.  This key will encrypt a symmetric key,
        // which will then be imbedded in the XML document.
        RSA rsaKey = RSA.Create();

        try
        {
            // Encrypt the "creditcard" element.
            Encrypt(xmlDoc, "creditcard", rsaKey, "rsaKey");

            // Inspect the EncryptedKey element.
            InspectElement(xmlDoc);

            // Decrypt the "creditcard" element.
            Decrypt(xmlDoc, rsaKey, "rsaKey");
        }
        catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }
        finally
        {
            // Clear the RSA key.
            rsaKey.Clear();
        }
    }

    public static void Encrypt(XmlDocument Doc, string ElementToEncrypt, RSA Alg, string KeyName)
    {
        // Check the arguments.
        if (Doc == null)
            throw new ArgumentNullException("Doc");
        if (ElementToEncrypt == null)
            throw new ArgumentNullException("ElementToEncrypt");
        if (Alg == null)
            throw new ArgumentNullException("Alg");

        ////////////////////////////////////////////////
        // Find the specified element in the XmlDocument
        // object and create a new XmlElemnt object.
        ////////////////////////////////////////////////

        XmlElement elementToEncrypt = Doc.GetElementsByTagName(ElementToEncrypt)[0] as XmlElement;

        // Throw an XmlException if the element was not found.
        if (elementToEncrypt == null)
        {
            throw new XmlException("The specified element was not found");
        }

        //////////////////////////////////////////////////
        // Create a new instance of the EncryptedXml class
        // and use it to encrypt the XmlElement with the
        // a new random symmetric key.
        //////////////////////////////////////////////////

        // Create a 256 bit Aes key.
        Aes sessionKey = Aes.Create();
        sessionKey.KeySize = 256;

        EncryptedXml eXml = new EncryptedXml();

        byte[] encryptedElement = eXml.EncryptData(elementToEncrypt, sessionKey, false);

        ////////////////////////////////////////////////
        // Construct an EncryptedData object and populate
        // it with the desired encryption information.
        ////////////////////////////////////////////////

        EncryptedData edElement = new EncryptedData();
        edElement.Type = EncryptedXml.XmlEncElementUrl;

        // Create an EncryptionMethod element so that the
        // receiver knows which algorithm to use for decryption.

        edElement.EncryptionMethod = new EncryptionMethod(EncryptedXml.XmlEncAES256Url);

        // Encrypt the session key and add it to an EncryptedKey element.
        EncryptedKey ek = new EncryptedKey();

        byte[] encryptedKey = EncryptedXml.EncryptKey(sessionKey.Key, Alg, false);

        ek.CipherData = new CipherData(encryptedKey);

        ek.EncryptionMethod = new EncryptionMethod(EncryptedXml.XmlEncRSA15Url);

        // Save some more information about the key using
        // the EncryptionProperty element.  In this example,
        // we will save the value "LibVersion1".  You can save
        // anything you want here.

        // Create a new "EncryptionProperty" XmlElement object.
        XmlElement element =  new XmlDocument().CreateElement("EncryptionProperty", EncryptedXml.XmlEncNamespaceUrl);

        // Set the value of the EncryptionProperty" XmlElement object.
        element.InnerText = "LibVersion1";

        // Create the EncryptionProperty object using the XmlElement object.
        EncryptionProperty encProp = new EncryptionProperty(element);

        // Add the EncryptionProperty object to the EncryptedData object.
        edElement.AddProperty(encProp);

        // Set the KeyInfo element to specify the
        // name of the RSA key.

        // Create a new KeyInfo element.
        edElement.KeyInfo = new KeyInfo();

        // Create a new KeyInfoName element.
        KeyInfoName kin = new KeyInfoName();

        // Specify a name for the key.
        kin.Value = KeyName;

        // Add the KeyInfoName element to the
        // EncryptedKey object.
        ek.KeyInfo.AddClause(kin);

        // Add the encrypted key to the
        // EncryptedData object.

        edElement.KeyInfo.AddClause(new KeyInfoEncryptedKey(ek));

        // Add the encrypted element data to the
        // EncryptedData object.
        edElement.CipherData.CipherValue = encryptedElement;

        ////////////////////////////////////////////////////
        // Replace the element from the original XmlDocument
        // object with the EncryptedData element.
        ////////////////////////////////////////////////////

        EncryptedXml.ReplaceElement(elementToEncrypt, edElement, false);
    }

    public static void Decrypt(XmlDocument Doc, RSA Alg, string KeyName)
    {
        // Check the arguments.
        if (Doc == null)
            throw new ArgumentNullException("Doc");
        if (Alg == null)
            throw new ArgumentNullException("Alg");
        if (KeyName == null)
            throw new ArgumentNullException("KeyName");

        // Create a new EncryptedXml object.
        EncryptedXml exml = new EncryptedXml(Doc);

        // Add a key-name mapping.
        // This method can only decrypt documents
        // that present the specified key name.
        exml.AddKeyNameMapping(KeyName, Alg);

        // Decrypt the element.
        exml.DecryptDocument();
    }

    static void InspectElement(XmlDocument Doc)
    {
        // Get the EncryptedData element from the XMLDocument object.
        XmlElement encryptedData = Doc.GetElementsByTagName("EncryptedData")[0] as XmlElement;

        // Create a new EncryptedData object.
        EncryptedData encData = new EncryptedData();

        // Load the XML from the document to
        // initialize the EncryptedData object.
        encData.LoadXml(encryptedData);

        // Display the properties.
        // Most values are Null by default.

        Console.WriteLine("EncryptedData.CipherData: " + encData.CipherData.GetXml().InnerXml);
        Console.WriteLine("EncryptedData.Encoding: " + encData.Encoding);
        Console.WriteLine("EncryptedData.EncryptionMethod: " + encData.EncryptionMethod.GetXml().InnerXml);

        EncryptionPropertyCollection encPropCollection = encData.EncryptionProperties;

        Console.WriteLine("Number of elements in the EncryptionPropertyCollection: " + encPropCollection.Count);
        //encPropCollection.

        foreach(EncryptionProperty encProp in encPropCollection)
        {
                Console.WriteLine("EncryptionProperty.ID: " + encProp.Id);
                Console.WriteLine("EncryptionProperty.PropertyElement: " + encProp.PropertyElement.InnerXml);
                Console.WriteLine("EncryptionProperty.Target: " + encProp.Target);
        }

        Console.WriteLine("EncryptedData.Id: " + encData.Id);
        Console.WriteLine("EncryptedData.KeyInfo: " + encData.KeyInfo.GetXml().InnerXml);
        Console.WriteLine("EncryptedData.MimeType: " + encData.MimeType);
    }
}

Commenti

La EncryptionProperty classe incapsula l'elemento <EncryptionProperty> definito dalla sintassi e dalla specifica di elaborazione XML del World Wide Web Consortium.

Usare la EncryptionProperty classe per fornire informazioni di crittografia aggiuntive correlate agli EncryptedData elementi e EncryptedKey . Ad esempio, è possibile usare questa classe per specificare un timestamp.

Costruttori

EncryptionPropertyCollection()

Inizializza una nuova istanza della classe EncryptionPropertyCollection.

Proprietà

Count	Ottiene il numero di elementi contenuti nell'oggetto EncryptionPropertyCollection.
IsFixedSize	Ottiene un valore che indica se le dimensioni dell'oggetto EncryptionPropertyCollection sono fisse.
IsReadOnly	Ottiene un valore che indica se l'oggetto EncryptionPropertyCollection è di sola lettura.
IsSynchronized	Ottiene un valore che indica se l'accesso all'oggetto EncryptionPropertyCollection è sincronizzato (thread-safe).
ItemOf[Int32]	Ottiene o imposta l'oggetto EncryptionProperty in corrispondenza dell'indice specificato.
SyncRoot	Ottiene un oggetto che può essere usato per sincronizzare l'accesso all'oggetto EncryptionPropertyCollection.

Metodi

Add(EncryptionProperty)	Aggiunge un oggetto EncryptionProperty all’oggetto EncryptionPropertyCollection.
Clear()	Consente di rimuovere tutti gli elementi dall'oggetto EncryptionPropertyCollection.
Contains(EncryptionProperty)	Consente di determinare se l'oggetto EncryptionPropertyCollection contiene un oggetto EncryptionProperty specifico.
CopyTo(Array, Int32)	Consente di copiare gli elementi dell'oggetto EncryptionPropertyCollection in una matrice, iniziando da un particolare indice di matrice.
CopyTo(EncryptionProperty[], Int32)	Copia gli elementi dell'oggetto EncryptionPropertyCollection in una matrice di oggetti EncryptionProperty, iniziando in corrispondenza di un particolare indice della matrice.
Equals(Object)	Determina se l'oggetto specificato è uguale all'oggetto corrente. (Ereditato da Object)
GetEnumerator()	Restituisce un enumeratore che consente di scorrere un oggetto EncryptionPropertyCollection.
GetHashCode()	Funge da funzione hash predefinita. (Ereditato da Object)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IndexOf(EncryptionProperty)	Consente di determinare l'indice di un elemento specifico dell'oggetto EncryptionPropertyCollection.
Insert(Int32, EncryptionProperty)	Consente di inserire un oggetto EncryptionProperty nell'oggetto EncryptionPropertyCollection, in corrispondenza della posizione specificata.
Item(Int32)	Restituisce l'oggetto EncryptionProperty in corrispondenza dell'indice specificato.
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
Remove(EncryptionProperty)	Consente di rimuovere la prima occorrenza di un oggetto EncryptionProperty specifico dall'oggetto EncryptionPropertyCollection.
RemoveAt(Int32)	Consente di rimuovere l'oggetto EncryptionProperty in corrispondenza dell'indice specificato.
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Implementazioni dell'interfaccia esplicita

IList.Add(Object)	Aggiunge un elemento a IList.
IList.Contains(Object)	Stabilisce se IList contiene un valore specifico.
IList.IndexOf(Object)	Determina l'indice di un elemento specifico in IList.
IList.Insert(Int32, Object)	Inserisce un elemento in IList in corrispondenza dell'indice specificato.
IList.Item[Int32]	Ottiene l'elemento in corrispondenza dell'indice specificato.
IList.Remove(Object)	Rimuove la prima occorrenza di un oggetto specifico da IList.

Metodi di estensione

Si applica a