This topic has not yet been rated - Rate this topic

MachineKey.Unprotect Method

.NET Framework 4.5

Unprotects the specified data, which was protected by the Protect method.

Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)

public static byte[] Unprotect(
	byte[] protectedData,
	params string[] purposes
)

Parameters

protectedData: Type: System.Byte[]
The ciphertext data to unprotect.

purposes: Type: System.String[]
A list of purposes that describe what the data is meant for. This must be the same value that was passed to the Protect method when the data was protected.

Return Value

Type: System.Byte[]
The plaintext data.

Exceptions

Exception	Condition
ArgumentNullException	The protectedData parameter is null.
ArgumentException	The purposes array contains one or more whitespace-only entries.
CryptographicException	Possible causes include the following: The protected data was tampered with. The value of the purposes parameter is not the same as the value that was specified when the data was protected. The application is deployed to more than one server and is using auto-generated encryption keys.

Exception

Condition

ArgumentNullException

The protectedData parameter is null.

ArgumentException

The purposes array contains one or more whitespace-only entries.

CryptographicException

Possible causes include the following:

The protected data was tampered with.
The value of the purposes parameter is not the same as the value that was specified when the data was protected.
The application is deployed to more than one server and is using auto-generated encryption keys.

Remarks

For information about this method, see the Protect method.

Version Information

.NET Framework

Supported in: 4.5

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

MachineKey Class

System.Web.Security Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)