-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce DefaultAzureCredentialWithoutManagedIdentity (#5354)
- Loading branch information
Konrad Jamrozik
authored
Feb 12, 2023
1 parent
753f295
commit c143be2
Showing
1 changed file
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,7 +28,8 @@ public static async Task Main(string[] args) | |
.UseContentRoot(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)) | ||
.ConfigureServices((context, services) => | ||
{ | ||
services.AddSingleton<TokenCredential, DefaultAzureCredential>(); | ||
services.AddSingleton<TokenCredential, ChainedTokenCredential>( | ||
DefaultAzureCredentialWithoutManagedIdentity); | ||
services.AddSingleton<ISecretClientProvider, SecretClientProvider>(); | ||
services.Configure<PipelineOwnerSettings>(context.Configuration); | ||
services | ||
|
@@ -46,6 +47,47 @@ public static async Task Main(string[] args) | |
await processor.ExecuteAsync(); | ||
} | ||
|
||
/// <summary> | ||
/// Instead of using DefaultAzureCredential [1] we use ChainedTokenCredential [2] which works | ||
/// as DefaultAzureCredential, but most importantly, it excludes ManagedIdentityCredential. | ||
/// We do so because there is an undesired managed identity available when we run this | ||
/// code in CI/CD pipelines, which takes priority over the desired AzureCliCredential coming | ||
/// from the calling AzureCLI@2 task. | ||
/// | ||
/// Besides, the returned ChainedTokenCredential also excludes following credentials: | ||
/// | ||
/// - SharedTokenCredential, as it appears to fail on linux with following error: | ||
/// SharedTokenCacheCredential authentication failed: Persistence check failed. Data was written but it could not be read. Possible cause: on Linux, LibSecret is installed but D-Bus isn't running because it cannot be started over SSH. | ||
/// | ||
/// - VisualStudioCodeCredential, as it doesn't work, as explained here: | ||
/// https://learn.microsoft.com/en-us/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#defaultazurecredential | ||
/// | ||
/// The remaining credentials are in the same order as in DefaultAzureCredential. | ||
/// | ||
/// For debugging aids helping determine which credential is used and how, | ||
/// please see the following tags in azure-sdk-tools repo: | ||
/// - kojamroz_debug_aid_default_azure_credentials | ||
/// Code from @hallipr showing how to get credential data using Microsoft Graph and JwtSecurityToken | ||
/// - kojamroz_debug_aid_diag_log_on_creds | ||
/// Code from kojamroz showing how to use Azure.Identity diagnostic output to get information on which | ||
/// credential ends up being in use (additional flags must be set to see the full info [3]) | ||
/// | ||
/// Full context provided here, on internal Azure SDK Engineering System Teams channel: | ||
/// https://teams.microsoft.com/l/message/19:[email protected]/1675713800408?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1675713800408&teamName=Azure%20SDK&channelName=Engineering%20System%20%F0%9F%9B%A0%EF%B8%8F&createdTime=1675713800408 | ||
/// | ||
/// [1] https://learn.microsoft.com/en-us/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#defaultazurecredential | ||
/// [2] https://learn.microsoft.com/en-us/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#define-a-custom-authentication-flow-with-chainedtokencredential | ||
/// [3] https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md#logging | ||
/// </summary> | ||
private static Func<IServiceProvider, ChainedTokenCredential> DefaultAzureCredentialWithoutManagedIdentity | ||
=> _ | ||
=> new ChainedTokenCredential( | ||
new EnvironmentCredential(), | ||
new VisualStudioCredential(), | ||
new AzureCliCredential(), | ||
new AzurePowerShellCredential(), | ||
new InteractiveBrowserCredential()); | ||
|
||
private static AzureDevOpsService CreateAzureDevOpsService(IServiceProvider provider) | ||
{ | ||
var logger = provider.GetRequiredService<ILogger<AzureDevOpsService>>(); | ||
|