The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
ProtectedData.Protect Method
.NET Framework 3.0
Protects the userData parameter and returns a byte array.
Namespace: System.Security.Cryptography
Assembly: System.Security (in system.security.dll)
Assembly: System.Security (in system.security.dll)
'Declaration Public Shared Function Protect ( _ userData As Byte(), _ optionalEntropy As Byte(), _ scope As DataProtectionScope _ ) As Byte() 'Usage Dim userData As Byte() Dim optionalEntropy As Byte() Dim scope As DataProtectionScope Dim returnValue As Byte() returnValue = ProtectedData.Protect(userData, optionalEntropy, scope)
public static byte[] Protect ( byte[] userData, byte[] optionalEntropy, DataProtectionScope scope )
public static function Protect ( userData : byte[], optionalEntropy : byte[], scope : DataProtectionScope ) : byte[]
Not applicable.
Parameters
- userData
A byte array containing data to protect.
- optionalEntropy
An additional byte array used to encrypt the data.
- scope
One of the DataProtectionScope values.
Return Value
A byte array representing the encrypted data.This method can be used to protect data such as passwords, keys, or connection strings. The optionalEntropy parameter enables you to use additional information to protect the data. This information must also be used when unprotecting the data using the Unprotect method.
The following code 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
import System.*;
import System.Security.Cryptography.*;
public class DataProtectionSample
{
// Create byte array for additional entropy when using Protect method.
private static ubyte sAditionalEntropy[] = { 9, 8, 7, 6, 5 };
public static void main(String args[])
{
// Create a simple byte array containing data to be encrypted.
ubyte secret[] = { 0, 1, 2, 3, 4, 1, 2, 3, 4 };
//Encrypt the data.
ubyte encryptedSecret[] = Protect(secret);
Console.WriteLine("The encrypted byte array is:");
PrintValues(encryptedSecret);
// Decrypt the data and store in a byte array.
ubyte originalData[] = Unprotect(encryptedSecret);
Console.WriteLine("{0}The original data is:",
Environment.get_NewLine());
PrintValues(originalData);
} //main
public static ubyte[] Protect(ubyte data[])
{
try {
// Encrypt the data using DataProtectionScope.CurrentUser.
// The result can be decrypted only by the same current user.
return ProtectedData.Protect(data, sAditionalEntropy,
DataProtectionScope.CurrentUser);
}
catch (CryptographicException e) {
Console.WriteLine("Data was not encrypted. An error occurred.");
Console.WriteLine(e.ToString());
return null;
}
} //Protect
public static ubyte[] Unprotect(ubyte data[])
{
try {
//Decrypt the data using DataProtectionScope.CurrentUser.
return ProtectedData.Unprotect(data, sAditionalEntropy,
DataProtectionScope.CurrentUser);
}
catch (CryptographicException e) {
Console.WriteLine("Data was not decrypted. An error occurred.");
Console.WriteLine(e.ToString());
return null;
}
} //Unprotect
public static void PrintValues(ubyte myArr[])
{
for (int iCtr = 0; iCtr < myArr.length; iCtr++) {
ubyte i = myArr[iCtr];
Console.Write("\t{0}", System.Convert.ToString(i));
}
Console.WriteLine();
} //PrintValues
} //DataProtectionSample
- DataProtectionPermission with the associated ProtectData flag for permission to protect data.
Community Additions
Show: