Skip to content
/ jwt Public

๐Ÿ” tiny JWT middleware for Node.js

Notifications You must be signed in to change notification settings

tinyhttp/jwt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

17 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

@tinyhttp/jwt

NPM NPM GitHub Workflow Status Coverage

JWT middleware for HTTP servers.

Install

bun i @tinyhttp/jwt

API

import { jwt } from '@tinyhttp/jwt'

Options

jwt(options)

  • secret: can be an array of strings (in case you are using private / public key encryption), or just a string if you are using basic HMAC signing (see the examples below)
  • algorithm? ("HS256"): the algorithm used to sign and verify the token
  • audience?: the expected "audience" of the jwt token
  • issuer?: who issued this token
  • expiresIn?: expiration time of the token (ex: 1d for 1 day)
  • notBefore?: not before date of the token (ex: 20m for 20 minutes)
  • requestHeaderName? ("Authorization"): the name of the header contaning the Bearer token
  • responseHeaderName? ("X-Token"): the name of the response header containing the new signed token that will be used later on
  • getToken(string)?: string: the method used for ex

Example

Basic secret

import { App } from '@tinyhttp/app'
import { jwt } from '@tinyhttp/jwt'

new App()
  .use(jwt({ secret: 'secret', algorithm: 'HS256' }))
  .get('/', (req, res) => res.send(`Data inside the payload: ${req['user']}`))
  .listen(8080)

Private / Public key

import { App } from '@tinyhttp/app'
import { jwt } from '@tinyhttp/jwt'

new App()
  .use(jwt({ secret: ['PRIVATE KEY', 'PUBLIC KEY'], algorithm: 'RS256' }))
  .get('/', (req, res) => res.send(`Data inside the payload: ${req['user']}`))
  .listen(8080)