EncryptionPropertyCollection Clase

Definición

Espacio de nombres:

System.Security.Cryptography.Xml

Ensamblado:

System.Security.Cryptography.Xml.dll

Paquete:

System.Security.Cryptography.Xml v8.0.0

Source:

EncryptionPropertyCollection.cs

Representa una colección de clases EncryptionProperty utilizada en cifrado XML. Esta clase no puede heredarse.

C#

public sealed class EncryptionPropertyCollection : System.Collections.IList

Herencia

Object

EncryptionPropertyCollection

Implementaciones

ICollection IEnumerable IList

Ejemplos

En el ejemplo de código siguiente se cifra y descifra un documento XML. En este ejemplo de código se crea un EncryptionProperty objeto que contiene información personalizada sobre el EncryptedKey elemento y se agrega el EncryptionProperty objeto a la EncryptionPropertyCollection colección de la EncryptedXml clase . Por último, en este ejemplo de código se muestra información sobre el EncryptionProperty objeto y la EncryptionPropertyCollection colección.

C#

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

Comentarios

La EncryptionProperty clase encapsula el <EncryptionProperty> elemento definido por la especificación de procesamiento y sintaxis de cifrado XML de World Wide Web Consortium.

Use la EncryptionProperty clase para proporcionar información de cifrado adicional relacionada con los EncryptedData elementos y EncryptedKey . Por ejemplo, puede usar esta clase para especificar una marca de tiempo.

Constructores

EncryptionPropertyCollection()

Inicializa una nueva instancia de la clase EncryptionPropertyCollection.

Propiedades

Count	Obtiene el número de elementos contenido en el objeto EncryptionPropertyCollection.
IsFixedSize	Obtiene un valor que indica si el objeto EncryptionPropertyCollection tiene un tamaño fijo.
IsReadOnly	Obtiene un valor que indica si el objeto EncryptionPropertyCollection es de solo lectura.
IsSynchronized	Obtiene un valor que indica si el acceso al objeto EncryptionPropertyCollection está sincronizado (es seguro para la ejecución de subprocesos).
ItemOf[Int32]	Obtiene o establece el objeto EncryptionProperty que se encuentra en el índice especificado.
SyncRoot	Obtiene un objeto que puede utilizarse para sincronizar el acceso al objeto EncryptionPropertyCollection.

Métodos

Add(EncryptionProperty)	Agrega un objeto EncryptionProperty al objeto EncryptionPropertyCollection.
Clear()	Quita todos los elementos del objeto EncryptionPropertyCollection.
Contains(EncryptionProperty)	Determina si el objeto EncryptionPropertyCollection contiene un objeto EncryptionProperty específico.
CopyTo(Array, Int32)	Copia los elementos del objeto EncryptionPropertyCollection en una matriz, que empieza en un índice de matriz en particular.
CopyTo(EncryptionProperty[], Int32)	Copia los elementos del objeto EncryptionPropertyCollection en una matriz de EncryptionProperty objetos, empezando por un índice de matriz determinado.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetEnumerator()	Devuelve un enumerador que recorre en iteración un objeto EncryptionPropertyCollection.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IndexOf(EncryptionProperty)	Determina el índice de un elemento específico del objeto EncryptionPropertyCollection.
Insert(Int32, EncryptionProperty)	Inserta un objeto EncryptionProperty en el objeto EncryptionPropertyCollection en la posición especificada.
Item(Int32)	Devuelve el objeto EncryptionProperty situado en el índice especificado.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
Remove(EncryptionProperty)	Quita la primera aparición de un objeto específico EncryptionProperty del objeto EncryptionPropertyCollection.
RemoveAt(Int32)	Quita el objeto EncryptionProperty en el índice especificado.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

IList.Add(Object)	Agrega un elemento a IList.
IList.Contains(Object)	Determina si IList contiene un valor específico.
IList.IndexOf(Object)	Determina el índice de un elemento específico de IList.
IList.Insert(Int32, Object)	Inserta un elemento en la interfaz IList, en el índice especificado.
IList.Item[Int32]	Obtiene el elemento en el índice especificado.
IList.Remove(Object)	Quita la primera aparición de un objeto específico de la interfaz IList.

Métodos de extensión

Se aplica a