token-middleware

Sumor Cloud ツール。
詳細なドキュメント

ExpressJS 用のトークンミドルウェア。

インストール

npm i @sumor/token-middleware --save

前提条件

Node.JS バージョン

Node.JS バージョン 18.x 以上が必要です。

Node.JS ES モジュールの要求

このパッケージは ES モジュールで書かれているため、package.json ファイル内の以下のコードを変更してください:

{
  "type": "module"
}

使用法

ExpressJS アプリにトークンミドルウェアを追加

import express from 'express'
import tokenMiddleware from '@sumor/token-middleware'

const app = express()
app.use(tokenMiddleware)

// トークンをロード
app.use(async (req, res, next) => {
  const tokenId = req.token.id
  const tokenInfo = await fetchToken(tokenId)
  req.token.user = tokenInfo.user
  req.token.data = tokenInfo.data
  req.token.permission = tokenInfo.permission
  next()
})

// トークンを設定
app.get('/login', async (req, res) => {
  const username = req.query.username
  const password = req.query.password
  req.token.id = await createToken(username, password)
  // トークンは自動的にレスポンスヘッダーのクッキー 't' に追加されます
  res.send('ログイン成功')
})

// トークンを使用
app.get('/api', (req, res) => {
  // 権限を確認
  req.token.check('AUTH1')

  res.send('Hello World')
})

権限の確認

// 権限を取得
req.token.permission = {
  AUTH1: ['READ', 'WRITE'],
  AUTH2: ['READ']
}
const hasAuth1 = req.token.has('AUTH1') // true
const hasAuth2 = req.token.has('AUTH2') // true
const hasAuth3 = req.token.has('AUTH3') // false

const hasAuth1Read = req.token.has('AUTH1', 'READ') // true
const hasAuth1Write = req.token.has('AUTH1', 'WRITE') // true
const hasAuth2Read = req.token.has('AUTH2', 'READ') // true
const hasAuth2Write = req.token.has('AUTH2', 'WRITE') // false

// 権限を確認
req.token.check('AUTH1') // パス
req.token.check('AUTH2') // パス
req.token.check('AUTH3') // エラー PERMISSION_DENIED Permission denied: AUTH3
req.token.check('AUTH1', 'READ') // パス
req.token.check('AUTH1', 'WRITE') // パス
req.token.check('AUTH2', 'READ') // パス
req.token.check('AUTH2', 'WRITE') // エラー PERMISSION_DENIED Permission denied: AUTH2=WRITE