0.0.2 • Published 3 years ago

jwt-rsa v0.0.2

Weekly downloads
10
License
MIT
Repository
github
Last release
3 years ago

jwt-rsa

wrapper that combines jsonwebtokens and node-rsa node-modules in one simple interface.

Getting Started

const { Token } = require('jwt-rsa')
const AccessToken = new Token(/* dir-path-of-rsa-keys*/)
const accessToken = AccessToken.sign({/* payload */})
const verified = AccessToken.verify(accessToken)

Options

The default options parameter are:

  • algorithm: 'RS256'
  • expiresIn: '30m'

you can override any of these by passing in your own options' object at instantiation as shown in the example below.

const { Token } = require('jwt-rsa')
const AccessToken = new Token(/* dir-path-of-rsa-keys*/, {
    algorithm: 'RS256', 
    expiresIn: '30m',
    /* add more options here ... */
})

API

const { Token } = require('jwt-rsa')
const AccessToken = new Token(/* dir-path-of-rsa-keys*/, {
    algorithm: 'RS256', 
    expiresIn: '30m',
})

const token = AccessToken.sing({/* some-object */})
const object = AccessToken.sing(token)
const privateKey = AccessToken.prikey()
const publicKey = AccessToken.pubkey()
AccessToken.renewkeys()

Use in Koa-Js

const koa = require('koa')
const app = new Koa
const { koatoken } = require('jwt-rsa')

app.use(koatoken('AccessToken',/* dir-path-of-rsa-keys*/, {
    algorithm: 'RS256', 
    expiresIn: '30m',
})))

app.use(async (ctx) => {
    const token = ctx.AccessToken.sing({/* some-object */})
    const object = ctx.AccessToken.verify(token)
})