ProtectedData.Protect Método

Definição

Namespace:: System.Security.Cryptography

Assembly:: System.Security.Cryptography.ProtectedData.dll

Assembly:: System.Security.dll

Pacote:: System.Security.Cryptography.ProtectedData v11.0.0-preview.5.26302.115

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Criptografa os dados em um buffer especificado e grava os dados criptografados em um buffer de destino.

Sobrecargas

Nome	Description
Protect(Byte[], Byte[], DataProtectionScope)	Criptografa os dados em uma matriz de bytes especificada e retorna uma matriz de bytes que contém os dados criptografados.
Protect(ReadOnlySpan<Byte>, DataProtectionScope, ReadOnlySpan<Byte>)	Criptografa os dados em um intervalo de bytes especificado e retorna uma matriz de bytes que contém os dados criptografados.
Protect(ReadOnlySpan<Byte>, DataProtectionScope, Span<Byte>, ReadOnlySpan<Byte>)	Criptografa os dados em um buffer especificado e grava os dados criptografados em um buffer de destino.

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

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Criptografa os dados em uma matriz de bytes especificada e retorna uma matriz de bytes que contém os dados criptografados.

public:
 static cli::array <System::Byte> ^ Protect(cli::array <System::Byte> ^ userData, cli::array <System::Byte> ^ optionalEntropy, System::Security::Cryptography::DataProtectionScope scope);

public static byte[] Protect(byte[] userData, byte[]? optionalEntropy, System.Security.Cryptography.DataProtectionScope scope);

public static byte[] Protect(byte[] userData, byte[] optionalEntropy, System.Security.Cryptography.DataProtectionScope scope);

static member Protect : byte[] * byte[] * System.Security.Cryptography.DataProtectionScope -> byte[]

Public Shared Function Protect (userData As Byte(), optionalEntropy As Byte(), scope As DataProtectionScope) As Byte()

Parâmetros

userData: Byte[]

Uma matriz de bytes que contém dados a serem criptografados.

optionalEntropy: Byte[]

Uma matriz de bytes adicional opcional usada para aumentar a complexidade da criptografia ou null para nenhuma complexidade adicional.

scope: DataProtectionScope

Um dos valores de enumeração que especifica o escopo da criptografia.

Retornos

Byte[]

Uma matriz de bytes que representa os dados criptografados.

Exceções

ArgumentNullException

O userData parâmetro é null.

CryptographicException

Falha na criptografia.

NotSupportedException

O sistema operacional não dá suporte a esse método.

OutOfMemoryException

O sistema ficou sem memória ao criptografar os dados.

PlatformNotSupportedException

somente .NET Core e .NET 5+: há suporte apenas para chamadas para o método Protect em sistemas operacionais Windows.

Exemplos

O exemplo a seguir mostra como usar a proteção de dados.

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

Comentários

Esse método pode ser usado para criptografar dados como senhas, chaves ou cadeias de conexão. O optionalEntropy parâmetro permite que você adicione dados para aumentar a complexidade da criptografia; especifique null sem complexidade adicional. Se fornecidas, essas informações também devem ser usadas ao descriptografar os dados usando o Unprotect método.

Observação

Se você usar esse método durante a representação, poderá receber o seguinte erro: "Chave não válida para uso no estado especificado". Para evitar esse erro, carregue o perfil do usuário que você deseja representar antes de chamar o método.

Aplica-se a

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

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Criptografa os dados em um intervalo de bytes especificado e retorna uma matriz de bytes que contém os dados criptografados.

public static byte[] Protect(ReadOnlySpan<byte> userData, System.Security.Cryptography.DataProtectionScope scope, ReadOnlySpan<byte> optionalEntropy = default);

static member Protect : ReadOnlySpan<byte> * System.Security.Cryptography.DataProtectionScope * ReadOnlySpan<byte> -> byte[]

Public Shared Function Protect (userData As ReadOnlySpan(Of Byte), scope As DataProtectionScope, Optional optionalEntropy As ReadOnlySpan(Of Byte) = Nothing) As Byte()

Parâmetros

userData: ReadOnlySpan<Byte>

Um buffer que contém os dados a serem criptografados.

scope: DataProtectionScope

Um dos valores de enumeração que especifica o escopo da criptografia.

optionalEntropy: ReadOnlySpan<Byte>

Um intervalo de bytes adicional opcional usado para aumentar a complexidade da criptografia ou vazio sem complexidade adicional.

Retornos

Byte[]

Uma matriz de bytes que representa os dados criptografados.

Exceções

CryptographicException

Falha na criptografia.

NotSupportedException

O sistema operacional não dá suporte a esse método.

OutOfMemoryException

O sistema ficou sem memória ao criptografar os dados.

PlatformNotSupportedException

O sistema operacional não é Windows.

Aplica-se a

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

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Origem:: ProtectedData.cs

Criptografa os dados em um buffer especificado e grava os dados criptografados em um buffer de destino.

public static int Protect(ReadOnlySpan<byte> userData, System.Security.Cryptography.DataProtectionScope scope, Span<byte> destination, ReadOnlySpan<byte> optionalEntropy = default);

static member Protect : ReadOnlySpan<byte> * System.Security.Cryptography.DataProtectionScope * Span<byte> * ReadOnlySpan<byte> -> int

Public Shared Function Protect (userData As ReadOnlySpan(Of Byte), scope As DataProtectionScope, destination As Span(Of Byte), Optional optionalEntropy As ReadOnlySpan(Of Byte) = Nothing) As Integer

Parâmetros

userData: ReadOnlySpan<Byte>

Um buffer que contém dados a serem criptografados.

scope: DataProtectionScope

Um dos valores de enumeração que especifica o escopo da criptografia.

destination: Span<Byte>

O buffer para receber os dados criptografados.

optionalEntropy: ReadOnlySpan<Byte>

Um buffer adicional opcional usado para aumentar a complexidade da criptografia ou vazio sem complexidade adicional.

Retornos

Int32

O número total de bytes gravados em destination

Exceções

ArgumentException

O buffer destination é muito pequeno para conter os dados criptografados.

CryptographicException

Falha na criptografia.

NotSupportedException

O sistema operacional não dá suporte a esse método.

OutOfMemoryException

O sistema ficou sem memória ao criptografar os dados.

PlatformNotSupportedException

O sistema operacional não é Windows.

Aplica-se a

Comentários

Esta página foi útil?