一次性令牌插件

一次性令牌（OTT）插件提供生成和验证安全的一次性会话令牌的功能。这些令牌通常用于跨域身份验证。

安装

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

export const auth = betterAuth({
    plugins: [
      oneTimeToken() 
    ]
    // ... 其他认证配置
});

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);
        }
    }
})