如何使用 Express.js 和 Passport.js 实现 OAuth 认证

OAuth 是一种常见的用户认证协议,它允许用户授权第三方应用访问他们在其他服务上的数据。例如,一个用户可以使用他们在 Google 上的账号登录到一个使用 Google API 的应用中。在前端开发中,我们通常使用 Express.js 和 Passport.js 来实现 OAuth 认证。

本文将介绍如何在 Express.js 应用中使用 Passport.js 实现 OAuth 认证。我们将以 GitHub OAuth2 为例,但是这个流程在大多数 OAuth2 提供商中都是相似的。

步骤 1:创建 OAuth 应用

首先,我们需要在 GitHub 上创建一个 OAuth 应用。登录 GitHub,进入 Settings -> Developer settings -> OAuth Apps。点击 New OAuth App 按钮,填写应用信息,包括应用名称、主页 URL、授权回调 URL 等。

授权回调 URL 是用户授权后 GitHub 重定向回我们应用的 URL。在本地开发中,我们可以使用 http://localhost:3000/auth/github/callback。在生产环境中,我们需要使用我们的域名和 HTTPS。

创建成功后,GitHub 将为我们提供一个 Client ID 和一个 Client Secret,我们需要在后面使用它们进行认证。

步骤 2:安装 Passport.js 和相关策略

我们需要安装 Passport.js 和相关的策略来处理 OAuth 认证。在终端中执行以下命令:

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

其中,passport-github2 是处理 GitHub OAuth2 的策略,express-session 是用于会话管理。

步骤 3:配置 Passport.js

我们需要在应用中配置 Passport.js。在 app.js 中添加以下代码:

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

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

其中,GITHUB_CLIENT_IDGITHUB_CLIENT_SECRET 是我们在 GitHub 上创建 OAuth 应用时获取到的 Client ID 和 Client Secret。callbackURL 是我们在前面创建 OAuth 应用时设置的授权回调 URL。

在回调函数中,我们可以处理认证成功后的逻辑。例如,将用户信息存储到数据库中,或者设置会话状态。

接下来,我们需要在应用中使用 Passport.js。在 app.js 中添加以下代码:

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

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

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

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

其中,secret 是用于加密会话的字符串。serializeUserdeserializeUser 方法用于在会话中存储和读取用户信息。

步骤 4:设置认证路由

现在我们可以设置认证路由了。在 app.js 中添加以下代码:

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

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

其中,/auth/github 是认证路由,/auth/github/callback 是授权回调路由。在 /auth/github 路由中,我们使用 passport.authenticate 方法来发起认证请求。在 /auth/github/callback 路由中,我们使用 passport.authenticate 方法来处理认证回调。

步骤 5:实现认证成功后的逻辑

最后,我们需要在认证成功后的回调中实现我们的逻辑。在 passport.use 方法中的回调函数中,我们可以将用户信息存储到数据库中,或者设置会话状态。例如:

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

其中,User 是我们的用户模型,findOrCreate 方法用于查找或创建用户。在回调函数中,我们返回用户信息。

/auth/github/callback 路由中,我们可以从 req.user 中获取用户信息,例如:

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

总结

在本文中,我们介绍了如何使用 Express.js 和 Passport.js 实现 OAuth 认证。我们创建了一个 GitHub OAuth2 应用,并使用 Passport.js 处理 OAuth 认证。我们还实现了认证成功后的逻辑,并将用户信息存储到数据库中。

OAuth 认证是一种常见的用户认证协议,它允许用户授权第三方应用访问他们在其他服务上的数据。在前端开发中,我们通常使用 Express.js 和 Passport.js 来实现 OAuth 认证。本文提供了一个示例,帮助你了解如何使用 Express.js 和 Passport.js 实现 OAuth 认证。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6637410dd3423812e456b984