EncryptionPropertyCollection Klasa

Definicja

Przestrzeń nazw:

System.Security.Cryptography.Xml

Zestaw:

System.Security.Cryptography.Xml.dll

Pakiet:

System.Security.Cryptography.Xml v8.0.0

Źródło:

EncryptionPropertyCollection.cs

Reprezentuje kolekcję klas używanych EncryptionProperty w szyfrowaniu XML. Klasa ta nie może być dziedziczona.

C#

public sealed class EncryptionPropertyCollection : System.Collections.IList

Dziedziczenie

Object

EncryptionPropertyCollection

Implementuje

ICollection IEnumerable IList

Przykłady

Poniższy przykład kodu szyfruje i odszyfrowuje dokument XML. Ten przykładowy kod tworzy EncryptionProperty obiekt zawierający niestandardowe informacje o EncryptedKey elemecie i dodaje EncryptionProperty obiekt do EncryptionPropertyCollection kolekcji EncryptedXml klasy. Na koniec ten przykładowy kod wyświetla informacje o EncryptionProperty obiekcie i kolekcji EncryptionPropertyCollection .

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

Uwagi

Klasa EncryptionProperty hermetyzuje <EncryptionProperty> element zdefiniowany przez specyfikację składni i przetwarzania XML konsorcjum World Wide Web Consortium.

Użyj klasy , EncryptionProperty aby podać dodatkowe informacje dotyczące szyfrowania powiązane z EncryptedData elementami i EncryptedKey . Na przykład można użyć tej klasy do określenia sygnatury czasowej.

Konstruktory

EncryptionPropertyCollection()

Inicjuje nowe wystąpienie klasy EncryptionPropertyCollection.

Właściwości

Count	Pobiera liczbę elementów zawartych w EncryptionPropertyCollection obiekcie.
IsFixedSize	Pobiera wartość wskazującą, czy EncryptionPropertyCollection obiekt ma stały rozmiar.
IsReadOnly	Pobiera wartość wskazującą, czy EncryptionPropertyCollection obiekt jest tylko do odczytu.
IsSynchronized	Pobiera wartość wskazującą, czy dostęp do EncryptionPropertyCollection obiektu jest synchronizowany (bezpieczny wątek).
ItemOf[Int32]	Pobiera lub ustawia EncryptionProperty obiekt w określonym indeksie.
SyncRoot	Pobiera obiekt, który może służyć do synchronizowania dostępu do EncryptionPropertyCollection obiektu.

Metody

Add(EncryptionProperty)	EncryptionProperty Dodaje obiekt do EncryptionPropertyCollection obiektu.
Clear()	Usuwa wszystkie elementy z EncryptionPropertyCollection obiektu.
Contains(EncryptionProperty)	Określa, EncryptionPropertyCollection czy obiekt zawiera określony EncryptionProperty obiekt.
CopyTo(Array, Int32)	Kopiuje elementy EncryptionPropertyCollection obiektu do tablicy, zaczynając od określonego indeksu tablicy.
CopyTo(EncryptionProperty[], Int32)	Kopiuje elementy EncryptionPropertyCollection obiektu do tablicy EncryptionProperty obiektów, zaczynając od określonego indeksu tablicy.
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetEnumerator()	Zwraca moduł wyliczający, który iteruje przez EncryptionPropertyCollection obiekt.
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
IndexOf(EncryptionProperty)	Określa indeks określonego elementu w EncryptionPropertyCollection obiekcie.
Insert(Int32, EncryptionProperty)	EncryptionProperty Wstawia obiekt do EncryptionPropertyCollection obiektu w określonej pozycji.
Item(Int32)	EncryptionProperty Zwraca obiekt w określonym indeksie.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
Remove(EncryptionProperty)	Usuwa pierwsze wystąpienie określonego EncryptionProperty obiektu z EncryptionPropertyCollection obiektu.
RemoveAt(Int32)	EncryptionProperty Usuwa obiekt w określonym indeksie.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Jawne implementacje interfejsu

IList.Add(Object)	Dodaje element do elementu IList.
IList.Contains(Object)	Określa, czy element IList zawiera określoną wartość.
IList.IndexOf(Object)	Określa indeks określonego elementu w elemencie IList.
IList.Insert(Int32, Object)	Wstawia element do IList określonego indeksu.
IList.Item[Int32]	Pobiera element wskazywany przez określony indeks.
IList.Remove(Object)	Usuwa pierwsze wystąpienie określonego obiektu z obiektu IList.

Metody rozszerzania

Dotyczy