前言
近年来，前端开发逐渐成为了IT行业中不可或缺的一个角色。在这个过程中，npm包的重要性也不言而喻。本文将介绍一款前端开发中常用的npm包 hapi-keycloak，并详细地阐述它的使用方法和指导意义。
hapi-keycloak 简介
hapi-keycloak 是基于 Node.js 和 Hapi.js 框架的一个 Javascript 前端 npm 包，它封装了 Keycloak 的 JavaScript Adapter，并提供了几个 Hapi 插件等功能。hapi-keycloak 使得使用 Keycloak 服务来保护您的 Hapi.js 应用程序变得非常容易。
使用步骤
本节将介绍 hapi-keycloak 的使用步骤。
步骤一：安装
在您的应用程序目录下执行以下命令来安装 hapi-keycloak：
npm install hapi-keycloak --save
步骤二：配置
在您的应用程序中增加如下配置项：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ------------ - -------------------------
----- ------ - --- ------------- ----- ---- ---
----- ---- - ----- -- -- -
----- -------------- - -
-------- ----------
------------------ -----------------------------
--------------- -------
----------- --------
---------------- -----
-------------------- -
--
----- --------------- - -
-------- ----------
----------- -------
--
----- -----------------
-
------- -------------
-------- -
---------------
---------------
-
-
--
-
-------步骤三：使用
接下来，在您想要使用 Keycloak 保护的路由上增加如下配置项：
-- -------------------- ---- -------
-
------- ------
----- ----
-------- --------- -- -- -
------ ------- --------
--
------- -
----- ----------
-
-当用户访问该路由时，如果用户未被认证，会自动跳转到 Keycloak 服务器，以获取身份验证。用户的授权信息会保存在请求头或 cookie 中，请求头或 cookie 中的信息会被 hapi-keycloak 插件自动提取并进行解密处理。如果用户已经被认证，将会返回 Hello, World!。
深度学习
除了上述基本使用，hapi-keycloak 还提供了以下的高级配置：
拓展事件监听
通过 hapi-keycloak 能够监听以下事件：
- [options.preAuth][] – 在验证和授权接受之前调用。
- [options.onAuthorizationBearer][] – 在 Bearer 授权流程完成后，生成包含 JWT 信息的授权凭据时调用。
- [options.onToken][] – 在解析 JWT 后调用，但在验证 JWT 合法性之前。
- [options.onPostAuth][] – 在身份验证，授权和额外的自定义身份验证后进行。
授权
通过 hapi-keycloak 支持的授权标记：
- "1": 访问被允许但没有任何其他权限。
- "2": 被赋予隐式访问记录权限。
- "4": 被分配为所有者。
- "8": 从组织架构声明中继承权限。
- "16": 被授权创建。
- "32": 被授权读取。
- "64": 被授权更新。
- "128": 被授权删除。
有创造权限的时候，然后可以添加HapiKeycloak.createRealmRoles([ 'admin' ])
和自定义访问控制策略的支持
Session Management
通过 hapi-keycloak 能够在各种事件上监听 session 过期事件， 例如:
- 程序过期的时候
- ajax 请求在超时的时候
- 窗口失去焦点的时候
- 程序唤醒设备的时候
结论
通过学习本文，我们可以了解到：
- hapi-keycloak 是基于 Node.js 和 Hapi.js 框架的一个 Javascript 前端 npm 包，它封装了 Keycloak 的 JavaScript Adapter。
- hapi-keycloak 使得使用 Keycloak 服务来保护您的 Hapi.js 应用程序变得非常容易，其使用方式简单。
- hapi-keycloak 还提供了高级配置方式，包括监听事件，支持授权标记等。
通过使用 hapi-keycloak，我们可以轻松地使用 Keycloak 服务来保护我们的应用程序，并且更加安全和规范。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055feb81e8991b448dda74