Add option --prompt-hint to enable customized header text for WAM p…

…rompts and web mode. (#11) * apis * optimize comments * unit test * format * Update src/AzureAuth/CommandMain.cs Co-authored-by: Shalini Khare <31912044+shalinikhare27@users.noreply.github.com> * Rename header-text to caller * Fix typos. * Update CommandMain.cs * Update TokenFetcherPublicClient.cs * rename "caller" to "prompt-hint" * Unit test for Prompt-Hint * Update CHANGELOG.md * add comment for GetTokenNormalFlowAsync_GetTokenInteractive_WithPromptHint * modify CHANGELOG.md Co-authored-by: Shalini Khare <31912044+shalinikhare27@users.noreply.github.com>
AzureAD · Apr 14, 2022 · 5d3bff7 · 5d3bff7
1 parent 1e5dee4
commit 5d3bff7
Show file tree

Hide file tree

Showing 8 changed files with 119 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Option `--prompt-hint` to support custom text to prompt caller in web and WAM mode.
+
 ### Changed
 - Rename the `--auth-mode` flag to `--mode`.
 
@@ -16,4 +19,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial project release.
 
 [Unreleased]: https://github.com/AzureAD/microsoft-authentication-cli/compare/v0.1.0...HEAD
-[v0.1.0]: https://github.com/AzureAD/microsoft-authentication-cli/releases/tag/v0.1.0
+[v0.1.0]: https://github.com/AzureAD/microsoft-authentication-cli/releases/tag/v0.1.0
diff --git a/src/AzureAuth.Test/AliasTest.cs b/src/AzureAuth.Test/AliasTest.cs
@@ -73,6 +73,20 @@ public void TestMergePrefersNonNullMembers()
             result.Should().BeEquivalentTo(this.expected);
         }
 
+        /// <summary>
+        /// The test to merge prompt hints.
+        /// </summary>
+        [Test]
+        public void TestMergePromptHint()
+        {
+            this.alias.PromptHint = "expected prompt hint";
+            this.expected.PromptHint = "expected prompt hint";
+
+            Alias result = this.alias.Override(this.other);
+
+            result.Should().BeEquivalentTo(this.expected);
+        }
+
         /// <summary>
         /// The test to merge multiple members.
         /// </summary>
@@ -100,6 +114,7 @@ public void TestMergeAllMembers()
             this.alias.Client = "unexpected client";
             this.alias.Domain = "unexpected domain";
             this.alias.Tenant = "unexpected tenant";
+            this.alias.PromptHint = "unexpected prompt hint";
             this.alias.Scopes = new List<string> { "unexpected scope" };
 
             Alias result = this.alias.Override(this.other);

diff --git a/src/AzureAuth.Test/CommandMainTest.cs b/src/AzureAuth.Test/CommandMainTest.cs
@@ -34,6 +34,7 @@ internal class CommandMainTest
 domain = ""contoso.com""
 tenant = ""a3be859b-7f9a-4955-98ed-f3602dbd954c""
 scopes = [ "".default"", ]
+prompt_hint = ""sample prompt hint.""
 ";
 
         private const string PartialAliasTOML = @"
@@ -162,6 +163,7 @@ public void TestEvaluateOptionsProvidedAliasWithoutCommandLineOptions()
                 Domain = "contoso.com",
                 Tenant = "a3be859b-7f9a-4955-98ed-f3602dbd954c",
                 Scopes = new List<string> { ".default" },
+                PromptHint = "sample prompt hint.",
             };
 
             CommandMain subject = this.serviceProvider.GetService<CommandMain>();
@@ -188,6 +190,7 @@ public void TestEvaluateOptionsProvidedAliasWithCommandLineOptions()
                 Domain = "contoso.com",
                 Tenant = "a3be859b-7f9a-4955-98ed-f3602dbd954c",
                 Scopes = new List<string> { ".default" },
+                PromptHint = "sample prompt hint.",
             };
 
             CommandMain subject = this.serviceProvider.GetService<CommandMain>();
@@ -217,6 +220,7 @@ public void TestEvaluateOptionsProvidedAliasWithEnvVarConfig()
                 Domain = "contoso.com",
                 Tenant = "a3be859b-7f9a-4955-98ed-f3602dbd954c",
                 Scopes = new List<string> { ".default" },
+                PromptHint = "sample prompt hint.",
             };
 
             CommandMain subject = this.serviceProvider.GetService<CommandMain>();

diff --git a/src/AzureAuth/Alias.cs b/src/AzureAuth/Alias.cs
@@ -30,6 +30,11 @@ public class Alias
         /// </summary>
         public string Tenant { get; set; }
 
+        /// <summary>
+        /// Gets or sets the customized prompt hint.
+        /// </summary>
+        public string PromptHint { get; set; }
+
         /// <summary>
         /// Gets or sets the scopes.
         /// </summary>
@@ -53,6 +58,7 @@ public Alias Override(Alias other)
                 Client = other.Client ?? this.Client,
                 Domain = other.Domain ?? this.Domain,
                 Tenant = other.Tenant ?? this.Tenant,
+                PromptHint = other.PromptHint ?? this.PromptHint,
                 Scopes = other.Scopes ?? this.Scopes,
             };
         }

diff --git a/src/AzureAuth/CommandMain.cs b/src/AzureAuth/CommandMain.cs
@@ -26,6 +26,7 @@ public class CommandMain
         private const string ResourceOption = "--resource";
         private const string ClientOption = "--client";
         private const string TenantOption = "--tenant";
+        private const string PromptHintOption = "--prompt-hint";
         private const string ScopeOption = "--scope";
         private const string ClearOption = "--clear";
         private const string DomainOption = "--domain";
@@ -104,6 +105,12 @@ public CommandMain(CommandExecuteEventData eventData, ILogger<CommandMain> logge
         [Option(TenantOption, "The ID of the Tenant where the client and resource entities exist in", CommandOptionType.SingleValue)]
         public string Tenant { get; set; }
 
+        /// <summary>
+        /// Gets or sets the customized prompt hint text for WAM prompts and web mode.
+        /// </summary>
+        [Option(PromptHintOption, "The prompt hint text for WAM prompts and web mode.", CommandOptionType.SingleValue)]
+        public string PromptHint { get; set; }
+
         /// <summary>
         /// Gets or sets the scopes.
         /// </summary>
@@ -172,6 +179,7 @@ public bool EvaluateOptions()
                 Client = this.Client,
                 Domain = this.PreferredDomain,
                 Tenant = this.Tenant,
+                PromptHint = this.PromptHint,
                 Scopes = this.Scopes?.ToList(),
             };
 
@@ -358,7 +366,8 @@ private ITokenFetcher TokenFetcher()
                     new Guid(this.tokenFetcherOptions.Client),
                     new Guid(this.tokenFetcherOptions.Tenant),
                     osxKeyChainSuffix: Constants.AuthOSXKeyChainSuffix,
-                    preferredDomain: this.tokenFetcherOptions.Domain);
+                    preferredDomain: this.tokenFetcherOptions.Domain,
+                    promptHint: this.PromptHint);
             }
 
             return this.tokenFetcher;

diff --git a/src/MSALWrapper.Test/TokenFetcherPublicClientTest.cs b/src/MSALWrapper.Test/TokenFetcherPublicClientTest.cs
@@ -49,6 +49,8 @@ public class TokenFetcherPublicClientTest
         private IEnumerable<string> scopes = new string[] { $"{ResourceId}/.default" };
         private TokenResult tokenResult;
 
+        private string promptHint = "test prompt hint";
+
         /// <summary>
         /// The setup.
         /// </summary>
@@ -73,7 +75,7 @@ public void Setup()
              .AddTransient<TokenFetcherPublicClient>((provider) =>
              {
                  var logger = provider.GetService<ILogger<TokenFetcherPublicClient>>();
-                 return new TokenFetcherPublicClient(logger, ResourceId, ClientId, TenantId);
+                 return new TokenFetcherPublicClient(logger, ResourceId, ClientId, TenantId, promptHint: this.promptHint);
              })
              .BuildServiceProvider();
 
@@ -371,6 +373,25 @@ public async Task GetTokenNormalFlowAsync_GetTokenInteractive_Throws_OperationCa
             tokenFetcher.ErrorsList[2].Message.Should().Be("Interactive Auth (with extra claims) timed out after 15 minutes.");
         }
 
+        /// <summary>
+        /// Ensure <see cref="IPCAWrapper.WithPromptHint"/> be invoked in <see cref="TokenFetcherPublicClient.GetTokenNormalFlowAsync"/>.
+        /// </summary>
+        /// <returns>The <see cref="Task"/>.</returns>
+        [Test]
+        public async Task GetTokenNormalFlowAsync_GetTokenInteractive_WithPromptHint()
+        {
+            this.SilentAuthUIRequired();
+            this.InteractiveAuthResult();
+
+            // Act
+            var tokenFetcher = this.Subject();
+            var result = await tokenFetcher.GetTokenNormalFlowAsync(this.pcaMock.Object, this.scopes, this.testAccount.Object);
+
+            // Verify
+            this.pcaMock.Verify((pca) => pca.WithPromptHint(this.promptHint), Times.Once());
+            this.pcaMock.VerifyAll();
+        }
+
         /// <summary>
         /// The get token_ device code_ flow_ happy path.
         /// </summary>
@@ -556,6 +577,7 @@ private void SilentAuthUIRequired()
             this.pcaMock
                 .Setup((pca) => pca.GetTokenSilentAsync(this.scopes, this.testAccount.Object, It.IsAny<CancellationToken>()))
                 .Throws(new MsalUiRequiredException("1", "UI is required"));
+            this.SetupInteractiveAuthWithPromptHint();
         }
 
         private void SilentAuthServiceException()
@@ -628,6 +650,13 @@ private void InteractiveAuthWithClaimsTimeout()
                 .Throws(new OperationCanceledException());
         }
 
+        private void SetupInteractiveAuthWithPromptHint()
+        {
+            this.pcaMock
+                .Setup(pca => pca.WithPromptHint(It.IsAny<string>()))
+                .Returns((string s) => this.pcaMock.Object);
+        }
+
         private TokenFetcherPublicClient Subject() => this.serviceProvider.GetService<TokenFetcherPublicClient>();
     }
 }
diff --git a/src/MSALWrapper/PCAWrapper.cs b/src/MSALWrapper/PCAWrapper.cs
@@ -86,6 +86,13 @@ public interface IPCAWrapper
         /// </returns>
         Task<TokenResult> GetTokenDeviceCodeAsync(IEnumerable<string> scopes, Func<DeviceCodeResult, Task> callback, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Customize the title bar by prompt hint(Web mode only).
+        /// </summary>
+        /// <param name="promptHint">The prompt hint text.</param>
+        /// <returns>This.</returns>
+        IPCAWrapper WithPromptHint(string promptHint);
+
         /// <summary>
         /// Tries to return a cached account when the list returns only one account using the preferred domain if provided.
         /// A null return indicates one of the following.
@@ -128,6 +135,22 @@ public PCAWrapper(ILogger logger, IPublicClientApplication pca)
             this.pca = pca;
         }
 
+        /// <summary>
+        /// Gets or sets, The prompt hint displayed in the title bar.
+        /// </summary>
+        public string PromptHint { get; set; }
+
+        /// <summary>
+        /// Customize the title bar by prompt hint(Web mode only).
+        /// </summary>
+        /// <param name="promptHint">see <see cref="PromptHint"/>.</param>
+        /// <returns>This.</returns>
+        public IPCAWrapper WithPromptHint(string promptHint)
+        {
+            this.PromptHint = promptHint;
+            return this;
+        }
+
         /// <summary>
         /// The get token silent async.
         /// </summary>
@@ -168,6 +191,10 @@ public async Task<TokenResult> GetTokenInteractiveAsync(IEnumerable<string> scop
         {
             AuthenticationResult result = await this.pca
                 .AcquireTokenInteractive(scopes)
+                .WithEmbeddedWebViewOptions(new EmbeddedWebViewOptions()
+                {
+                    Title = this.PromptHint,
+                })
                 .WithAccount(account)
                 .ExecuteAsync(cancellationToken)
                 .ConfigureAwait(false);
@@ -193,6 +220,10 @@ public async Task<TokenResult> GetTokenInteractiveAsync(IEnumerable<string> scop
         {
             AuthenticationResult result = await this.pca
                 .AcquireTokenInteractive(scopes)
+                .WithEmbeddedWebViewOptions(new EmbeddedWebViewOptions()
+                {
+                    Title = this.PromptHint,
+                })
                 .WithClaims(claims)
                 .ExecuteAsync(cancellationToken)
                 .ConfigureAwait(false);

diff --git a/src/MSALWrapper/TokenFetcherPublicClient.cs b/src/MSALWrapper/TokenFetcherPublicClient.cs
@@ -60,6 +60,8 @@ public class TokenFetcherPublicClient : ITokenFetcher
         private readonly bool windows;
         private readonly bool windows10;
 
+        private readonly string promptHint;
+
         #region Required MSAL GUIDs
 
         /// <summary>
@@ -115,7 +117,10 @@ public class TokenFetcherPublicClient : ITokenFetcher
         /// <param name="verifyPersistence">
         /// Optionally choose to verify the cache persistence layer when setting up the token cache.
         /// </param>
-        public TokenFetcherPublicClient(ILogger logger, Guid resourceId, Guid clientId, Guid tenantId, string osxKeyChainSuffix = null, string preferredDomain = null, bool verifyPersistence = false)
+        /// <param name="promptHint">
+        /// The customized header text in account picker for WAM prompts.
+        /// </param>
+        public TokenFetcherPublicClient(ILogger logger, Guid resourceId, Guid clientId, Guid tenantId, string osxKeyChainSuffix = null, string preferredDomain = null, bool verifyPersistence = false, string promptHint = null)
         {
             this.windows = PlatformUtils.IsWindows(logger);
             this.windows10 = PlatformUtils.IsWindows10(logger);
@@ -125,6 +130,8 @@ public TokenFetcherPublicClient(ILogger logger, Guid resourceId, Guid clientId,
             this.resourceId = resourceId;
             this.clientId = clientId;
 
+            this.promptHint = promptHint;
+
             this.osxKeyChainSuffix = osxKeyChainSuffix;
             this.verifyPersistence = verifyPersistence;
             this.preferredDomain = preferredDomain;
@@ -334,7 +341,9 @@ public async Task<TokenResult> GetTokenNormalFlowAsync(IPCAWrapper pcaWrapper, I
                         var tokenResult = await this.CompleteWithin(
                             this.interactiveAuthTimeout,
                             "Interactive Auth",
-                            (cancellationToken) => pcaWrapper.GetTokenInteractiveAsync(scopes, account, cancellationToken)) // TODO: Need to pass account here
+                            (cancellationToken) => pcaWrapper
+                            .WithPromptHint(this.promptHint)
+                            .GetTokenInteractiveAsync(scopes, account, cancellationToken)) // TODO: Need to pass account here
                             .ConfigureAwait(false);
                         this.SetAuthenticationType(tokenResult, AuthType.Interactive);
                         return tokenResult;
@@ -347,7 +356,9 @@ public async Task<TokenResult> GetTokenNormalFlowAsync(IPCAWrapper pcaWrapper, I
                     var tokenResult = await this.CompleteWithin(
                         this.interactiveAuthTimeout,
                         "Interactive Auth (with extra claims)",
-                        (cancellationToken) => pcaWrapper.GetTokenInteractiveAsync(scopes, ex.Claims, cancellationToken))
+                        (cancellationToken) => pcaWrapper
+                        .WithPromptHint(this.promptHint)
+                        .GetTokenInteractiveAsync(scopes, ex.Claims, cancellationToken))
                         .ConfigureAwait(false);
                     this.SetAuthenticationType(tokenResult, AuthType.Interactive);
                     return tokenResult;
@@ -471,6 +482,11 @@ private IPublicClientApplication PCAWeb()
         private IPublicClientApplication PCABroker()
         {
             var pcaBuilder = this.PCABase();
+            pcaBuilder.WithWindowsBrokerOptions(new WindowsBrokerOptions
+            {
+                HeaderText = this.promptHint,
+            });
+
 #if NETFRAMEWORK
             pcaBuilder.WithWindowsBroker();
 #else