【Node】使用 koa2 實現(xiàn)一個簡單JWT鑒權(quán)

JWT 簡介

什么是 JWT

全稱 JSON Web Token, 是目前最流行的跨域認證解決方案。基本的實現(xiàn)是服務(wù)端認證后,生成一個 JSON 對象,發(fā)回給用戶。用戶與服務(wù)端通信的時候,都要發(fā)回這個 JSON 對象。

JSON 類似如下:

{
  "姓名": "張三",
  "角色": "管理員",
  "到期時間": "2018年7月1日0點0分"
}

為什么需要 JWT

先看下一般的認證流程,基于 session_idCookie 實現(xiàn)

  • 用戶向服務(wù)器發(fā)送用戶名和密碼。
  • 服務(wù)器驗證通過后,在當前對話(session)里面保存相關(guān)數(shù)據(jù),比如用戶角色、登錄時間等等。
  • 服務(wù)器向用戶返回一個 session_id,寫入用戶的 Cookie
  • 用戶隨后的每一次請求,都會通過 Cookie,將 session_id 傳回服務(wù)器。
  • 服務(wù)器收到 session_id,找到前期保存的數(shù)據(jù),由此得知用戶的身份。

但是這里有一個大的問題,假如是服務(wù)器集群,則要求 session 數(shù)據(jù)共享,每臺服務(wù)器都能夠讀取 session。這個實現(xiàn)成本是比較大的。

JWT 轉(zhuǎn)換了思路,將 JSON 數(shù)據(jù)返回給前端的,前端再次請求時候?qū)?shù)據(jù)發(fā)送到后端,后端進行驗證。也就是服務(wù)器是無狀態(tài)的,所以更加容易拓展。

JWT 的數(shù)據(jù)結(jié)構(gòu)

JWT 的三個部分依次如下:

  • Header(頭部),類似如下
{
  "alg": "HS256",
  "typ": "JWT"
}

alg 屬性表示簽名的算法(algorithm),默認是 HMAC SHA256(寫成 HS256)。typ 屬性表示這個令牌(token)的類型(type),JWT 令牌統(tǒng)一寫為 JWT

  • Payload(負載)。也是一個 JSON,用來存放實際需要傳遞的數(shù)據(jù)。JWT 規(guī)定了 7 個官方字段。如下所示

  • iss (issuer):簽發(fā)人

  • exp (expiration time):過期時間

  • sub (subject):主題

  • aud (audience):受眾

  • nbf (Not Before):生效時間

  • iat (Issued At):簽發(fā)時間

  • jti (JWT ID):編號

當然也可以自定義私有字段。但是要注意,JWT 默認是不加密的,任何人都可以讀到,所以不要把秘密信息放在這個部分。

  • Signature(簽名)。Signature 部分是對前兩部分的簽名,防止數(shù)據(jù)篡改。首先,需要指定一個密鑰(secret)。這個密鑰只有服務(wù)器才知道,不能泄露給用戶。然后,使用 Header 里面指定的簽名算法(默認是 HMAC SHA256),按照下面的公式產(chǎn)生簽名。
HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

算出簽名以后,把 HeaderPayloadSignature 三個部分拼成一個字符串,每個部分之間用"點"(.)分隔,就可以返回給用戶。如下所示

image

JWT 的安全

  • JWT 默認是不加密,但也是可以加密的。JWT 不加密的情況下,不能將秘密數(shù)據(jù)寫入 JWT

  • JWT 本身包含了認證信息,一旦泄露,任何人都可以獲得該令牌的所有權(quán)限。為了減少盜用,JWT 的有效期應該設(shè)置得比較短。對于一些比較重要的權(quán)限,使用時應該再次對用戶進行認證

  • 為了減少盜用,JWT 不應該使用 HTTP 協(xié)議明碼傳輸,要使用 HTTPS 協(xié)議傳輸

Node 簡單demo—— Koa JWT 的實現(xiàn)

說完理論知識,我們來看下如何實現(xiàn) JWT,大致的流程如下:

image

首先,用戶登錄后服務(wù)端根據(jù)用戶信息生成并返回 token 給到客戶端,前端在下次請求中把 token 帶給服務(wù)器,服務(wù)器驗證有效后,返回數(shù)據(jù)。無效的話,返回 401 狀態(tài)碼

這里我們用 Node 實現(xiàn),主要用到的兩個庫有

快速搭建一個 koa 項目

發(fā)現(xiàn)官方目前沒有一個快速搭建 koa 項目的方式,像 Vue-cli 一樣。(可能是搭建一個 koa 項目成本也很低)。但懶人的我,還是找到了一個工具 —— koa-generator,使用也相對簡單,如下

  • 安裝
npm install -g koa-generator
  • koa2 my-project 新建一個叫做 my-projectkoa2 項目
  • cd my-projectnpm install
  • 啟動項目 npm start
  • 打開 localhost:3000

生成 Token

為了演示方便,我這里直接定義了變量 userList 存儲用戶的信息,真實應該是存放在數(shù)據(jù)庫中的。

const crypto = require("crypto"),
  jwt = require("jsonwebtoken");
// TODO:使用數(shù)據(jù)庫
// 這里應該是用數(shù)據(jù)庫存儲,這里只是演示用
let userList = [];

class UserController {
  // 用戶登錄
  static async login(ctx) {
    const data = ctx.request.body;
    if (!data.name || !data.password) {
      return ctx.body = {
        code: "000002", 
        message: "參數(shù)不合法"
      }
    }
    const result = userList.find(item => item.name === data.name && item.password === crypto.createHash('md5').update(data.password).digest('hex'))
    if (result) {
      const token = jwt.sign(
        {
          name: result.name
        },
        "Gopal_token", // secret
        { expiresIn: 60 * 60 } // 60 * 60 s
      );
      return ctx.body = {
        code: "0",
        message: "登錄成功",
        data: {
          token
        }
      };
    } else {
      return ctx.body = {
        code: "000002",
        message: "用戶名或密碼錯誤"
      };
    }
  }
}

module.exports = UserController;

通過 jsonwebtokensign 方法生成一個 token。該方法第一個參數(shù)指的是 Payload(負載),用于編碼后存儲在 token 中的數(shù)據(jù),也是校驗 token 后可以拿到的數(shù)據(jù)。第二個是秘鑰,服務(wù)端特有,注意校驗的時候要相同才能解碼,而且是保密的,一般而言,最好是定公共的變量,這里只是演示方便,直接寫死。第三個參數(shù)是 option,可以定義 token 過期時間

客戶端獲取 token

前端登錄獲取到 token 后可以存儲到 cookie 中也可以存放在 localStorage 中。這里我直接存到了 localStorage

login() {
  this.$axios
    .post("/api/login", {
      ...this.ruleForm,
    })
    .then(res => {
      if (res.code === "0") {
        this.$message.success('登錄成功');
        localStorage.setItem("token", res.data.token);
        this.$router.push("/");
      } else {
        this.$message(res.message);
      }
    });
}

封裝 axios 的攔截器,每次請求的時候把 token 帶在請求頭發(fā)送給服務(wù)器進行驗證。這里如果之前放在 Cookie 中,可以讓它自動發(fā)送,但是這樣不能跨域。所以推薦做法是放在 HTTP 請求頭 Authorization 中,注意這里的 Authorization 的設(shè)置,前面要加上 Bearer。詳情可以見 Bearer Authentication

// axios 請求攔截器處理請求數(shù)據(jù)
axios.interceptors.request.use(config => {
  const token = localStorage.getItem('token');
  config.headers.common['Authorization'] = 'Bearer ' + token; // 留意這里的 Authorization
  return config;
})

校驗 token

使用 koa-jwt 中間件進行驗證,方式比較簡單,如下所示

// 錯誤處理
app.use((ctx, next) => {
  return next().catch((err) => {
      if(err.status === 401){
          ctx.status = 401;
        ctx.body = 'Protected resource, use Authorization header to get access\n';
      }else{
          throw err;
      }
  })
})

// 注意:放在路由前面
app.use(koajwt({
  secret: 'Gopal_token'
}).unless({ // 配置白名單
  path: [/\/api\/register/, /\/api\/login/]
}))

// routes
app.use(index.routes(), index.allowedMethods())
app.use(users.routes(), users.allowedMethods())

需要注意的是以下幾點:

  • secret 必須和 sign 時候保持一致
  • 可以通過 unless 配置接口白名單,也就是哪些 URL 可以不用經(jīng)過校驗,像登陸/注冊都可以不用校驗
  • 校驗的中間件需要放在需要校驗的路由前面,無法對前面的 URL 進行校驗

演示

  • 如果直接訪問需要登錄的接口,則會 401
image
  • 先注冊,后登錄,不然會提示用戶名或者密碼錯誤
image
  • 登錄后帶上 Authorization,可以正常訪問,返回 200 以及正確的數(shù)據(jù)
image

總結(jié)

本文總結(jié)了關(guān)于 JWT 鑒權(quán)相關(guān)的知識,并提供了一個 koa2 實現(xiàn)的簡單 demo,希望對大家有所幫助。

受制于篇幅,有機會單獨說下 koa-jwt 的源碼,也相對比較簡單~

本文 demo 地址: ClientServer

參考

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,333評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,491評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,263評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,946評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,708評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,409評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,939評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,774評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,641評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,872評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,650評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

推薦閱讀更多精彩內(nèi)容