ByteDev.Azure.KeyVault 2.0.0

ByteDev.Azure.KeyVault

.NET Standard library providing some Azure Key Vault functionality.

Installation

ByteDev.Azure.KeyVault has been written as a .NET Standard 2.1 library and is based on the Azure.Security.KeyVault.Secrets package.

ByteDev.Azure.KeyVault is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Azure.KeyVault

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

Secrets

Secrets functionality is accessed through the KeyVaultSecretClient class in namespace ByteDev.Azure.KeyVault.Secrets.

Methods:

• DeleteAllAsync
• DeleteAndPurgeAsync
• DeleteAsync
• DeleteIfExistsAsync
• ExistsAsync
• GetAllAsync
• GetAsync
• GetDeletedAsync
• GetDeletedIfExistsAsync
• GetIfExistsAsync
• GetSectionAsync
• GetValueAsync
• GetValueIfExistsAsync
• GetValuesIfExistsAsync
• IsDeletedAsync
• IsDeletedAsync
• PurgeAllDeletedAsync
• PurgeAsync
• PurgeIfDeletedAsync
• SafeSetValueAsync
• SetValueAsync

Example usage:

IKeyVaultSecretClient client = new KeyVaultSecretClient(keyVaultUri);

// Create a secret
await client.SetValueAsync("Test1", "Some value");

// Get the secret's value
string value = await client.GetValueAsync("Test1");

// Delete the secret
await client.DeleteAsync("Test1", true);

// Purge the soft deleted secret
await client.PurgeAsync("Test1");

Keys

Keys functionality is accessed through the KeyVaultKeyClient class in namespace ByteDev.Azure.KeyVault.Keys.

Methods:

• CreateAsync
• DecryptAsync
• EncryptAsync
• GetAsync
• SignAsync
• UnwrapAsync
• VerifyAsync
• WrapAsync

Example usage:

IKeyVaultKeyClient client = new KeyVaultKeyClient(keyVaultUri);

const string clearText = "test string";

// Encrypt/decrypt some text using the Key Vault key

byte[] cipher = await client.EncryptAsync("Test1", EncryptionAlgorithm.RsaOaep, clearText, Encoding.Unicode);

string result = await client.DecryptAsync("Test1", EncryptionAlgorithm.RsaOaep, cipher, Encoding.Unicode);

// result == "test string"