koa-session

Simple session middleware for Koa. Defaults to cookie-based sessions and supports external stores.

Installation

1npm install koa-session

Notice

7.x has a breaking change: drop Node.js < 18.19.0 support. And it support CommonJS and ESM both.

6.x changed the default cookie key from koa:sess to koa.sess to ensure set-cookie value valid with HTTP spec. See issue. If you want to be compatible with the previous version, you can manually set config.key to koa:sess.

Example

View counter example:

1import Koa from 'koa';
2import session from 'koa-session';
3
4const app = new Koa();
5
6app.keys = ['some secret hurr'];
7
8const CONFIG = {
9  key: 'koa.sess', /** (string) cookie key (default is koa.sess) */
10  /** (number || 'session') maxAge in ms (default is 1 days) */
11  /** 'session' will result in a cookie that expires when session/browser is closed */
12  /** Warning: If a session cookie is stolen, this cookie will never expire */
13  maxAge: 86400000,
14  autoCommit: true, /** (boolean) automatically commit headers (default true) */
15  overwrite: true, /** (boolean) can overwrite or not (default true) */
16  httpOnly: true, /** (boolean) httpOnly or not (default true) */
17  signed: true, /** (boolean) signed or not (default true) */
18  rolling: false, /** (boolean) Force a session identifier cookie to be set on every response. The expiration is reset to the original maxAge, resetting the expiration countdown. (default is false) */
19  renew: false, /** (boolean) renew session when session is nearly expired, so we can always keep user logged in. (default is false)*/
20  secure: true, /** (boolean) secure cookie*/
21  sameSite: null, /** (string) session cookie sameSite options (default null, don't set it) */
22};
23
24app.use(session(CONFIG, app));
25// or if you prefer all default config, just use => app.use(session(app));
26
27app.use(ctx => {
28  // ignore favicon
29  if (ctx.path === '/favicon.ico') return;
30
31  let n = ctx.session.views || 0;
32  ctx.session.views = ++n;
33  ctx.body = n + ' views';
34});
35
36app.listen(3000);
37console.log('listening on port 3000');

API

Options

The cookie name is controlled by the key option, which defaults to "koa.sess". All other options are passed to ctx.cookies.get() and ctx.cookies.set() allowing you to control security, domain, path, and signing among other settings.

Custom encode/decode Support

Use options.encode and options.decode to customize your own encode/decode methods.

Hooks

• valid(): valid session value before use it
• beforeSave(): hook before save session

External Session Stores

The session is stored in a cookie by default, but it has some disadvantages:

• Session is stored on client side unencrypted

• Browser cookies always have length limits

  You can store the session content in external stores (Redis, MongoDB or other DBs) by passing options.store with three methods (these need to be async functions):

• get(key, maxAge, { rolling, ctx }): get session object by key

• set(key, sess, maxAge, { rolling, changed, ctx }): set session object for key, with a maxAge (in ms)

• destroy(key, {ctx}): destroy session for key

  Once you pass options.store, session storage is dependent on your external store -- you can't access the session if your external store is down. Use external session stores only if necessary, avoid using session as a cache, keep the session lean, and store it in a cookie if possible!

  The way of generating external session id is controlled by the options.genid(ctx), which defaults to uuid.v4().

  If you want to add prefix for all external session id, you can use options.prefix, it will not work if options.genid(ctx) present.

  If your session store requires data or utilities from context, opts.ContextStore is also supported. ContextStore must be a class which claims three instance methods demonstrated above. new ContextStore(ctx) will be executed on every request.

Events

koa-session will emit event on app when session expired or invalid:

• session:missed: can't get session value from external store.
• session:invalid: session value is invalid.
• session:expired: session value is expired.

Custom External Key

External key is used the cookie by default, but you can use options.externalKey to customize your own external key methods. options.externalKey with two methods:

• get(ctx): get the external key
• set(ctx, value): set the external key

Session#isNew

Returns true if the session is new.

1if (this.session.isNew) {
2  // user has not logged in
3} else {
4  // user has already logged in
5}

Session#maxAge

Get cookie's maxAge.

Session#maxAge=

Set cookie's maxAge.

Session#externalKey

Get session external key, only exist when external session store present.

Session#save()

Save this session no matter whether it is populated.

Session#manuallyCommit()

Session headers are auto committed by default. Use this if autoCommit is set to false.

Destroying a session

To destroy a session simply set it to null:

1this.session = null;

License

MIT

Contributors

Made with contributors-img.