TAP-AzureKeyVault 1.0.1

Azure KeyVault Utility

The Azure KeyVault Utility is a C# library that simplifies working with Azure Key Vault. It includes features for key rotation and key retrieval, making it easier to manage cryptographic keys in your Azure Key Vault.

Table of Contents

• Azure KeyVault Utility
  • Table of Contents
  • Introduction
  • Features
  • Getting Started
    • Prerequisites
    • Installation
      • Using .NET CLI
      • Using Package Manager (NuGet)
      • Using PackageReference
      • Using Paket CLI
      • Using Script & Interactive
      • Using Cake
      • Using GIT
    • Configuration
  • Usage
    • Key Rotation
    • Key Retrieval
  • Advanced
    • Dependency Injection
  • Contributing
  • License

Introduction

Azure Key Vault is a secure and centralized service for managing secrets, keys, and certificates used by cloud applications and services. This utility simplifies interactions with Azure Key Vault by providing a set of C# classes and methods.

Features

• Key Rotation: Rotate keys in your Azure Key Vault, creating a new version with updated key material while preserving key attributes and tags.
• Key Retrieval: Retrieve keys from your Azure Key Vault.

Getting Started

Prerequisites

• .NET Core or .NET Framework installed on your development machine.
• An Azure subscription with an Azure Key Vault created and configured.

Installation

1. You can import the TAP-AzureKeyVault library into your project using one of the methods below:

Using .NET CLI

To add the TAP-AzureKeyVault library to your project using the .NET CLI, open a command prompt or terminal and navigate to your project's directory. Then run the following command:

dotnet add package TAP-AzureKeyVault --version 1.0.1

Using Package Manager (NuGet)

If you prefer using the Package Manager Console in Visual Studio, open the console and run the following command:

Install-Package TAP-AzureKeyVault -Version 1.0.1

Using PackageReference

If your project file uses the PackageReference format (common in .csproj files), add the following line to your project file:

<ItemGroup>
  <PackageReference Include="TAP-AzureKeyVault" Version="1.0.1" />
</ItemGroup>

Using Paket CLI

To add the TAP-AzureKeyVault library using the Paket CLI, run the following command:

paket add TAP-AzureKeyVault --version 1.0.1

Using Script & Interactive

For script and interactive scenarios, you can include the library by adding the following line:

#r "nuget: TAP-AzureKeyVault, 1.0.1"

Using Cake

For Cake build scripts, you can include the library as a Cake Addin or Tool using the following directives:

// Install TAP-AzureKeyVault as a Cake Addin
#addin nuget:?package=TAP-AzureKeyVault&version=1.0.1

// Install TAP-AzureKeyVault as a Cake Tool
#tool nuget:?package=TAP-AzureKeyVault&version=1.0.1

Using GIT

To clone the library directly from the GitHub repository, run the following GIT command:

git clone https://github.com/TouchAndPay-Technologies/TKV-TAPKeyVault-Lib_CSharp.git

Choose the method that best fits your development environment and project's requirements. After importing the library, you can start using it in your code.

2. Open the project in your preferred development environment.

Configuration

1. Open the appsettings.json file in the project.
2. Configure the following settings:

{
  "AzureKeyVault": {
    "VaultBaseUrl": "https://your-keyvault.vault.azure.net/",
    "KeyName": "your-key-name"
  },
  "AzureActiveDirectory": {
    "TenantId": "your-tenant-id",
    "ClientId": "your-client-id",
    "ClientSecret": "your-client-secret"
  }
}

Replace the placeholders with your actual Azure Key Vault and Azure Active Directory credentials.

Usage

Key Rotation

To rotate a key in your Azure Key Vault:

using AzureKeyVault;

var keyVault = new TapAzureKeyVault();
await keyVault.RotateKeyAsync("your-key-name");

Key Retrieval

To retrieve a key from your Azure Key Vault:

using AzureKeyVault;

var keyVault = new TapAzureKeyVault();
var key = await keyVault.GetKeyAsync("your-key-name");

Advanced

Dependency Injection

If you are using an ASP.NET Core application, you can register the TapAzureKeyVault as a service and inject it where needed. Here's how:

1. In your Startup.cs file, add the service registration:

   using AzureKeyVault;
   
   public void ConfigureServices(IServiceCollection services)
   {
       var azureKeyConfig = new AzureKeyConfig
       {
           // Configure your AzureKeyConfig here
       };
   
       services.AddAzureKeyVaultClient(azureKeyConfig);
   }
   

2. Inject the IKeyVaultService interface in your controller or service:

   using AzureKeyVault;
   
   public class MyService
   {
       private readonly IKeyVaultService _keyVaultService;
   
       public MyService(IKeyVaultService keyVaultService)
       {
           _keyVaultService = keyVaultService;
       }
   }
   

Contributing

We welcome contributions! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and write tests if necessary.
4. Run the existing tests to ensure they pass.
5. Submit a pull request.

License

This project is licensed under the Touchandpay License. See the LICENSE file for details.