如何使用 .NET Core (Blazor Server) 构建 Kakao 登录

给我们的新朋友:

Logto 是一个为现代应用和 SaaS 产品设计的 Auth0 替代方案。它提供 Cloud 和开源服务，帮助你快速启动身份和管理 (IAM) 系统。享受认证 (Authentication)、授权 (Authorization) 和多租户管理一体化。

我们建议从 Logto Cloud 上的免费开发租户开始。这可以让你轻松探索所有功能。

在本文中，我们将介绍使用 .NET Core (Blazor Server) 和 Logto 快速构建 Kakao 登录体验（用户认证 (Authentication)）的步骤。

先决条件

一个正在运行的 Logto 实例。查看介绍页面以开始。
.NET Core (Blazor Server) 的基本知识。
一个可用的 Kakao 账户。

在 Logto 中创建一个应用程序

Logto 基于 OpenID Connect (OIDC) 认证 (Authentication) 和 OAuth 2.0 授权 (Authorization)。它支持跨多个应用程序的联合身份管理，通常称为单点登录 (SSO)。

要创建你的传统网页应用程序，只需按照以下步骤操作：

打开 Logto Console。在“开始使用”部分，点击“查看全部”链接以打开应用程序框架列表。或者，你可以导航到 Logto Console > Applications，然后点击“创建应用程序”按钮。
在打开的模态窗口中，点击“传统网页”部分，或使用左侧的快速过滤复选框过滤所有可用的“传统网页”框架。点击 ".Net Core (Blazor Server)" 框架卡片以开始创建你的应用程序。
输入应用程序名称，例如“Bookstore”，然后点击“创建应用程序”。

🎉 太棒了！你刚刚在 Logto 中创建了你的第一个应用程序。你将看到一个祝贺页面，其中包含详细的集成指南。按照指南查看你的应用程序中的体验将会是什么样的。

集成 .Net Core (Blazor Server) SDK

提示:

以下演示基于 .NET Core 8.0 构建。该 SDK 兼容 .NET 6.0 或更高版本。
.NET Core 示例项目可在 GitHub 仓库中找到。

安装

将 NuGet 包添加到你的项目中：

dotnet add package Logto.AspNetCore.Authentication

添加 Logto 认证 (Authentication)

打开 Startup.cs（或 Program.cs）并添加以下代码以注册 Logto 认证服务：

Program.cs
using Logto.AspNetCore.Authentication;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddLogtoAuthentication(options =>
{
  options.Endpoint = builder.Configuration["Logto:Endpoint"]!;
  options.AppId = builder.Configuration["Logto:AppId"]!;
  options.AppSecret = builder.Configuration["Logto:AppSecret"];
});

AddLogtoAuthentication 方法将执行以下操作：

将默认认证方案设置为 LogtoDefaults.CookieScheme。
将默认挑战方案设置为 LogtoDefaults.AuthenticationScheme。
将默认注销方案设置为 LogtoDefaults.AuthenticationScheme。
将 cookie 和 OpenID Connect 认证处理程序添加到认证方案中。

在我们继续之前，需要澄清 .NET Core 认证中间件中的两个容易混淆的术语：

CallbackPath：用户登录后，Logto 将用户重定向回来的 URI（在 Logto 中称为“重定向 URI”）
RedirectUri：在 Logto 认证中间件中完成必要操作后，将重定向到的 URI。

登录过程可以如下图所示：

类似地，.NET Core 也有用于注销流程的 SignedOutCallbackPath 和 RedirectUri。

为了清晰起见，我们将它们称为：

我们使用的术语	.NET Core 术语
Logto 重定向 URI	CallbackPath
Logto 注销后重定向 URI	SignedOutCallbackPath
应用程序重定向 URI	RedirectUri

此认证 (Authentication) 过程遵循 OpenID Connect (OIDC) 协议，Logto 强制执行严格的安全措施以保护用户登录。
如果你有多个应用程序，可以使用相同的身份提供商 (IdP)（日志 (Logto)）。一旦用户登录到一个应用程序，当用户访问另一个应用程序时，Logto 将自动完成登录过程。

要了解有关基于重定向的登录的原理和好处的更多信息，请参阅 Logto 登录体验解释。

配置重定向 URI

备注:

在以下代码片段中，我们假设你的应用程序运行在 http://localhost:3000/。

首先，让我们配置 Logto 重定向 URI。将以下 URI 添加到 Logto 应用详情页面的“重定向 URI”列表中：

http://localhost:3000/Callback

要配置 Logto 签出后重定向 URI，请将以下 URI 添加到 Logto 应用详情页面的“签出后重定向 URI”列表中：

http://localhost:3000/SignedOutCallback

更改默认路径

Logto 重定向 URI 的默认路径是 /Callback，而 Logto 签出后重定向 URI 的默认路径是 /SignedOutCallback。

如果没有特殊要求，你可以保持原样。如果你想更改它，可以为 LogtoOptions 设置 CallbackPath 和 SignedOutCallbackPath 属性：

Program.cs
builder.Services.AddLogtoAuthentication(options =>
{
  // 其他配置...
  options.CallbackPath = "/Foo";
  options.SignedOutCallbackPath = "/Bar";
});

记得在 Logto 应用详情页面中相应地更新值。

添加路由

由于 Blazor Server 使用 SignalR 在服务器和客户端之间进行通信，这意味着直接操作 HTTP 上下文的方法（如发起挑战或重定向）在从 Blazor 组件调用时无法按预期工作。

为了正确实现，我们需要显式添加两个用于登录和注销重定向的端点：

Program.cs
app.MapGet("/SignIn", async context =>
{
    if (!(context.User?.Identity?.IsAuthenticated ?? false))
    {
        await context.ChallengeAsync(new AuthenticationProperties { RedirectUri = "/" });
    } else {
        context.Response.Redirect("/");
    }
});

app.MapGet("/SignOut", async context =>
{
    if (context.User?.Identity?.IsAuthenticated ?? false)
    {
        await context.SignOutAsync(new AuthenticationProperties { RedirectUri = "/" });
    } else {
        context.Response.Redirect("/");
    }
});

现在我们可以重定向到这些端点以触发登录和注销。

实现登录 / 登出按钮

在 Razor 组件中，添加以下代码：

Components/Pages/Index.razor
@using Microsoft.AspNetCore.Components.Authorization
@using System.Security.Claims
@inject AuthenticationStateProvider AuthenticationStateProvider
@inject NavigationManager NavigationManager

@* ... *@

<p>是否认证 (Is authenticated): @User.Identity?.IsAuthenticated</p>
@if (User.Identity?.IsAuthenticated == true)
{
    <button @onclick="SignOut">登出</button>
}
else
{
    <button @onclick="SignIn">登录</button>
}

@* ... *@

@code {
    private ClaimsPrincipal? User { get; set; }

    protected override async Task OnInitializedAsync()
    {
        var authState = await AuthenticationStateProvider.GetAuthenticationStateAsync();
        User = authState.User;
    }

    private void SignIn()
    {
        NavigationManager.NavigateTo("/SignIn", forceLoad: true);
    }

    private void SignOut()
    {
        NavigationManager.NavigateTo("/SignOut", forceLoad: true);
    }
}

说明：

注入的 AuthenticationStateProvider 用于获取当前用户的认证状态，并填充 User 属性。
SignIn 和 SignOut 方法用于分别将用户重定向到登录和登出端点。由于 Blazor Server 的特性，我们需要使用 NavigationManager 并强制加载以触发重定向。

如果用户未认证，页面将显示“登录”按钮；如果用户已认证，则显示“登出”按钮。

`<AuthorizeView />` 组件

或者，你可以使用 AuthorizeView 组件根据用户的认证状态有条件地渲染内容。当你想向已认证和未认证用户显示不同内容时，这个组件非常有用。

在你的 Razor 组件中，添加以下代码：

Components/Pages/Index.razor
@using Microsoft.AspNetCore.Components.Authorization

@* ... *@

<AuthorizeView>
    <Authorized>
        <p>名称：@User?.Identity?.Name</p>
        @* 已认证用户的内容 *@
    </Authorized>
    <NotAuthorized>
        @* 未认证用户的内容 *@
    </NotAuthorized>
</AuthorizeView>

@* ... *@

AuthorizeView 组件需要一个类型为 Task<AuthenticationState> 的级联参数。获取此参数的直接方法是添加 <CascadingAuthenticationState> 组件。然而，由于 Blazor Server 的特性，我们不能简单地将组件添加到布局或根组件（可能无法按预期工作）。相反，我们可以在构建器中添加以下代码（Program.cs 或 Startup.cs）来提供级联参数：

Program.cs
builder.Services.AddCascadingAuthenticationState();

然后你可以在每个需要的组件中使用 AuthorizeView 组件。

检查点：测试你的应用程序

现在，你可以测试你的应用程序：

运行你的应用程序，你将看到登录按钮。
点击登录按钮，SDK 将初始化登录过程并将你重定向到 Logto 登录页面。
登录后，你将被重定向回你的应用程序，并看到登出按钮。
点击登出按钮以清除令牌存储并登出。

添加 Kakao 连接器

要实现快速登录并提高用户转化率，请将 .Net Core (Blazor Server) 作为身份提供商 (IdP) 进行连接。Logto 社交连接器可以帮助你在几分钟内通过允许输入多个参数来建立此连接。

要添加社交连接器，只需按照以下步骤操作：

导航到 Console > Connectors > Social Connectors。
点击“添加社交连接器”并选择“Kakao”。
按照 README 指南完成必填字段并自定义设置。

备注:

如果你正在按照现场连接器指南进行操作，可以跳过下一部分。

设置 Kakao login

在 Kakao 开发者控制台中设置项目

访问 Kakao 开发者控制台并使用你的 Kakao 账户登录。
点击 添加应用程序 以创建新项目或选择现有项目。

从菜单中点击 产品设置 -> Kakao 登录。
打开 Kakao 登录激活
在 Redirect URI 中添加以下 URL
- http(s)://YOUR_URL/callback/${connector_id} (connector_id 可以在 Logto 管理控制台连接器详情页面的顶部栏找到。)
- （请将 YOUR_URL 替换为你的 Logto URL，并根据你的情况选择 http 或 https。）

隐私设置

从菜单中点击 产品设置 -> Kakao 登录 -> 同意项。
将 昵称、头像 和 电子邮件 的状态更改为 必需同意（由于项目设置，你可能无法将 电子邮件 更改为 必需同意。）

安全设置（可选）

从菜单中点击 产品设置 -> Kakao 登录 -> 安全。
点击 客户端密钥代码 以生成密钥代码。
将 激活状态 更改为启用。（如果你启用了它，则需要 密钥代码。）

配置 Logto

配置类型

名称	类型
clientId	string
clientSecret	string?

clientId

clientId 是你项目的 REST API key。（你可以在 Kakao 开发者控制台的项目 摘要 中找到。）

clientSecret

clientSecret 是你项目的 密钥代码。（请查看安全设置（可选））

保存你的配置

仔细检查你是否在 Logto 连接器配置区域填写了必要的值。点击“保存并完成”（或“保存更改”），Kakao 连接器现在应该可用了。

一旦你成功创建了一个社交连接器，你可以在登录体验中将其启用为“继续使用 Kakao”按钮。

导航到 Console > 登录体验 > 注册和登录。
（可选）如果只需要社交登录，选择“无”作为注册标识符。
将配置好的 Kakao 连接器添加到“社交登录”部分。

登录体验选项卡

测试和验证

返回到你的 .NET Core (Blazor Server) 应用。你现在应该可以使用 Kakao 登录了。享受吧！

拓展阅读

终端用户流程：Logto 提供开箱即用的认证 (Authentication) 流程，包括多因素认证 (MFA) 和企业单点登录 (SSO)，以及强大的 API，用于灵活实现账户设置、安全验证和多租户体验。

授权 (Authorization)：授权 (Authorization) 定义了用户在被认证 (Authentication) 后可以执行的操作或访问的资源。探索如何保护你的 API 以用于原生和单页应用程序，并实现基于角色的访问控制 (RBAC)。

组织 (Organizations)：在多租户 SaaS 和 B2B 应用中特别有效，组织功能支持租户创建、成员管理、组织级 RBAC 和即时供应。

客户 IAM 系列：我们关于客户（或消费者）身份和访问管理的系列博客文章，从 101 到高级主题及更深入的内容。

在 Logto 中创建一个应用程序​

集成 .Net Core (Blazor Server) SDK​

安装​

添加 Logto 认证 (Authentication)​

登录 / 登出流程​

关于基于重定向的登录​

配置重定向 URI​

更改默认路径​

添加路由​

实现登录 / 登出按钮​

<AuthorizeView /> 组件​

检查点：测试你的应用程序​

添加 Kakao 连接器​

设置 Kakao login​

在 Kakao 开发者控制台中设置项目​

配置 Kakao 登录​

激活 Kakao 登录​

隐私设置​

安全设置（可选）​

配置 Logto​

配置类型​

clientId​

clientSecret​

保存你的配置​

在登录体验中启用 Kakao 连接器​

测试和验证​

拓展阅读​