# @gjermundgaraba/clankerauth-dev 中文文档

规范地址：https://npmcn.com/package/%40gjermundgaraba/clankerauth-dev/

版本：0\.35\.1
npm 元数据更新时间：2026-11-11T02:10:04.463Z
中文译文更新时间：2026-11-16T15:27:14.339Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gjermundgaraba/clankerauth-dev
原文对照：https://npmcn.com/package/%40gjermundgaraba/clankerauth-dev/?lang=original
源码仓库：https://github.com/gjermundgaraba/clankerauth

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

- 包体积（解压后）：2.7 MB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26\.13\.0
- 运行依赖：0 个
- 首次发布：2026-09-20T12:44:15.892Z
- 最新版本发布：2026-11-11T02:10:03.925Z
- 近 30 天下载量：3631（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

用于应用程序开发的可处理的本地 Crankerauth 发行商

## 安装

```sh
npm install @gjermundgaraba/clankerauth-dev
```

也可以使用：`pnpm add @gjermundgaraba/clankerauth-dev`、`yarn add @gjermundgaraba/clankerauth-dev`、`bun add @gjermundgaraba/clankerauth-dev`

## README

# @gjermundgaraba/clankerauth-dev 页面存档备份,存于互联网档案馆

一次性 [科克劳斯](https://github.com/gjermundgaraba/clankerauth) 用于开发和测试对一进行认证的应用程序的发行人。 包将整个服务器和仪表板捆绑起来,没有依赖性,因此它只需要节点26或更新.

```sh
npm install --save-dev @gjermundgaraba/clankerauth-dev
```

```ts
import { startDisposableIssuer } from "@gjermundgaraba/clankerauth-dev";

const issuer = await startDisposableIssuer({
  resources: [
    {
      identifier: "http://127.0.0.1:8080/",
      name: "Notes",
      scopes: ["notes:read"],
    },
  ],
  client: {
    name: "Notes console",
    redirect: "http://localhost:5173/callback",
    resources: ["http://127.0.0.1:8080/"],
  },
});

issuer.issuer; // OAuth issuer URL, for discovery and token verification
issuer.url; // dashboard origin, sign in with issuer.owner.email and issuer.owner.password
issuer.clientId; // a confidential native client for the given redirect and resources
issuer.clientSecret;

await issuer.close();
```

每一次调用都会在一个随机回回端口上收听,在临时目录中创建新的SQLite数据库和秘密,通过服务器的管理模块提供所有者,资源和客户端在进程中,然后返回. 只有返回的发行器通过HTTP到达. 客户端为第一人:一旦所有者签名入内,授权请求直接以代码重定向回调,没有同意步骤. `close()` 排出飞行中的请求,关闭数据库并删除目录。 呼叫之间没有任何东西是共享的,也没有任何东西能幸存下来。 失败的开始, 例如在无效时 `cookieDomain`,拒绝方式 `ProvisioningError` 在做同样的事情之后, 它没有离开任何港口 约束和没有什么关闭.

## 规定

发行商提供什么样的测试或开发脚本,否则会针对其HTTP API手写:

```ts
const key = await issuer.apiKey({
  permissions: { [resource.identifier]: ["notes:read"] },
});

// Needs a cookieDomain: the forward cookie is what a browser holds.
const { cookie, cookies } = await issuer.ownerSession(
  "http://app.notes.localhost:5173"
);
const token = await issuer.ownerToken({
  resource: resource.identifier,
  appOrigin: "http://app.notes.localhost:5173",
});
```

`apiKey` 返回一次密钥. `ownerSession` 薄荷为所有者在进程中的会话,没有速率限制的登录端点,所以任何次数的呼叫和重启都永远不会遇到429,并且将前方饼干封装为 `/forward-auth/continue` 用于浏览器; `cookies` 是浏览器自定义上下文中的名称/值. `ownerToken` 运行相同的前向自动检查并返回访问符,因此测试从不组装饼干罐. 拒绝 `apiKey` 拒绝方式 `ProvisioningError`,拒绝 `ownerSession` 或者说 `ownerToken` 与 `ForwardAuthError`两个类别都出口,每个类别都是 `_tag` 这是它的名字.

## 在重启后幸存的工作空间

过 `dataDir` 和一个固定的 `port` 保持发行人状态:

```ts
const issuer = await startDisposableIssuer({
  ...options,
  dataDir: ".dev/clankerauth",
  port: 5174,
});
```

拥有者账户和密码,签名秘诀,注册客户端和数据库都保存在该目录中,提供是一码事,所以下次开始重复使用它们:相同的签入作品,API密钥在被验证之前已经计数,由来源所键的浏览器存储活下来了. 固定端口是其中的一部分,因为源头就是饼干和已注册的重定向URI的键. `close()` 留下目录 把它当作整个工作空间的秘密来对待,使其不受版本控制. `credentials.json` 由这个包单独写和读取,并在每次启动时对照其方案验证,因此拒绝编辑或截取文件,而不是半读. 无 `dataDir`,无变化:临时目录、随机端口和全部删除 `close()`。 。 。 .

要在前方认证后开发一个应用程序, 请通过 `cookieDomain`数字 :

```ts
const issuer = await startDisposableIssuer({
  resources: [
    {
      identifier: "http://app.notes.localhost:8080/",
      name: "Notes",
      scopes: [],
    },
  ],
  client: {
    name: "Notes console",
    redirect: "http://localhost:5173/callback",
    resources: [],
  },
  cookieDomain: "notes.localhost",
});

issuer.url; // http://clankerauth.notes.localhost:<port>
```

然后发行商就服务于 `/forward-auth?resource=<identifier>`, (中文(简体) ), `/forward-auth/continue` 财务报告和审定财务报表 `/forward-auth/logout`,并共享其前置饼干 与每个主机在域下, 因此服务应用程序之一, 例如 `app.notes.localhost`。浏览器和节点解析 `.localhost` 没有主机文件条目,要回放名称。 签到的房主支票答覆 `204` 带有 `Authorization` 上游复制页眉;没有会话,页导航(`Sec-Fetch-Mode: navigate`)通过登录重新定向,任何其他请求都是 `401`没有 `cookieDomain` 发行者是 `http://127.0.0.1:<port>` 而这些路线却得不到服务.

## 边缘

`@gjermundgaraba/clankerauth-dev/edge` 是本地发展的部署边缘: `forward_auth` 检查,并升级一个反向代理。 别再写了.

```ts
import {
  forwardAuth,
  reserveLoopbackPort,
} from "@gjermundgaraba/clankerauth-dev/edge";

export default defineConfig({
  plugins: [
    forwardAuth({
      issuer: "http://clankerauth.notes.localhost:5174",
      appOrigin: "http://app.notes.localhost:5173",
      resource: "http://app.notes.localhost:5173/",
      sockets: { backend: "http://127.0.0.1:8080", paths: ["/eventlog"] },
      verifiesAuthorization: (path) => path.startsWith("/api/"),
      onError: (error) => console.error("[forward-auth]", error.message),
    }),
  ],
});
```

本套件中没有导入 Vite, 在运行时或其类型: 插件是普通对象 Vite 接受 。 在普通节点服务器上, `attach(server, options)` a. 安装同一两半并返回请求的中间软件; `check(options)` 财务报告和审定财务报表 `middleware(options)` 可自行获得.

-   检查使用 `node:http`永远 `fetch`数字 : `fetch` 拥有 `Sec-Fetch-Mode`,而该信头是告诉发行人是否可以通过登录重新定向请求。 浏览器的自有头部被转发,连同它的饼干,加 `x-forwarded-proto`, (中文(简体) ), `-host` 财务报告和审定财务报表 `-uri`。 。 。 .
-   它有一个超时(默认为5s)和 **拒绝** 而不是决定发行者何时无法接触、太慢或回答 `204` 没有 `Authorization` 向前进. `middleware` 将拒绝变为502,并将错误传递给 `onError`;从未向上游转发过空证书.
-   如发行商所写: 其地位 `Location`页:1 `WWW-Authenticate`,其正文和内容类型。 未签名的脚本已读 `{"error":"unauthenticated"}` 而不是一个空的401, 和挑战命名资源元数据, 所以 OAuth 客户端可以发现在哪里签名 .
-   `publicPaths` 默认为 `/mcp`, (中文(简体) ), `/.well-known` 财务报告和审定财务报表 `/healthz`,并且请求已经包含 `Authorization` 眉头没有检查在哪里 `verifiesAuthorization(path)` 说在边缘后面的服务器 验证一个, 默认每个路径: 机上的特工自己和探测器运行。 开发服务器验证什么也没有,所以在Vite 答案前有一个边缘 `false` 用于 Vite 服务的路径; 否则任何 `Authorization` 值,甚至 `x`,到达其页面和模块。 在它回答的地方 `false`,标题被忽略并被发行人的符号所取代.
-   只有一条平坦的道路没有受到阻碍。 带有点段的路径, 编码 `.`, (中文(简体) ), `/` 或者说 `\`,或者像其它一样通过检查,所以边缘后面的服务器无法解析 `/mcp/../src/main.ts` 输入支票从未见过的一页。 与 `sockets` 给与,在这样的路径上升级 被拒绝与400.
-   `upgrade` 只取入路径 `sockets.paths`,所以一个开发服务器保留自己的热重装套接字;它返回 `false` 在普通的节点服务器上意味着另一个听众必须回答。 这些升级没有被检查:另一个听众在到达时回答升级,在发行者决定的时候边缘无法持有. Vite 拒绝发送一个 `Origin` 因此,在这个或另一个网站上,没有页面打开一个;一个客户端发送不 `Origin`,例如 `curl`,可以,也可以读取哪些模块改变了。 奥米 `sockets` 不需要钱 已检查的升级为 `sockets.backend`;半个收尾通常会结束另一半,只有错误会破坏. 在发行商决定时放弃的客户端完全没有代理权. 报告套接字出错 `onError` 并且从不崩溃服务器.
-   `reserveLoopbackPort()` 拥有一个自由港 之前,任何必须知道自己的来源 前面.

边缘类型导入 `node:http` 类型,所以 TypeScript 消费者需要 `@types/node`。 。 。 .

两个可选的测试钩帮助锻炼集成:

-   `cimdTransport(input, init)` 替换出局客户端ID元数据文档检索并返回 a `Response` 或者说 `Promise<Response>`。它的参数匹配 `fetch`。使用它为没有外部服务器的 HTTPS 客户端ID 提供固定元数据。 省略后,发行方使用其安全的元数据传输.
-   `onRequest({ method, url })` 在发行方的收听器中观察到实际收到的HTTP请求,如发现,JWKS,动态客户端注册,和符号请求等. 提供是进行中,因此观察者只看到测试本身的流量. `url` 是一个 `URL`;头和身体从不通过. 回调在处理每个请求前同步运行 。 被抛出的错误使得HTTP 500的请求失败,所以保持观察者不扔.

## 测试用的假发行商

一个只需要JWKS和密钥列表的测试——一个必须在两秒内过期的标志,一个在他人资源上授予的密钥,一个停用——想要SDK的假发者, `@gjermundgaraba/clankerauth-sdk/testing`,而不是这个包。 使用 `startDisposableIssuer` 当协议本身是测试对象时——签入,同意,转发认证,动态注册.

麻省理工学院有执照 捆绑的第三方许可证列于 `dist/THIRD_PARTY_NOTICES.txt`。 。 。 .

## 常见问题

### @gjermundgaraba/clankerauth-dev 是什么？

用于应用程序开发的可处理的本地 Crankerauth 发行商

### 如何安装 @gjermundgaraba/clankerauth-dev？

在项目目录运行 npm install @gjermundgaraba/clankerauth-dev，或使用 pnpm add / yarn add / bun add。

### @gjermundgaraba/clankerauth-dev 支持 TypeScript 吗？

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

### @gjermundgaraba/clankerauth-dev 支持 ESM 还是 CommonJS？

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

### @gjermundgaraba/clankerauth-dev 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=26\.13\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gjermundgaraba/clankerauth-dev 可以商用吗？

@gjermundgaraba/clankerauth-dev 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gjermundgaraba/clankerauth-dev 的下载量有多少？

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

### @gjermundgaraba/clankerauth-dev 还在维护吗？

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

