EncryptedKey Class

.NET Framework (current version)

Other Versions

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

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

Inheritance Hierarchy

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

Syntax

C++

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

Constructors

	Name	Description
	EncryptedKey()	Initializes a new instance of the EncryptedKey class.

Properties

	Name	Description
	CarriedKeyName	Gets or sets the optional <CarriedKeyName> element in XML encryption.
	CipherData	Gets or sets the CipherData value for an instance of an EncryptedType class.(Inherited from EncryptedType.)
	Encoding	Gets or sets the Encoding attribute of an EncryptedType instance in XML encryption.(Inherited from EncryptedType.)
	EncryptionMethod	Gets or sets the <EncryptionMethod> element for XML encryption.(Inherited from EncryptedType.)
	EncryptionProperties	Gets or sets the <EncryptionProperties> element in XML encryption.(Inherited from EncryptedType.)
	Id	Gets or sets the Id attribute of an EncryptedType instance in XML encryption.(Inherited from EncryptedType.)
	KeyInfo	Gets of sets the <KeyInfo> element in XML encryption.(Inherited from EncryptedType.)
	MimeType	Gets or sets the MimeType attribute of an EncryptedType instance in XML encryption.(Inherited from EncryptedType.)
	Recipient	Gets or sets the optional Recipient attribute in XML encryption.
	ReferenceList	Gets or sets the <ReferenceList> element in XML encryption.
	Type	Gets or sets the Type attribute of an EncryptedType instance in XML encryption.(Inherited from EncryptedType.)

Methods

	Name	Description
	AddProperty(EncryptionProperty^)	Adds an <EncryptionProperty> child element to the <EncryptedProperties> element in the current EncryptedType object in XML encryption.(Inherited from EncryptedType.)
	AddReference(DataReference^)	Adds a <DataReference> element to the <ReferenceList> element.
	AddReference(KeyReference^)	Adds a <KeyReference> element to the <ReferenceList> element.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetXml()	Returns the XML representation of the EncryptedKey object.(Overrides EncryptedType::GetXml().)
	LoadXml(XmlElement^)	Loads the specified XML information into the <EncryptedKey> element in XML encryption.(Overrides EncryptedType::LoadXml(XmlElement^).)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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.

Examples

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.

C++

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

Version Information

.NET Framework
Available since 2.0

Thread Safety

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