@basenative/auth

中文文档
3.3.0发布于 2026/11/03Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 1874

BaseNative apps的认证、会议管理、RBAC和OAuth2/OIDC

中文使用文档
文档目录9 节
  1. 安装
  2. 快速启动
  3. API 密码
  4. 会议
  5. 密码
  6. 非洲区域局
  7. 中间软件
  8. OAuth 供应商
  9. 许可证

@ aslative/ auth (帮助)

会话管理,密码散列,RBAC和OAuth——没有外部依赖性

部分 基础 生态系统——一个基于信号的网络运行时间超过本土的HTML.

安装

npm install @basenative/auth

快速启动

import {
  createSessionManager,
  hashPassword,
  verifyPassword,
  defineRoles,
  createGuard,
  sessionMiddleware,
  requireAuth,
} from '@basenative/auth';

// Password hashing (uses node:crypto — no bcrypt dependency)
const hash = await hashPassword('secret123');
const ok = await verifyPassword('secret123', hash); // true

// Session management
const sessions = createSessionManager({ maxAge: 24 * 60 * 60 * 1000 });
const session = await sessions.create({ userId: 42, role: 'admin' });

// RBAC
const roles = defineRoles({
  admin: { permissions: ['read', 'write', 'delete'] },
  editor: { permissions: ['read', 'write'] },
  viewer: { permissions: ['read'] },
});
const guard = createGuard(roles);
guard.can('editor', 'write'); // true
guard.can('viewer', 'write'); // false

API 密码

会议

  • createSessionManager(options?) ——创建带有可插件存储的会话管理器. 选项 : store, (中文(简体) ), cookieName, (中文(简体) ), maxAge, (中文(简体) ), secure, (中文(简体) ), sameSite, (中文(简体) ), httpOnly。 。 。 .
    • .create(data) ——创建新会话并返回.
    • .get(id) 以身份证获取会话(返回) null (如果过期).
    • .update(id, data) 将数据合并到现有的会话中.
    • .destroy(id) 删除会话.
  • createMemoryStore() ——内幕会话商店(开发/单程).
  • createDbStore(db) - 数据库支持的会话存储使用 @basenative/db 适配器.

密码

  • hashPassword(password) 使用 PBKDF2 的密码 node:crypto返回a Promise<string>。 。 。 .
  • verifyPassword(password, hash) 对照所储存的散列验证密码。 回返a Promise<boolean>。 。 。 .

非洲区域局

  • defineRoles(config) ——定义带有权限数组的角色等级.
  • createGuard(roles) —— 创建守护对象 .can(role, permission) 检查.

中间软件

  • sessionMiddleware(manager) 从请求的 cookie 装入会话并附加到 ctx.state.session。 。 。 .
  • requireAuth(options?) ——以401个答复拒绝未经认证的请求.
  • login(manager, sessionData, ctx) ——创建会话,并设置会话 cookie 对应.
  • logout(manager, ctx) - 破坏本届会议并清除饼干.

OAuth 供应商

  • credentialsProvider(options) ——用户名/密码认证策略.
  • oauthProvider(providerName, options) ——OAuth 2.0流为被命名的提供者.
  • providers ——为普通供应商(GitHub,Google等)预设了OAuth设置.

许可证

阿帕奇 - 2.0

版本与发布记录

@basenative/auth 共发布 14 个版本,首次发布于 2026/03/20;过去 12 个月发布了 14 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.3.0latest2026/11/035 天前
3.2.02026/11/035 天前
3.1.02026/11/017 天前
3.0.02026/10/317 天前
2.4.02026/10/2613 天前
2.3.22026/10/2217 天前

关于 @basenative/auth 的常见问题

@basenative/auth 是什么?

BaseNative apps的认证、会议管理、RBAC和OAuth2/OIDC

如何安装 @basenative/auth?

在项目目录运行 npm install @basenative/auth,或使用 pnpm add / yarn add / bun add。

@basenative/auth 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@basenative/auth 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@basenative/auth 可以商用吗?

@basenative/auth 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@basenative/auth 的下载量有多少?

根据 npm 官方下载统计,@basenative/auth 在 2026/10/08 – 2026/11/06 这 30 天内被下载 1,874 次,日均约 62 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@basenative/auth 还在维护吗?

最新版本 3.3.0 发布于 2026/11/03(5 天前);至今共发布 14 个版本,其中过去 12 个月发布了 14 个;首次发布于 2026/03/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。