Nastavení externího přihlášení Google v ASP.NET CoreGoogle external login setup in ASP.NET Core

Od Valeriy Novytskyy a Rick AndersonBy Valeriy Novytskyy and Rick Anderson

V tomto kurzu se dozvíte, jak uživatelům povolit, aby se k účtu Google přihlásili pomocí projektu ASP.NET Core 3,0 vytvořeného na předchozí stránce.This tutorial shows you how to enable users to sign in with their Google account using the ASP.NET Core 3.0 project created on the previous page.

Vytvoření projektu konzoly rozhraní Google API a ID klientaCreate a Google API Console project and client ID

  • Nainstalujte Microsoft. AspNetCore. Authentication. Google.Install Microsoft.AspNetCore.Authentication.Google.
  • Přejděte k integraci přihlášení Google do vaší webové aplikace a vyberte Konfigurovat projekt.Navigate to Integrating Google Sign-In into your web app and select Configure a project.
  • V dialogovém okně Konfigurace klienta OAuth vyberte možnost webový server.In the Configure your OAuth client dialog, select Web server.
  • Do textového pole autorizovaných identifikátorů URI pro přesměrování nastavte identifikátor URI přesměrování.In the Authorized redirect URIs text entry box, set the redirect URI. Například https://localhost:44312/signin-google.For example, https://localhost:44312/signin-google
  • Uložte ID klienta a tajný klíč klienta.Save the Client ID and Client Secret.
  • Při nasazování lokality Zaregistrujte novou veřejnou adresu URL z konzoly Google.When deploying the site, register the new public url from the Google Console.

Uložte si ID a tajný kód klienta Google.Store the Google client ID and secret

Uložte citlivá nastavení, jako je třeba ID klienta Google a tajné hodnoty pomocí správce tajnýchkódů.Store sensitive settings such as the Google client ID and secret values with Secret Manager. V této ukázce použijte následující postup:For this sample, use the following steps:

  1. Inicializujte projekt pro tajné úložiště podle pokynů v tématu Povolení tajného úložiště.Initialize the project for secret storage per the instructions at Enable secret storage.

  2. Uložte citlivá nastavení do místního úložiště tajných klíčů pomocí tajných klíčů Authentication:Google:ClientId a Authentication:Google:ClientSecret :Store the sensitive settings in the local secret store with the secret keys Authentication:Google:ClientId and Authentication:Google:ClientSecret:

    dotnet user-secrets set "Authentication:Google:ClientId" "<client-id>"
    dotnet user-secrets set "Authentication:Google:ClientSecret" "<client-secret>"
    

:Oddělovač nefunguje s hierarchickými klíči proměnné prostředí na všech platformách.The : separator doesn't work with environment variable hierarchical keys on all platforms. __, je dvojité podtržítko:__, the double underscore, is:

  • Podporováno všemi platformami.Supported by all platforms. Například : oddělovač není podporován bash, ale __ je.For example, the : separator is not supported by Bash, but __ is.
  • Automaticky nahrazeno:Automatically replaced by a :

Přihlašovací údaje a využití rozhraní API můžete spravovat v konzole API.You can manage your API credentials and usage in the API Console.

Konfigurace ověřování GoogleConfigure Google authentication

Přidat službu Google do Startup.ConfigureServices :Add the Google service to Startup.ConfigureServices:

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(
            Configuration.GetConnectionString("DefaultConnection")));
    services.AddDefaultIdentity<IdentityUser>(options =>
        options.SignIn.RequireConfirmedAccount = true)
            .AddEntityFrameworkStores<ApplicationDbContext>();
    services.AddRazorPages();

    services.AddAuthentication()
        .AddGoogle(options =>
        {
            IConfigurationSection googleAuthNSection =
                Configuration.GetSection("Authentication:Google");

            options.ClientId = googleAuthNSection["ClientId"];
            options.ClientSecret = googleAuthNSection["ClientSecret"];
        });
}

Volání AddIdentity nakonfiguruje výchozí nastavení schématu.The call to AddIdentity configures the default scheme settings. Přetížení AddAuthentication (String) nastaví vlastnost DefaultScheme .The AddAuthentication(String) overload sets the DefaultScheme property. Přetížení AddAuthentication (Action<AuthenticationOptions>) umožňuje konfigurovat možnosti ověřování, které lze použít k nastavení výchozích schémat ověřování pro různé účely.The AddAuthentication(Action<AuthenticationOptions>) overload allows configuring authentication options, which can be used to set up default authentication schemes for different purposes. Následná volání AddAuthentication přepsat dříve nakonfigurované vlastnosti AuthenticationOptions .Subsequent calls to AddAuthentication override previously configured AuthenticationOptions properties.

Metody rozšíření AuthenticationBuilder , které registrují obslužnou rutinu ověřování, se můžou volat jenom jednou pro každé schéma ověřování.AuthenticationBuilder extension methods that register an authentication handler may only be called once per authentication scheme. Existují přetížení, která umožňují konfigurovat vlastnosti schématu, název schématu a zobrazované jméno.Overloads exist that allow configuring the scheme properties, scheme name, and display name.

Přihlásit se přes GoogleSign in with Google

  • Spusťte aplikaci a klikněte na Přihlásit se.Run the app and click Log in. Zobrazí se možnost přihlásit se přes Google.An option to sign in with Google appears.
  • Klikněte na tlačítko Google , které přesměruje na Google pro ověřování.Click the Google button, which redirects to Google for authentication.
  • Po zadání přihlašovacích údajů Google budete přesměrováni zpátky na web.After entering your Google credentials, you are redirected back to the web site.

Dopředné informace o žádosti pomocí proxy serveru nebo nástroje pro vyrovnávání zatíženíForward request information with a proxy or load balancer

Pokud je aplikace nasazená za proxy server nebo nástrojem pro vyrovnávání zatížení, můžou se některé původní informace žádosti přeslat do aplikace v hlavičkách žádostí.If the app is deployed behind a proxy server or load balancer, some of the original request information might be forwarded to the app in request headers. Tyto informace obvykle zahrnují schéma zabezpečeného požadavku (https), hostitele a IP adresu klienta.This information usually includes the secure request scheme (https), host, and client IP address. Aplikace nečtou tyto hlavičky požadavků automaticky ke zjištění a používání původních informací o požadavku.Apps don't automatically read these request headers to discover and use the original request information.

Schéma se používá v generaci odkazů, které má vliv na tok ověřování s externími poskytovateli.The scheme is used in link generation that affects the authentication flow with external providers. Výsledkem ztráty zabezpečeného schématuhttps() je, že aplikace generuje nesprávné adresy URL nezabezpečeného přesměrování.Losing the secure scheme (https) results in the app generating incorrect insecure redirect URLs.

Použijte middleware předaných hlaviček k zpřístupnění původních informací o požadavku aplikaci pro zpracování žádostí.Use Forwarded Headers Middleware to make the original request information available to the app for request processing.

Další informace naleznete v tématu Konfigurace ASP.NET Core pro práci se servery proxy a nástroji pro vyrovnávání zatížení.For more information, see Konfigurace ASP.NET Core pro práci se servery proxy a nástroji pro vyrovnávání zatížení.

Zprostředkovatelé více ověřováníMultiple authentication providers

Když aplikace vyžaduje víc poskytovatelů, nařetězení rozšiřujících metod poskytovatele za AddAuthentication:When the app requires multiple providers, chain the provider extension methods behind AddAuthentication:

services.AddAuthentication()
    .AddMicrosoftAccount(microsoftOptions => { ... })
    .AddGoogle(googleOptions => { ... })
    .AddTwitter(twitterOptions => { ... })
    .AddFacebook(facebookOptions => { ... });

GoogleOptionsDalší informace o možnostech konfigurace, které podporuje ověřování Google, najdete v referenčních informacích k rozhraní API.See the GoogleOptions API reference for more information on configuration options supported by Google authentication. Dá se použít k vyžádání různých informací o uživateli.This can be used to request different information about the user.

Změna výchozího identifikátoru URI zpětného voláníChange the default callback URI

Segment identifikátoru URI /signin-google je nastaven jako výchozí zpětné volání poskytovatele ověřování Google.The URI segment /signin-google is set as the default callback of the Google authentication provider. Výchozí identifikátor URI zpětného volání můžete změnit při konfiguraci middleware pro ověřování Google prostřednictvím zděděné vlastnosti RemoteAuthenticationOptions. CallbackPath třídy GoogleOptions .You can change the default callback URI while configuring the Google authentication middleware via the inherited RemoteAuthenticationOptions.CallbackPath property of the GoogleOptions class.

Řešení potížíTroubleshooting

  • Pokud přihlášení nefunguje a nezískáváte žádné chyby, přepněte do vývojového režimu, aby se tento problém zjednodušil při ladění.If the sign-in doesn't work and you aren't getting any errors, switch to development mode to make the issue easier to debug.
  • Pokud Identity není nakonfigurováno voláním services.AddIdentity v ConfigureServices , probíhá pokus o ověření výsledků v souboru ArgumentException: je třeba zadat možnost SignInScheme.If Identity isn't configured by calling services.AddIdentity in ConfigureServices, attempting to authenticate results in ArgumentException: The 'SignInScheme' option must be provided. Šablona projektu použitá v tomto kurzu zajišťuje, že je to hotové.The project template used in this tutorial ensures that this is done.
  • Pokud se databáze lokality nevytvořila při použití prvotní migrace, při zpracování chyby žádosti se zobrazí operace databáze .If the site database has not been created by applying the initial migration, you get A database operation failed while processing the request error. Vyberte možnost použít migrace k vytvoření databáze a aktualizujte stránku, aby bylo možné pokračovat v minulosti.Select Apply Migrations to create the database, and refresh the page to continue past the error.

Další krokyNext steps

  • Tento článek ukazuje, jak se dá ověřit pomocí Google.This article showed how you can authenticate with Google. Můžete postupovat podle podobného přístupu k ověřování u jiných poskytovatelů uvedených na předchozí stránce.You can follow a similar approach to authenticate with other providers listed on the previous page.
  • Jakmile aplikaci publikujete do Azure, resetujte ji ClientSecret v konzole rozhraní Google API.Once you publish the app to Azure, reset the ClientSecret in the Google API Console.
  • Nastavte Authentication:Google:ClientId nastavení a Authentication:Google:ClientSecret jako nastavení aplikace v Azure Portal.Set the Authentication:Google:ClientId and Authentication:Google:ClientSecret as application settings in the Azure portal. Konfigurační systém je nastaven na čtení klíčů z proměnných prostředí.The configuration system is set up to read keys from environment variables.