Skip to content

Commit a39288f

Browse files
msJinLeimsJinLei
authored
Fix that RemoveUser doesn't work when create Public Client with broker (Azure#27448)
1 parent ccd1e5e commit a39288f

13 files changed

+90
-78
lines changed

‎src/Accounts/Accounts/Account/DisconnectAzureRmAccount.cs

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -124,21 +124,20 @@ public override void ExecuteCmdlet()
124124

125125
if (ShouldProcess(string.Format("Log out principal '{0}'", azureAccount.Id), "log out"))
126126
{
127-
if (GetContextModificationScope() == ContextModificationScope.CurrentUser)
128-
{
129-
AzureSession.Instance.AuthenticationFactory.RemoveUser(azureAccount, null);
130-
}
131-
132127
if (AzureRmProfileProvider.Instance.Profile != null)
133128
{
134129
ModifyContext((localProfile, profileClient) =>
135-
{
136-
var matchingContexts = localProfile.Contexts?.Values?.Where((c) => c != null && c.Account != null && string.Equals(c.Account.Id, azureAccount.Id, StringComparison.CurrentCultureIgnoreCase));
137-
foreach (var context in matchingContexts)
138-
{
139-
profileClient.TryRemoveContext(context);
140-
}
141-
});
130+
{
131+
var matchingContexts = localProfile.Contexts?.Values?.Where((c) => c != null && c.Account != null && string.Equals(c.Account.Id, azureAccount.Id, StringComparison.CurrentCultureIgnoreCase));
132+
foreach (var context in matchingContexts)
133+
{
134+
if (GetContextModificationScope() == ContextModificationScope.CurrentUser)
135+
{
136+
AzureSession.Instance.AuthenticationFactory.RemoveUser(azureAccount, context.Environment);
137+
}
138+
profileClient.TryRemoveContext(context);
139+
}
140+
});
142141
}
143142

144143
WriteObject(new PSAzureRmAccount(azureAccount));

‎src/Accounts/Accounts/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020

2121
## Upcoming Release
22+
* Fixed that removeUser didn't work when create Public Client with broker.
2223

2324
## Version 4.2.0
2425
* Updated warning message about MFA. For more details, see https://go.microsoft.com/fwlink/?linkid=2276314

‎src/Accounts/Accounts/Context/ClearAzureRmContext.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,29 +65,29 @@ void ClearContext(AzureRmProfile profile, RMProfileClient client)
6565
bool result = false;
6666
if (profile != null)
6767
{
68+
PowerShellTokenCacheProvider tokenCacheProvider = null;
69+
if (!AzureSession.Instance.TryGetComponent(PowerShellTokenCacheProvider.PowerShellTokenCacheProviderKey, out tokenCacheProvider))
70+
{
71+
WriteWarning(Resources.ClientFactoryNotRegisteredClear);
72+
}
73+
6874
var contexts = profile.Contexts.Values;
6975
foreach (var context in contexts)
7076
{
77+
tokenCacheProvider?.ClearCache(context.Environment.ActiveDirectoryAuthority);
7178
client.TryRemoveContext(context);
7279
}
7380

74-
PowerShellTokenCacheProvider tokenCacheProvider;
75-
if (!AzureSession.Instance.TryGetComponent(PowerShellTokenCacheProvider.PowerShellTokenCacheProviderKey, out tokenCacheProvider))
81+
if (tokenCacheProvider != null)
7682
{
77-
WriteWarning(Resources.ClientFactoryNotRegisteredClear);
78-
}
79-
else
80-
{
81-
tokenCacheProvider.ClearCache();
82-
var defaultContext = new AzureContext();
83-
profile.TrySetDefaultContext(defaultContext);
83+
profile.TrySetDefaultContext(new AzureContext());
8484
result = true;
8585
}
86+
8687
if (AzureSession.Instance.TryGetComponent(AzKeyStore.Name, out AzKeyStore keyStore))
8788
{
8889
keyStore?.Clear();
8990
}
90-
9191
}
9292

9393
AzureSession.Instance.RaiseContextClearedEvent();

‎src/Accounts/Accounts/Context/GetAzureRMContext.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ public override void ExecuteCmdlet()
8484
var defaultProfile = DefaultProfile as AzureRmProfile;
8585
if (defaultProfile != null && string.Equals(AzureSession.Instance?.ARMContextSaveMode, "CurrentUser"))
8686
{
87+
AzureSession.Instance.SetProperty(AzureSession.Property.Environment, DefaultContext.Environment.Name);
8788
defaultProfile.RefreshContextsFromCache(_cmdletContext);
8889
}
8990
}

‎src/Accounts/Accounts/Context/RemoveAzureRmContext.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,16 @@
1212
// limitations under the License.
1313
// ----------------------------------------------------------------------------------
1414

15-
using System;
16-
using System.Linq;
17-
using System.Management.Automation;
18-
1915
using Microsoft.Azure.Commands.Common.Authentication;
2016
using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
2117
using Microsoft.Azure.Commands.Common.Authentication.Models;
2218
using Microsoft.Azure.Commands.Profile.Common;
2319
using Microsoft.Azure.Commands.Profile.Models.Core;
2420
using Microsoft.Azure.Commands.Profile.Properties;
25-
using Microsoft.WindowsAzure.Commands.Utilities.Common;
21+
22+
using System;
23+
using System.Linq;
24+
using System.Management.Automation;
2625

2726
namespace Microsoft.Azure.Commands.Profile.Context
2827
{
@@ -91,7 +90,7 @@ public override void ExecuteCmdlet()
9190
}
9291
else
9392
{
94-
if (!tokenCacheProvider.TryRemoveAccount(removedContext.Account.Id))
93+
if (!tokenCacheProvider.TryRemoveAccount(removedContext.Account.Id, removedContext.Environment.ActiveDirectoryAuthority))
9594
{
9695
WriteWarning(string.Format(Resources.NoContextsRemain, removedContext.Account.Id));
9796
}

‎src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -819,9 +819,12 @@ public void RefreshContextsFromCache(ICmdletContext cmdletContext)
819819
out PowerShellTokenCacheProvider tokenCacheProvider);
820820

821821
string authority = null;
822+
//If the function is called from "public virtual IAzureContext DefaultContext", authroity is empty and then ListAccounts will return empty.
823+
//But as "ShouldRefreshContextsFromCache" is always false, the only call path is from GetAzureRMContext for now.
822824
if (TryGetEnvironment(AzureSession.Instance.GetProperty(AzureSession.Property.Environment), out IAzureEnvironment sessionEnvironment))
823825
{
824-
authority = $"{sessionEnvironment.ActiveDirectoryAuthority}organizations";
826+
authority = new Uri(new Uri(sessionEnvironment.ActiveDirectoryAuthority), "organizations").AbsoluteUri;
827+
825828
}
826829
var accounts = tokenCacheProvider.ListAccounts(authority);
827830
if (!accounts.Any())

‎src/Accounts/Authentication/Authentication/TokenCache/InMemoryTokenCacheProvider.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
using Azure.Identity;
1616

17+
using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
1718
using Microsoft.Identity.Client;
1819

1920
namespace Microsoft.Azure.Commands.Common.Authentication
@@ -46,7 +47,7 @@ public override void FlushTokenData()
4647
}
4748
}
4849

49-
public override void ClearCache()
50+
public override void ClearCache(string authority)
5051
{
5152
InMemoryTokenCacheOptions = new InMemoryTokenCacheOptions();
5253
}

‎src/Accounts/Authentication/Authentication/TokenCache/PowerShellTokenCacheProvider.cs

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
// limitations under the License.
1313
// ----------------------------------------------------------------------------------
1414

15-
using System;
16-
using System.Collections.Generic;
17-
using System.Linq;
18-
1915
using Azure.Identity;
2016

2117
using Hyak.Common;
@@ -24,13 +20,15 @@
2420
using Microsoft.Azure.Commands.Common.Authentication.Abstractions.Extensions;
2521
using Microsoft.Azure.Commands.Common.Authentication.Abstractions.Interfaces;
2622
using Microsoft.Azure.Commands.Common.Authentication.Utilities;
27-
using Microsoft.Azure.Commands.Shared.Config;
2823
using Microsoft.Azure.Internal.Subscriptions;
2924
using Microsoft.Azure.Internal.Subscriptions.Models;
30-
using Microsoft.Azure.PowerShell.Common.Config;
3125
using Microsoft.Identity.Client;
3226
using Microsoft.Identity.Client.Broker;
3327

28+
using System;
29+
using System.Collections.Generic;
30+
using System.Linq;
31+
3432
namespace Microsoft.Azure.Commands.Common.Authentication
3533
{
3634
public abstract class PowerShellTokenCacheProvider
@@ -55,14 +53,14 @@ public virtual void FlushTokenData()
5553
_tokenCacheDataToFlush = null;
5654
}
5755

58-
public virtual void ClearCache()
56+
public virtual void ClearCache(string authority = null)
5957
{
6058
}
6159

62-
public bool TryRemoveAccount(string accountId)
60+
public bool TryRemoveAccount(string accountId, string authority = null)
6361
{
6462
TracingAdapter.Information(string.Format("[AuthenticationClientFactory] Calling GetAccountsAsync"));
65-
var client = CreatePublicClient();
63+
var client = CreatePublicClient(authority);
6664
var account = client.GetAccountsAsync()
6765
.ConfigureAwait(false).GetAwaiter().GetResult()
6866
.FirstOrDefault(a => string.Equals(a.Username, accountId, StringComparison.OrdinalIgnoreCase));
@@ -89,7 +87,7 @@ public IEnumerable<IAccount> ListAccounts(string authority = null)
8987
{
9088
TracingAdapter.Information(string.Format("[PowerShellTokenCacheProvider] Calling GetAccountsAsync on {0}", authority ?? "AzureCloud"));
9189

92-
return CreatePublicClient(authority: authority)
90+
return CreatePublicClient(authority)
9391
.GetAccountsAsync()
9492
.ConfigureAwait(false).GetAwaiter().GetResult();
9593
}
@@ -195,18 +193,7 @@ public virtual IPublicClientApplication CreatePublicClient(string authority, str
195193
/// </summary>
196194
public virtual IPublicClientApplication CreatePublicClient(string authority = null)
197195
{
198-
var builder = PublicClientApplicationBuilder.Create(Constants.PowerShellClientId);
199-
if (AzConfigReader.IsWamEnabled(authority))
200-
{
201-
builder = builder.WithBroker(new BrokerOptions(BrokerOptions.OperatingSystems.Windows));
202-
}
203-
if (!string.IsNullOrEmpty(authority))
204-
{
205-
builder.WithAuthority(authority);
206-
}
207-
var client = builder.Build();
208-
RegisterCache(client);
209-
return client;
196+
return CreatePublicClient(authority, organizationTenant);
210197
}
211198

212199
public abstract TokenCachePersistenceOptions GetTokenCachePersistenceOptions();

‎src/Accounts/Authentication/Authentication/TokenCache/SharedTokenCacheProvider.cs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@
1212
// limitations under the License.
1313
// ----------------------------------------------------------------------------------
1414

15-
using System;
16-
1715
using Azure.Identity;
1816

17+
using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
1918
using Microsoft.Identity.Client;
2019
using Microsoft.Identity.Client.Extensions.Msal;
2120

21+
using System;
22+
2223
namespace Microsoft.Azure.Commands.Common.Authentication
2324
{
2425
public class SharedTokenCacheProvider : PowerShellTokenCacheProvider
@@ -103,9 +104,9 @@ protected override void RegisterCache(IPublicClientApplication client)
103104
}
104105
}
105106

106-
public override void ClearCache()
107+
public override void ClearCache(string authority)
107108
{
108-
var client = CreatePublicClient();
109+
var client = CreatePublicClient(authority);
109110
var accounts = client.GetAccountsAsync().GetAwaiter().GetResult();
110111
foreach (var account in accounts)
111112
{

‎src/Accounts/Authentication/Factories/AuthenticationFactory.cs

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,16 @@ public ServiceClientCredentials GetServiceClientCredentials(string accessToken,
487487
/// <param name="account"></param>
488488
/// <param name="tokenCache">This parameter is no longer used. However to keep the API unchanged it's not removed.</param>
489489
public void RemoveUser(IAzureAccount account, IAzureTokenCache tokenCache)
490+
{
491+
RemoveUser(account, environment: null);
492+
}
493+
494+
/// <summary>
495+
/// Remove any stored credentials for the given user and the Azure environment used.
496+
/// </summary>
497+
/// <param name="account">The account to remove credentials for</param>
498+
/// <param name="environment">The environment which account belongs to</param>
499+
public void RemoveUser(IAzureAccount account, IAzureEnvironment environment)
490500
{
491501
if (account != null && !string.IsNullOrEmpty(account.Id) && !string.IsNullOrWhiteSpace(account.Type))
492502
{
@@ -513,10 +523,10 @@ public void RemoveUser(IAzureAccount account, IAzureTokenCache tokenCache)
513523
// make best effort to remove credentials
514524
}
515525

516-
RemoveFromTokenCache(account);
526+
RemoveFromTokenCache(account, environment.ActiveDirectoryAuthority);
517527
break;
518528
case AzureAccount.AccountType.User:
519-
RemoveFromTokenCache(account);
529+
RemoveFromTokenCache(account, environment.ActiveDirectoryAuthority);
520530
break;
521531
}
522532
}
@@ -558,20 +568,20 @@ private string GetEndpointToken(IAzureAccount account, string targetEndpoint)
558568
return account.GetProperty(tokenKey);
559569
}
560570

561-
private void RemoveFromTokenCache(IAzureAccount account)
571+
private void RemoveFromTokenCache(IAzureAccount account, string authority = null)
562572
{
563573
PowerShellTokenCacheProvider tokenCacheProvider;
564574
if (!AzureSession.Instance.TryGetComponent(PowerShellTokenCacheProvider.PowerShellTokenCacheProviderKey, out tokenCacheProvider))
565575
{
566576
throw new NullReferenceException(Resources.AuthenticationClientFactoryNotRegistered);
567577
}
568578

569-
var publicClient = tokenCacheProvider.CreatePublicClient();
579+
var publicClient = tokenCacheProvider.CreatePublicClient(authority);
570580
var accounts = publicClient.GetAccountsAsync()
571581
.ConfigureAwait(false).GetAwaiter().GetResult();
572582
var tokenAccounts = accounts.Where(a => MatchCacheItem(account, a));
573583
foreach (var tokenAccount in tokenAccounts)
574-
{
584+
{
575585
publicClient.RemoveAsync(tokenAccount)
576586
.ConfigureAwait(false).GetAwaiter().GetResult();
577587
}

‎tools/Common.Netcore.Dependencies.targets

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
<ItemGroup>
44
<PackageReference Include="Microsoft.Rest.ClientRuntime" Version="2.3.24"/>
55
<PackageReference Include="Microsoft.Rest.ClientRuntime.Azure" Version="3.3.19"/>
6-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Aks" Version="1.3.106-preview"/>
7-
<PackageReference Include="Microsoft.Azure.PowerShell.Authentication.Abstractions" Version="1.3.106-preview"/>
8-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Authorization" Version="1.3.106-preview"/>
9-
<PackageReference Include="Microsoft.Azure.PowerShell.Common" Version="1.3.106-preview"/>
10-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Compute" Version="1.3.106-preview"/>
11-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Graph.Rbac" Version="1.3.106-preview"/>
12-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.KeyVault" Version="1.3.106-preview"/>
13-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Monitor" Version="1.3.106-preview"/>
14-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Network" Version="1.3.106-preview"/>
15-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.PolicyInsights" Version="1.3.106-preview"/>
16-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.ResourceManager" Version="1.3.106-preview"/>
17-
<PackageReference Include="Microsoft.Azure.PowerShell.Storage" Version="1.3.106-preview"/>
18-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Storage.Management" Version="1.3.106-preview"/>
19-
<PackageReference Include="Microsoft.Azure.PowerShell.Strategies" Version="1.3.106-preview"/>
20-
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Websites" Version="1.3.106-preview"/>
21-
<PackageReference Include="Microsoft.Azure.PowerShell.Common.Share" Version="1.3.106-preview"/>
6+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Aks" Version="1.3.107-preview"/>
7+
<PackageReference Include="Microsoft.Azure.PowerShell.Authentication.Abstractions" Version="1.3.107-preview"/>
8+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Authorization" Version="1.3.107-preview"/>
9+
<PackageReference Include="Microsoft.Azure.PowerShell.Common" Version="1.3.107-preview"/>
10+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Compute" Version="1.3.107-preview"/>
11+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Graph.Rbac" Version="1.3.107-preview"/>
12+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.KeyVault" Version="1.3.107-preview"/>
13+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Monitor" Version="1.3.107-preview"/>
14+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Network" Version="1.3.107-preview"/>
15+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.PolicyInsights" Version="1.3.107-preview"/>
16+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.ResourceManager" Version="1.3.107-preview"/>
17+
<PackageReference Include="Microsoft.Azure.PowerShell.Storage" Version="1.3.107-preview"/>
18+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Storage.Management" Version="1.3.107-preview"/>
19+
<PackageReference Include="Microsoft.Azure.PowerShell.Strategies" Version="1.3.107-preview"/>
20+
<PackageReference Include="Microsoft.Azure.PowerShell.Clients.Websites" Version="1.3.107-preview"/>
21+
<PackageReference Include="Microsoft.Azure.PowerShell.Common.Share" Version="1.3.107-preview"/>
2222
<PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
2323
</ItemGroup>
2424
<ItemGroup>
@@ -37,7 +37,7 @@
3737
<PackageReference Include="PowerShellStandard.Library" Version="5.1.0" PrivateAssets="All" />
3838
</ItemGroup>
3939
<PropertyGroup>
40-
<StorageToolsPath>$(NugetPackageRoot)\microsoft.azure.powershell.storage\1.3.106-preview\tools\</StorageToolsPath>
40+
<StorageToolsPath>$(NugetPackageRoot)\microsoft.azure.powershell.storage\1.3.107-preview\tools\</StorageToolsPath>
4141
</PropertyGroup>
4242
<ItemGroup Condition="'$(OmitJsonPackage)' != 'true'">
4343
<PackageReference Include="Newtonsoft.Json" Version="13.0.2"/>

‎tools/TestFx/Mocks/MockCertificateAuthenticationFactory.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,5 +124,10 @@ public IAccessToken Authenticate(IAzureAccount account, IAzureEnvironment enviro
124124
{
125125
throw new NotImplementedException();
126126
}
127+
128+
public void RemoveUser(IAzureAccount account, IAzureEnvironment environment)
129+
{
130+
throw new NotImplementedException();
131+
}
127132
}
128133
}

‎tools/TestFx/Mocks/MockTokenAuthenticationFactory.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,5 +148,10 @@ public ServiceClientCredentials GetServiceClientCredentials(IAzureContext contex
148148
{
149149
return GetServiceClientCredentials(context, targetEndpoint, AzureCmdletContext.CmdletNone);
150150
}
151+
152+
public void RemoveUser(IAzureAccount account, IAzureEnvironment environment)
153+
{
154+
throw new NotImplementedException();
155+
}
151156
}
152157
}

0 commit comments

Comments
 (0)