Node-jwt-redis

Features

• Json Web Token method is used, but forced logout function can be used.
• There is extensibility by using Json Web Token method.
• There is security like the Session method.

Tech

Node-jwt-redis uses a number of open source projects to work properly:

• jsonwebtoken
• redis

And of course Node-jwt-redis itself is open source with a public repository on GitHub.

Installation

Here's how to install it:

1npm install node-jwt-redis

Note: If jsonwebtoken and redis are already installed, there is a possibility of conflict. So you better to delete it in advance

Usage

Basic Example

1const jwtRedis = require("node-jwt-redis").jwtRedis;
2
3let redisOptions = {}
4if(redisEnv=='local'){//local Redis
5   redisOptions = {
6      legacyMode: true, // required !!
7   }
8}else{//cloud Redis
9   redisOptions = {
10      url: `redis://${redisHost}:${redisPort}`,
11      legacyMode: true, // required !!
12   }
13}
14const jwtOptions = {
15    accessSecret : accessSecret, // secret string
16    refreshSecret:  refreshSecret, // secret string
17    accessExpiresIn:  60*15, // seconds : if zero never expired
18    refreshExpiresIn:  60*60*24*90 // seconds : if zero never expired
19}
20const jwtr = new jwtRedis(redisOptions,jwtOptions);
21
22//issue accessToken and refreshToken
23let {accessToken,refreshToken} = await jwtr.issueTokenPair(keyId);
24//reissue accessToken
25    {accessToken,refreshToken} = await jwtr.reissueAccessToken(accessToken,refreshToken);
26//verify accessToken => Commonly used as middleware
27const {ok, message, id, exp, ...} = await jwtr.verifyAccessToken(accessToken);
28/*{
29    ok: boolean ,
30    message: message,
31    id : keyId,
32    exp : expire time,
33    ...
34}*/
35
36//verify refreshToken
37const boolean = await jwtr.verifyRefreshToken(refreshToken,keyId);
38
39//destroy accessToken and refreshToken => Used when logging out
40await jwtr.destroyToken(accessToken,refreshToken);

API

Method for creating a token.

1jwtr.issueTokenPair(keyId): Promise

Method for recreating an accessToken.

1jwtr.reissueAccessToken(accessToken,refreshToken): Promise

Method for verifying an accessToken

1jwtr.verifyAccessToken(accessToken): Promise

Method for verifying a refreshToken

1jwtr.verifyRefreshToken(refreshToken,keyId): Promise

Method for breaking tokens

1jwtr.destroyToken(accessToken,refreshToken): void

ETC Redis Method

1jwtr.redisAsync.set(key,value) : Promise
2jwtr.redis.set(key,value,callbackFunc) 
3...
4jwtr.redis.quit()

You can use the general method of redis
ex) jwtr.redis.[method]

ETC Jsonwebtoken Method

1jwtr.jwt.decode(token [, options])

You can use the general method of jsonwebtoken
ex) jwtr.jwt.[method]

License

ISC