ProtectedData Class
Provides methods for encrypting and decrypting data. This class cannot be inherited.
Assembly: System.Security (in System.Security.dll)
The ProtectedData type exposes the following members.
This class provides access to the Data Protection API (DPAPI) available in Microsoft Windows 2000 and later operating systems. This is a service that is provided by the operating system and does not require additional libraries. It provides protection using the user or machine credentials to encrypt or decrypt data.
The class consists of two wrappers for the unmanaged DPAPI, Protect and Unprotect. These two methods can be used to encrypt and decrypt data such as passwords, keys, and connection strings.
If you use these methods during impersonation, you may receive the following error: "Key not valid for use in specified state." This occurs because the DPAPI stores the key data in user profiles. If the profile is not loaded, DPAPI won’t be able to perform the decryption. To prevent this error, load the profile of the user you want to impersonate before calling either method. Using DPAPI with impersonation can incur significant complication and requires careful design choices.
Note |
|---|
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. |
| Topic | Location |
|---|---|
| How to: Use Data Protection | .NET Framework: Security |
| How to: Use Data Protection | .NET Framework: Security |
The following example shows how to use data protection.
Imports System Imports System.Security.Cryptography Public Class DataProtectionSample ' Create byte array for additional entropy when using Protect method. Private Shared s_aditionalEntropy As Byte() = {9, 8, 7, 6, 5} Public Shared Sub Main() ' Create a simple byte array containing data to be encrypted. Dim secret As Byte() = {0, 1, 2, 3, 4, 1, 2, 3, 4} 'Encrypt the data. Dim encryptedSecret As Byte() = Protect(secret) Console.WriteLine("The encrypted byte array is:") PrintValues(encryptedSecret) ' Decrypt the data and store in a byte array. Dim originalData As Byte() = Unprotect(encryptedSecret) Console.WriteLine("{0}The original data is:", Environment.NewLine) PrintValues(originalData) End Sub Public Shared Function Protect(ByVal data() As Byte) As Byte() Try ' Encrypt the data using DataProtectionScope.CurrentUser. The result can be decrypted ' only by the same current user. Return ProtectedData.Protect(data, s_aditionalEntropy, DataProtectionScope.CurrentUser) Catch e As CryptographicException Console.WriteLine("Data was not encrypted. An error occurred.") Console.WriteLine(e.ToString()) Return Nothing End Try End Function Public Shared Function Unprotect(ByVal data() As Byte) As Byte() Try 'Decrypt the data using DataProtectionScope.CurrentUser. Return ProtectedData.Unprotect(data, s_aditionalEntropy, DataProtectionScope.CurrentUser) Catch e As CryptographicException Console.WriteLine("Data was not decrypted. An error occurred.") Console.WriteLine(e.ToString()) Return Nothing End Try End Function Public Shared Sub PrintValues(ByVal myArr() As [Byte]) Dim i As [Byte] For Each i In myArr Console.Write(vbTab + "{0}", i) Next i Console.WriteLine() End Sub End Class
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.


Note