Logto 是一个为现代应用和 SaaS 产品设计的 Auth0 替代方案。它提供 Cloud 和 开源 服务,帮助你快速启动身份和管理 (IAM) 系统。享受认证 (Authentication)、授权 (Authorization) 和多租户管理 一体化。
我们建议从 Logto Cloud 上的免费开发租户开始。这可以让你轻松探索所有功能。
在本文中,我们将介绍使用 React 和 Logto 快速构建 Twilio 登录体验(用户认证 (Authentication))的步骤。
先决条件
在 Logto 中创建一个应用程序
Logto 基于 OpenID Connect (OIDC) 认证 (Authentication) 和 OAuth 2.0 授权 (Authorization)。它支持跨多个应用程序的联合身份管理,通常称为单点登录 (SSO)。
要创建你的 单页应用 应用程序,只需按照以下步骤操作:
- 打开 Logto Console。在“开始使用”部分,点击“查看全部”链接以打开应用程序框架列表。或者,你可以导航到 Logto Console > Applications,然后点击“创建应用程序”按钮。
- 在打开的模态窗口中,点击“单页应用”部分,或使用左侧的快速过滤复选框过滤所有可用的“单页应用”框架。点击 "React" 框架卡片以开始创建你的应用程序。
- 输入应用程序名称,例如“Bookstore”,然后点击“创建应用程序”。
🎉 太棒了!你刚刚在 Logto 中创建了你的第一个应用程序。你将看到一个祝贺页面,其中包含详细的集成指南。按照指南查看你的应用程序中的体验将会是什么样的。
集成 Logto SDK
- 示例项目可在我们的 SDK 仓库 中找到。
- 教程视频可在我们的 YouTube 频道 上观看。
安装
通过你喜欢的包管理器安装 Logto SDK:
- npm
- pnpm
- yarn
npm i @logto/react
pnpm add @logto/react
yarn add @logto/react
初始化 LogtoClient
将 LogtoProvider
导入并用于为你的应用提供一个 Logto 上下文:
import { LogtoProvider, LogtoConfig } from '@logto/react';
const config: LogtoConfig = {
endpoint: '<your-logto-endpoint>', // 例如 http://localhost:3001
appId: '<your-application-id>',
};
const App = () => (
<LogtoProvider config={config}>
<YourAppContent />
</LogtoProvider>
);
配置重定向 URI
在我们深入细节之前,这里是终端用户体验的快速概述。登录过程可以简化如下:
- 你的应用调用登录方法。
- 用户被重定向到 Logto 登录页面。对于原生应用,将打开系统浏览器。
- 用户登录并被重定向回你的应用(配置为重定向 URI)。
关于基于重定向的登录
- 此认证 (Authentication) 过程遵循 OpenID Connect (OIDC) 协议,Logto 强制执行严格的安全措施以保护用户登录。
- 如果你有多个应用程序,可以使用相同的身份提供商 (IdP)(日志 (Logto))。一旦用户登录到一个应用程序,当用户访问另一个应用程序时,Logto 将自动完成登录过程。
要了解有关基于重定向的登录的原理和好处的更多信息,请参阅 Logto 登录体验解释。
在以下代码片段中,我们假设你的应用程序运行在 http://localhost:3000/
。
配置重定向 URI
切换到 Logto Console 的应用详情页面。添加一个重定向 URI http://localhost:3000/callback
。
就像登录一样,用户应该被重定向到 Logto 以注销共享会话。完成后,最好将用户重定向回你的网站。例如,添加 http://localhost:3000/
作为注销后重定向 URI 部分。
然后点击“保存”以保存更改。
处理重定向
由于我们使用 http://localhost:3000/callback
作为重定向 URI,现在我们需要正确处理它。
首先,让我们创建一个回调页面:
import { useHandleSignInCallback } from '@logto/react';
const Callback = () => {
const { isLoading } = useHandleSignInCallback(() => {
// 完成后执行某些操作,例如重定向到主页
});
// 当它正在处理中
if (isLoading) {
return <div>正在重定向...</div>;
}
return null;
};
最后插入下面的代码来创建一个不需要认证 (Authentication) 的 /callback
路由:
// 假设使用 react-router
<Route path="/callback" element={<Callback />} />
实现登录和登出
我们提供了两个钩子 useHandleSignInCallback()
和 useLogto()
,可以帮助你轻松管理认证 (Authentication) 流程。
在调用 .signIn()
之前,请确保你已在管理控制台中正确配置了重定向 URI。
import { useLogto } from '@logto/react';
const Home = () => {
const { signIn, signOut, isAuthenticated } = useLogto();
return isAuthenticated ? (
<button onClick={signOut}>Sign Out</button>
) : (
<button onClick={() => signIn('http://localhost:3000/callback')}>Sign In</button>
);
};
调用 .signOut()
将清除内存和 localStorage 中所有的 Logto 数据(如果存在)。
检查点:测试你的应用程序
现在,你可以测试你的应用程序:
- 运行你的应用程序,你将看到登录按钮。
- 点击登录按钮,SDK 将初始化登录过程并将你重定向到 Logto 登录页面。
- 登录后,你将被重定向回你的应用程序,并看到登出按钮。
- 点击登出按钮以清除令牌存储并登出。
添加 Twilio 连接器
SMS 连接器是一种用于发送一次性密码 (OTP) 的方法,用于认证 (Authentication)。它支持 电话号码 验证,以支持无密码认证 (Authentication),包括基于 SMS 的注册、登录、双因素认证 (2FA) 和账户恢复。 你可以轻松地将 Twilio 连接为你的 SMS 提供商。使用 Logto SMS 连接器,你可以在几分钟内完成设置。
要添加 SMS 连接器,只需按照以下步骤操作:
- 导航到 Console > Connector > Email and SMS connectors。
- 要添加新的 SMS 连接器,点击“设置”按钮并选择“Twilio”。
- 查看你选择的提供商的 README 文档。
- 在“参数配置”部分完成配置字段。
- 使用 JSON 编辑器自定义 SMS 模板。
- 通过向你的 电话号码 发送验证码来测试你的配置。
如果你正在按照就地连接器指南进行操作,可以跳过下一部分。
设置 Twilio SMS 连接器
注册 Twilio 账户
在 Twilio 上创建一个新账户。(如果你已经有一个账户,请跳到下一步。)
设置发送者的电话号码
进入 Twilio 控制台页面并使用你的 Twilio 账户登录。
在“Phone Numbers” -> “Manage” -> “Buy a number”下购买一个电话号码。
有时你可能会遇到在特定国家或地区不支持短信服务的情况。选择其他地区的号码以绕过此限制。
一旦我们拥有一个有效的号码,导航到“Messaging” -> “Services”。点击按钮创建一个新的消息服务。
给服务起一个友好的名称,并选择 Notify my users 作为我们的服务目的。
在下一步中,选择 Phone Number
作为 Sender Type,并将我们刚刚申请的电话号码添加到此服务中作为发送者。
每个电话号码只能与一个消息服务关联。
获取账户凭证
我们需要 API 凭证来使连接器工作。让我们从 Twilio 控制台页面开始。
点击右上角的“Account”菜单,然后进入“API keys & tokens”页面以获取你的 Account SID
和 Auth token
。
返回侧边栏的“Messaging” -> “Services”设置页面,找到你的服务的 Sid
。
编写连接器 JSON
用相应消息服务的 Account SID
、Auth token
和 Sid
填写 accountSID、authToken 和 fromMessagingServiceSID 字段。
你可以为不同的情况添加多个 SMS 连接器模板。以下是添加单个模板的示例:
- 用任意字符串类型的内容填写
content
字段。不要忘记为随机验证码保留{{code}}
占位符。 - 用
Register
、SignIn
、ForgotPassword
或Generic
填写usageType
字段以适应不同的用例。为了启用完整的用户流程,需要使用Register
、SignIn
、ForgotPassword
和Generic
的模板。
测试 Twilio SMS 连接器
你可以输入一个电话号码并点击“Send”以查看设置是否在“Save and Done”之前有效。
就是这样。不要忘记在 登录体验中启用连接器。
配置类型
名称 | 类型 |
---|---|
accountSID | string |
authToken | string |
fromMessagingServiceSID | string |
templates | Templates[] |
模板属性 | 类型 | 枚举值 |
---|---|---|
content | string | N/A |
usageType | enum string | 'Register' | 'SignIn' | 'ForgotPassword' | 'Generic' |
保存你的配置
仔细检查你是否在 Logto 连接器配置区域填写了必要的值。点击“保存并完成”(或“保存更改”),Twilio 连接器现在应该可用了。
在登录体验中启用 Twilio 连接器
一旦你成功创建了一个 连接器,你就可以启用基于手机号的无密码登录和注册。
- 导航到 Console > 登录体验 > 注册和登录。
- 设置注册方法(可选):
- 选择“电话号码”或“电子邮件或手机号”作为注册标识符。
- “注册时验证”被强制启用。你还可以在注册时启用“创建密码”。
- 设置登录方法:
- 选择 电话号码 作为登录标识符之一。你可以提供多个可用的标识符(电子邮件、手机号和用户名)。
- 选择“验证码”和 / 或“密码”作为认证 (Authentication) 因素。
- 点击“保存更改”并在“实时预览”中测试。
除了通过 一次性密码进行注册和登录外,你还可以启用密码恢复和基于 的安全验证,以及将 电话号码 关联到个人资料。有关更多详细信息,请参阅 终端用户流程。
测试和验证
返回到你的 React 应用。你现在应该可以使用 Twilio 登录了。享受吧!
进一步阅读
终端用户流程:Logto 提供开箱即用的认证 (Authentication) 流程,包括多因素认证 (MFA) 和企业单点登录 (SSO),以及强大的 API,用于灵活实现账户设置、安全验证和多租户体验。
授权 (Authorization):授权 (Authorization) 定义了用户在被认证 (Authentication) 后可以执行的操作或访问的资源。探索如何保护你的 API 以用于原生和单页应用程序,并实现基于角色的访问控制 (RBAC)。
组织 (Organizations):在多租户 SaaS 和 B2B 应用中特别有效,组织功能支持租户创建、成员管理、组织级 RBAC 和即时供应。
客户 IAM 系列:我们关于客户(或消费者)身份和访问管理的系列博客文章,从 101 到高级主题及更深入的内容。