# @haneinfo/oidc-auth 中文文档

规范地址：https://npmcn.com/package/%40haneinfo/oidc-auth/

版本：6\.0\.1
npm 元数据更新时间：2026-11-17T01:11:55.771Z
中文译文更新时间：2026-11-17T07:47:34.531Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40haneinfo/oidc-auth
原文对照：https://npmcn.com/package/%40haneinfo/oidc-auth/?lang=original

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

- 包体积（解压后）：225 kB，152 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：4 个
- peer 依赖：zod ^4\.4\.0，next ^16\.2\.9，react ^19\.0\.0，react-dom ^19\.0\.0，@nestjs/core ^11\.0\.0 \|\| ^12\.0\.0，@nestjs/common ^11\.0\.0 \|\| ^12\.0\.0，@prisma/client ^6\.19\.0 \|\| ^7\.10\.1，@haneinfo/common ^0\.6\.1 \|\| ^0\.7\.0，@haneinfo/frontend-shell ^1\.1\.0，@haneinfo/plugin-host-nest ^2\.0\.0
- 首次发布：2026-10-02T05:26:12.765Z
- 最新版本发布：2026-11-17T01:11:55.551Z
- 近 30 天下载量：5119（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

Haneinfoapps的OIDC交互式认证:JWKS/RS256验证,(发件人,主题)身份映射,JIT提供和入境授权(RFC 8693)信任配置.

## 安装

```sh
npm install @haneinfo/oidc-auth
```

也可以使用：`pnpm add @haneinfo/oidc-auth`、`yarn add @haneinfo/oidc-auth`、`bun add @haneinfo/oidc-auth`

## README

# @haneinfo/oidc-auth (英语)

OIDC交互式认证和入境授权(RFC 8693)为Haneinfo NestJS应用程序进行符号验证.

## 建筑(6.0)

-   **单一交互式核查路径**数字 : `JwtVerifierService.verifyJwtToken(token)` 是交互式无记名符号的唯一核查入口(用于: `OidcInteractiveStrategy` 财务报告和审定财务报表 `@haneinfo/plugin-host-nest`是因为 `InteractiveAuthGuard`) (中文(简体) ).
-   **IAM 概况合同**数字 : `issuer`, (中文(简体) ), `jwksUri` (通过) `getTrustedMetadata()`),签名算法授权列表(`signingAlgorithms`,并声称正常化(`normalizeClaims('web', payload, header)`所有来自注射器 `IAM_PROFILE` (单位:千美元)`IamProfilePort`,能力 `haneinfo.iam-profile`) (中文(简体) ).
-   **观众和客户端分离**页:1`web.apiAudience`)和Web RP客户端ID(`web.clientId`)来自部署配置(`IamDeploymentConfig`),并由 `IAM_PROFILE` 执行,而不是 `OIDC_AUDIENCE` 或者说 `azp === audience`。 。 。 .
-   **切换时间戳验证**数字 : `iat` 财务报告和审定财务报表 `exp` 边距( e)`clockToleranceSeconds`, (中文(简体) ), `maxIssuedLifetimeSeconds`() 由 `@haneinfo/plugin-api`是因为 `validateTokenTimestamps`。 。 。 .

## 从 5.x 迁移到 6.0

### 删除的环境变量和导出

-   `OIDC_ISSUER`, (中文(简体) ), `OIDC_AUDIENCE` 财务报告和审定财务报表 `OIDC_JWKS_URL` 不再读取.
-   `oidcAuthConfigFromEnvironment` 被删除,以及 `oidcAuthConfigSchema` 现在 `z.object({}).strict()`。 。 。 .
-   护照路径被移除 : `OidcStrategy`, (中文(简体) ), `JwtAuthGuard`,则 `passport`, (中文(简体) ), `passport-jwt` 财务报告和审定财务报表 `@nestjs/passport` 依赖性。 使用 `InteractiveAuthGuard` 从 `@haneinfo/plugin-host-nest` 换句话说.
-   `JwtVerifierService.buildOidcJwtUser` 删除。 它从未验证的有效载荷上造出主力.

### 新的所需能力

-   `requires` 现在包括 `haneinfo.iam-profile` (单位:千美元)`CAPABILITY_IAM_PROFILE`),以及 `engine.haneinfoPluginApi` 实值 `^1.29.0`。 。 。 .

### 变动至 `haneinfo.config.ts`

设定 `runtime.oidc` 改为 `{}`,然后添加 `@haneinfo/iam-keycloak/plugin`, (中文(简体) ), `runtime.iam` 财务报告和审定财务报表 `iam.deployment`编辑 `@haneinfo/plugin-host-nest` README有细节.

```ts
import { iamKeycloakPlugin } from '@haneinfo/iam-keycloak/plugin';
import { oidcAuthPlugin } from '@haneinfo/oidc-auth/plugin';
import type { IamDeploymentConfig } from '@haneinfo/plugin-api';
import { defineHaneinfoConfig } from '@haneinfo/plugin-host-nest';

// Single source of truth for profileId, issuer, capabilities, web.apiAudience and web.clientId.
const iamDeployment: IamDeploymentConfig = {
  /* ... */
};

export default defineHaneinfoConfig({
  inventory,
  plugins: [{ plugin: iamKeycloakPlugin }, { plugin: oidcAuthPlugin } /* , ... */],
  iam: { deployment: iamDeployment },
  runtime: {
    iam: iamDeployment,
    oidc: {},
  },
});
```

### `DelegatedAuthModule` 变动

-   `DelegatedAuthModule.forFeature(options)` 不再接受一个 `oidc` 选项,不再读 `OIDC_JWKS_URL`。 。 。 .
-   `DelegatedJwtVerifierService` 注射数 `IAM_PROFILE`在第一次核实时,它写着: `jwksUri` 从 `getTrustedMetadata()` 并检查它与 `validateDelegatedJwksUrl`。 。 。 .
-   Apps必须制造 `IAM_PROFILE` 可通过 `options.imports`,加上 `PrismaService`, (中文(简体) ), `IDENTITY_STORE` 财务报告和审定财务报表 `AUDIT_SINK`。 。 。 .
-   **O3 启动门**数字 : `DelegatedAuthModule` 检查 `IAM_PROFILE.mcpCapabilities.delegation` 启动时拒绝启动,除非是 `true` (跨应用程序授权O3未启用,因此授权的切入点不得注册).

### 尚未迁移(第2W7阶段)

模板、应用软件和 `@haneinfo/app-tooling` (例如 `packages/app-tooling/src/scaffold.ts` 和它的测试)仍然使用这些名字. 他们在第二阶段W7中迁移:

-   `OIDC_ISSUER`
-   `OIDC_AUDIENCE`
-   `OIDC_JWKS_URL`

## 常见问题

### @haneinfo/oidc-auth 是什么？

Haneinfoapps的OIDC交互式认证:JWKS/RS256验证,\(发件人,主题\)身份映射,JIT提供和入境授权\(RFC 8693\)信任配置\.

### 如何安装 @haneinfo/oidc-auth？

在项目目录运行 npm install @haneinfo/oidc-auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.4\.0）、@nestjs/core（^11\.0\.0 \|\| ^12\.0\.0）、@nestjs/common（^11\.0\.0 \|\| ^12\.0\.0）、@prisma/client（^6\.19\.0 \|\| ^7\.10\.1）、@haneinfo/common（^0\.6\.1 \|\| ^0\.7\.0）、@haneinfo/plugin-host-nest（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haneinfo/oidc-auth 支持 TypeScript 吗？

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

### @haneinfo/oidc-auth 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @haneinfo/oidc-auth 需要什么版本的 Node\.js？

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

### @haneinfo/oidc-auth 可以商用吗？

@haneinfo/oidc-auth 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @haneinfo/oidc-auth 的下载量有多少？

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

### @haneinfo/oidc-auth 还在维护吗？

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

