KeyInfoEncryptedKey Class
Wraps the EncryptedKey class, it to be placed as a subelement of the KeyInfo class.
System.Security.Cryptography.Xml::KeyInfoClause
System.Security.Cryptography.Xml::KeyInfoEncryptedKey
Assembly: System.Security (in System.Security.dll)
The KeyInfoEncryptedKey type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | KeyInfoEncryptedKey() | Initializes a new instance of the KeyInfoEncryptedKey class. |
![]() | KeyInfoEncryptedKey(EncryptedKey) | Initializes a new instance of the KeyInfoEncryptedKey class using an EncryptedKey object. |
| Name | Description | |
|---|---|---|
![]() | EncryptedKey | Gets or sets an EncryptedKey object that encapsulates an encrypted key. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetXml | Returns an XML representation of a KeyInfoEncryptedKey object. (Overrides KeyInfoClause::GetXml().) |
![]() | LoadXml | Parses the input XmlElement object and configures the internal state of the KeyInfoEncryptedKey object to match. (Overrides KeyInfoClause::LoadXml(XmlElement).) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
The KeyInfoEncryptedKey class wraps the EncryptedKey class, which allows you to add the EncryptedKey class as a subelement of the KeyInfo class. Initialize the KeyInfoEncryptedKey class to an instance of the EncryptedKey class when you need to add an encrypted session key to your encrypted XML document.
Note |
|---|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document.
#using <System.Xml.dll> #using <System.Security.dll> #using <System.dll> using namespace System; using namespace System::Xml; using namespace System::Security::Cryptography; using namespace System::Security::Cryptography::Xml; static void Encrypt( XmlDocument^ Doc, String^ ElementToEncrypt, RSA^ Alg, String^ KeyName ) { // Check the arguments. if ( Doc == nullptr ) throw gcnew ArgumentNullException( L"Doc" ); if ( ElementToEncrypt == nullptr ) throw gcnew ArgumentNullException( L"ElementToEncrypt" ); if ( Alg == nullptr ) throw gcnew ArgumentNullException( L"Alg" ); //////////////////////////////////////////////// // Find the specified element in the XmlDocument // object and create a new XmlElemnt object. //////////////////////////////////////////////// XmlElement^ elementToEncrypt = dynamic_cast<XmlElement^>(Doc->GetElementsByTagName( ElementToEncrypt )->Item( 0 )); // Throw an XmlException if the element was not found. if ( elementToEncrypt == nullptr ) { throw gcnew XmlException( L"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 = gcnew RijndaelManaged; sessionKey->KeySize = 256; EncryptedXml^ eXml = gcnew EncryptedXml; array<Byte>^encryptedElement = eXml->EncryptData( elementToEncrypt, sessionKey, false ); //////////////////////////////////////////////// // Construct an EncryptedData object and populate // it with the desired encryption information. //////////////////////////////////////////////// EncryptedData^ edElement = gcnew EncryptedData; edElement->Type = EncryptedXml::XmlEncElementUrl; // Create an EncryptionMethod element so that the // receiver knows which algorithm to use for decryption. edElement->EncryptionMethod = gcnew EncryptionMethod( EncryptedXml::XmlEncAES256Url ); // Encrypt the session key and add it to an EncryptedKey element. EncryptedKey^ ek = gcnew EncryptedKey; array<Byte>^encryptedKey = EncryptedXml::EncryptKey( sessionKey->Key, Alg, false ); ek->CipherData = gcnew CipherData( encryptedKey ); ek->EncryptionMethod = gcnew EncryptionMethod( EncryptedXml::XmlEncRSA15Url ); // Set the KeyInfo element to specify the // name of the RSA key. // Create a new KeyInfo element. edElement->KeyInfo = gcnew KeyInfo; // Create a new KeyInfoName element. KeyInfoName^ kin = gcnew 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( gcnew 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 ); } static void Decrypt( XmlDocument^ Doc, RSA^ Alg, String^ KeyName ) { // Check the arguments. if ( Doc == nullptr ) throw gcnew ArgumentNullException( L"Doc" ); if ( Alg == nullptr ) throw gcnew ArgumentNullException( L"Alg" ); if ( KeyName == nullptr ) throw gcnew ArgumentNullException( L"KeyName" ); // Create a new EncryptedXml object. EncryptedXml^ exml = gcnew 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(); } int main() { // Create an XmlDocument object. XmlDocument^ xmlDoc = gcnew XmlDocument; // Load an XML file into the XmlDocument object. try { xmlDoc->PreserveWhitespace = true; xmlDoc->Load( L"test.xml" ); } catch ( Exception^ e ) { Console::WriteLine( e->Message ); return 0; } // Create a new RSA key. This key will encrypt a symmetric key, // which will then be imbedded in the XML document. RSA^ rsaKey = gcnew RSACryptoServiceProvider; try { // Encrypt the "creditcard" element. Encrypt( xmlDoc, L"creditcard", rsaKey, L"rsaKey" ); // Display the encrypted XML to the console. Console::WriteLine( L"Encrypted XML:" ); Console::WriteLine(); Console::WriteLine( xmlDoc->OuterXml ); xmlDoc->Save( L"test.xml" ); // Decrypt the "creditcard" element. Decrypt( xmlDoc, rsaKey, L"rsaKey" ); // Display the encrypted XML to the console. Console::WriteLine(); Console::WriteLine( L"Decrypted XML:" ); Console::WriteLine(); Console::WriteLine( xmlDoc->OuterXml ); xmlDoc->Save( L"test.xml" ); } catch ( Exception^ e ) { Console::WriteLine( e->Message ); } finally { // Clear the RSA key. rsaKey->Clear(); } return 1; }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
