DataProtectionBuilderExtensions Class

Definition

Namespace:

Microsoft.AspNetCore.DataProtection

Assembly:

Microsoft.AspNetCore.DataProtection.dll

Package:

Microsoft.AspNetCore.DataProtection v8.0.0

Source:

DataProtectionBuilderExtensions.cs

Extensions for configuring data protection using an IDataProtectionBuilder.

public ref class DataProtectionBuilderExtensions abstract sealed

public static class DataProtectionBuilderExtensions

type DataProtectionBuilderExtensions = class

Public Module DataProtectionBuilderExtensions

Inheritance

Object

DataProtectionBuilderExtensions

Methods

AddKeyEscrowSink(IDataProtectionBuilder, Func<IServiceProvider,IKeyEscrowSink>)	Registers a IKeyEscrowSink to perform escrow before keys are persisted to storage.
AddKeyEscrowSink(IDataProtectionBuilder, IKeyEscrowSink)	Registers a IKeyEscrowSink to perform escrow before keys are persisted to storage.
AddKeyEscrowSink<TImplementation>(IDataProtectionBuilder)	Registers a IKeyEscrowSink to perform escrow before keys are persisted to storage.
AddKeyManagementOptions(IDataProtectionBuilder, Action<KeyManagementOptions>)	Configures the key management options for the data protection system.
DisableAutomaticKeyGeneration(IDataProtectionBuilder)	Configures the data protection system not to generate new keys automatically.
PersistKeysToFileSystem(IDataProtectionBuilder, DirectoryInfo)	Configures the data protection system to persist keys to the specified directory. This path may be on the local machine or may point to a UNC share.
PersistKeysToRegistry(IDataProtectionBuilder, RegistryKey)	Configures the data protection system to persist keys to the Windows registry.
ProtectKeysWithCertificate(IDataProtectionBuilder, String)	Configures keys to be encrypted to a given certificate before being persisted to storage.
ProtectKeysWithCertificate(IDataProtectionBuilder, X509Certificate2)	Configures keys to be encrypted to a given certificate before being persisted to storage.
ProtectKeysWithDpapi(IDataProtectionBuilder)	Configures keys to be encrypted with Windows DPAPI before being persisted to storage. The encrypted key will only be decryptable by the current Windows user account.
ProtectKeysWithDpapi(IDataProtectionBuilder, Boolean)	Configures keys to be encrypted with Windows DPAPI before being persisted to storage.
ProtectKeysWithDpapiNG(IDataProtectionBuilder)	Configures keys to be encrypted with Windows CNG DPAPI before being persisted to storage. The keys will be decryptable by the current Windows user account.
ProtectKeysWithDpapiNG(IDataProtectionBuilder, String, DpapiNGProtectionDescriptorFlags)	Configures keys to be encrypted with Windows CNG DPAPI before being persisted to storage.
SetApplicationName(IDataProtectionBuilder, String)	Sets the unique name of this application within the data protection system.
SetDefaultKeyLifetime(IDataProtectionBuilder, TimeSpan)	Sets the default lifetime of keys created by the data protection system.
UnprotectKeysWithAnyCertificate(IDataProtectionBuilder, X509Certificate2[])	Configures certificates which can be used to decrypt keys loaded from storage.
UseCryptographicAlgorithms(IDataProtectionBuilder, AuthenticatedEncryptorConfiguration)	Configures the data protection system to use the specified cryptographic algorithms by default when generating protected payloads.
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, CngCbcAuthenticatedEncryptorConfiguration)	Configures the data protection system to use custom Windows CNG algorithms. This API is intended for advanced scenarios where the developer cannot use the algorithms specified in the EncryptionAlgorithm and ValidationAlgorithm enumerations.
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, CngGcmAuthenticatedEncryptorConfiguration)	Configures the data protection system to use custom Windows CNG algorithms. This API is intended for advanced scenarios where the developer cannot use the algorithms specified in the EncryptionAlgorithm and ValidationAlgorithm enumerations.
UseCustomCryptographicAlgorithms(IDataProtectionBuilder, ManagedAuthenticatedEncryptorConfiguration)	Configures the data protection system to use custom algorithms. This API is intended for advanced scenarios where the developer cannot use the algorithms specified in the EncryptionAlgorithm and ValidationAlgorithm enumerations.
UseEphemeralDataProtectionProvider(IDataProtectionBuilder)	Configures the data protection system to use the EphemeralDataProtectionProvider for data protection services.