npmpackage.info

Gathering detailed insights and metrics for koa2-jwt-redis-session

koa2-jwt-redis-session - 0.0.31 | npmpackage.info

koa2-jwt-redis-session

Pure JWT implementation using Redis as session storage for Koa 2, without any cookies

0.0.31

MIT

JavaScript

1.7

Installations

npm install koa2-jwt-redis-session

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

7.10.0

NPM Version

4.2.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

iwater

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

50 Commits

1 Forks

1 Watchers

4 Branches

1 Contributors

Updated on May 21, 2017

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.0.31

Package Id

koa2-jwt-redis-session@0.0.31

Size

7.31 kB

NPM Version

4.2.0

Node Version

7.10.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

#JWT Redis Session for Koa 2

Pure JWT implementation using Redis as session storage for Koa 2, without any cookies

Quick Start

As middleware:

1const koa = require('koa'),
2      bodyParser = require('koa-bodyparser'),
3      session = require('koa2-jwt-redis-session')
4// import session from 'koa2-jwt-redis-session'
5
6const app = new koa()
7app.use(bodyParser())
8
9app.use(session.default())
10
11// If using import
12// app.use(session()) 
13
14app.use(async function(ctx, next){
15    let views = ctx.session.views || 0
16    ctx.session.views = ++views
17    try{
18       ctx.body = {views: ctx.session.views}
19       await next()
20    }catch(ex){
21       console.error('something wrong:', ex)
22       ctx.status = 500
23       ctx.body = 'something wrong'
24    }
25})
26
27app.listen(3333)

As a function:

1// After used as middleware
2// Somewhere when using as backdore
3import {createSession, authoriseRequest} from 'koa2-jwt-redis-session'
4
5let openDoorHandler = async (ctx, next)=>{
6    let userObj = {account: 'sneaky', password: 'open_the_back_door'};
7    let token = await createSession(ctx, userObj);
8    ctx.body = token;
9    // Token is in JSON format: {token: ..... , expiresIn: 3600}
10    // expiresIn is the expire time in seconds, default is 3600
11}
12
13let guardHandler = async (ctx, next)=>{
14    let user = await authoriseRequest(ctx);
15    if( user != undefined){
16        ctx.body = user;
17    }else{
18        ctx.throw(new Error('Unauthorized'));
19    }
20}
21

Options

When creating session instance, you can pass in an option object

1const sessionOptions = {
2       // ......
3}
4app.use(session.default(sessionOptions))
5
6// If using import
7app.use(session(sessionOptions))

Here is the default option values

1{
2  jwt: {
3    contentType: 'application/json',
4    charset: 'utf-8',
5    secret: 'koa2-jwt-redis-session' + new Date().getTime(),
6    authPath: '/authorize',
7    registerPath: '/register',
8    refreshTokenPath: '/refreshToken',
9    expiresIn: 3600,
10    accountKey: 'account',
11    passwordKey: 'password',
12    authHandler: function (account, password) {
13            		if (account && password) {
14 				let user = {};
15				user[accountKey] = account;
16				return user;
17			}
18			else return false;
19        },
20    registerHandler: function (account, password) {
21           		if (account && password) {
22				let user = {};
23				user[accountKey] = account;
24				return user;
25			}
26			else return false; 
27        }
28  },
29  session: {
30    sessionKey: 'session',
31    sidKey: 'koa:sess',
32  },
33  redis: {
34    port: 6379,
35    host: '127.0.0.1',
36    db: 0,
37    ttl: 3600,
38    options: {}
39  }
40}

Action flow

Anonymous client post JSON user credential information { account: "...", password: "..." } to /register to register an account,
or post to /authorize to get authorization
Client get token in JSON like { token: "...", expiresIn: 3600 }, or an 401 error if not authorized
From then on, client send every request by the http header: Authorization: Bearer <token>,
or client would get 401 error if not authorized or token expired
On the server side, afterward middlewares can operate ctx.session as will

Enjoy!

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

61 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-rvg8-pwq2-xj7q
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-h452-7996-h45h
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-9qj9-36jm-prpv
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33
Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959
Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6
Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m
Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-446m-mv8f-q348
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-8225-6cvr-8pqp
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

koa2-jwt-redis-session

Installations

Developer Guide

No

CommonJS

7.10.0

4.2.0

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

iwater

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Quick Start

Options

Here is the default option values

Action flow

Enjoy!

10

10

0

0

0

0

0

0

0

0

1.7

/10