[Identity] Fix VisualStudioCodeCredential to use refresh token for AzureCloud by default (Azure#16775)

schaabs · web-flow · commit ea54d9c7a4cd · 2020-11-09T11:52:07.000-08:00
* [Identity] Fix VisualStudioCodeCredential to use refresh token for AzureCloud by default

* fix GetAzureCloudInstance logic
diff --git a/sdk/identity/Azure.Identity/CHANGELOG.md b/sdk/identity/Azure.Identity/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Release History
 ## 1.3.0-beta.3 (Unreleased)
 
+### Fixes and improvements
+- Prevent `VisualStudioCodeCredential` using invalid authentication data when no user is signed in to Visual Studio Code ([#15870](https://github.com/Azure/azure-sdk-for-net/issues/15870))
+
 ### Breaking Changes
 - Rename property `IncludeX5CClaimHeader` on `ClientCertificateCredentialOptions` to `SendCertificateChain`
 - Removing Application Authentication APIs for GA release. These will be reintroduced in 1.4.0-beta.1.
diff --git a/sdk/identity/Azure.Identity/src/VisualStudioCodeCredential.cs b/sdk/identity/Azure.Identity/src/VisualStudioCodeCredential.cs
@@ -120,7 +120,7 @@ private void GetUserSettings(out string tenant, out string environmentName)
         {
             var path = _vscAdapter.GetUserSettingsPath();
             tenant = _tenantId;
-            environmentName = "Azure";
+            environmentName = "AzureCloud";
 
             try
             {
@@ -164,7 +164,7 @@ private static IVisualStudioCodeAdapter GetVscAdapter()
         private static AzureCloudInstance GetAzureCloudInstance(string name) =>
             name switch
             {
-                "Azure" => AzureCloudInstance.AzurePublic,
+                "AzureCloud" => AzureCloudInstance.AzurePublic,
                 "AzureChina" => AzureCloudInstance.AzureChina,
                 "AzureGermanCloud" => AzureCloudInstance.AzureGermany,
                 "AzureUSGovernment" => AzureCloudInstance.AzureUsGovernment,
diff --git a/sdk/identity/Azure.Identity/tests/ChainedTokenCredentialLiveTests.cs b/sdk/identity/Azure.Identity/tests/ChainedTokenCredentialLiveTests.cs
@@ -117,7 +117,7 @@ public async Task ChainedTokenCredential_UseVisualStudioCodeCredential_ParallelC
         public async Task ChainedTokenCredential_UseAzureCliCredential()
         {
             var (expectedToken, expectedExpiresOn, processOutput) = CredentialTestHelpers.CreateTokenForAzureCli();
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
             var processService = new TestProcessService(new TestProcess { Output = processOutput });
 
@@ -148,7 +148,7 @@ public async Task ChainedTokenCredential_UseAzureCliCredential()
         public async Task ChainedTokenCredential_UseAzureCliCredential_ParallelCalls()
         {
             var (expectedToken, expectedExpiresOn, processOutput) = CredentialTestHelpers.CreateTokenForAzureCli();
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
             var processService = new TestProcessService { CreateHandler = psi => new TestProcess { Output = processOutput }};
 
@@ -177,7 +177,7 @@ public async Task ChainedTokenCredential_UseAzureCliCredential_ParallelCalls()
         [Test]
         public void ChainedTokenCredential_AllCredentialsHaveFailed_CredentialUnavailableException()
         {
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", "{}");
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", "{}");
 
             var fileSystem = new TestFileSystemService();
             var processService = new TestProcessService(new TestProcess { Error = "'az' is not recognized" });
@@ -232,7 +232,7 @@ public void ChainedTokenCredential_AllCredentialsHaveFailed_FirstAuthenticationF
         [Test]
         public void ChainedTokenCredential_AllCredentialsHaveFailed_LastAuthenticationFailedException()
         {
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = new TestFileSystemService();
             var processService = new TestProcessService(new TestProcess {Error = "Error"});
 
diff --git a/sdk/identity/Azure.Identity/tests/DefaultAzureCredentialLiveTests.cs b/sdk/identity/Azure.Identity/tests/DefaultAzureCredentialLiveTests.cs
@@ -142,7 +142,7 @@ public async Task DefaultAzureCredential_UseAzureCliCredential()
 
             var (expectedToken, expectedExpiresOn, processOutput) = CredentialTestHelpers.CreateTokenForAzureCli();
             var testProcess = new TestProcess { Output = processOutput };
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
 
             var factory = new TestDefaultAzureCredentialFactory(options, fileSystem, new TestProcessService(testProcess), vscAdapter) { ManagedIdentitySourceFactory = () => default };
@@ -178,7 +178,7 @@ public async Task DefaultAzureCredential_UseAzureCliCredential_ParallelCalls()
 
             var (expectedToken, expectedExpiresOn, processOutput) = CredentialTestHelpers.CreateTokenForAzureCli();
             var processService = new TestProcessService { CreateHandler = psi => new TestProcess { Output = processOutput }};
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
 
             var factory = new TestDefaultAzureCredentialFactory(options, fileSystem, processService, vscAdapter) { ManagedIdentitySourceFactory = () => default };
@@ -210,7 +210,7 @@ public void DefaultAzureCredential_AllCredentialsHaveFailed_CredentialUnavailabl
                 ExcludeSharedTokenCacheCredential = true,
             });
 
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", "{}");
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", "{}");
             var factory = new TestDefaultAzureCredentialFactory(options, new TestFileSystemService(), new TestProcessService(new TestProcess { Error = "'az' is not recognized" }), vscAdapter) { ManagedIdentitySourceFactory = () => default };
             var credential = InstrumentClient(new DefaultAzureCredential(factory, options));
 
@@ -266,7 +266,7 @@ public void DefaultAzureCredential_AllCredentialsHaveFailed_LastAuthenticationFa
                 ExcludeSharedTokenCacheCredential = true,
             });
 
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var factory = new TestDefaultAzureCredentialFactory(options, new TestFileSystemService(), new TestProcessService(new TestProcess { Error = "Error" }), vscAdapter) { ManagedIdentitySourceFactory = () => default };
             var credential = InstrumentClient(new DefaultAzureCredential(factory, options));
 
diff --git a/sdk/identity/Azure.Identity/tests/VisualStudioCodeCredentialLiveTests.cs b/sdk/identity/Azure.Identity/tests/VisualStudioCodeCredentialLiveTests.cs
@@ -39,7 +39,7 @@ public async Task AuthenticateWithVscCredential_NoSettingsFile()
         {
             var refreshToken = await CredentialTestHelpers.GetRefreshTokenAsync(TestEnvironment, Mode);
             var fileSystemService = new TestFileSystemService { ReadAllHandler = s => throw new FileNotFoundException() };
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", refreshToken);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", refreshToken);
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = TestEnvironment.TestTenantId });
             VisualStudioCodeCredential credential = InstrumentClient(new VisualStudioCodeCredential(options, default, default, fileSystemService, vscAdapter));
@@ -52,7 +52,7 @@ public async Task AuthenticateWithVscCredential_BrokenSettingsFile()
         {
             var refreshToken = await CredentialTestHelpers.GetRefreshTokenAsync(TestEnvironment, Mode);
             var fileSystemService = new TestFileSystemService { ReadAllHandler = s => "{a,}" };
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", refreshToken);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", refreshToken);
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = TestEnvironment.TestTenantId });
             VisualStudioCodeCredential credential = InstrumentClient(new VisualStudioCodeCredential(options, default, default, fileSystemService, vscAdapter));
@@ -65,7 +65,7 @@ public async Task AuthenticateWithVscCredential_EmptySettingsFile()
         {
             var refreshToken = await CredentialTestHelpers.GetRefreshTokenAsync(TestEnvironment, Mode);
             var fileSystemService = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", refreshToken);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", refreshToken);
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = TestEnvironment.TestTenantId });
             VisualStudioCodeCredential credential = InstrumentClient(new VisualStudioCodeCredential(options, default, default, fileSystemService, vscAdapter));
@@ -107,7 +107,7 @@ public void AuthenticateWithVscCredential_NoVscInstalled()
         public void AuthenticateWithVscCredential_NoRefreshToken()
         {
             var tenantId = TestEnvironment.TestTenantId;
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", null);
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", null);
             var fileSystem = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = tenantId });
@@ -121,7 +121,7 @@ public void AuthenticateWithVscCredential_AuthenticationCodeInsteadOfRefreshToke
         {
             var tenantId = TestEnvironment.TestTenantId;
             var fileSystemService = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", "{}");
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", "{}");
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = tenantId });
             VisualStudioCodeCredential credential = InstrumentClient(new VisualStudioCodeCredential(options, default, default, fileSystemService, vscAdapter));
@@ -134,7 +134,7 @@ public void AuthenticateWithVscCredential_InvalidRefreshToken()
         {
             var tenantId = TestEnvironment.TestTenantId;
             var fileSystemService = CredentialTestHelpers.CreateFileSystemForVisualStudioCode(TestEnvironment);
-            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "Azure", Guid.NewGuid().ToString());
+            var vscAdapter = new TestVscAdapter(ExpectedServiceName, "AzureCloud", Guid.NewGuid().ToString());
 
             var options = InstrumentClientOptions(new VisualStudioCodeCredentialOptions { TenantId = tenantId });
             VisualStudioCodeCredential credential = InstrumentClient(new VisualStudioCodeCredential(options, default, default, fileSystemService, vscAdapter));

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ private void GetUserSettings(out string tenant, out string environmentName)`
`120`	`120`	`{`
`121`	`121`	`var path = _vscAdapter.GetUserSettingsPath();`
`122`	`122`	`tenant = _tenantId;`
`123`		`- environmentName = "Azure";`
	`123`	`+ environmentName = "AzureCloud";`
`124`	`124`
`125`	`125`	`try`
`126`	`126`	`{`
`@@ -164,7 +164,7 @@ private static IVisualStudioCodeAdapter GetVscAdapter()`
`164`	`164`	`private static AzureCloudInstance GetAzureCloudInstance(string name) =>`
`165`	`165`	`name switch`
`166`	`166`	`{`
`167`		`- "Azure" => AzureCloudInstance.AzurePublic,`
	`167`	`+ "AzureCloud" => AzureCloudInstance.AzurePublic,`
`168`	`168`	`"AzureChina" => AzureCloudInstance.AzureChina,`
`169`	`169`	`"AzureGermanCloud" => AzureCloudInstance.AzureGermany,`
`170`	`170`	`"AzureUSGovernment" => AzureCloudInstance.AzureUsGovernment,`