# @exlinc/keycloak-passport 中文文档

规范地址：https://npmcn.com/package/%40exlinc/keycloak-passport/

版本：1\.0\.2
npm 元数据更新时间：2023-12-05T00:16:39.467Z
中文译文更新时间：2026-11-14T03:37:58.358Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40exlinc/keycloak-passport
原文对照：https://npmcn.com/package/%40exlinc/keycloak-passport/?lang=original
项目主页：https://github.com/exlinc/keycloak-passport#readme
源码仓库：https://github.com/exlinc/keycloak-passport

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

- 包体积（解压后）：16.5 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2018-07-23T01:15:35.263Z
- 最新版本发布：2018-07-23T04:44:15.201Z
- 近 30 天下载量：16040（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

EXL Inc.的灵活Keycloak护照策略(有多现实支持).

## 安装

```sh
npm install @exlinc/keycloak-passport
```

也可以使用：`pnpm add @exlinc/keycloak-passport`、`yarn add @exlinc/keycloak-passport`、`bun add @exlinc/keycloak-passport`

## README

# Keycloak 护照战略 -- -- oAuth2/OIDC

该图书馆提供制作准备和维护的Keycloak护照连接器,提供下列关键功能:

-   在同一应用程序中使用多个域( 多租借)
    
-   在 keycloak 中使用 oAuth2/ 打开 ID 连接客户端
    
-   通过 JSON API 从 keycloak 自动获取用户数据
    

## 为什么? 这事还没完成吗?

在某种程度上,是的。 大约有3到4个重置者将自己作为"Keycloak Passport"的品牌,然而其中没有一个被积极维护,并且大部分要么是完全空的,不允许使用多域,只执行协议的一部分,并/或不从Keycloak获取用户的数据. Keycloak 计划本身也有一个专用的节点JS连接器, 不过, 如果您想要将 Keycloak 作为“ yeat another” 护照策略, 该项目填补了这一空白.

## 使用量

## 安装

```bash
npm install @exlinc/keycloak-passport
```

### 导入

```javascript
import KeycloakStrategy from "@exlinc/keycloak-passport";
```

### 初始化

```javascript
// Register the strategy with passport
passport.use(
  "keycloak",
  new KeycloakStrategy(
    {
      host: process.env.KEYCLOAK_HOST,
      realm: process.env.KEYCLOAK_REALM,
      clientID: process.env.KEYCLOAK_CLIENT_ID,
      clientSecret: process.env.KEYCLOAK_CLIENT_SECRET,
      callbackURL: `/api${AUTH_KEYCLOAK_CALLBACK}`
    },
    (accessToken, refreshToken, profile, done) => {
      // This is called after a successful authentication has been completed
      // Here's a sample of what you can then do, i.e., write the user to your DB
      User.findOrCreate({ email: profile.email }, (err, user) => {
        assert.ifError(err);
        user.keycloakId = profile.keycloakId;
        user.imageUrl = profile.avatar;
        user.name = profile.name;
        user.save((err, savedUser) => done(err, savedUser));
      });
    }
  )
);
```

### 路线

```javascript
router.get(
  routes.AUTH_KEYCLOAK,
  passport.authenticate("keycloak", DEFAULT_PASSPORT_OPTIONS)
);
router.get(
  routes.AUTH_KEYCLOAK_CALLBACK,
  passport.authenticate("keycloak", DEFAULT_PASSPORT_OPTIONS),
  AuthController.keyCloakSuccess
);
```

## 贡献/反馈

欢迎通过 " 问题 " 和 " 拉动 " 倡议提供一切形式的协助

## 常见问题

### @exlinc/keycloak-passport 是什么？

EXL Inc\.的灵活Keycloak护照策略\(有多现实支持\)\.

### 如何安装 @exlinc/keycloak-passport？

在项目目录运行 npm install @exlinc/keycloak-passport，或使用 pnpm add / yarn add / bun add。

### @exlinc/keycloak-passport 支持 TypeScript 吗？

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

### @exlinc/keycloak-passport 支持 ESM 还是 CommonJS？

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

### @exlinc/keycloak-passport 可以商用吗？

@exlinc/keycloak-passport 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @exlinc/keycloak-passport 的下载量有多少？

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

### @exlinc/keycloak-passport 还在维护吗？

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