npm 包 easy_openid_client 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

Easy_OpenID_Client 是一款基于 Node.js 环境下的 OpenID 客户端模块。它提供了一种简单且易用的方式，用于处理OpenID认证与授权的逻辑。这篇文章将会详细介绍该模块的安装、使用、以及一些食用技巧。

安装

首先需要在你的项目目录下，通过 npm 安装这个包：

npm install easy_openid_client

使用

安装完毕之后，我们需要在代码中引入这个库，如下所示：

const EasyOpenIDClient = require('easy_openid_client');

其中 EasyOpenIDClient 是我们引入的类对象。从这个类中可以创建一个新的实例，如下所示：

const openidClient = new EasyOpenIDClient();

授权请求的发送

接下来，我们需要为本地服务提供授权功能。在处理完用户的授权请求之后，我们需要使用 openidClient 类中的 createAuthUrl() 方法生成一个请求 URL ，并将其返回。

const return_url = 'http://localhost:3000/return';
const scope = 'openid';
const auth_uri = openidClient.createAuthUrl(return_url, scope);

//然后我们可以将这个 URL 作为回复发送给前端，让用户进入授权页面授权并获取 Code。

处理授权的响应

在得到 Code 后，我们使用这个 Code 去换取 Access Token。可以使用 openidClient 类中的 getToken() 方法，示例代码如下：

const code = req.query.code;
const redirect_uri = 'http://localhost:3000/return';
const token = openidClient.getToken(code, redirect_uri);

验证 Access Token

我们可以使用 openidClient 类中的 getUserinfo(token) 方法，通过请求 /userinfo 端点来验证 Access Token，获取用户信息。示例代码如下：

const userinfo = await openidClient.getUserinfo(token.access_token);
console.log(userinfo);

配置选项

Easy_OpenID_Client 支持各种授权服务器、不同类型的应用，这就导致了不同的授权策略和不同的参数组合。在实际使用中，我们需要对其进行配置。这里介绍几个常用的选项：

client_id

ClientID 是授权服务器发放的唯一标识。有些平台的 ClientID 需要在特定的地方进行配置，可以使用 openidClient 类的 setClientId() 方法将其设置到 openidClient 类中：

const openidClient = new EasyOpenIDClient();
openidClient.setClientId(process.env.CLIENT_ID);

client_secret

Client Secret 是和 Client ID 配套的另一个秘钥。该秘钥需要严格保密，普通用户是无法获取到的。可以使用 openidClient 类的 setClientSecret() 方法将其设置到 openidClient 类中：

const openidClient = new EasyOpenIDClient();
openidClient.setClientSecret(process.env.CLIENT_SECRET);

redirect_uri

Redirect URI 是应用在完成授权后，授权服务器跳转回的地址。可以使用 openidClient 类的 setRedirectUri() 方法将其设置到 openidClient 类中：

const openidClient = new EasyOpenIDClient();
openidClient.setRedirectUri('http://localhost:3000/return');

scope

Scope 是指定应用能够获取到的 Access Token 的范围，一般需要在特定的地方进行配置。可以使用 openidClient 类的 setScope() 方法将其设置到 openidClient 类中：

const openidClient = new EasyOpenIDClient();
openidClient.setScope('openid');

总结

在本篇文章中，我们详细讲解了如何使用 Easy_OpenID_Client 这个库，并且介绍了一些常用的配置选项。现在，你可以使用这个库，自己构建自己的授权应用了，希望对大家有所帮助。完整示例代码可以在 GitHub 上的 Easy_OpenID_Client 获取。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055e8381e8991b448dbe15