EncryptionPropertyCollection EncryptionPropertyCollection EncryptionPropertyCollection EncryptionPropertyCollection Class

定義

表示 XML 加密所使用之 EncryptionProperty 類別的集合。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
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類別會封裝<EncryptionProperty>World Wide Web Consortium 所定義的項目XML 加密語法和處理規格。The EncryptionProperty class encapsulates the <EncryptionProperty> element defined by the World Wide Web Consortium XML Encryption Syntax and Processing specification.

使用EncryptionProperty類別,以提供額外的加密資訊與相關EncryptedDataEncryptedKey項目。Use 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()

取得目前執行個體的 TypeGets 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 的淺層複本 (Shallow Copy)。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)

將項目加入至 IListAdds 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)

將項目插入位於指定索引的 IListInserts 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.

Extension Methods

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)

將轉換IEnumerableIQueryableConverts an IEnumerable to an IQueryable.

適用於