EncryptionProperty 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
表示用於 XML 加密的 <EncryptionProperty> 項目。 此類別無法獲得繼承。
public ref class EncryptionProperty sealedpublic sealed class EncryptionPropertytype EncryptionProperty = classPublic NotInheritable Class EncryptionProperty- 繼承
-
EncryptionProperty
範例
下列程式碼範例會加密和解密 XML 檔。 此程式碼範例會 EncryptionProperty 建立 物件，其中包含 專案的相關 EncryptedKey 自訂資訊，並將 物件加入 EncryptionProperty 至 EncryptionPropertyCollection 類別的 EncryptedXml 集合。 最後，此程式碼範例會顯示 物件和 EncryptionPropertyCollection 集合的相關資訊 EncryptionProperty 。
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);
}
}
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 RSA = 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 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 Aes key.
Dim sessionKey As Aes = Aes.Create()
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 加密語法和處理 規格所定義的專案。
EncryptionProperty使用 類別來提供與 和 EncryptedKey 專案相關的 EncryptedData 其他加密資訊。 例如，使用此類別來指定時間戳記。
建構函式
| EncryptionProperty() |
初始化 EncryptionProperty 類別的新執行個體。 |
| EncryptionProperty(XmlElement) |
使用 EncryptionProperty 物件，初始化 XmlElement 類別的新執行個體。 |
屬性
| Id |
取得目前 EncryptionProperty 物件的 ID。 |
| PropertyElement |
取得或設定XmlElement 物件，表示 EncryptionProperty 物件。 |
| Target |
取得 EncryptionProperty 物件的目標。 |
方法
| Equals(Object) |
判斷指定的物件是否等於目前的物件。 (繼承來源 Object) |
| GetHashCode() |
做為預設雜湊函式。 (繼承來源 Object) |
| GetType() |
取得目前執行個體的 Type。 (繼承來源 Object) |
| GetXml() |
傳回 XmlElement 物件，封裝 EncryptionProperty 類別的執行個體。 |
| LoadXml(XmlElement) |
剖析輸入的 XmlElement，並設定 EncryptionProperty 物件的內部狀態來對應。 |
| MemberwiseClone() |
建立目前 Object 的淺層複製。 (繼承來源 Object) |
| ToString() |
傳回代表目前物件的字串。 (繼承來源 Object) |