CipherData Class
Represents the <CipherData> element in XML encryption. This class cannot be inherited.
Assembly: System.Security (in System.Security.dll)
The CipherData type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | CipherData() | Initializes a new instance of the CipherData class. |
![]() | CipherData(array<Byte>) | Initializes a new instance of the CipherData class using a byte array as the CipherValue value. |
![]() | CipherData(CipherReference) | Initializes a new instance of the CipherData class using a CipherReference object. |
| Name | Description | |
|---|---|---|
![]() | CipherReference | Gets or sets the <CipherReference> element. |
![]() | CipherValue | Gets or sets the <CipherValue> element. |
| 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 | Gets the XML values for the CipherData object. |
![]() | LoadXml | Loads XML data from an XmlElement into a CipherData object. |
![]() | 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 CipherData class represents the <CipherData> element in XML encryption. It is a required element that provides the encrypted data. It must either contain the encrypted data as base64-encoded text of the <CipherValue> element, or provide a reference to an external location containing the encrypted data using the <CipherReference> element.
In many cases, you do not need to directly create a new instance of the CipherData class. The EncryptedXml, EncryptedData, and EncryptedKey classes create instances for you.
Note |
|---|
A CipherData object can have either a CipherReference property or a CipherValue property, but not both. A CryptographicException is thrown if both are assigned to a CipherData object. |
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 uses the EncryptedData class to create an <EncryptedData> element that contains a <CipherData> element, and then writes the XML to an XML file.
#using <System.Xml.dll> #using <System.Security.dll> using namespace System; using namespace System::Xml; using namespace System::Security::Cryptography; using namespace System::Security::Cryptography::Xml; using namespace System::IO; /// This sample used the EncryptedData class to create a EncryptedData element /// and write it to an XML file. int main() { // Create a new CipherData object. CipherData^ cipher = gcnew CipherData(); // Assign a byte array to be the CipherValue. This is a // byte array representing encrypted data. cipher->CipherValue = gcnew array<Byte>(8); // Create a new EncryptedData object. EncryptedData^ encryptionRoot = gcnew EncryptedData(); //Add an encryption method to the object. encryptionRoot->Id = "ED"; encryptionRoot->EncryptionMethod = gcnew EncryptionMethod( "http://www.w3.org/2001/04/xmlenc#aes128-cbc"); encryptionRoot->CipherData = cipher; //Add key information to the object. KeyInfo^ keyDetails = gcnew KeyInfo(); keyDetails->AddClause(gcnew KeyInfoRetrievalMethod("#EK", "http://www.w3.org/2001/04/xmlenc#EncryptedKey")); encryptionRoot->KeyInfo = keyDetails; // Create new XML document and put encrypted data into it. XmlDocument^ doc = gcnew XmlDocument(); XmlElement^ encryptionPropertyElement = doc->CreateElement("EncryptionProperty", EncryptedXml::XmlEncNamespaceUrl); EncryptionProperty^ property = gcnew EncryptionProperty( encryptionPropertyElement); encryptionRoot->AddProperty(property); // Output the resulting XML information into a file. String^ path = "test.xml"; try { File::WriteAllText(path, encryptionRoot->GetXml()->OuterXml); } catch (IOException^ ex) { Console::WriteLine("There was an error writing to {0}", path); Console::WriteLine(ex->Message); } //Console.WriteLine(ed.GetXml().OuterXml); }
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.
