一次性令牌插件

一次性令牌 (OTT) 插件提供生成和验证安全的、单次使用会话令牌的功能。这些通常用于跨域认证。

安装

import { betterAuth } from "better-auth";
import { oneTimeToken } from "better-auth/plugins/one-time-token";

export const auth = betterAuth({
    plugins: [
      oneTimeToken()
    ]
    // ... other auth config
});

import { createAuthClient } from "better-auth/client"
import { oneTimeTokenClient } from "better-auth/client/plugins"

export const authClient = createAuthClient({
    plugins: [
        oneTimeTokenClient()
    ]
})

使用

1. 生成令牌

使用 auth.api.generateOneTimeToken 或 authClient.oneTimeToken.generate 生成令牌

const { data, error } = await authClient.oneTimeToken.generate();

const data = await auth.api.generateOneTimeToken({    // This endpoint requires session cookies.    headers: await headers(),});

这将返回一个附加到当前会话的 token，可用于验证一次性令牌。默认情况下，令牌将在 3 分钟后过期。

2. 验证令牌

当用户点击链接或提交令牌时，在另一个 API 路由中使用 auth.api.verifyOneTimeToken 或 authClient.oneTimeToken.verify 方法来验证它。

const { data, error } = await authClient.oneTimeToken.verify({    token: "some-token", // required});

const data = await auth.api.verifyOneTimeToken({    body: {        token: "some-token", // required    },});

这将返回附加到令牌的会话。

选项

在添加 oneTimeToken 插件时，可以配置这些选项：

• disableClientRequest (boolean)：可选。如果为 true，令牌仅在服务器端生成。默认值：false。
• expiresIn (number)：可选。令牌有效期（以分钟为单位）。默认值：3。

oneTimeToken({
    expiresIn: 10 // 10 分钟
})

• generateToken：一个自定义令牌生成函数，接受 session 对象和 ctx 作为参数。

• storeToken：可选。此选项允许您配置令牌在数据库中的存储方式。

  • plain：令牌以明文形式存储。（默认）
  • hashed：使用默认哈希器对令牌进行哈希。
  • custom-hasher：一个自定义哈希函数，接受令牌并返回哈希令牌。

示例：

oneTimeToken({
    storeToken: "plain"
})

oneTimeToken({
    storeToken: "hashed"
})

oneTimeToken({
    storeToken: {
        type: "custom-hasher",
        hash: async (token) => {
            return myCustomHasher(token);
        }
    }
})