@sumor/token-middleware

token-middleware

Инструмент Sumor Cloud.
Дополнительная документация

Промежуточное ПО для токена для ExpressJS.

CI Test Coverage Audit

Установка

npm i @sumor/token-middleware --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 18.x или выше

Требуется использование ES-модуля Node.JS

Поскольку этот пакет написан на 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)
  // токен автоматически добавляется в ответный заголовок cookie 't'
  res.send('Успешный вход')
})

// использование токена
app.get('/api', (req, res) => {
  // проверка разрешения
  req.token.check('AUTH1')

  res.send('Привет, мир')
})

Проверка разрешения

// получение разрешения
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