Node使用koa2實(shí)現(xiàn)一個(gè)簡(jiǎn)單JWT鑒權(quán)的方法
JWT 簡(jiǎn)介
什么是 JWT
全稱 JSON Web Token
, 是目前最流行的跨域認(rèn)證解決方案?;镜膶?shí)現(xiàn)是服務(wù)端認(rèn)證后,生成一個(gè) JSON
對(duì)象,發(fā)回給用戶。用戶與服務(wù)端通信的時(shí)候,都要發(fā)回這個(gè) JSON
對(duì)象。
該 JSON
類似如下:
{ "姓名": "張三", "角色": "管理員", "到期時(shí)間": "2018年7月1日0點(diǎn)0分" }
為什么需要 JWT
先看下一般的認(rèn)證流程,基于 session_id
和 Cookie
實(shí)現(xiàn)
1、用戶向服務(wù)器發(fā)送用戶名和密碼。
2、服務(wù)器驗(yàn)證通過(guò)后,在當(dāng)前對(duì)話( session
)里面保存相關(guān)數(shù)據(jù),比如用戶角色、登錄時(shí)間等等。
3、服務(wù)器向用戶返回一個(gè) session_id
,寫入用戶的 Cookie
。
4、用戶隨后的每一次請(qǐng)求,都會(huì)通過(guò) Cookie
,將 session_id
傳回服務(wù)器。
5、服務(wù)器收到 session_id
,找到前期保存的數(shù)據(jù),由此得知用戶的身份。
但是這里有一個(gè)大的問(wèn)題, 假如是服務(wù)器集群,則要求 session 數(shù)據(jù)共享,每臺(tái)服務(wù)器都能夠讀取 session 。這個(gè)實(shí)現(xiàn)成本是比較大的。
而 JWT
轉(zhuǎn)換了思路,將 JSON
數(shù)據(jù)返回給前端的,前端再次請(qǐng)求時(shí)候?qū)?shù)據(jù)發(fā)送到后端,后端進(jìn)行驗(yàn)證。也就是服務(wù)器是無(wú)狀態(tài)的,所以更加容易拓展。
JWT 的數(shù)據(jù)結(jié)構(gòu)
JWT
的三個(gè)部分依次如下:
Header
(頭部),類似如下
{ "alg": "HS256", "typ": "JWT" }
alg
屬性表示簽名的算法( algorithm
),默認(rèn)是 HMAC SHA256
(寫成 HS256
)。 typ
屬性表示這個(gè)令牌( token
)的類型( type
), JWT
令牌統(tǒng)一寫為 JWT
Payload
(負(fù)載)。也是一個(gè) JSON
,用來(lái)存放實(shí)際需要傳遞的數(shù)據(jù)。 JWT
規(guī)定了 7 個(gè)官方字段。如下所示
- iss (issuer):簽發(fā)人
- exp (expiration time):過(guò)期時(shí)間
- sub (subject):主題
- aud (audience):受眾
- nbf (Not Before):生效時(shí)間
- iat (Issued At):簽發(fā)時(shí)間
- jti (JWT ID):編號(hào)
當(dāng)然也可以自定義私有字段。 但是要注意,JWT 默認(rèn)是不加密的,任何人都可以讀到,所以不要把秘密信息放在這個(gè)部分。
Signature
(簽名)。 Signature
部分是對(duì)前兩部分的簽名,防止數(shù)據(jù)篡改。首先,需要指定一個(gè)密鑰( secret
)。這個(gè)密鑰只有服務(wù)器才知道,不能泄露給用戶。然后,使用 Header
里面指定的簽名算法(默認(rèn)是 HMAC SHA256
),按照下面的公式產(chǎn)生簽名。
HMACSHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload), secret)
算出簽名以后,把 Header
、 Payload
、 Signature
三個(gè)部分拼成一個(gè)字符串,每個(gè)部分之間用"點(diǎn)"(.)分隔,就可以返回給用戶。如下所示
JWT 的安全
JWT
默認(rèn)是不加密,但也是可以加密的。JWT
不加密的情況下,不能將秘密數(shù)據(jù)寫入JWT
JWT
本身包含了認(rèn)證信息,一旦泄露,任何人都可以獲得該令牌的所有權(quán)限。為了減少盜用,JWT
的有效期應(yīng)該設(shè)置得比較短。對(duì)于一些比較重要的權(quán)限,使用時(shí)應(yīng)該再次對(duì)用戶進(jìn)行認(rèn)證- 為了減少盜用,
JWT
不應(yīng)該使用HTTP
協(xié)議明碼傳輸,要使用HTTPS
協(xié)議傳輸
Node 簡(jiǎn)單demo—— Koa JWT 的實(shí)現(xiàn)
說(shuō)完理論知識(shí),我們來(lái)看下如何實(shí)現(xiàn) JWT
,大致的流程如下:
首先,用戶登錄后服務(wù)端根據(jù)用戶信息生成并返回 token
給到客戶端,前端在下次請(qǐng)求中把 token
帶給服務(wù)器,服務(wù)器驗(yàn)證有效后,返回?cái)?shù)據(jù)。無(wú)效的話,返回 401
狀態(tài)碼
這里我們用 Node
實(shí)現(xiàn),主要用到的兩個(gè)庫(kù)有
jsonwebtoken ,可以生成 token
,校驗(yàn)等
koa-jwt 中間件 對(duì) jsonwebtoken
進(jìn)一步的封裝,主要用來(lái)校驗(yàn) token
快速搭建一個(gè) koa 項(xiàng)目
發(fā)現(xiàn)官方目前沒(méi)有一個(gè)快速搭建 koa
項(xiàng)目的方式,像 Vue-cli
一樣。(可能是搭建一個(gè) koa
項(xiàng)目成本也很低)。但懶人的我,還是找到了一個(gè)工具 ——koa-generator ,使用也相對(duì)簡(jiǎn)單,如下
安裝
npm install -g koa-generator
koa2 my-project
新建一個(gè)叫做 my-project
的 koa2
項(xiàng)目
cd my-project
和 npm install
啟動(dòng)項(xiàng)目 npm start
打開(kāi) localhost:3000
生成 Token
為了演示方便,我這里直接定義了變量 userList
存儲(chǔ)用戶的信息,真實(shí)應(yīng)該是存放在數(shù)據(jù)庫(kù)中的。
const crypto = require("crypto"), jwt = require("jsonwebtoken"); // TODO:使用數(shù)據(jù)庫(kù) // 這里應(yīng)該是用數(shù)據(jù)庫(kù)存儲(chǔ),這里只是演示用 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: "用戶名或密碼錯(cuò)誤" }; } } } module.exports = UserController;
通過(guò) jsonwebtoken
的 sign
方法生成一個(gè) token
。該方法第一個(gè)參數(shù)指的是 Payload
(負(fù)載),用于編碼后存儲(chǔ)在 token
中的數(shù)據(jù),也是校驗(yàn) token
后可以拿到的數(shù)據(jù)。第二個(gè)是秘鑰,服務(wù)端特有, 注意校驗(yàn)的時(shí)候要相同才能解碼,而且是保密的 ,一般而言,最好是定公共的變量,這里只是演示方便,直接寫死。第三個(gè)參數(shù)是 option
,可以定義 token
過(guò)期時(shí)間
客戶端獲取 token
前端登錄獲取到 token
后可以存儲(chǔ)到 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
的攔截器,每次請(qǐng)求的時(shí)候把 token
帶在請(qǐng)求頭發(fā)送給服務(wù)器進(jìn)行驗(yàn)證。這里如果之前放在 Cookie
中,可以讓它自動(dòng)發(fā)送,但是這樣不能跨域。所以推薦做法是放在 HTTP 請(qǐng)求頭 Authorization
中,注意這里的 Authorization
的設(shè)置,前面要加上 Bearer
。詳情可以見(jiàn) Bearer Authentication
// axios 請(qǐng)求攔截器處理請(qǐng)求數(shù)據(jù) axios.interceptors.request.use(config => { const token = localStorage.getItem('token'); config.headers.common['Authorization'] = 'Bearer ' + token; // 留意這里的 Authorization return config; })
校驗(yàn) token
使用 koa-jwt
中間件進(jìn)行驗(yàn)證,方式比較簡(jiǎn)單,如下所示
// 錯(cuò)誤處理 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())
需要注意的是以下幾點(diǎn):
secret
必須和sign
時(shí)候保持一致- 可以通過(guò)
unless
配置接口白名單,也就是哪些URL
可以不用經(jīng)過(guò)校驗(yàn),像登陸/注冊(cè)都可以不用校驗(yàn) - 校驗(yàn)的中間件需要放在需要校驗(yàn)的路由前面,無(wú)法對(duì)前面的
URL
進(jìn)行校驗(yàn)
演示
如果直接訪問(wèn)需要登錄的接口,則會(huì) 401
先注冊(cè),后登錄,不然會(huì)提示用戶名或者密碼錯(cuò)誤
登錄后帶上 Authorization
,可以正常訪問(wèn),返回 200
以及正確的數(shù)據(jù)
總結(jié)
本文總結(jié)了關(guān)于 JWT
鑒權(quán)相關(guān)的知識(shí),并提供了一個(gè) koa2
實(shí)現(xiàn)的簡(jiǎn)單 demo
,希望對(duì)大家有所幫助。
受制于篇幅,有機(jī)會(huì)單獨(dú)說(shuō)下 koa-jwt
的源碼,也相對(duì)比較簡(jiǎn)單~
參考
Node.js 應(yīng)用:Koa2 使用 JWT 進(jìn)行鑒權(quán)
到此這篇關(guān)于Node使用koa2實(shí)現(xiàn)一個(gè)簡(jiǎn)單JWT鑒權(quán)的方法的文章就介紹到這了,更多相關(guān)Node koa2 JWT鑒權(quán)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Node.js API詳解之 assert模塊用法實(shí)例分析
這篇文章主要介紹了Node.js API詳解之 assert模塊用法,結(jié)合實(shí)例形式分析了Node.js API中assert模塊基本函數(shù)、功能、用法及操作注意事項(xiàng),需要的朋友可以參考下2020-05-05node使用querystring內(nèi)置模塊解決分頁(yè)返回?cái)?shù)據(jù)太多導(dǎo)致json.parse()解析報(bào)錯(cuò)問(wèn)題
這篇文章主要介紹了node使用querystring內(nèi)置模塊解決分頁(yè)返回?cái)?shù)據(jù)太多導(dǎo)致json.parse()解析報(bào)錯(cuò)問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-09-09Mongoose中document與object的區(qū)別示例詳解
這篇文章主要給大家介紹了關(guān)于Mongoose中document與object區(qū)別的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考借鑒,下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧。2017-09-09node.js同步/異步文件讀寫-fs,Stream文件流操作實(shí)例詳解
這篇文章主要介紹了node.js同步/異步文件讀寫-fs,Stream文件流操作,結(jié)合實(shí)例形式詳細(xì)分析了node.js針對(duì)文件的同步/異步讀寫與文件流相關(guān)操作技巧,需要的朋友可以參考下2023-06-06Node.js中path.join()優(yōu)勢(shì)例舉分析
在本篇文章里小編給大家整理的是一篇關(guān)于Node.js中path.join()優(yōu)勢(shì)例舉分析,有興趣的朋友們可以學(xué)習(xí)下。2021-08-08NodeJS多種創(chuàng)建WebSocket監(jiān)聽(tīng)的方式(三種)
這篇文章主要介紹了NodeJS多種創(chuàng)建WebSocket監(jiān)聽(tīng)的方式,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-06-06Linux下為Node.js程序配置MySQL或Oracle數(shù)據(jù)庫(kù)的方法
這篇文章主要介紹了Linux下為Node.js程序配置MySQL或Oracle數(shù)據(jù)庫(kù)的方法,這里默認(rèn)已經(jīng)裝配好了Node環(huán)境然后我們利用npm包管理工具來(lái)進(jìn)行配置,需要的朋友可以參考下2016-03-03