Updating to .NET 8 Preview 1 breaks AuthorizationEndpoint query on AddGoogle

[jamesgurung]

The following web application correctly shows a Google sign in page when it is built with net7.0 and version 7.0.3 of Microsoft.AspNetCore.Authentication.Google. Note that a prompt query parameter is added to the authorization endpoint to force an account selection dialog to appear, rather than automatically signing in with the current Google account.

In net8.0 (Preview 1), the same app shows an error page on accounts.google.com:

Access blocked: authorisation error
OAuth 2 parameters can only have a single value: prompt
Error 400: invalid_request

This is a breaking change, but I couldn't find it on the Breaking Changes in .NET 8 page. It might be enough of an edge case that it doesn't matter, but I thought I'd raise an issue just in case.

WebApplication1.csproj

<Project Sdk="Microsoft.NET.Sdk.Web">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.Authentication.Google" Version="8.0.0-preview.1.23112.2" />
  </ItemGroup>
</Project>

Program.cs

using Microsoft.AspNetCore.Authentication.Cookies;
using Microsoft.AspNetCore.Authentication.Google;

var builder = WebApplication.CreateBuilder(args);
builder.Services
  .AddAuthentication(o => {
    o.DefaultScheme = CookieAuthenticationDefaults.AuthenticationScheme;
    o.DefaultChallengeScheme = GoogleDefaults.AuthenticationScheme;
  })
  .AddCookie()
  .AddGoogle(o =>
  {
    o.ClientId = builder.Configuration["Google:ClientId"];
    o.ClientSecret = builder.Configuration["Google:ClientSecret"];
    o.AuthorizationEndpoint += "?prompt=select_account"; // <-- Broken in .NET 8
  });
var app = builder.Build();
app.UseAuthentication();
app.MapGet("/", () => Results.Challenge());
app.Run();

dotnet --version

8.0.100-preview.1.23115.2

Summary Comment : #47054 (comment)

[Tratcher]

What did the resulting url look like? It sounds like the options callback is being invoked twice for the same instance which would be bad. There was a bug in lazy options caching like that recently.

[jamesgurung]

@Tratcher The URL is:

https://accounts.google.com/o/oauth2/v2/auth?prompt=select_account&prompt=select_account&client_id=REDACTED.apps.googleusercontent.com&scope=openid%20profile%20email&response_type=code&redirect_uri=https%3A%2F%2Flocalhost%3A5001%2Fsignin-google&code_challenge=REDACTED&code_challenge_method=S256&state=REDACTED

[mkArtakMSFT]

@Tratcher do you think this is a bug we've introduced that we need to address?

[Tratcher]

@mkArtakMSFT yes, this needs to be investigated.

[ghost]

To learn more about what this message means, what to expect next, and how this issue will be handled you can read our Triage Process document.
We're moving this issue to the .NET 9 Planning milestone for future evaluation / consideration. Because it's not immediately obvious what is causing this behavior, we would like to keep this around to collect more feedback, which can later help us determine how to handle this. We will re-evaluate this issue, during our next planning meeting(s).
If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact work.

[PowerSaka]

The last line of BuildChallengeUrl() function causes duplicate parameters:
?prompt=select_account&prompt=select_account

[Tratcher]

Found the regression: afb6ec4#diff-dbfbf20eedf9c001d9d7848400c42e852216354b81f651f5bc82dbf42632475cR63 (thanks @PowerSaka)

To enable PKCE in 8.0 the Google auth handler was changed to call base.BuildChallengeUrl,
var queryStrings = QueryHelpers.ParseQuery(new Uri(base.BuildChallengeUrl(properties, redirectUri)).Query);

which calls

aspnetcore/src/Security/Authentication/OAuth/src/OAuthHandler.cs

Line 331 in c15938b

return QueryHelpers.AddQueryString(Options.AuthorizationEndpoint, parameters!);

This results in a query param list that contains the original parameters from AuthorizationEndpoint. Once google adds it's extra properties to the list it calls this again:

aspnetcore/src/Security/Authentication/Google/src/GoogleHandler.cs

Line 84 in c15938b

return QueryHelpers.AddQueryString(Options.AuthorizationEndpoint, queryStrings);

pulling the original parameters from the AuthorizationEndpoint again, causing duplication.

Workaround:

• Add the parameter in the RedirectToAuthorizationEndpoint event.

  .AddGoogle(o =>
  {
    o.ClientId = builder.Configuration["Google:ClientId"];
    o.ClientSecret = builder.Configuration["Google:ClientSecret"];
-    o.AuthorizationEndpoint += "?prompt=select_account"; // <-- Broken in .NET 8
+    o.Events = new OAuthEvents()
+    {
+        OnRedirectToAuthorizationEndpoint = c =>
+        {
+          c.RedirectUri += "&prompt=consent";
+          c.Response.Redirect(c.RedirectUri);
+          return Task.CompletedTask;
+        }
+    };
  });

Possible fix: Since we know that base.BuildChallengeUrl already includes the original query params from AuthorizationEndpoint, drop them from the AuthorizationEndpoint before adding the final set of query params here.

aspnetcore/src/Security/Authentication/Google/src/GoogleHandler.cs

Line 84 in c15938b

return QueryHelpers.AddQueryString(Options.AuthorizationEndpoint, queryStrings);

Note this is more complex than what other handlers support because they only support append, not per-challenge replacement of base parameters like scope.

aspnetcore/src/Security/Authentication/Google/src/GoogleHandler.cs

Line 74 in c15938b

SetQueryParam(queryStrings, properties, GoogleChallengeProperties.ScopeKey, FormatScope, Options.Scope);

Also, adding GoogleOptions.PromptParamter like we have for other parameters would make direct manipulation of the AuthorizationEndpoint less necessary. Also consider ApprovalPrompt.

[Tratcher]

@kevinchalet @martincostello I see a similar issue here:
https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers/blob/163a006c3b3ec38a82da4cb0949c209ae4e04fd3/src/AspNet.Security.OAuth.VisualStudio/VisualStudioAuthenticationHandler.cs#L90-L100

[martincostello]

Thanks - I'll take a look at this some time in the next week to resolve that for our v8 release.

[kevinchalet]

@kevinchalet @martincostello I see a similar issue here:
https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers/blob/163a006c3b3ec38a82da4cb0949c209ae4e04fd3/src/AspNet.Security.OAuth.VisualStudio/VisualStudioAuthenticationHandler.cs#L90-L100

Thanks for letting us know. Did you see any other provider that may be affected?

If it's only VSO, then it's probably not a huge deal as it's almost a legacy thing: pretty much all APIs that use this provider can now be used with Azure AD directly (and Azure AD offers a much more OIDC-compliant implementation).

[Tratcher]

I didn't see any other providers with issues, they all append rather than try to replace parameters.

[martincostello]

Looking at the docs, I'm not sure if we really need to do anything in our VisualStudioOnline provider.

It seems that the only value recognised for response_type is Assertion, so if you were overriding it in AuthorizationEndpoint you would be either setting to to the same value we set for you already, so it would be redundant/duplicated, or you'd be setting it to something that isn't supported.

I can't see a use case for someone genuinely needing to set it themselves and getting the duplication issue, unless I'm misunderstanding something about how the original issue applies in our case.

[Tratcher]

@martincostello if someone added any query parameter to AuthorizationEndpoint it would get duplicated by the current code because of the pattern used to allow replacing an existing parameter. If nobody ever adds to AuthorizationEndpoint then you might never notice.

[martincostello]

Ah right, I see. Thanks - I'll take another look tomorrow.

[knopa]

Any update on this?

[MattyLeslie]

Should this be closed after the merged fixes ?

[imparikshith]

Is anybody contributing to this story, if not I would like to contribute.

[halter73]

I'd hold off @imparikshith. We might stop shipping the Microsoft.AspnetCore.Authentication.Google package altogether. See #61817 for more details.

Instead, I'd recommend using the official official Google.Apis.Auth.AspNetCore3 NuGet package from Google which has a lot more functionality. You can find documentation for it at https://developers.google.com/api-client-library/dotnet/guide/aaa_oauth#web-applications-asp.net-core-3. It mentions "ASP.NET Core 3", but it works with .NET 6.0+ as noted on their GitHub README at https://github.com/googleapis/google-api-dotnet-client.