驗證結果

最後更新


本頁說明 VerifyJWT() 回傳的 VerifyResult 三個旗標代表什麼,以及每種情境對應的值。

結構


  1. interface VerifyResult {
  2. data?: AuthData;
  3. isAuth: boolean;
  4. isError: boolean;
  5. isGuest: boolean;
  6. }

旗標意義
isAuth驗證成功,data 為使用者資料
isError請求可疑(指紋不符、簽章無效等),建議回 400
isGuest未登入;isAuth 為 false 時一律為 true

情境對照


情境isAuthisErrorisGuest
Access Token 有效且指紋相符truefalsefalse
Access Token 過期,續期成功truefalsefalse
沒有 Access Token 與 Refresh IDfalsefalsetrue
Access Token 在撤銷黑名單falsefalsetrue
checkUserExists() 回傳 falsefalsefalsetrue
Refresh 資料指紋不符falsefalsetrue
Access Token 指紋不符falsetruetrue
簽章無效或 Token 格式錯誤falsetruetrue
Refresh 資料不存在falsetruetrue

路由分流


  1. import { NextFunction, Request, Response } from "express";
  2. import { JWTAuth } from "@pardnchiu/jwt-auth";
  3. export async function requireAuth(req: Request, res: Response, next: NextFunction) {
  4. try {
  5. const result = await JWTAuth.VerifyJWT(req, res);
  6. if (result.isAuth) {
  7. res.locals.user = result.data;
  8. return next();
  9. }
  10. res.status(result.isError ? 400 : 401).json({
  11. error: result.isError ? "Bad Request" : "Unauthorized",
  12. });
  13. } catch (err) {
  14. // 未呼叫 init() 或黑名單查詢遇到 Redis 錯誤時會到這裡
  15. res.status(500).json({ error: (err as Error).message });
  16. }
  17. }

舊版回傳值


舊版 VerifyJWT() 回傳 AuthData 或狀態碼 400/401。JWTAuth.GetAuth() 可把舊值轉成同樣的三旗標結構:
輸入輸出
AuthData{ ...data, isAuth: true, isError: false, isGuest: false }
401{ isAuth: false, isError: false, isGuest: true }
400{ isAuth: false, isError: true, isGuest: true }
其他數字{ isAuth: true, isError: false, isGuest: false }

相關:Refresh Token 輪替、裝置指紋
EN