IDataProtectionBuilder インターフェイス

定義

名前空間:

Microsoft.AspNetCore.DataProtection

アセンブリ:

Microsoft.AspNetCore.DataProtection.dll

パッケージ:

Microsoft.AspNetCore.DataProtection v9.0.0

ソース:

IDataProtectionBuilder.cs

データ保護システムの構成へのアクセスを提供します。これにより、開発者は既定の暗号化アルゴリズム、キーの保存場所、および保存時にキーを保護するメカニズムを構成できます。

public interface class IDataProtectionBuilder

public interface IDataProtectionBuilder

type IDataProtectionBuilder = interface

Public Interface IDataProtectionBuilder

注釈

開発者が保存時のキー保護メカニズムを変更する場合は、キーの保存場所も変更することを目的としています。その逆も同様です。 たとえば、通常、ProtectKeysWithCertificate(IDataProtectionBuilder, String) の呼び出しには、PersistKeysToFileSystem(IDataProtectionBuilder, DirectoryInfo)の呼び出しが伴う必要があります。または、データ保護システムがキーを保持する場所を認識していないため、実行時に例外が発生する可能性があります。

同様に、開発者が既定の保護されたペイロード暗号化アルゴリズムを変更する場合は、明示的なキーストレージの場所も設定する必要があります。 したがって、通常、UseCryptographicAlgorithms(IDataProtectionBuilder, AuthenticatedEncryptorConfiguration) の呼び出しは、たとえば、PersistKeysToFileSystem(IDataProtectionBuilder, DirectoryInfo)の呼び出しとペアにする必要があります。

既定の暗号化アルゴリズムまたは保存時キー保護メカニズムが変更された場合、リポジトリ内の新しい キー にのみ影響します。 リポジトリには、古いアルゴリズムまたは保護メカニズムを使用する既存のキーが含まれている場合があります。

プロパティ

Services

このオブジェクトのコンストラクターに渡される IServiceCollection へのアクセスを提供します。

拡張メソッド

AddKeyEscrowSink(IDataProtectionBuilder, IKeyEscrowSink)	キーがストレージに永続化される前にエスクローを実行する IKeyEscrowSink を登録します。
AddKeyEscrowSink(IDataProtectionBuilder, Func<IServiceProvider,IKeyEscrowSink>)	キーがストレージに永続化される前にエスクローを実行する IKeyEscrowSink を登録します。
AddKeyEscrowSink<TImplementation>(IDataProtectionBuilder)	キーがストレージに永続化される前にエスクローを実行する IKeyEscrowSink を登録します。
AddKeyManagementOptions(IDataProtectionBuilder, Action<KeyManagementOptions>)	データ保護システムのキー管理オプションを構成します。
DisableAutomaticKeyGeneration(IDataProtectionBuilder)	新しいキーを自動的に生成しないようにデータ保護システムを構成します。
PersistKeysToFileSystem(IDataProtectionBuilder, DirectoryInfo)	指定したディレクトリにキーを保持するようにデータ保護システムを構成します。 このパスは、ローカル コンピューター上にあるか、UNC 共有を指している可能性があります。
PersistKeysToRegistry(IDataProtectionBuilder, RegistryKey)	Windows レジストリにキーを保持するようにデータ保護システムを構成します。
ProtectKeysWithCertificate(IDataProtectionBuilder, X509Certificate2)	ストレージに永続化される前に、特定の証明書に対して暗号化されるようにキーを構成します。
ProtectKeysWithCertificate(IDataProtectionBuilder, String)	ストレージに永続化される前に、特定の証明書に対して暗号化されるようにキーを構成します。
ProtectKeysWithDpapi(IDataProtectionBuilder, Boolean)	ストレージに永続化される前に、Windows DPAPI で暗号化されるようにキーを構成します。
ProtectKeysWithDpapi(IDataProtectionBuilder)	ストレージに永続化される前に、Windows DPAPI で暗号化されるようにキーを構成します。 暗号化されたキーは、現在の Windows ユーザー アカウントによってのみ復号化できます。
ProtectKeysWithDpapiNG(IDataProtectionBuilder, String, DpapiNGProtectionDescriptorFlags)	ストレージに永続化する前に、Windows CNG DPAPI で暗号化されるようにキーを構成します。
ProtectKeysWithDpapiNG(IDataProtectionBuilder)	ストレージに永続化する前に、Windows CNG DPAPI で暗号化されるようにキーを構成します。 キーは、現在の Windows ユーザー アカウントによって復号化できます。
SetApplicationName(IDataProtectionBuilder, String)	データ保護システム内のこのアプリケーションの一意の名前を設定します。
SetDefaultKeyLifetime(IDataProtectionBuilder, TimeSpan)	データ保護システムによって作成されるキーの既定の有効期間を設定します。
UnprotectKeysWithAnyCertificate(IDataProtectionBuilder, X509Certificate2[])	ストレージから読み込まれたキーの暗号化を解除するために使用できる証明書を構成します。
UseCryptographicAlgorithms(IDataProtectionBuilder, AuthenticatedEncryptorConfiguration)	保護されたペイロードを生成するときに、指定された暗号化アルゴリズムを既定で使用するようにデータ保護システムを構成します。
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, CngCbcAuthenticatedEncryptorConfiguration)	カスタム Windows CNG アルゴリズムを使用するようにデータ保護システムを構成します。 この API は、開発者が EncryptionAlgorithm および ValidationAlgorithm 列挙型で指定されたアルゴリズムを使用できない高度なシナリオを対象としています。
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, CngGcmAuthenticatedEncryptorConfiguration)	カスタム Windows CNG アルゴリズムを使用するようにデータ保護システムを構成します。 この API は、開発者が EncryptionAlgorithm および ValidationAlgorithm 列挙型で指定されたアルゴリズムを使用できない高度なシナリオを対象としています。
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, ManagedAuthenticatedEncryptorConfiguration)	カスタム アルゴリズムを使用するようにデータ保護システムを構成します。 この API は、開発者が EncryptionAlgorithm および ValidationAlgorithm 列挙型で指定されたアルゴリズムを使用できない高度なシナリオを対象としています。
UseEphemeralDataProtectionProvider(IDataProtectionBuilder)	データ保護サービスに EphemeralDataProtectionProvider を使用するようにデータ保護システムを構成します。
PersistKeysToDbContext<TContext>(IDataProtectionBuilder)	EntityFrameworkCore データストアにキーを保持するようにデータ保護システムを構成します
PersistKeysToStackExchangeRedis(IDataProtectionBuilder, IConnectionMultiplexer, RedisKey)	Redis データベースで指定されたキーにキーを保持するようにデータ保護システムを構成します
PersistKeysToStackExchangeRedis(IDataProtectionBuilder, IConnectionMultiplexer)	Redis データベースの既定のキー ('DataProtection-Keys') にキーを保持するようにデータ保護システムを構成します
PersistKeysToStackExchangeRedis(IDataProtectionBuilder, Func<IDatabase>, RedisKey)	Redis データベースで指定されたキーにキーを保持するようにデータ保護システムを構成します