Azure.Extensions.AspNetCore.DataProtection.Keys
1.3.0
Prefix Reserved
dotnet add package Azure.Extensions.AspNetCore.DataProtection.Keys --version 1.3.0
NuGet\Install-Package Azure.Extensions.AspNetCore.DataProtection.Keys -Version 1.3.0
<PackageReference Include="Azure.Extensions.AspNetCore.DataProtection.Keys" Version="1.3.0" />
paket add Azure.Extensions.AspNetCore.DataProtection.Keys --version 1.3.0
#r "nuget: Azure.Extensions.AspNetCore.DataProtection.Keys, 1.3.0"
// Install Azure.Extensions.AspNetCore.DataProtection.Keys as a Cake Addin #addin nuget:?package=Azure.Extensions.AspNetCore.DataProtection.Keys&version=1.3.0 // Install Azure.Extensions.AspNetCore.DataProtection.Keys as a Cake Tool #tool nuget:?package=Azure.Extensions.AspNetCore.DataProtection.Keys&version=1.3.0
Azure Key Vault Key Encryptor for Microsoft.AspNetCore.DataProtection
The Azure.Extensions.AspNetCore.DataProtection.Keys
package allows protecting keys at rest using Azure Key Vault Key Encryption/Wrapping feature.
Getting started
Install the package
Install the package with NuGet:
dotnet add package Azure.Extensions.AspNetCore.DataProtection.Keys
Prerequisites
You need an Azure subscription, Key Vault and a Key to use this package.
To create a new Key Vault, you can use the Azure Portal, Azure PowerShell, or the Azure CLI. Here's an example using the Azure CLI:
az keyvault create --name MyVault --resource-group MyResourceGroup --location westus
az keyvault key create --name MyKey --vault-name MyVault
# give write access to a service principal (application)
az keyvault set-policy -n MyVault --object-id <application_id> --key-permissions get unwrapKey wrapKey
Key concepts
Thread safety
We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.
Additional concepts
Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime
Examples
To protect keys using Azure Key Vault Key, configure the system with ProtectKeysWithAzureKeyVault
when configuring the services:
public void ConfigureServices(IServiceCollection services)
{
services
.AddDataProtection()
.ProtectKeysWithAzureKeyVault(new Uri("<Key-ID>"), new DefaultAzureCredential());
}
The Azure Identity library provides easy Azure Active Directory support for authentication.
Next steps
Read more about DataProtection in ASP.NET Core.
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Azure.Core (>= 1.44.1)
- Azure.Security.KeyVault.Keys (>= 4.6.0)
- Microsoft.AspNetCore.DataProtection (>= 8.0.11)
- Microsoft.Bcl.AsyncInterfaces (>= 8.0.0)
-
net8.0
- Azure.Core (>= 1.44.1)
- Azure.Security.KeyVault.Keys (>= 4.6.0)
- Microsoft.AspNetCore.DataProtection (>= 8.0.11)
- Microsoft.Bcl.AsyncInterfaces (>= 8.0.0)
NuGet packages (24)
Showing the top 5 NuGet packages that depend on Azure.Extensions.AspNetCore.DataProtection.Keys:
Package | Downloads |
---|---|
Skoruba.IdentityServer4.Shared.Configuration
Shared common layer for the administration of the IdentityServer4 and Asp.Net Core Identity |
|
CyberEye.Identity.Lib
Package chứa các thư viện, hàm tiện ích, class model về ASP.NET Identity |
|
Skoruba.Duende.IdentityServer.Shared.Configuration
Shared common layer for the administration of the Duende IdentityServer and Asp.Net Core Identity |
|
Rsk.AdminUI
Package Description |
|
Nox.Secrets.Abstractions
Nox secrets abstractions library |
GitHub repositories (12)
Showing the top 5 popular GitHub repositories that depend on Azure.Extensions.AspNetCore.DataProtection.Keys:
Repository | Stars |
---|---|
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
|
|
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 9, 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
|
|
nopSolutions/nopCommerce
ASP.NET Core eCommerce software. nopCommerce is a free and open-source shopping cart.
|
|
skoruba/IdentityServer4.Admin
The administration for the IdentityServer4 and Asp.Net Core Identity
|
|
enkodellc/blazorboilerplate
Blazor Boilerplate / Starter Template with MudBlazor
|
Version | Downloads | Last updated |
---|---|---|
1.3.0 | 50,848 | 11/27/2024 |
1.2.4 | 959,892 | 8/15/2024 |
1.2.3 | 1,993,827 | 2/13/2024 |
1.2.2 | 3,671,465 | 3/14/2023 |
1.2.1 | 61,624 | 3/7/2023 |
1.2.0 | 231,902 | 2/7/2023 |
1.1.0 | 4,237,932 | 9/2/2021 |
1.0.3 | 905,244 | 5/14/2021 |
1.0.2 | 1,426,886 | 9/4/2020 |
1.0.1 | 69,832 | 8/10/2020 |
1.0.0 | 69,195 | 6/5/2020 |
1.0.0-preview.2 | 477 | 5/5/2020 |