ProtectedData Klasse

Definition

Stellt Methoden zum Verschlüsseln und Entschlüsseln von Daten bereit. Diese Klasse kann nicht vererbt werden.

public ref class ProtectedData abstract sealed
public ref class ProtectedData sealed
public static class ProtectedData
public sealed class ProtectedData
type ProtectedData = class
Public Class ProtectedData
Public NotInheritable Class ProtectedData
Vererbung
ProtectedData

Beispiele

Das folgende Beispiel zeigt, wie Der Datenschutz verwendet wird.

using System;
using System.Security.Cryptography;

public class DataProtectionSample
{
    // Create byte array for additional entropy when using Protect method.
    static byte [] s_additionalEntropy = { 9, 8, 7, 6, 5 };

    public static void Main()
    {
        // Create a simple byte array containing data to be encrypted.
        byte [] secret = { 0, 1, 2, 3, 4, 1, 2, 3, 4 };

        //Encrypt the data.
        byte [] encryptedSecret = Protect( secret );
        Console.WriteLine("The encrypted byte array is:");
        PrintValues(encryptedSecret);

        // Decrypt the data and store in a byte array.
        byte [] originalData = Unprotect( encryptedSecret );
        Console.WriteLine("{0}The original data is:", Environment.NewLine);
        PrintValues(originalData);
    }

    public static byte [] Protect( byte [] data )
    {
        try
        {
            // Encrypt the data using DataProtectionScope.CurrentUser. The result can be decrypted
            // only by the same current user.
            return ProtectedData.Protect( data, s_additionalEntropy, DataProtectionScope.CurrentUser );
        }
        catch (CryptographicException e)
        {
            Console.WriteLine("Data was not encrypted. An error occurred.");
            Console.WriteLine(e.ToString());
            return null;
        }
    }

    public static byte [] Unprotect( byte [] data )
    {
        try
        {
            //Decrypt the data using DataProtectionScope.CurrentUser.
            return ProtectedData.Unprotect( data, s_additionalEntropy, DataProtectionScope.CurrentUser );
        }
        catch (CryptographicException e)
        {
            Console.WriteLine("Data was not decrypted. An error occurred.");
            Console.WriteLine(e.ToString());
            return null;
        }
    }

    public static void PrintValues( Byte[] myArr )
    {
        foreach ( Byte i in myArr )
        {
            Console.Write( "\t{0}", i );
        }
        Console.WriteLine();
    }
}
Imports System.Security.Cryptography



Public Class DataProtectionSample
    ' Create byte array for additional entropy when using Protect method.
    Private Shared s_additionalEntropy 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_additionalEntropy, 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_additionalEntropy, 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

Hinweise

Diese Klasse bietet Zugriff auf die Datenschutz-API (DPAPI), die in Windows Betriebssystemen verfügbar ist. Dies ist ein Dienst, der vom Betriebssystem bereitgestellt wird und keine zusätzlichen Bibliotheken erfordert. Sie bietet Schutz mithilfe der Benutzer- oder Computeranmeldeinformationen zum Verschlüsseln oder Entschlüsseln von Daten.

Important

Da dies von DPAPI abhängt, wird die ProtectedData-Klasse nur auf der Windows-Plattform unterstützt. Seine Verwendung auf .NET Core auf anderen Plattformen als Windows löst einen PlatformNotSupportedException aus.

Die Klasse besteht aus zwei Wrappern für die nicht verwaltete DPAPI Protect und Unprotect. Diese beiden Methoden können verwendet werden, um Daten wie Kennwörter, Schlüssel und Verbindungszeichenfolgen zu verschlüsseln und zu entschlüsseln.

Wenn Sie diese Methoden während des Identitätswechsels verwenden, erhalten Sie möglicherweise die folgende Fehlermeldung: "Schlüssel ist für die Verwendung im angegebenen Zustand ungültig.". Dies geschieht, da die DPAPI die Schlüsseldaten in Benutzerprofilen speichert. Wenn das Profil nicht geladen wird, kann DPAPI die Entschlüsselung nicht ausführen. Um diesen Fehler zu verhindern, laden Sie das Profil des Benutzers, den Sie vor dem Aufrufen einer der Methoden imitieren möchten. Die Verwendung von DPAPI mit Identitätswechsel kann zu erheblichen Komplikationen führen und erfordert sorgfältige Designentscheidungen.

Methoden

Name Beschreibung
Protect(Byte[], Byte[], DataProtectionScope)

Verschlüsselt die Daten in einem angegebenen Bytearray und gibt ein Bytearray zurück, das die verschlüsselten Daten enthält.

Protect(ReadOnlySpan<Byte>, DataProtectionScope, ReadOnlySpan<Byte>)

Verschlüsselt die Daten in einer angegebenen Bytespanne und gibt ein Bytearray zurück, das die verschlüsselten Daten enthält.

Protect(ReadOnlySpan<Byte>, DataProtectionScope, Span<Byte>, ReadOnlySpan<Byte>)

Verschlüsselt die Daten in einem angegebenen Puffer und schreibt die verschlüsselten Daten in einen Zielpuffer.

TryProtect(ReadOnlySpan<Byte>, DataProtectionScope, Span<Byte>, Int32, ReadOnlySpan<Byte>)

Verschlüsselt die Daten in einem angegebenen Puffer und schreibt die verschlüsselten Daten in einen Zielpuffer.

TryUnprotect(ReadOnlySpan<Byte>, DataProtectionScope, Span<Byte>, Int32, ReadOnlySpan<Byte>)

Entschlüsselt die Daten in einem angegebenen Puffer und schreibt die entschlüsselten Daten in einen Zielpuffer.

Unprotect(Byte[], Byte[], DataProtectionScope)

Entschlüsselt die Daten in einem angegebenen Bytearray und gibt ein Bytearray zurück, das die entschlüsselten Daten enthält.

Unprotect(ReadOnlySpan<Byte>, DataProtectionScope, ReadOnlySpan<Byte>)

Entschlüsselt die Daten in einem angegebenen Bytearray und gibt ein Bytearray zurück, das die entschlüsselten Daten enthält.

Unprotect(ReadOnlySpan<Byte>, DataProtectionScope, Span<Byte>, ReadOnlySpan<Byte>)

Entschlüsselt die Daten in einem angegebenen Puffer und schreibt die entschlüsselten Daten in einen Zielpuffer.

Gilt für: