EncryptionPropertyCollection EncryptionPropertyCollection EncryptionPropertyCollection EncryptionPropertyCollection Class

Определение

Представляет коллекцию классов EncryptionProperty, используемых в XML-шифровании.Represents a collection of EncryptionProperty classes used in XML encryption. Этот класс не наследуется.This class cannot be inherited.

public ref class EncryptionPropertyCollection sealed : System::Collections::IList
public sealed class EncryptionPropertyCollection : System.Collections.IList
type EncryptionPropertyCollection = class
    interface IList
    interface ICollection
    interface IEnumerable
Public NotInheritable Class EncryptionPropertyCollection
Implements IList
Наследование
EncryptionPropertyCollectionEncryptionPropertyCollectionEncryptionPropertyCollectionEncryptionPropertyCollection
Реализации

Примеры

В следующем примере кода выполняется шифрование и расшифровка XML-документа.The following code example encrypts and decrypts an XML document. Этот пример EncryptionProperty кода создает объект, который содержит пользовательские сведения EncryptedKey об EncryptionProperty элементе, и EncryptionPropertyCollection добавляет объект в коллекцию EncryptedXml класса.This code example creates an EncryptionProperty object that contains custom information about the EncryptedKey element, and adds the EncryptionProperty object to the EncryptionPropertyCollection collection of the EncryptedXml class. Наконец, в EncryptionProperty этом примере кода отображаются сведения об объекте EncryptionPropertyCollection и коллекции.Finally, this code example displays information about the EncryptionProperty object and the EncryptionPropertyCollection collection.

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 = new RSACryptoServiceProvider();


        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 Rijndael key.
        RijndaelManaged sessionKey = new RijndaelManaged();
        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);
    }

}
Imports System.Xml
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml



Module Program

    Sub Main(ByVal args() As String)

        ' Create an XmlDocument object.
        Dim xmlDoc As New XmlDocument()

        ' Load an XML file into the XmlDocument object.
        Try
            xmlDoc.PreserveWhitespace = True
            xmlDoc.Load("test.xml")
        Catch e As Exception
            Console.WriteLine(e.Message)
        End Try

        ' Create a new RSA key.  This key will encrypt a symmetric key,
        ' which will then be imbedded in the XML document.  
        Dim rsaKey As New RSACryptoServiceProvider()


        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 e As Exception
            Console.WriteLine(e.Message)
        Finally
            ' Clear the RSA key.
            rsaKey.Clear()
        End Try

    End Sub


    Sub Encrypt(ByVal Doc As XmlDocument, ByVal ElementToEncryptValue As String, ByVal Alg As RSA, ByVal KeyName As String)
        ' Check the arguments.  
        If Doc Is Nothing Then
            Throw New ArgumentNullException("Doc")
        End If
        If ElementToEncryptValue Is Nothing Then
            Throw New ArgumentNullException("ElementToEncrypt")
        End If
        If Alg Is Nothing Then
            Throw New ArgumentNullException("Alg")
        End If
        ''''''''''''''''''''''''''''''''''''''''''''''''''
        ' Find the specified element in the XmlDocument
        ' object and create a new XmlElemnt object.
        ''''''''''''''''''''''''''''''''''''''''''''''''''
        Dim elementToEncrypt As XmlElement = Doc.GetElementsByTagName(ElementToEncryptValue)(0)

        ' Throw an XmlException if the element was not found.
        If elementToEncrypt Is Nothing Then
            Throw New XmlException("The specified element was not found")
        End If

        ''''''''''''''''''''''''''''''''''''''''''''''''''
        ' 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 Rijndael key.
        Dim sessionKey As New RijndaelManaged()
        sessionKey.KeySize = 256

        Dim eXml As New EncryptedXml()

        Dim encryptedElement As Byte() = eXml.EncryptData(elementToEncrypt, sessionKey, False)

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

        Dim edElement As 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.
        Dim ek As New EncryptedKey()

        Dim encryptedKey As Byte() = 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. 
        Dim element As XmlElement = 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. 
        Dim encProp As 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.
        Dim kin As 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)

    End Sub


    Sub Decrypt(ByVal Doc As XmlDocument, ByVal Alg As RSA, ByVal KeyName As String)
        ' Check the arguments.  
        If Doc Is Nothing Then
            Throw New ArgumentNullException("Doc")
        End If
        If Alg Is Nothing Then
            Throw New ArgumentNullException("Alg")
        End If
        If KeyName Is Nothing Then
            Throw New ArgumentNullException("KeyName")
        End If
        ' Create a new EncryptedXml object.
        Dim exml As 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()

    End Sub


    Sub InspectElement(ByVal Doc As XmlDocument)
        ' Get the EncryptedData element from the XMLDocument object.
        Dim encryptedData As XmlElement = Doc.GetElementsByTagName("EncryptedData")(0)

        ' Create a new EncryptedData object.
        Dim encData As 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)

        Dim encPropCollection As EncryptionPropertyCollection = encData.EncryptionProperties

        Console.WriteLine("Number of elements in the EncryptionPropertyCollection: " + encPropCollection.Count.ToString())
        'encPropCollection.
        Dim encProp As EncryptionProperty
        For Each encProp In encPropCollection
            Console.WriteLine("EncryptionProperty.ID: " + encProp.Id)
            Console.WriteLine("EncryptionProperty.PropertyElement: " + encProp.PropertyElement.InnerXml)
            Console.WriteLine("EncryptionProperty.Target: " + encProp.Target)
        Next encProp



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

    End Sub
End Module

Комментарии

Класс инкапсулирует <EncryptionProperty> элемент, определяемый синтаксисом консорциум W3C XML-шифрования и спецификацией обработки. EncryptionPropertyThe EncryptionProperty class encapsulates the <EncryptionProperty> element defined by the World Wide Web Consortium XML Encryption Syntax and Processing specification.

Используйте класс для предоставления дополнительных сведений о шифровании, EncryptedData связанных с EncryptedKey элементами и. EncryptionPropertyUse the EncryptionProperty class to provide additional encryption information related to the EncryptedData and EncryptedKey elements. Например, этот класс можно использовать для задания отметки времени.For example, you can use this class to specify a time stamp.

Конструкторы

EncryptionPropertyCollection() EncryptionPropertyCollection() EncryptionPropertyCollection() EncryptionPropertyCollection()

Инициализирует новый экземпляр класса EncryptionPropertyCollection.Initializes a new instance of the EncryptionPropertyCollection class.

Свойства

Count Count Count Count

Получает число элементов, содержащихся в объекте EncryptionPropertyCollection.Gets the number of elements contained in the EncryptionPropertyCollection object.

IsFixedSize IsFixedSize IsFixedSize IsFixedSize

Возвращает значение, указывающее, имеет ли объект EncryptionPropertyCollection фиксированный размер.Gets a value that indicates whether the EncryptionPropertyCollection object has a fixed size.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Возвращает значение, указывающее, является ли объект EncryptionPropertyCollection доступным только для чтения.Gets a value that indicates whether the EncryptionPropertyCollection object is read-only.

IsSynchronized IsSynchronized IsSynchronized IsSynchronized

Получает значение, указывающее, является ли доступ к объекту EncryptionPropertyCollection синхронизированным (потокобезопасным).Gets a value that indicates whether access to the EncryptionPropertyCollection object is synchronized (thread safe).

ItemOf[Int32] ItemOf[Int32] ItemOf[Int32] ItemOf[Int32]

Возвращает или задает объект EncryptionProperty по указанному индексу.Gets or sets the EncryptionProperty object at the specified index.

SyncRoot SyncRoot SyncRoot SyncRoot

Возвращает объект, который позволяет синхронизировать доступ к объекту EncryptionPropertyCollection.Gets an object that can be used to synchronize access to the EncryptionPropertyCollection object.

Методы

Add(EncryptionProperty) Add(EncryptionProperty) Add(EncryptionProperty) Add(EncryptionProperty)

Добавляет объект EncryptionProperty в объект EncryptionPropertyCollection.Adds an EncryptionProperty object to the EncryptionPropertyCollection object.

Clear() Clear() Clear() Clear()

Удаляет все элементы из объекта EncryptionPropertyCollection.Removes all items from the EncryptionPropertyCollection object.

Contains(EncryptionProperty) Contains(EncryptionProperty) Contains(EncryptionProperty) Contains(EncryptionProperty)

Определяет, содержит ли объект EncryptionPropertyCollection определенный объект EncryptionProperty.Determines whether the EncryptionPropertyCollection object contains a specific EncryptionProperty object.

CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32)

Копирует элементы объекта EncryptionPropertyCollection в массив, начиная с определенного индекса.Copies the elements of the EncryptionPropertyCollection object to an array, starting at a particular array index.

CopyTo(EncryptionProperty[], Int32) CopyTo(EncryptionProperty[], Int32) CopyTo(EncryptionProperty[], Int32) CopyTo(EncryptionProperty[], Int32)

Копирует элементы объекта EncryptionPropertyCollection в массив объектов EncryptionProperty, начиная с указанного индекса в массиве.Copies the elements of the EncryptionPropertyCollection object to an array of EncryptionProperty objects, starting at a particular array index.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Возвращает перечислитель, который перебирает элементы объекта EncryptionPropertyCollection.Returns an enumerator that iterates through an EncryptionPropertyCollection object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IndexOf(EncryptionProperty) IndexOf(EncryptionProperty) IndexOf(EncryptionProperty) IndexOf(EncryptionProperty)

Определяет индекс конкретного элемента в объекте EncryptionPropertyCollection.Determines the index of a specific item in the EncryptionPropertyCollection object.

Insert(Int32, EncryptionProperty) Insert(Int32, EncryptionProperty) Insert(Int32, EncryptionProperty) Insert(Int32, EncryptionProperty)

Вставляет объект EncryptionProperty в объект EncryptionPropertyCollection по указанной позиции.Inserts an EncryptionProperty object into the EncryptionPropertyCollection object at the specified position.

Item(Int32) Item(Int32) Item(Int32) Item(Int32)

Возвращает объект EncryptionProperty, расположенный по заданному индексу.Returns the EncryptionProperty object at the specified index.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
Remove(EncryptionProperty) Remove(EncryptionProperty) Remove(EncryptionProperty) Remove(EncryptionProperty)

Удаляет первое вхождение указанного объекта EncryptionProperty из объекта EncryptionPropertyCollection.Removes the first occurrence of a specific EncryptionProperty object from the EncryptionPropertyCollection object.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Удаляет объект EncryptionProperty по указанному индексу.Removes the EncryptionProperty object at the specified index.

ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

IList.Add(Object) IList.Add(Object) IList.Add(Object) IList.Add(Object)

Добавляет элемент в коллекцию IList.Adds an item to the IList.

IList.Contains(Object) IList.Contains(Object) IList.Contains(Object) IList.Contains(Object)

Определяет, содержит ли коллекция IList указанное значение.Determines whether the IList contains a specific value.

IList.IndexOf(Object) IList.IndexOf(Object) IList.IndexOf(Object) IList.IndexOf(Object)

Определяет индекс заданного элемента в списке IList.Determines the index of a specific item in the IList.

IList.Insert(Int32, Object) IList.Insert(Int32, Object) IList.Insert(Int32, Object) IList.Insert(Int32, Object)

Вставляет элемент в список IList по указанному индексу.Inserts an item to the IList at the specified index.

IList.Item[Int32] IList.Item[Int32] IList.Item[Int32] IList.Item[Int32]

Получает элемент с указанным индексом.Gets the element at the specified index.

IList.Remove(Object) IList.Remove(Object) IList.Remove(Object) IList.Remove(Object)

Удаляет первое вхождение указанного объекта из коллекции IList.Removes the first occurrence of a specific object from the IList.

Методы расширения

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

Приводит элементы объекта IEnumerable к заданному типу.Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

Выполняет фильтрацию элементов объекта IEnumerable по заданному типу.Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

Позволяет осуществлять параллельный запрос.Enables parallelization of a query.

AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

Преобразовывает коллекцию IEnumerable в объект IQueryable.Converts an IEnumerable to an IQueryable.

Применяется к