# @arkstack/auth 中文文档

规范地址：https://npmcn.com/package/%40arkstack/auth/

版本：0\.22\.2
npm 元数据更新时间：2026-11-07T14:01:18.617Z
中文译文更新时间：2026-11-06T20:48:50.783Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40arkstack/auth
原文对照：https://npmcn.com/package/%40arkstack/auth/?lang=original
项目主页：https://arkstack.toneflix.net/guide/auth
源码仓库：https://github.com/arkstack-hq/arkstack

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：55.1 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：5 个
- peer 依赖：@h3ravel/support ^2\.2\.7，@arkstack/database ^0\.22\.2
- 首次发布：2026-05-03T19:12:38.170Z
- 最新版本发布：2026-11-07T14:01:18.415Z
- 近 30 天下载量：2366（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：190（近 12 个月 190 个）

## 中文简介

Arkstack的认证模块,提供核心认证和身份特征.

## 安装

```sh
npm install @arkstack/auth
```

也可以使用：`pnpm add @arkstack/auth`、`yarn add @arkstack/auth`、`bun add @arkstack/auth`

## README

# @arkstack/ auth (韩语)

[![@arkstack/auth](https://img.shields.io/npm/dt/@arkstack/auth?style=flat-square&label=@arkstack/auth&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/auth)](https://www.npmjs.com/package/@arkstack/auth)

Arkstack的认证模块,提供核心认证和身份特征.

`@arkstack/auth` 提供 Arkstack 运行时驱动程序所使用的框架中立认证服务。 它支持认证验证,JWT支持的个人访问符,临时目的约束符,当前会话查询,两个要素认证帮助器,以及认证特定例外.

## 使用量

```ts
import { Auth } from '@arkstack/auth'

const auth = Auth.make()
const token = await auth.login(email, password)
const user = await auth.authorizeToken(token.token)
```

Auth解决您的应用程序 `User` 财务报告和审定财务报表 `PersonalAccessToken` 模型为 `getModel()` 从 `@arkstack/common`。 。 。 .

## 双向认证

```ts
import { TwoFactor } from '@arkstack/auth'

const setup = TwoFactor.createSetup(user)
await TwoFactor.setSecret(user.id, setup.secret)

if (TwoFactor.verifyCode(user, setup.secret, code)) {
  const recoveryCodes = TwoFactor.generateBackupCodes()

  await TwoFactor.setMethod(user.id, 'authenticator')
  await TwoFactor.setEnabledAt(user.id)
  await TwoFactor.writeRecoveryCodeHashes(user.id, await TwoFactor.hashBackupCodes(recoveryCodes))
}
```

持续使用2FA状态的应用程序应提供 `UserTwoFactor` 模型由 `user_two_factors` 页:1 起步器模板包括这个模型和迁移. 设定 `TWO_FACTOR_ENCRYPTION_KEY` 在存储验证器机密之前.

SMS 2FA 发行并存储挑战 `@arkstack/auth`,然后通过 `@arkstack/notifications`数字 :

```ts
import { Notification } from '@arkstack/notifications'

const issued = await TwoFactor.issueSmsCode(user, 'login')

await Notification.sms().recipient(user.phone).send('Your login code is {code}', undefined, undefined, {
  code: issued.code,
})
```

配置短消息提供者为 `notifications.drivers.sms.transport` 和运输证书 `notifications.transports.twilio` 或者说 `notifications.transports.africastalking`。 。 。 .

驱动程序中间软件生活在运行时包中 :

```ts
import { auth } from '@arkstack/driver-express/middlewares'
import { auth as h3Auth } from '@arkstack/driver-h3/middlewares'
```

见完整设置的文档认证指南.

## 常见问题

### @arkstack/auth 是什么？

Arkstack的认证模块,提供核心认证和身份特征\.

### 如何安装 @arkstack/auth？

在项目目录运行 npm install @arkstack/auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@h3ravel/support（^2\.2\.7）、@arkstack/database（^0\.22\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @arkstack/auth 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/arkstack\_\_auth 是否存在。

### @arkstack/auth 支持 ESM 还是 CommonJS？

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

### @arkstack/auth 可以商用吗？

@arkstack/auth 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @arkstack/auth 的下载量有多少？

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

### @arkstack/auth 还在维护吗？

最新版本 0\.22\.2 发布于 2026/11/07（今天）；至今共发布 190 个版本，其中过去 12 个月发布了 190 个；首次发布于 2026/05/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。