Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agconti/express-jwt-token
A lean and configurable implementation of jwt auth for Express.js
https://github.com/agconti/express-jwt-token
authentication express-middleware json-web-token jwt nodejs
Last synced: 16 days ago
JSON representation
A lean and configurable implementation of jwt auth for Express.js
- Host: GitHub
- URL: https://github.com/agconti/express-jwt-token
- Owner: agconti
- License: mit
- Created: 2015-04-24T15:12:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-26T18:51:36.000Z (over 6 years ago)
- Last Synced: 2024-10-20T18:34:29.435Z (23 days ago)
- Topics: authentication, express-middleware, json-web-token, jwt, nodejs
- Language: JavaScript
- Homepage: http://agconti.github.io/express-jwt-token/
- Size: 203 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JWT token auth for express.js
[](https://travis-ci.org/agconti/express-jwt-token)
[](http://badge.fury.io/js/express-jwt-token)
This package provides [JSON Web Token Authentication](http://tools.ietf.org/html/draft-ietf-oauth-json-web-token) support for
[Express](http://expressjs.com/). It conveniently sets `req.user` for authenticated requests. The authorization header is in the from of:
```
Authorization JWT < jwt token >
```
New to using JSON Web Tokens? Take a look at these resources:
- [JWT.io](http://jwt.io/)
- [JSON Web Token Abstract](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html)
- [Token based authentication with Socket.io](https://auth0.com/blog/2014/01/15/auth-with-socket-io/)
# Installation
```bash
npm install express-jwt-token
```
# Usage
```js
var express = require('express')
, auth = require('express-jwt-token')
, app = express()
, router = express.Router()
// Require jwt authorization on all routes
router.all('*', auth.jwtAuthProtected)
// Require jwt authorization on only api routes
router.all('/api/*', auth.jwtAuthProtected)
// Require jwt auth on a specific route
router.get('/auth-protected', auth.jwtAuthProtected, function(req, res){
res.send({'msg': 'Im jwt auth protected!'})
})
app.use('/', router)
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'`.
```js
process.env.JWT_SECRET_KEY = 'Your Secret'
```
Configure the authorization header prefix. this is optional. Default is `'JWT'`.
```js
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 `express-jwt-token` will return an `UnauthorizedError` with some helpful details about what went wrong.
This implementation was based on the excellent [django-rest-framework-jwt library](https://github.com/GetBlimp/django-rest-framework-jwt).