Azure.Extensions.AspNetCore.DataProtection.Keys 1.4.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Azure.Extensions.AspNetCore.DataProtection.Keys --version 1.4.0
                    


                    

                
NuGet\Install-Package Azure.Extensions.AspNetCore.DataProtection.Keys -Version 1.4.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Azure.Extensions.AspNetCore.DataProtection.Keys" Version="1.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Azure.Extensions.AspNetCore.DataProtection.Keys" Version="1.4.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Azure.Extensions.AspNetCore.DataProtection.Keys" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Azure.Extensions.AspNetCore.DataProtection.Keys --version 1.4.0
                    


                    

                
#r "nuget: Azure.Extensions.AspNetCore.DataProtection.Keys, 1.4.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Azure.Extensions.AspNetCore.DataProtection.Keys&version=1.4.0
                    


                            Install Azure.Extensions.AspNetCore.DataProtection.Keys as a Cake Addin
                        

                    

                
#tool nuget:?package=Azure.Extensions.AspNetCore.DataProtection.Keys&version=1.4.0
                    


                            Install Azure.Extensions.AspNetCore.DataProtection.Keys as a Cake Tool

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 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (26)

Showing the top 5 NuGet packages that depend on Azure.Extensions.AspNetCore.DataProtection.Keys:

Package Downloads
Kentico.Xperience.Cloud

Provides logic, supporting API, and tools that allow deployment of applications to the Xperience by Kentico software as a service hosting environment.
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

Admin user interface for Duende IdentityServer. To purchase a license or get a demo license, contact sales@identityserver.com.

GitHub repositories (15)

Showing the top 15 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 10 Preview 4, 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
OfficeDev/Microsoft-Teams-Samples
Welcome to the Microsoft Teams samples repository. Here you will find task-focused samples in C#, JavaScript and TypeScript to help you get started with the Microsoft Teams App!
grandnode/grandnode2
E-commerce platform built with ASP.NET Core using MongoDB for NoSQL storage
Aguafrommars/TheIdServer
OpenID/Connect, OAuth2, WS-Federation and SAML 2.0 server based on Duende IdentityServer and ITFoxtec Identity SAML 2.0 with its admin UI
skoruba/Duende.IdentityServer.Admin
The administration for the Duende IdentityServer and Asp.Net Core Identity ⚡
Implem/Implem.Pleasanter
Pleasanter is a no-code/low-code development platform that runs on .NET. You can quickly create business applications with simple operations.
rstropek/Samples
mburumaxwell/dependabot-azure-devops
Tools for updating dependencies in Azure DevOps repositories using https://dependabot.com
dotnet/AspNetCore.Docs.Samples
bitwarden/passwordless-server
Bitwarden Passwordless.dev infrastructure/backend (API, database, Docker, etc).
KevinDockx/SecuringAspNetCore6WithOAuth2AndOIDC
Fully functioning finished sample code for my Securing ASP.NET Core 6 with OAuth2 and OpenID Connect course
Version Downloads Last updated
1.6.0 63,070 5/20/2025
1.5.0 53,533 5/7/2025
1.4.0 616,174 2/7/2025
1.3.0 582,519 11/27/2024
1.2.4 1,897,702 8/15/2024
1.2.3 2,620,250 2/13/2024
1.2.2 4,265,762 3/14/2023
1.2.1 68,802 3/7/2023
1.2.0 240,529 2/7/2023
1.1.0 4,534,870 9/2/2021
1.0.3 940,088 5/14/2021
1.0.2 1,479,033 9/4/2020
1.0.1 73,285 8/10/2020
1.0.0 83,082 6/5/2020
1.0.0-preview.2 546 5/5/2020

https://github.com/Azure/azure-sdk-for-net/blob/Azure.Extensions.AspNetCore.DataProtection.Keys_1.4.0/sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Keys/CHANGELOG.md