ProtectedData.Protect メソッド

定義

名前空間:

System.Security.Cryptography

アセンブリ:

System.Security.Cryptography.ProtectedData.dll

オーバーロード

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

指定されたバイト配列のデータを暗号化し、暗号化されたデータを含むバイト配列を返します。

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

ソース:

ProtectedData.cs

指定されたバイト配列のデータを暗号化し、暗号化されたデータを含むバイト配列を返します。

C#

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

パラメーター

userData

Byte[]

暗号化するデータを格納するバイト配列。

optionalEntropy

Byte[]

暗号化の複雑さを増加させるのに使用するオプションの追加のバイト配列。複雑さを増加させない場合は、null。

scope

DataProtectionScope

暗号化のスコープを指定する列挙値のいずれか。

戻り値

Byte[]

暗号化されたデータを表すバイト配列。

例外

ArgumentNullException

userData パラメーターが null です。

CryptographicException

暗号化に失敗しました。

NotSupportedException

このメソッドがオペレーティング システムでサポートされていません。

OutOfMemoryException

データの暗号化処理中にシステムで使用できるメモリがなくなりました。

PlatformNotSupportedException

.NET Core と .NET 5 以降のみ: メソッドの Protect 呼び出しは、Windows オペレーティング システムでのみサポートされています。

例

次の例は、データ保護の使用方法を示しています。

C#

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();
    }
}

注釈

このメソッドは、パスワード、キー、接続文字列などのデータを暗号化するために使用できます。 optionalEntropyパラメーターを使用すると、データを追加して暗号化の複雑さを増やし、複雑さを増やさないことを指定nullできます。 この情報を指定する場合は、 メソッドを使用してデータの暗号化を解除するときにも、この情報を Unprotect 使用する必要があります。

注意

偽装中にこのメソッドを使用すると、"キーが指定された状態で使用できません" というエラーが表示されることがあります。このエラーを回避するには、 メソッドを呼び出す前に、偽装するユーザーのプロファイルを読み込みます。