Express.js 中使用 Passport.js 实现 OAuth 认证

阅读时长 7 分钟读完

在 Web 开发中,用户认证和授权是一项必不可少的功能。随着 Web 应用规模的增大和用户量的增长,传统的本地认证方式已经难以满足需求。

OAuth2.0 是一个授权框架,它使得用户可以授权第三方应用访问他们存储在另外一些服务提供者的资源。它是目前业界使用最广泛的一种用户认证和授权方式,例如 Google、Facebook 等都对 OAuth2.0 提供了支持。

Express.js 是一个非常流行的 Web 开发框架,它提供了极为灵活的扩展性,可以轻松地实现各种认证方式。而 Passport.js 是一个 Node.js 身份验证库,可以简化开发者在 Node.js 中实现 OAuth2.0 认证流程的难度和复杂度,它支持超过 300 种身份验证策略,可以支持各种社交媒体和第三方应用的 OAuth2.0 认证。

本文将介绍如何在 Express.js 中使用 Passport.js 实现 OAuth2.0 认证。

第一步:安装 Passport.js

在使用 Passport.js 之前,需要先通过 npm 安装它:

第二步:配置 Passport.js

在 Express.js 应用中,可以在 app.js 或 index.js 等主文件中配置 Passport.js。

首先,需要在应用中引入必要的模块:

其中,passport-google-oauth20 是 Passport.js 的一个 OAuth2.0 策略,可以帮助我们快速配置 Google OAuth2.0 认证。

然后,在应用中配置 Passport.js:

-- -------------------- ---- -------
-------------
  --- ---------
    -
      --------- -----------------
      ------------- ---------------------
      ------------ ------------------------
    --
    -------- ------------- ------------- -------- --- -
      ------ -------- ---------
    -
  -
--

以上代码中,我们创建了一个 Google OAuth2.0 策略。其中,clientID 和 clientSecret 是在 Google Cloud Console 中创建 OAuth2.0 Client ID 后生成的。callbackURL 是用于接收 Google 服务器返回的授权码的回调地址。accessToken、refreshToken、profile 是授权成功后的回调参数。在这里,我们只是简单地将授权成功后返回的 profile 对象返回给回调函数。

接下来,需要设置 Passport.js 的序列化和反序列化函数:

这样,当用户登陆成功后就可以序列化用户的信息,并将其存储到 session 中。

最后,在 Express.js 应用中需要添加 Passport.js 的初始化和 session 支持中间件:

-- -------------------- ---- -------
-------------------------------
----------------------------
--------
  ----------------------------
    ------- ------------------
    ------- -----
    ------------------ -----
  --
--

第三步:创建认证路由

在 Express.js 应用中,可以通过创建 GET 路由来实现 OAuth2.0 认证。当用户点击认证按钮时,将跳转到 Google OAuth2.0 的认证页面。当用户授权成功后,将跳转回 callbackURL,进而触发 Passport.js 配置文件中定义的回调函数。

-- -------------------- ---- -------
--------
  ---------------
  ------------------------------- - ------ ----------- --
--

--------
  ------------------------
  ------------------------------- - ---------------- -------- ---
  -------- ----- ---- -
    ------------------
  -
--

在以上代码中,/auth/google 是用户点击“Google 认证”时的路由地址,passport.authenticate('google') 是 Passport.js 中的一个方法,调用它会将请求重定向到 Google OAuth2.0 的认证页面。'/auth/google/callback' 是 Google 认证成功回调的路由地址,我们在这里通过 passport.authenticate('google') 来处理用户的授权信息。当授权成功后,将重定向到用户的首页。

示例代码

完整示例代码中,我们以 Express 应用为例,实现了 Google OAuth2.0 认证。在代码中对各个步骤进行了详细的注释,可以直接使用。

-- -------------------- ---- -------
----- ------- - -------------------
----- -------- - --------------------
----- -------- - --------------------------------------------

-- -- ------ -------- ----
-------------
  --- ---------
    -
      --------- -----------------
      ------------- ---------------------
      ------------ ------------------------
    --
    -------- ------------- ------------- -------- --- -
      ------ -------- ---------
    -
  -
--

-- ------------
------------------------------- ------ --- -
  -------- ------
---

--------------------------------- ----- --- -
  -------- -----
---

-- -- ---------- --
----- --- - ----------

-- -- ---------- --------
--------
  ----------------------------
    ------- ------------------
    ------- -----
    ------------------ -----
  --
--
-------------------------------
----------------------------

-- ----
------------ -------- ----- ---- -
  ------------ -------------------------- ---------
---

--------
  ---------------
  ------------------------------- - ------ ----------- --
--

--------
  ------------------------
  ------------------------------- - ---------------- -------- ---
  -------- ----- ---- -
    ------------------
  -
--

---------------- -- -- ---------------- --------- -- ---- ---------

总结

在本文中,我们介绍了如何在 Express.js 中使用 Passport.js 实现 OAuth2.0 认证。通过简单的配置和路由定义,我们可以快速地实现 OAuth2.0 认证,并将其应用到我们所开发的 Web 应用中,为用户提供更安全和更便捷的认证方式。

当然,在实际的开发中,OAuth2.0 认证还有很多需要注意的细节和安全问题,开发者需要对这些知识有更深入的了解。对于那些需要实现 OAuth2.0 认证的应用,我们建议使用 Passport.js 等相关库来快速实现认证功能,减轻开发者的复杂度和工作量。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6650641dd3423812e42d462f

纠错
反馈