https://github.com/kandros/micro-jwt-auth

jwt authorization wrapper for https://github.com/zeit/micro
https://github.com/kandros/micro-jwt-auth

authorization jwt micro microservice

Last synced: about 2 months ago
JSON representation

jwt authorization wrapper for https://github.com/zeit/micro

• Host: GitHub
• URL: https://github.com/kandros/micro-jwt-auth
• Owner: kandros
• License: mit
• Created: 2017-02-15T20:20:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-15T01:25:20.000Z (almost 3 years ago)
• Last Synced: 2024-04-15T07:27:17.910Z (9 months ago)
• Topics: authorization, jwt, micro, microservice
• Language: JavaScript
• Homepage:
• Size: 239 KB
• Stars: 94
• Watchers: 4
• Forks: 30
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-micro - micro-jwt-auth - Json web token(jwt) authorization wrapper for Micro. (Modules / Wrappers)
• awesome-list-microservice - micro-jwt-auth

README

        
[![Build Status](https://travis-ci.org/kandros/micro-jwt-auth.svg?branch=master)](https://travis-ci.org/kandros/micro-jwt-auth)

[![npm](https://img.shields.io/npm/v/micro-jwt-auth.svg)](https://www.npmjs.com/package/micro-jwt-auth)

# micro-jwt-auth

[json web token(jwt)](https://jwt.io/introduction/) authorization wrapper for [Micro](https://github.com/zeit/micro)

> An `Authorization` header with value `Bearer MY_TOKEN_HERE` is expected

## examples

#### with no other wrappers

```javascript

'use strict'

const jwtAuth = require('micro-jwt-auth')

/*

    if Authorization Bearer is not present or not valid, return 401

*/

module.exports = jwtAuth('my_jwt_secret')(async(req, res) => {

  return `Ciaone ${req.jwt.username}!`

})

```

#### with multiple wrappers

```javascript

'use strict'

const jwtAuth = require('micro-jwt-auth')

const compose = (...fns) => fns.reduce((f, g) => (...args) => f(g(...args)))

const handle = async(req, res) => {

  return `Ciaone ${req.jwt.username}!`

}

module.exports = compose(

    jwtAuth(process.env.jwt_secret),

    anotherWrapper,

    analitycsWrapper,

    redirectWrapper,

    yetAnotherWrapper

)(handle)

```

#### with whitelist of paths

Whitelisted paths make JWT token *optional*. However if valid token is provided it will be  decoded.

```javascript

'use strict'

const jwtAuth = require('micro-jwt-auth')

/*

    Bypass authentication for login route

*/

module.exports = jwtAuth('my_jwt_secret', [ 'api/login' ])(async(req, res) => {

  return `Ciaone ${req.jwt.username}!`

})

```

#### with custom responses

```javascript

'use strict'

const jwtAuth = require('micro-jwt-auth')

/*

    You can overwrite the default response with the optional config object

*/

module.exports = jwtAuth('my_jwt_secret', ['api/login'], {

  resAuthInvalid: 'Error: Invalid authentication token',

  resAuthMissing: 'Error: Missing authentication token'

})(async(req, res) => {

  return `Ciaone ${req.jwt.username}!`

})

/*

  You may skip the whitelist if unnecessary

*/

module.exports = jwtAuth('my_jwt_secret', {

  resAuthInvalid: 'Error: Invalid authentication token',

  resAuthMissing: 'Error: Missing authentication token'

})(async(req, res) => {

  return `Ciaone ${req.jwt.username}!`

})

```