Package Exports

@mgcrea/fastify-session

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mgcrea/fastify-session) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Fastify Session

Session plugin for fastify that supports both stateless and sateful sessions.

Requires fastify-cookie to handle cookies.
Relies on sodium-native to perform crypto.
Built with TypeScript for static type checking with exported types along the library.

Usage

npm install fastify-cookie @mgcrea/fastify-session --save
# or
yarn add fastify-cookie @mgcrea/fastify-session

Stateless session

No external store required, the entire session data is encrypted using a secret-key with libsodium's crypto_secretbox_easy

Using a key (recommended)

import createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import fastifyCookie from 'fastify-cookie';
import fastifySession from '@mgcrea/fastify-session';
import Redis from 'ioredis';
import { IS_PROD, IS_TEST, REDIS_URI, SESSION_TTL } from './config/env';
import { RedisStore } from 'fastify-redis-session';

const SESSION_KEY = 'Egb/g4RUumlD2YhWYfeDlm5MddajSjGEBhm0OW+yo9s='';
const SESSION_TTL = 864e3; // 1 day

export const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {
  const fastify = createFastify(options);

  fastify.register(fastifyCookie);
  fastify.register(fastifySession, {
    key: Buffer.from(SESSION_KEY, 'base64'),
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Using a secret (will derive a key on startup)

import createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import fastifyCookie from 'fastify-cookie';
import fastifySession from '@mgcrea/fastify-session';
import Redis from 'ioredis';
import { IS_PROD, IS_TEST, REDIS_URI, SESSION_TTL } from './config/env';
import { RedisStore } from 'fastify-redis-session';

const SESSION_TTL = 864e3; // 1 day

export const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {
  const fastify = createFastify(options);

  fastify.register(fastifyCookie);
  fastify.register(fastifySession, {
    secret: 'a secret with minimum length of 32 characters',
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Stateful session

Leveraging an external store, the session id (generated with nanoid) is signed using a secret-key with libsodium's crytpo_auth

Using a in memory store (not production-ready!)

import createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import fastifyCookie from 'fastify-cookie';
import fastifySession, { MemoryStore } from '@mgcrea/fastify-session';
import Redis from 'ioredis';
import { IS_PROD, IS_TEST, REDIS_URI, SESSION_TTL } from './config/env';
import { RedisStore } from 'fastify-redis-session';

const SESSION_TTL = 864e3; // 1 day

export const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {
  const fastify = createFastify(options);

  fastify.register(fastifyCookie);
  fastify.register(fastifySession, {
    store: new MemoryStore(),
    secret: 'a secret with minimum length of 32 characters',
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Using an external store (eg. redis)

Using fastify-redis-session

import createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import fastifyCookie from 'fastify-cookie';
import fastifySession from '@mgcrea/fastify-session';
import Redis from 'ioredis';
import { IS_PROD, IS_TEST, REDIS_URI, SESSION_TTL } from './config/env';
import { RedisStore } from 'fastify-redis-session';

const SESSION_TTL = 864e3; // 1 day

export const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {
  const fastify = createFastify(options);

  fastify.register(fastifyCookie);
  fastify.register(fastifySession, {
    store: new RedisStore({ client: new Redis(REDIS_URI), ttl: SESSION_TTL }),
    secret: 'a secret with minimum length of 32 characters',
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Authors

Olivier Louvignes <olivier@mgcrea.io>

Credits

Heavily inspired from

License

The MIT License

Copyright (c) 2020 Olivier Louvignes <olivier@mgcrea.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.