Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/a-patel/azure-key-vault-labs
Demo: Azure Key Vault + .NET 5/ASP.NET Core
https://github.com/a-patel/azure-key-vault-labs
asp-net-core aspnet-core aspnetcore azure azure-key-vault azure-keyvault demo dotnet dotnet-core key-vault sample
Last synced: 2 months ago
JSON representation
Demo: Azure Key Vault + .NET 5/ASP.NET Core
- Host: GitHub
- URL: https://github.com/a-patel/azure-key-vault-labs
- Owner: a-patel
- License: mit
- Created: 2019-12-18T17:09:30.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T20:58:36.000Z (over 1 year ago)
- Last Synced: 2024-05-02T03:41:10.616Z (9 months ago)
- Topics: asp-net-core, aspnet-core, aspnetcore, azure, azure-key-vault, azure-keyvault, demo, dotnet, dotnet-core, key-vault, sample
- Language: C#
- Homepage:
- Size: 43 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Azure Key Vault (with .NET) Labs
> Demo: Azure Key Vault + .NET 5.x
Please refer to below article(s) of my publication [Awesome Azure](https://medium.com/awesome-azure) on Azure Key Vault:
- [Keeping Secrets Safe in .NET/ASP.NET Core Applications with Azure Key Vault](https://medium.com/awesome-azure/keeping-secrets-safe-in-asp-net-core-with-azure-key-vault-228a1409bb3a)
---
## Usage: Web/API Application :page_facing_up:
### Step 1 : Install the package :package:
> To install NuGet, run the following command in the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console)
```Powershell
PM> Install-Package Azure.Security.KeyVault.Secrets
PM> Install-Package Microsoft.Extensions.Configuration.AzureKeyVault
PM> Install-Package Azure.Identity
```
### Step 2 : Configuration 🔨
> Here are samples that show you how to config.
##### 2.1 : AppSettings
```js
{
// Way-1: Connect to Azure App Configuration using the Managed Identity (for Production Scenario)
"AzureKeyVaultEndpoint": "https://.vault.azure.net",
// Way-2: Connect to Azure App Configuration using the Connection String (for Development Scenario)
"AzureKeyVault": {
"Endpoint": "https://.vault.azure.net",
"ClientId": "",
"ClientSecret": ""
},
"Settings": {
"AppName": "Azure Key Vault Labs",
"Version": 1.0,
"FontSize": 50,
"RefreshRate": 1000,
"Language": "English",
"Messages": "Hello There. Thanks for using Azure Key Vault.",
"BackgroundColor": "Black"
}
}
```
##### 2.2 : Configure Program Class
```cs
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, config) =>
{
var settings = config.Build();
if (!context.HostingEnvironment.IsDevelopment())
{
// Way-1
// Connect to Azure Key Vault using the Managed Identity.
var keyVaultEndpoint = settings["AzureKeyVaultEndpoint"];
if (!string.IsNullOrEmpty(keyVaultEndpoint))
{
var azureServiceTokenProvider = new AzureServiceTokenProvider();
var keyVaultClient = new KeyVaultClient(new KeyVaultClient.AuthenticationCallback(azureServiceTokenProvider.KeyVaultTokenCallback));
config.AddAzureKeyVault(keyVaultEndpoint, keyVaultClient, new DefaultKeyVaultSecretManager());
}
}
else
{
// Way-2
// Connect to Azure Key Vault using the Client Id and Client Secret (AAD) - Get them from Azure AD Application.
var keyVaultEndpoint = settings["AzureKeyVault:Endpoint"];
var keyVaultClientId = settings["AzureKeyVault:ClientId"];
var keyVaultClientSecret = settings["AzureKeyVault:ClientSecret"];
if (!string.IsNullOrEmpty(keyVaultEndpoint) && !string.IsNullOrEmpty(keyVaultClientId) && !string.IsNullOrEmpty(keyVaultClientSecret))
{
config.AddAzureKeyVault(keyVaultEndpoint, keyVaultClientId, keyVaultClientSecret, new DefaultKeyVaultSecretManager());
}
}
})
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup();
});
}
```
### Step 3 : Use in Controller or Business layer :memo:
```cs
public class TestController : ControllerBase
{
#region Members
private readonly Settings _settings;
private readonly IAzureKeyVaultService _azureKeyVaultService;
private readonly IConfiguration _configuration;
#endregion
#region Ctor
public TestController(IAzureKeyVaultService azureKeyVaultService, IConfiguration configuration, IOptions options)
{
_azureKeyVaultService = azureKeyVaultService;
_configuration = configuration;
_settings = options.Value;
}
#endregion
#region Methods
///
/// Get Settings (From Azure Key Vault - Specific setting)
///
///
[HttpGet]
[Route("get-settings-from-azure-key-vault")]
public async Task GetSpecificSettings()
{
var appName = await _azureKeyVaultService.GetSecret("Settings__AppName");
var language = await _azureKeyVaultService.GetSecret("Settings__Language");
var messages = await _azureKeyVaultService.GetSecret("Settings__Messages");
var settings = new Settings
{
AppName = appName,
Language = language,
Messages = messages
};
return Ok(settings);
}
///
/// Get Settings
///
///
[HttpGet]
[Route("get-settings")]
public IActionResult GetSettings()
{
var settings = _settings;
return Ok(settings);
}
#endregion
}
```
---
## Give a Star! :star:
Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project.
## Support :telephone:
> Reach out to me at one of the following places!
- Email :envelope: at `[email protected]`
## Author :boy:
* **Ashish Patel** - [A-Patel](https://github.com/a-patel)
##### Connect with me
| Linkedin | Portfolio | Medium | GitHub | NuGet | Microsoft | Twitter | Facebook | Instagram |
|----------|----------|----------|----------|----------|----------|----------|----------|----------|
| [](https://www.linkedin.com/in/iamaashishpatel) | [](https://aashishpatel.netlify.app/) | [](https://iamaashishpatel.medium.com) | [](https://github.com/a-patel) | [](https://nuget.org/profiles/iamaashishpatel) | [](https://docs.microsoft.com/en-us/users/iamaashishpatel) | [](https://twitter.com/aashish_mrcool) | [](https://www.facebook.com/aashish.mrcool) | [](https://www.instagram.com/iamaashishpatel/) |
## Donate :dollar:
If you find this project useful — or just feeling generous, consider buying me a beer or a coffee. Cheers! :beers: :coffee:
| PayPal | BMC | Patreon |
| ------------- | ------------- | ------------- |
| [](https://www.paypal.me/iamaashishpatel) | [](https://www.buymeacoffee.com/iamaashishpatel) | [](https://www.patreon.com/iamaashishpatel) |
## License :lock:
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.