Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytesleo/redis-jwt
Management of sessions by Redis and JWT for horizontal scalability, with the possibility of having one session at a time or multiple for the same user
https://github.com/bytesleo/redis-jwt
jwt node-jwt node-redis nodejs-jwt redis redis-jwt redis-jwt-nodejs redis-session session session-jwt
Last synced: 3 months ago
JSON representation
Management of sessions by Redis and JWT for horizontal scalability, with the possibility of having one session at a time or multiple for the same user
- Host: GitHub
- URL: https://github.com/bytesleo/redis-jwt
- Owner: bytesleo
- License: mit
- Created: 2017-09-01T18:50:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T18:13:19.000Z (over 5 years ago)
- Last Synced: 2024-10-08T14:44:44.586Z (4 months ago)
- Topics: jwt, node-jwt, node-redis, nodejs-jwt, redis, redis-jwt, redis-jwt-nodejs, redis-session, session, session-jwt
- Language: JavaScript
- Size: 64.5 KB
- Stars: 21
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# redis-jwt
[](https://npmjs.org/package/redis-jwt) [](https://travis-ci.org/kevoj/redis-jwt) [](https://david-dm.org/kevoj/redis-jwt) [](https://david-dm.org/kevoj/redis-jwt?type=dev)
[](https://raw.githubusercontent.com/kevoj/redis-jwt/master/LICENSE)
> Management of sessions by Redis and JWT for horizontal scalability, with the possibility of having one session at a time or multiple for the same user
## Requirements
- [Nodejs](https://nodejs.org) **>= 6.x.x** (**Recommended 8.x.x**)
- [Redis](https://redis.io) **>= 3.x.x** (**Recommended 4.x.x**)
## Installation
Npm
```bash
npm install redis-jwt --save
```
Yarn
```bash
yarn add redis-jwt
```
## Usage
```javascript
import RedisJwt from 'redis-jwt';
const r = new RedisJwt({
//host: '/tmp/redis.sock', //unix domain
host: '127.0.0.1', //can be IP or hostname
port: 6379, // port
maxretries: 10, //reconnect retries, default 10
//auth: '123', //optional password, if needed
db: 0, //optional db selection
secret: 'secret_key', // secret key for Tokens!
multiple: false, // single or multiple sessions by user
kea: false // Enable notify-keyspace-events KEA
});
r.sign('507f191e810c19729de860ea').then(token => {
r.verify(token).then(decode => {
// [Object]
}).catch(err => {
// Wrong token
});
});
```
### Example Redis-jwt with Express
```javascript
import RedisJwt from 'redis-jwt';
import express from 'express';
const r = new RedisJwt();
const app = express();
// Login
app.get('/login', (req, res) => {
r.sign('507f191e810c19729de860ea', {
ttl: '15 minutes',
dataToken: { // Public
hello: 'world'
},
dataSession: { // Private
hello: 'world',
headers : req.headers
}
}
}).then(token => {
res.json({token});
});
});
// Me
app.get('/me', mw(), (req, res) => {
res.json(req.user);
});
// Middleware
function mw() {
return (req, res, next) => {
const token = req.headers['authorization'];
r.verify(token).then(decode =>
// here you can get user from DB by id (decode.id)
req.user = decode;
next();
}).catch(err => {
res.status(401).json({err})
})
}
}
app.listen(3000, () => console.log('Server listening on port 3000!'));
```
## Options
### Sign
```javascript
// Basic
r.sign('507f191e810c19729de860ea').then..
// TTL : 50 seconds, 10 minutes, 5 hours, 3 days, 1 year ...
r.sign('507f191e810c19729de860ea', {
ttl: '15 minutes'
}).then...
// Save data in token : Object are saved in token
r.sign('507f191e810c19729de860ea', {
dataToken: {world: 'hello'}
}).then...
// Save data in redis : Object are saved in redis-jwt
r.sign('507f191e810c19729de860ea', {
dataSession: {hello: 'world'}
}).then...
// Example TTL + dataToken + dataSession
r.sign('507f191e810c19729de860ea', {
ttl: '15 minutes',
dataToken: {world: 'hello'},
dataSession: {hello: 'world'}
}).then...
```
### Verify
```javascript
// Basic
r.verify(token).then(decode => {
/*
{
"rjwt": "507f191e810c19729de860ea:ZYYlwOGqTmx",
"dataToken": [Object]
"iat": 1504334208,
"id": "507f191e810c19729de860ea",
"ttl": 60
}
*/
}).catch(err => {
// Wrong token
})
// Get data from redis
r.verify(token, true).then(decode => {
/*
{
"rjwt": "507f191e810c19729de860ea:ZYYlwOGqTmx",
"dataToken": [Object]
"dataSession": [Object] ----> get data session
"iat": 1504334208,
"id": "507f191e810c19729de860ea",
"ttl": 60
}
*/
}).catch(err => {
// Wrong token
})
```
### Exec
```javascript
// Execute Redis comands
const exec = r.exec();
exec.rawCall(['keys', `507f191e810c19729de860ea:*`], (err, result) => {
/*
[
"507f191e810c19729de860ea:ZYYlwOGqTmx",
"507f191e810c19729de860ea:d39K8J249Hd",
]
*/
});
```
### Call
```javascript
// Method's redis-jwt
const call = r.call();
// Test Ping
call.ping().then..
// Create
call.create(key, value, ttl).then..
// exits by key
call.exists(key).then..
// Get ttl by Key
call.ttl(key).then..
// Get values by key
call.getValueByKey(key).then..
// Get values by Pattern
call.getValuesByPattern(pattern).then..
// Get count by Pattern
call.getCountByPattern(pattern).then..
// Get info
call.getInfo(section).then..
// Destroy by key
call.destroy(key).then..
// Destroy multiple by key
call.destroyMultiple(key).then..
```
## Events
```javascript
// Ready
r.on('ready', () => {
console.log('redis-jwt-> ready!');
});
// connected
r.on('connected', () => {
console.log('redis-jwt-> connected!');
});
// disconnected
r.on('disconnected', () => {
console.log('redis-jwt-> disconnected!');
});
// error
r.on('error', (err) => {
console.log('redis-jwt-> error!', err);
});
```
## Development
### Start
`npm start`
### Compile
`npm run compile`
### Test
`npm test`
## License
MIT © [Leonardo Rico](https://github.com/kevoj/redis-jwt/blob/master/LICENSE)