https://github.com/heaths/keyvaultproxy
Sample showing how to use an HttpPipelinePolicy to proxy secrets, keys, and certificates from Azure Key Vault.
https://github.com/heaths/keyvaultproxy
azure-core azure-keyvault
Last synced: about 2 months ago
JSON representation
Sample showing how to use an HttpPipelinePolicy to proxy secrets, keys, and certificates from Azure Key Vault.
- Host: GitHub
- URL: https://github.com/heaths/keyvaultproxy
- Owner: heaths
- License: mit
- Created: 2020-05-05T03:07:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-12T09:56:35.000Z (over 5 years ago)
- Last Synced: 2025-01-01T10:16:48.696Z (over 1 year ago)
- Topics: azure-core, azure-keyvault
- Language: C#
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Azure Key Vault Proxy
This is a sample showing how to use an `HttpPipelinePolicy` to cache and proxy secrets, keys, and certificates from Azure Key Vault. The [Azure.Core](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md) packages provides a number of useful HTTP pipeline policies like configurable retries, logging, and more; and, you can add your own policies.
## Getting started
To use this sample, you will need to install the [Azure.Core](https://nuget.org/packages/Azure.Core) package, which is installed automatically when installing any of the Azure Key Vault packages:
* [Azure.Security.KeyVault.Certificates](https://nuget.org/packages/Azure.Security.KeyVault.Certificates)
* [Azure.Security.KeyVault.Keys](https://nuget.org/packages/Azure.Security.KeyVault.Keys)
* [Azure.Security.KeyVault.Secrets](https://nuget.org/packages/Azure.Security.KeyVault.Secrets)
Once you build this project, you can reference this sample in your own project by either:
* Adding a `` to this sample project in your own project, or
* Running `dotnet pack` on this sample project, publish it to a private NuGet source, and add a `` to `AzureSamples.Security.KeyVault.Proxy`.
After you reference this sample, in your own project source, add the following:
```csharp
using AzureSamples.Security.KeyVault.Proxy;
```
## Examples
All HTTP clients for Azure.* packages allow you to customize the HTTP pipeline using their respective client options classes, such as the `SecretClientOptions` class below:
```csharp
SecretClientOptions options = new SecretClientOptions();
options.AddPolicy(new KeyVaultProxy(), HttpPipelinePosition.PerCall);
SecretClient client = new SecretClient(
new Uri("https://myvault.vault.azure.net"),
new DefaultAzureCredential(),
options);
```
Whenever you make a call to a resource with given a unique URI, it will be cached, by default, for 1 hour. You can change the default time-to-live (TTL) like so:
```csharp
SecretClientOptions options = new SecretClientOptions();
options.AddPolicy(new KeyVaultProxy(TimeSpan.FromSeconds(30)), HttpPipelinePosition.PerCall);
```
When the resource has expired, the next request will go to the server and a successful `GET` response for certificates, keys, or secrets will be cached.
## Feedback
Please leave feedback, ask questions, and file issues in our [Issues](https://github.com/heaths/KeyVaultProxy/issues) page.
## License
This project is licensed under the [MIT license](LICENSE.txt).