EncryptedXml.DecryptEncryptedKey(EncryptedKey) Method

Definition

Namespace:

System.Security.Cryptography.Xml

Assembly:

System.Security.Cryptography.Xml.dll

Package:

System.Security.Cryptography.Xml v9.0.0-preview.3.24172.9

Source:

EncryptedXml.cs

Determines the key represented by the EncryptedKey element.

public:
 virtual cli::array <System::Byte> ^ DecryptEncryptedKey(System::Security::Cryptography::Xml::EncryptedKey ^ encryptedKey);

public virtual byte[]? DecryptEncryptedKey (System.Security.Cryptography.Xml.EncryptedKey encryptedKey);

abstract member DecryptEncryptedKey : System.Security.Cryptography.Xml.EncryptedKey -> byte[]
override this.DecryptEncryptedKey : System.Security.Cryptography.Xml.EncryptedKey -> byte[]

Public Overridable Function DecryptEncryptedKey (encryptedKey As EncryptedKey) As Byte()

Parameters

encryptedKey

EncryptedKey

The EncryptedKey object that contains the key to retrieve.

Returns

Byte[]

A byte array that contains the key.

Exceptions

ArgumentNullException

The value of the encryptedKey parameter is null.

CryptographicException

The value of the encryptedKey parameter is not the Triple DES Key Wrap algorithm or the Advanced Encryption Standard (AES) Key Wrap algorithm (also called Rijndael).

Remarks

The DecryptEncryptedKey method decrypts an encrypted key contained within the <EncryptedKey> element of an XML document.

This recursive method finds the key represented by the EncryptedKey object. Note that an EncryptedKey object can contain another EncryptedKey object that specifies its KeyInfo value.