Skip to content

Commit 68acbc9

Browse files
committed
msauth: update MSAuth flow comment to reflect today
Update the large block comment on how we select which types of flows to use for Microsoft authentication.
1 parent 2a18505 commit 68acbc9

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

src/shared/Core/Authentication/MicrosoftAuthentication.cs

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,26 +78,25 @@ public async Task<IMicrosoftAuthenticationResult> GetTokenAsync(
7878
}
7979

8080
//
81-
// If we failed to acquire an AT silently (either because we don't have an existing user, or the user's RT has expired)
82-
// we need to prompt the user for credentials.
81+
// If we failed to acquire an AT silently (either because we don't have an existing user, or the user's
82+
// RT has expired) we need to prompt the user for credentials.
8383
//
84-
// If the user has expressed a preference in how the want to perform the interactive authentication flows then we respect that.
85-
// Otherwise, depending on the current platform and session type we try to show the most appropriate authentication interface:
84+
// If the user has expressed a preference in how they want to perform the interactive authentication
85+
// flows then we respect that. Otherwise, depending on the current platform and session type we try to
86+
// show the most appropriate authentication interface:
8687
//
87-
// On Windows 10 & .NET Framework, MSAL supports the Web Account Manager (WAM) broker - we try to use that if possible
88-
// in the first instance.
88+
// On Windows 10+ & .NET Framework, MSAL supports the Web Account Manager (WAM) broker - we try to use
89+
// that if possible in the first instance.
8990
//
90-
// On .NET Framework MSAL supports the WinForms based 'embedded' webview UI. For Windows + .NET Framework this is the
91-
// best and natural experience.
91+
// On .NET Framework MSAL supports the WinForms based 'embedded' webview UI. This experience is less
92+
// jarring that the system webview flow so try that option next.
9293
//
93-
// On other runtimes (e.g., .NET Core) MSAL only supports the system webview flow (launch the user's browser),
94-
// and the device-code flows.
94+
// On other runtimes (e.g., .NET 6+) MSAL only supports the system webview flow (launch the user's
95+
// browser), and the device-code flows. The system webview flow requires that the redirect URI is a
96+
// loopback address, and that we are in an interactive session.
9597
//
96-
// Note: .NET Core 3 allows using WinForms when run on Windows but MSAL does not yet support this.
97-
//
98-
// The system webview flow requires that the redirect URI is a loopback address, and that we are in an interactive session.
99-
//
100-
// The device code flow has no limitations other than a way to communicate to the user the code required to authenticate.
98+
// The device code flow has no limitations other than a way to communicate to the user the code required
99+
// to authenticate.
101100
//
102101
if (result is null)
103102
{

0 commit comments

Comments
 (0)