Skip to content

Change ProtectKeysWithAzureKeyVault to take a Uri #11588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pakrym merged 4 commits into from
Apr 27, 2020
Merged

Change ProtectKeysWithAzureKeyVault to take a Uri #11588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40711ee
Change ProtectKeysWithAzureKeyVault to take a Uri
pakrym Apr 24, 2020
ff15260
argument
pakrym Apr 25, 2020
8d04ee5
Snippet
pakrym Apr 25, 2020
8327d07
Can I even code?
pakrym Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Keys/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 1.0.0-preview.2 (Unreleased)

- Package renamed to Azure.Extensions.AspNetCore.DataProtection.Keys
- Default overload of ProtectKeysWithAzureKeyVault now takes a Uri to be consistent with other extension methods and KeyVault clients.

## 1.0.0-preview.1 (2020)

Expand Down
2 changes: 1 addition & 1 deletion sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Keys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public void ConfigureServices(IServiceCollection services)
{
services
.AddDataProtection()
.ProtectKeysWithAzureKeyVault("<Key-ID>", new DefaultAzureCredential());
.ProtectKeysWithAzureKeyVault(new Uri("<Key-ID>"), new DefaultAzureCredential());
}
```

Expand Down
2 changes: 1 addition & 1 deletion ...DataProtection.Keys/api/Azure.Extensions.AspNetCore.DataProtection.Keys.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ namespace Microsoft.AspNetCore.DataProtection
public static partial class AzureDataProtectionKeyVaultKeyBuilderExtensions
{
public static Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder ProtectKeysWithAzureKeyVault(this Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder builder, string keyIdentifier, Azure.Core.Cryptography.IKeyEncryptionKeyResolver keyResolver) { throw null; }
Copy link
Copy Markdown
Contributor Author

@pakrym pakrym Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is an advanced scenario that requires string because IKeyEncryptionKeyResolver is string based.

public static Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder ProtectKeysWithAzureKeyVault(this Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder builder, string keyIdentifier, Azure.Core.TokenCredential tokenCredential) { throw null; }
public static Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder ProtectKeysWithAzureKeyVault(this Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder builder, System.Uri keyIdentifier, Azure.Core.TokenCredential tokenCredential) { throw null; }
}
}
6 changes: 4 additions & 2 deletions ...ons.AspNetCore.DataProtection.Keys/src/AzureDataProtectionKeyVaultKeyBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using Azure.Extensions.AspNetCore.DataProtection.Keys;
using Azure.Core;
using Azure.Core.Cryptography;
Expand All @@ -24,9 +25,10 @@ public static class AzureDataProtectionKeyVaultKeyBuilderExtensions
/// <param name="keyIdentifier">The Azure Key Vault key identifier used for key encryption.</param>
/// <param name="tokenCredential">The token credential to use for authentication.</param>
/// <returns>The value <paramref name="builder"/>.</returns>
public static IDataProtectionBuilder ProtectKeysWithAzureKeyVault(this IDataProtectionBuilder builder, string keyIdentifier, TokenCredential tokenCredential)
public static IDataProtectionBuilder ProtectKeysWithAzureKeyVault(this IDataProtectionBuilder builder, Uri keyIdentifier, TokenCredential tokenCredential)
{
return ProtectKeysWithAzureKeyVault(builder, keyIdentifier, new KeyResolver(tokenCredential));
Argument.AssertNotNull(keyIdentifier, nameof(keyIdentifier));
return ProtectKeysWithAzureKeyVault(builder, keyIdentifier.ToString(), new KeyResolver(tokenCredential));
Comment thread
pakrym marked this conversation as resolved.
}

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion ...zure.Extensions.AspNetCore.DataProtection.Keys/tests/DataProtectionKeysFunctionalTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public async Task ProtectsKeysWithKeyVaultKey()

var testKeyRepository = new TestKeyRepository();

serviceCollection.AddDataProtection().ProtectKeysWithAzureKeyVault(key.Value.Id.ToString(), credential);
serviceCollection.AddDataProtection().ProtectKeysWithAzureKeyVault(key.Value.Id, credential);

serviceCollection.Configure<KeyManagementOptions>(options =>
{
Expand Down
2 changes: 1 addition & 1 deletion sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Keys/tests/Snippets.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public void ConfigureServices(IServiceCollection services)
{
services
.AddDataProtection()
.ProtectKeysWithAzureKeyVault("<Key-ID>", new DefaultAzureCredential());
.ProtectKeysWithAzureKeyVault(new Uri("<Key-ID>"), new DefaultAzureCredential());
}
#endregion
}
Expand Down