@sumor/token-middleware

token-middleware

Una herramienta de Sumor Cloud.
Más Documentación Un middleware de token para ExpressJS.

CI Test Cobertura Auditoría

Instalación

npm i @sumor/token-middleware --save

Requisitos previos

Versión de Node.JS

Requiere Node.JS versión 16.x o superior

Requiere módulo ES de Node.JS

Como este paquete está escrito en módulo ES, por favor cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

Añadir middleware de token a la aplicación ExpressJS

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

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

// cargar token
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()
})

// establecer token
app.get('/login', async (req, res) => {
  const username = req.query.username
  const password = req.query.password
  req.token.id = await createToken(username, password)
  // se añadirá automáticamente el token a la cookie del encabezado de respuesta 't'
  res.send('Inicio de sesión exitoso')
})

// utilizar token
app.get('/api', (req, res) => {
  // comprobar permiso
  req.token.check('AUTH1')

  res.send('Hola Mundo')
})

Comprobación de permisos

// obtener permisos
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

// comprobar permiso
req.token.check('AUTH1') // válido
req.token.check('AUTH2') // válido
req.token.check('AUTH3') // lanza Error PERMISSION_DENIED Permiso denegado: AUTH3
req.token.check('AUTH1', 'READ') // válido
req.token.check('AUTH1', 'WRITE') // válido
req.token.check('AUTH2', 'READ') // válido
req.token.check('AUTH2', 'WRITE') // lanza Error PERMISSION_DENIED Permiso denegado: AUTH2=WRITE