設定

最後更新


本頁列出 JWTAuth.init() 接收的 Config 每個欄位、預設值與驗證規則。

欄位


欄位型別必要預設值說明
privateKeyPathstring二擇一—私鑰檔案路徑;有設定時覆蓋 privateKey
privateKeystring二擇一—私鑰 PEM 內容
publicKeyPathstring二擇一—公鑰檔案路徑;有設定時覆蓋 publicKey
publicKeystring二擇一—公鑰 PEM 內容
accessTokenExpiresnumber是—Access Token 壽命(秒);同時是撤銷黑名單 TTL
refreshTokenExpiresnumber是—Refresh ID 壽命(秒),每次續期重設
isProdboolean是—決定 cookie 的 secure、sameSite、domain
domainstring否—isProd 為 true 時的 cookie 網域;未設定時 cookie 不帶 domain 屬性(僅限當前主機)
redis.hoststring是localhostRedis 主機
redis.portnumber是6379Redis 連接埠
redis.passwordstring否—Redis 密碼
redis.dbnumber否0Redis 資料庫編號
checkUserExists(userId: string) => Promise<boolean>是—續期時確認使用者仍存在
AccessTokenCookieKeystring型別上必填access_tokenAccess Token cookie 名稱
RefreshTokenCookieKeystring型別上必填refresh_idRefresh ID cookie 名稱

init 的驗證與錯誤


情況結果
publicKey 與 publicKeyPath 都未提供拋出 publicKey is required
privateKey 與 privateKeyPath 都未提供拋出 privateKey is required
金鑰路徑不存在readFileSync 拋出的錯誤原樣傳出
Redis 連線失敗以 console.error 記錄後拋出

init() 會直接修改傳入的設定物件:讀入的金鑰寫回 publicKey/privateKey,cookie 名稱補上預設值。

金鑰來源


  1. import { JWTAuth } from "@pardnchiu/jwt-auth";
  2. // 從環境變數讀取 PEM 內容,適合容器部署
  3. await JWTAuth.init({
  4. privateKey: process.env.JWT_PRIVATE_KEY,
  5. publicKey: process.env.JWT_PUBLIC_KEY,
  6. accessTokenExpires: 900,
  7. refreshTokenExpires: 604800,
  8. isProd: true,
  9. domain: "example.com",
  10. AccessTokenCookieKey: "access_token",
  11. RefreshTokenCookieKey: "refresh_id",
  12. redis: { host: "redis", port: 6379, password: process.env.REDIS_PASSWORD },
  13. checkUserExists: async (userId) => true,
  14. });

套件本身不讀取任何環境變數。

行程訊號


匯入套件時即註冊 SIGINT 與 SIGTERM 處理器:呼叫 JWTAuth.close() 後執行 process.exit(0)。應用若有自己的優雅關閉流程,需注意此處理器會在 Redis 斷線後立即結束行程。
相關:Token 傳遞、API 參考
EN