重发提供商
概述
重发提供商使用电子邮件发送“魔法链接”,其中包含包含验证令牌的 URL,可用于登录。
除了一个或多个 OAuth 服务之外,添加对通过电子邮件登录的支持,为用户提供了一种在他们失去对 OAuth 帐户的访问权限时(例如,如果帐户被锁定或删除)登录的方法。
重发提供商可与一个或多个 OAuth 提供商一起使用(或代替一个或多个 OAuth 提供商)。
工作原理
在初始登录时,会将**验证令牌**发送到提供的电子邮件地址。默认情况下,此令牌有效期为 24 小时。如果验证令牌在该时间段内使用(即通过单击电子邮件中的链接),则会为用户创建帐户,并且他们会登录。
如果有人在登录时提供了*现有帐户*的电子邮件地址,则会发送一封电子邮件,并且当他们单击电子邮件中的链接并使用验证令牌时,他们将登录到与该电子邮件地址关联的帐户。
重发提供商可与 JSON Web Token 和数据库管理的会话一起使用,但**必须配置数据库**才能使用它。如果没有使用数据库,则无法启用电子邮件登录。
配置
-
首先,您需要将您的域名添加到您的重发帐户。这是重发所要求的,也是您在
from
提供商选项中使用的地址的域名。 -
接下来,您必须在重发仪表板中生成 API 密钥。您可以将此 API 密钥保存为
AUTH_RESEND_KEY
环境变量。
AUTH_RESEND_KEY=abc
如果您将环境变量命名为AUTH_RESEND_KEY
,则提供商将自动将其选中,并且您的 Auth.js 配置对象可以更简单。但是,如果您想将其重命名为其他名称,则必须在 Auth.js 配置中将其手动传递给提供商。
import NextAuth from "next-auth"
import Resend from "next-auth/providers/resend"
export const { handlers, auth, signIn, signOut } = NextAuth({
adapter: ...,
providers: [
Resend({
// If your environment variable is named differently than default
apiKey: AUTH_RESEND_KEY,
from: "[email protected]"
}),
],
})
-
不要忘记为存储电子邮件验证令牌设置一个数据库适配器。
-
您现在可以在
/api/auth/signin
处使用电子邮件地址开始登录过程。
在用户首次验证其电子邮件地址之前,不会为用户创建用户帐户(即Users
表中的条目)。如果电子邮件地址已与帐户关联,则当用户单击魔法链接电子邮件中的链接并使用验证令牌时,用户将登录到该帐户。
自定义
电子邮件正文
您可以通过将自定义函数作为sendVerificationRequest
选项传递给Resend()
来完全自定义发送的登录电子邮件。
import NextAuth from "next-auth"
import Resend from "next-auth/providers/resend"
export const { handlers, auth, signIn, signOut } = NextAuth({
providers: [
Resend({
server: process.env.EMAIL_SERVER,
from: process.env.EMAIL_FROM,
sendVerificationRequest({
identifier: email,
url,
provider: { server, from },
}) {
// your function
},
}),
],
})
例如,以下显示了我们内置的sendVerificationRequest()
方法的源代码。请注意,我们正在渲染 HTML(html()
)并对重发进行网络调用(fetch()
)以在此方法中实际执行发送。
export async function sendVerificationRequest(params) {
const { identifier: to, provider, url, theme } = params
const { host } = new URL(url)
const res = await fetch("https://api.resend.com/emails", {
method: "POST",
headers: {
Authorization: `Bearer ${provider.apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
from: provider.from,
to,
subject: `Sign in to ${host}`,
html: html({ url, host, theme }),
text: text({ url, host }),
}),
})
if (!res.ok)
throw new Error("Resend error: " + JSON.stringify(await res.json()))
}
function html(params: { url: string; host: string; theme: Theme }) {
const { url, host, theme } = params
const escapedHost = host.replace(/\./g, "​.")
const brandColor = theme.brandColor || "#346df1"
const color = {
background: "#f9f9f9",
text: "#444",
mainBackground: "#fff",
buttonBackground: brandColor,
buttonBorder: brandColor,
buttonText: theme.buttonText || "#fff",
}
return `
<body style="background: ${color.background};">
<table width="100%" border="0" cellspacing="20" cellpadding="0"
style="background: ${color.mainBackground}; max-width: 600px; margin: auto; border-radius: 10px;">
<tr>
<td align="center"
style="padding: 10px 0px; font-size: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
Sign in to <strong>${escapedHost}</strong>
</td>
</tr>
<tr>
<td align="center" style="padding: 20px 0;">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td align="center" style="border-radius: 5px;" bgcolor="${color.buttonBackground}"><a href="${url}"
target="_blank"
style="font-size: 18px; font-family: Helvetica, Arial, sans-serif; color: ${color.buttonText}; text-decoration: none; border-radius: 5px; padding: 10px 20px; border: 1px solid ${color.buttonBorder}; display: inline-block; font-weight: bold;">Sign
in</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="center"
style="padding: 0px 0px 10px 0px; font-size: 16px; line-height: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
If you did not request this email you can safely ignore it.
</td>
</tr>
</table>
</body>
`
}
// Email Text body (fallback for email clients that don't render HTML, e.g. feature phones)
function text({ url, host }: { url: string; host: string }) {
return `Sign in to ${host}\n${url}\n\n`
}
如果您想使用 React 生成与许多电子邮件客户端兼容的外观精美的电子邮件,请查看mjml或react-email
验证令牌
默认情况下,我们正在生成随机验证令牌。如果您想覆盖它,可以在提供商选项中定义一个generateVerificationToken
方法
import NextAuth from "next-auth"
import Resend from "next-auth/providers/resend"
export const { handlers, auth, signIn, signOut } = NextAuth({
providers: [
Resend({
async generateVerificationToken() {
return crypto.randomUUID()
},
}),
],
})
规范化电子邮件地址
默认情况下,Auth.js 会规范化电子邮件地址。它将地址视为不区分大小写(这在技术上不符合RFC 2821 规范,但在实践中,这会导致比解决更多的问题,例如从数据库中按电子邮件查找用户时)。并删除可能作为逗号分隔列表传入的任何辅助电子邮件地址。您可以通过Resend
提供商上的normalizeIdentifier
方法应用自己的规范化。以下示例显示了默认行为
import NextAuth from "next-auth"
import Resend from "next-auth/providers/resend"
export const { handlers, auth, signIn, signOut } = NextAuth({
providers: [
Resend({
normalizeIdentifier(identifier: string): string {
// Get the first two elements only,
// separated by `@` from user input.
let [local, domain] = identifier.toLowerCase().trim().split("@")
// The part before "@" can contain a ","
// but we remove it on the domain part
domain = domain.split(",")[0]
return `${local}@${domain}`
// You can also throw an error, which will redirect the user
// to the sign-in page with error=EmailSignin in the URL
// if (identifier.split("@").length > 2) {
// throw new Error("Only one email allowed")
// }
},
}),
],
})
始终确保这返回单个电子邮件地址,即使传入多个电子邮件地址也是如此。