@farm.js/auth (英语)
Farm.js应用程序的内置电子邮件/密码认证. 设定 auth: true 内
farm.config.ts 和 Farm 挂载认证路径,存储基于数据库的会话,并曝光
服务器帮助器和反应钩。 更好的 Auth 是下面的引擎, 但应用程序代码从来没有
配置或导入它.
见 稳定和支持 对于这个包裹的保证.
安装
pnpm add @farm.js/auth
react 是一个对等依赖,由客户端钩子使用。 更好的奥特和 pg 邮政驱动程序
安装软件包。 本地开发打开 SQLite 通过 node:sqlite 在22号节点和之后,
然后回到可选的 better-sqlite3 依赖更古老的节点释放.
从一个完整的应用程序开始:
pnpm create @farm.js/app my-app --template auth
配置
import { defineConfig } from "@farm.js/core";
export default defineConfig({
auth: true,
});
这是顶级的 auth 框架键,而非 integrations.auth 供养. 农场装了这个
软件包,仅当键被启用时。 设置两者 auth 财务报告和审定财务报表 integrations.auth 是一个
配置出错, 因为每个都拥有所有路径的认证 .
没有其他选择,农场:
- 挂载
GET财务报告和审定财务报表POST处理者在/api/auth/[...auth]· ; - 允许电子邮件/密码登录和登录;
- 创建基于数据库的会议,持续7天,每天更新;
- 用途
.farm/auth.sqlite正在开发中,并更新其首先使用的计划; - 通过 Postgres
DATABASE_URL在生产中.
服务器助手
在服务器组件、服务器功能、中间软件或路由中读取当前会话或用户
处理者。 两个都回来 null 对于匿名请求.
import { auth } from "@farm.js/auth/server";
const session = await auth.session();
const user = await auth.user();
过 required: true 当请求必须签名时。 匿名请求会发出 401
用代码响应 FARM_AUTH_REQUIRED数字 :
const user = await auth.user({ required: true });
两位帮手也接受明确 request,如同此路由中间软件:
// src/app/dashboard/middleware.ts
import { auth } from "@farm.js/auth/server";
export const config = {
runtime: "nodejs" as const,
};
export async function middleware(request: Request) {
const user = await auth.user({ request });
if (!user) {
return Response.redirect(new URL("/sign-in", request.url), 307);
}
}
客户助手
"use client";
import { useAuth } from "@farm.js/auth/client";
export function AccountMenu() {
const { user, isPending, signOut } = useAuth();
if (isPending) return <span>Loading</span>;
if (!user) return <a href="/sign-in">Sign in</a>;
return <button onClick={() => signOut()}>Sign out {user.email}</button>;
}
useAuth ưμ㼯a session, (中文(简体) ), error, (中文(简体) ), isRefetching, (中文(简体) ), refetch, (中文(简体) ), signIn,以及 signUp编辑
同一种函数直接导出于不需要勾结的窗体:
import { signIn, signUp } from "@farm.js/auth/client";
await signUp({ name: "Ada Lovelace", email: "[email protected]", password: "a-long-password" });
await signIn({ email: "[email protected]", password: "a-long-password" });
getSession 也可以输出。 何时 basePath 定制, 创建匹配的帮助
createFarmAuthClient({ basePath: "/account/auth" })。它也接受 baseURL 客户
不在浏览器中运行.
选项
| 选项 | 默认 | 页:1 |
|---|---|---|
enabled | true | 设定 false 在不删除的情况下禁用. |
appName | "Farm app" | 认证元数据和电子邮件中使用的名称 . |
basePath | "/api/auth" | 路线前缀. 一定是一个简单的路径名 . |
emailAndPassword | 启用 | 设定 false 以禁用. |
emailAndPassword.requireEmailVerification | false | |
emailAndPassword.minPasswordLength | 8 | |
emailAndPassword.maxPasswordLength | 128 | |
session.expiresIn | 604800 | 会话寿命数秒. |
session.updateAge | 86400 | 刷新间隔数秒 . |
database.url | DATABASE_URL | Postgres 连接字符串 . |
database.path | .farm/auth.sqlite | 本地 SQLite 文件 . |
database.migrateInDevelopment | true | 更新本地的首次使用计划 . |
auth: { enabled: true } 等同为 auth: true。 。 。 .
环境和部署
| 变量 | 目的 |
|---|---|
DATABASE_URL | Postgres 连接字符串 。 生产中要求. |
FARM_AUTH_SECRET | 签名秘密,生产中需要. AUTH_SECRET 财务报告和审定财务报表 BETTER_AUTH_SECRET 还有工作. |
FARM_AUTH_URL | 出自大众. BETTER_AUTH_URL 也读作。 未定时引入凡尔塞. |
无 FARM_AUTH_URL, (中文(简体) ), farm dev 信任它的源头
localhost, (中文(简体) ), *.localhost,或者一个IP地址,所以其他端口,Android模拟器 10.0.2.2,以及
局域网设备 --host 可以签入。 生产只信任配置的来源 .
没有秘密,开发就会产生随机的 .farm/auth-secret 并重用它跨越
重启 。 正在装入 farm.config.ts 运行 farm build 从不连接数据库。 应用
服务交通前的生产计划:
farm auth migrate
farm auth migrate --dry-run
farm auth migrate --write auth-schema.sql
第一个命令应用了这个计划. --dry-run 打印语句和 --write 保存到
文件,不更改数据库。 命令需求 DATABASE_URL 但不是那个秘密.
签名率限制客户端地址上的密钥 Farm 解析请求 。 在代理商背后,
启用 server.trustProxy 因此,访客并非全部被算作代理地址.
入境点
@farm.js/auth/server页:1auth.session()财务报告和审定财务报表auth.user()帮手.@farm.js/auth/client数字 :useAuth, (中文(简体) ),signIn, (中文(简体) ),signUp, (中文(简体) ),signOut, (中文(简体) ),getSession,以及createFarmAuthClient。反应原生屏幕(page.native.tsx)使用相同的导入: Metro 决定:react-native构造,它称为通过serverFetch从@farm.js/native(可选对等).signIn财务报告和审定财务报表signUp通过移动外壳的原生 代码, 将会话 cookie 保存在 WebView 中并发布设备符; 社交签名 暂时拒绝 Web 捆绑不改变 .@farm.js/auth数字 :resolveFarmAuthConfig以及配置和会话类型,例如FarmAuthConfig, (中文(简体) ),FarmAuthSession,以及FarmAuthUser。 。 。 .@farm.js/auth/internal: 由农场核心装入farm auth migrate。应用程序不 导入它.
使用 @farm.js/better-auth 而不是当
应用程序需要更好的 Auth 插件、适配器、社会提供者或原始实例 API.
文档
报告问题和在报告 Farm.js仓库。 。 。 .