EncryptedKey 类

  • 参考

定义

命名空间:
System.Security.Cryptography.Xml
程序集:
System.Security.Cryptography.Xml.dll
程序集:
System.Security.dll
包:
System.Security.Cryptography.Xml v6.0.0
包:
System.Security.Cryptography.Xml v7.0.0
包:
System.Security.Cryptography.Xml v8.0.0
包:
System.Security.Cryptography.Xml v9.0.0-preview.2.24128.5
Source:
EncryptedKey.cs
Source:
EncryptedKey.cs
Source:
EncryptedKey.cs

表示 XML 加密中的 <EncryptedKey> 元素。 此类不能被继承。

public ref class EncryptedKey sealed : System::Security::Cryptography::Xml::EncryptedType
public sealed class EncryptedKey : System.Security.Cryptography.Xml.EncryptedType
type EncryptedKey = class
    inherit EncryptedType
Public NotInheritable Class EncryptedKey
Inherits EncryptedType
继承
Object
EncryptedType
EncryptedKey

示例

下面的示例演示如何使用 EncryptedKey 类加密和解密 XML 元素。 然后，此示例向控制台显示 类的各种属性 EncryptedKey 的值。

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

        // 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 EncryptedKey element from the XMLDocument object.
        XmlElement encryptedKey = Doc.GetElementsByTagName("EncryptedKey")[0] as XmlElement;

        // Create a new EncryptedKey object.
        EncryptedKey k = new EncryptedKey();

        // Load the XML from the document to
        // initialize the EncryptedKey object.
        k.LoadXml(encryptedKey);

        // Display the properties.
        // Most values are Null by default.
        Console.WriteLine("EncryptedKey.KeyInfo: " + k.KeyInfo.GetXml().InnerXml);
        Console.WriteLine("EncryptedKey.Id: " + k.Id);
        Console.WriteLine("EncryptedKey.CarriedKeyName: " + k.CarriedKeyName);
        Console.WriteLine("EncryptedKey.CipherData: " + k.CipherData.GetXml().InnerXml);
        Console.WriteLine("EncryptedKey.Encoding: " + k.Encoding);
        Console.WriteLine("EncryptedKey.EncryptionMethod: " + k.EncryptionMethod.GetXml().InnerXml);
        if (k.EncryptionProperties.Count >= 1)
        {
            Console.WriteLine("EncryptedKey.EncryptionProperties: " + k.EncryptionProperties[0].GetXml().InnerXml);
        }
        Console.WriteLine("EncryptedKey.MimeType: " + k.MimeType);
        Console.WriteLine("EncryptedKey.Recipient: " + k.Recipient);

        if (k.ReferenceList.Count >= 1)
        {
            Console.WriteLine("EncryptedKey.ReferenceList: " + k.ReferenceList[0].GetXml().InnerXml);
        }
    }
}

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 ElementToEncryptParam 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 ElementToEncryptParam 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(ElementToEncryptParam)(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)

        ' 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 EncryptedKey element from the XMLDocument object.
        Dim encryptedKey As XmlElement = Doc.GetElementsByTagName("EncryptedKey")(0)

        ' Create a new EncryptedKey object.
        Dim k As New EncryptedKey()

        ' Load the XML from the document to
        ' initialize the EncryptedKey object.
        k.LoadXml(encryptedKey)

        ' Display the properties.
        ' Most values are Null by default.
        Console.WriteLine("EncryptedKey.KeyInfo: " + k.KeyInfo.GetXml().InnerXml)
        Console.WriteLine("EncryptedKey.Id: " + k.Id)
        Console.WriteLine("EncryptedKey.CarriedKeyName: " + k.CarriedKeyName)
        Console.WriteLine("EncryptedKey.CipherData: " + k.CipherData.GetXml().InnerXml)
        Console.WriteLine("EncryptedKey.Encoding: " + k.Encoding)
        Console.WriteLine("EncryptedKey.EncryptionMethod: " + k.EncryptionMethod.GetXml().InnerXml)
        If k.EncryptionProperties.Count >= 1 Then
            Console.WriteLine("EncryptedKey.EncryptionProperties: " + k.EncryptionProperties(0).GetXml().InnerXml)
        End If
        Console.WriteLine("EncryptedKey.MimeType: " + k.MimeType)
        Console.WriteLine("EncryptedKey.Recipient: " + k.Recipient)

        If k.ReferenceList.Count >= 1 Then
            Console.WriteLine("EncryptedKey.ReferenceList: " + k.ReferenceList(0).GetXml().InnerXml)
        End If

    End Sub
End Module

注解

此类表示 <EncryptedKey> XML 加密中的 元素。 元素 <EncryptedKey> 用于发送加密密钥。 它可以在独立的 XML 文档中创建、放置在应用程序文档中，或作为 元素的<KeyInfo>子元素在 元素内<EncryptedData>。 密钥值始终加密给收件人。 解密后 <EncryptedKey> ，生成的密钥可供算法使用， <EncryptionMethod> 而无需进行任何其他处理。

元素 <EncryptedKey> 类似于 <EncryptedData> 类的 EncryptedData 元素，只不过加密的数据始终是密钥值。

构造函数

EncryptedKey()

初始化 EncryptedKey 类的新实例。

属性

CarriedKeyName

获取或设置 XML 加密中的可选 <CarriedKeyName> 元素。
CipherData

对于 EncryptedType 类的实例，获取或设置 CipherData 值。

(继承自 EncryptedType)
Encoding

获取或设置 XML 加密中某个 EncryptedType 实例的 Encoding 特性。

(继承自 EncryptedType)
EncryptionMethod

获取或设置 XML 加密的 <EncryptionMethod> 元素。

(继承自 EncryptedType)
EncryptionProperties

获取或设置 XML 加密中的 <EncryptionProperties> 元素。

(继承自 EncryptedType)
Id

获取或设置 XML 加密中某个 EncryptedType 实例的 Id 特性。

(继承自 EncryptedType)
KeyInfo

获取或设置 XML 加密中的 <KeyInfo> 元素。

(继承自 EncryptedType)
MimeType

获取或设置 XML 加密中某个 EncryptedType 实例的 MimeType 特性。

(继承自 EncryptedType)
Recipient

获取或设置 XML 加密中的可选 Recipient 属性。
ReferenceList

获取或设置 XML 加密中的 <ReferenceList> 元素。
Type

获取或设置 XML 加密中某个 EncryptedType 实例的 Type 特性。

(继承自 EncryptedType)

方法

AddProperty(EncryptionProperty)

在 XML 加密的当前 EncryptedType 对象中，向 <EncryptedProperties> 元素添加 <EncryptionProperty> 子元素。

(继承自 EncryptedType)
AddReference(DataReference)

将一个 <DataReference> 元素添加到 <ReferenceList> 元素中。
AddReference(KeyReference)

将一个 <KeyReference> 元素添加到 <ReferenceList> 元素中。
Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetType()

获取当前实例的 Type。

(继承自 Object)
GetXml()

返回 EncryptedKey 对象的 XML 表示形式。
LoadXml(XmlElement)

指定的 XML 将信息加载到 XML 加密的 <EncryptedKey> 元素中。
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
ToString()

返回表示当前对象的字符串。

(继承自 Object)

适用于