ITimeLimitedDataProtector.Unprotect(Byte[], DateTimeOffset) Method

Definition

Namespace:

Microsoft.AspNetCore.DataProtection

Assembly:

Microsoft.AspNetCore.DataProtection.Extensions.dll

Package:

Microsoft.AspNetCore.DataProtection.Extensions v9.0.0

Source:

ITimeLimitedDataProtector.cs

Cryptographically unprotects a piece of protected data.

public:
 cli::array <System::Byte> ^ Unprotect(cli::array <System::Byte> ^ protectedData, [Runtime::InteropServices::Out] DateTimeOffset % expiration);

public byte[] Unprotect (byte[] protectedData, out DateTimeOffset expiration);

abstract member Unprotect : byte[] * DateTimeOffset -> byte[]

Public Function Unprotect (protectedData As Byte(), ByRef expiration As DateTimeOffset) As Byte()

Parameters

protectedData

Byte[]

The protected data to unprotect.

expiration

DateTimeOffset

An 'out' parameter which upon a successful unprotect operation receives the expiration date of the payload.

Returns

Byte[]

The plaintext form of the protected data.

Exceptions

CryptographicException

Thrown if protectedData is invalid, malformed, or expired.