This documentation is archived and is not being maintained.

EncryptedKey Class

Represents the <EncryptedKey> element in XML encryption. This class cannot be inherited.

System::Object
  System.Security.Cryptography.Xml::EncryptedType
    System.Security.Cryptography.Xml::EncryptedKey

Namespace:  System.Security.Cryptography.Xml
Assembly:  System.Security (in System.Security.dll)

[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class EncryptedKey sealed : public EncryptedType

The EncryptedKey type exposes the following members.

  NameDescription
Public methodEncryptedKeyInitializes a new instance of the EncryptedKey class.
Top

  NameDescription
Public propertyCarriedKeyNameGets or sets the optional <CarriedKeyName> element in XML encryption.
Public propertyCipherDataGets or sets the CipherData value for an instance of an EncryptedType class. (Inherited from EncryptedType.)
Public propertyEncodingGets or sets the Encoding attribute of an EncryptedType instance in XML encryption. (Inherited from EncryptedType.)
Public propertyEncryptionMethodGets or sets the <EncryptionMethod> element for XML encryption. (Inherited from EncryptedType.)
Public propertyEncryptionPropertiesGets or sets the <EncryptionProperties> element in XML encryption. (Inherited from EncryptedType.)
Public propertyIdGets or sets the Id attribute of an EncryptedType instance in XML encryption. (Inherited from EncryptedType.)
Public propertyKeyInfoGets of sets the <KeyInfo> element in XML encryption. (Inherited from EncryptedType.)
Public propertyMimeTypeGets or sets the MimeType attribute of an EncryptedType instance in XML encryption. (Inherited from EncryptedType.)
Public propertyRecipientGets or sets the optional Recipient attribute in XML encryption.
Public propertyReferenceListGets or sets the <ReferenceList> element in XML encryption.
Public propertyTypeGets or sets the Type attribute of an EncryptedType instance in XML encryption. (Inherited from EncryptedType.)
Top

  NameDescription
Public methodAddPropertyAdds an <EncryptionProperty> child element to the <EncryptedProperties> element in the current EncryptedType object in XML encryption. (Inherited from EncryptedType.)
Public methodAddReference(DataReference)Adds a <DataReference> element to the <ReferenceList> element.
Public methodAddReference(KeyReference)Adds a <KeyReference> element to the <ReferenceList> element.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetXmlReturns the XML representation of the EncryptedKey object. (Overrides EncryptedType::GetXml().)
Public methodLoadXmlLoads the specified XML information into the <EncryptedKey> element in XML encryption. (Overrides EncryptedType::LoadXml(XmlElement).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

This class represents the <EncryptedKey> element in XML encryption. The <EncryptedKey> element is used to send encryption keys. It can be created in a stand-alone XML document, be placed within an application document, or be inside an <EncryptedData> element as a child of a <KeyInfo> element. The key value is always encrypted to the recipient. When <EncryptedKey> is decrypted, the resulting key is made available to the <EncryptionMethod> algorithm without any additional processing.

The <EncryptedKey> element is similar to the <EncryptedData> element of the EncryptedData class except that the data encrypted is always a key value.

NoteNote

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 example illustrates how to encrypt and decrypt an XML element by using the EncryptedKey class. This example then displays the values of various properties of the EncryptedKey class to the console.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: