Nested Parenthetical Madness

    jwt-token-auth

    0.1.3 • Public • Published

    JWT token auth for express.js

    Build Status npm version

    This package provides JSON Web Token Authentication support for Express.

    New to using JSON Web Tokens? Take a look at these resources:

    Installation

    npm install jwt-token-auth

    Usage

    var express = require('express')
      , auth = require('jwt-token-auth')
      , app = express()
     
     
    // Require jwt authorization on all routes
    app.use(auth.jwtAuthProtected)
     
    // Reguire jwt auth on a specfic route
    app.get('/', auth.jwtAuthProtected, function(req, res){
      res.send({'msg': 'Im jwt auth protected!'})
    })
     
    app.listen(3000)

    Now your route(s) are protected and require an authorization header in the form of:

    Authorization JWT < jwt token > 
    

    Configuration

    Configure your JWT Secret. This must be changed for production. Default value is 'secret'.

    process.env.JWT_SECRET_KEY = 'Your Secret'

    Configure the authorization header prefix. this is optional. Default is 'JWT'.

    process.env.jwtAuthHeaderPrefix

    Provided Middleware

    ensureAuthorizationHeader

    An Express.js middleware that ensures that a request has supplied an authorization header.

    • @param {object} req
    • @param {object} res
    • @param {function} next

    validateJWTAuth

    An Express.js middleware validates a JWT token.

    • @param {object} req
    • @param {object} res
    • @param {function} next

    ensureAuthorized

    An Express.js middleware that ensures that a request has supplied an authorization header.

    • @param {object} req
    • @param {object} res
    • @param {function} next

    jwtAuthProtected

    The grouped middleware needed to enforce jwt Auth. Mounts the same as a single middleware.

    Errors

    When authorization fails jwt-token-auth will return an UnauthorizedError with some helpful details about what went wrong.

    This implementation was based on the excellent django-rest-framework-jwt library.

    Install

    npm i jwt-token-auth

    DownloadsWeekly Downloads

    15

    Version

    0.1.3

    License

    MIT

    Last publish

    Collaborators

    • agconti