Bearer Token 认证

Bearer 插件支持使用 Bearer 令牌作为浏览器 cookie 的替代方案进行身份验证。它会拦截请求,在将请求转发到您的 API 之前,将 Bearer 令牌添加到 Authorization 头部。

请谨慎使用此功能;它仅适用于不支持 cookie 或需要 Bearer 令牌进行身份验证的 API。不当实现很容易导致安全漏洞。

安装 Bearer 插件

将 Bearer 插件添加到您的身份验证设置中:

auth.ts
import { betterAuth } from "better-auth";
import { bearer } from "better-auth/plugins";

export const auth = betterAuth({
    plugins: [bearer()]
});

如何使用 Bearer 令牌

1. 获取 Bearer 令牌

成功登录后,您将在响应头中收到一个会话令牌。请安全地存储此令牌(例如在 localStorage 中):

auth-client.ts
const { data } = await authClient.signIn.email({
    email: "user@example.com",
    password: "securepassword"
}, {
  onSuccess: (ctx)=>{
    const authToken = ctx.response.headers.get("set-auth-token") // 从响应头获取令牌
    // 安全地存储令牌(例如在 localStorage 中)
    localStorage.setItem("bearer_token", authToken);
  }
});

您也可以在您的认证客户端中全局设置:

auth-client.ts
export const authClient = createAuthClient({
    fetchOptions: {
        onSuccess: (ctx) => {
            const authToken = ctx.response.headers.get("set-auth-token") // 从响应头获取令牌
            // 安全地存储令牌(例如在 localStorage 中)
            if(authToken){
              localStorage.setItem("bearer_token", authToken);
            }
        }
    }
});

您可能希望根据响应状态码或其他条件清除令牌:

2. 配置认证客户端

设置您的认证客户端,使其在所有请求中包含 Bearer token:

auth-client.ts
export const authClient = createAuthClient({
    fetchOptions: {
        auth: {
           type:"Bearer",
           token: () => localStorage.getItem("bearer_token") || "" // 从 localStorage 获取 token
        }
    }
});

3. 发起认证请求

现在您可以发起经过认证的 API 调用:

auth-client.ts
// 此请求会自动进行认证
const { data } = await authClient.listSessions();

4. 按请求提供 Token(可选)

您也可以为单个请求提供 token:

auth-client.ts
const { data } = await authClient.listSessions({
    fetchOptions: {
        headers: {
            Authorization: `Bearer ${token}`
        }
    }
});

5. 在认证客户端之外使用 Bearer Token

Bearer token 可用于对 API 的任何请求进行认证,即使不使用认证客户端时也是如此:

api-call.ts
const token = localStorage.getItem("bearer_token");

const response = await fetch("https://api.example.com/data", {
  headers: {
    Authorization: `Bearer ${token}`
  }
});

const data = await response.json();

在服务器端,您可以使用 auth.api.getSession 函数来认证请求:

server.ts
import { auth } from "@/auth";

export async function handler(req, res) {
  const session = await auth.api.getSession({
    headers: req.headers
  });

  if (!session) {
    return res.status(401).json({ error: "Unauthorized" });
  }

  // 处理认证请求
  // ...
}

选项

requireSignature (boolean): 要求 token 必须经过签名。默认值:false

On this page