\n\n\n## Features\n\nSession plugin for [fastify](https://github.com/fastify/fastify) that supports both stateless and sateful sessions.\n\n- Requires [@fastify/cookie](https://github.com/fastify/fastify-cookie) to handle cookies.\n\n- Works with [fastify](https://github.com/fastify/fastify) `>=4.0.0`.\n\n- Can leverage crypto addons like\n [@mgcrea/fastify-session-sodium-crypto](https://github.com/mgcrea/fastify-session-sodium-crypto) to perform crypto.\n\n- Can leverage store addons like:\n\n - [@mgcrea/fastify-session-redis-store](https://github.com/mgcrea/fastify-session-redis-store)\n - [@mgcrea/fastify-session-prisma-store](https://github.com/mgcrea/fastify-session-prisma-store)\n - [fastify-session-sqlite-store](https://github.com/oof2win2/fastify-session-sqlite-store)\n\n- Built with [TypeScript](https://www.typescriptlang.org/) for static type checking with exported types along the\n library.\n\n## Install\n\n```bash\nnpm install @mgcrea/fastify-session @fastify/cookie\n# or\npnpm add @mgcrea/fastify-session @fastify/cookie\n```\n\n## Quickstart\n\n### Basic example (signed session with hmac stored in a volatile in-memory store)\n\nDefaults to a volatile in-memory store for sessions (great for tests), with\n[hmac](https://nodejs.org/api/crypto.html#crypto_crypto_createhmac_algorithm_key_options) for signature.\n\n```ts\nimport createFastify, { FastifyInstance, FastifyServerOptions } from \"fastify\";\nimport fastifyCookie from \"@fastify/cookie\";\nimport fastifySession from \"@mgcrea/fastify-session\";\n\nconst SESSION_SECRET = \"a secret with minimum length of 32 characters\";\nconst SESSION_TTL = 86400; // 1 day in seconds\n\nexport const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {\n const fastify = createFastify(options);\n\n fastify.register(fastifyCookie);\n fastify.register(fastifySession, {\n secret: SESSION_SECRET,\n cookie: { maxAge: SESSION_TTL },\n });\n\n return fastify;\n};\n```\n\n### Production example (signed session with sodium stored in redis)\n\nFor better performance/security, you can use the\n[@mgcrea/fastify-session-sodium-crypto](https://github.com/mgcrea/fastify-session-sodium-crypto) addon:\n\nLeveraging an external redis store, the session id (generated with [nanoid](https://github.com/ai/nanoid)) is signed\nusing a secret-key with\n[libsodium's crytpo_auth](https://libsodium.gitbook.io/doc/secret-key_cryptography/secret-key_authentication)\n\n```ts\nimport createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';\nimport fastifyCookie from 'fastify-cookie';\nimport fastifySession from '@mgcrea/fastify-session';\nimport { SODIUM_AUTH } from '@mgcrea/fastify-session-sodium-crypto';\n\nconst SESSION_KEY = 'Egb/g4RUumlD2YhWYfeDlm5MddajSjGEBhm0OW+yo9s='';\nconst SESSION_TTL = 86400; // 1 day in seconds\nconst REDIS_URI = process.env.REDIS_URI || 'redis://localhost:6379/1';\n\nexport const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {\n const fastify = createFastify(options);\n\n fastify.register(fastifyCookie);\n fastify.register(fastifySession, {\n key: Buffer.from(SESSION_KEY, 'base64'),\n crypto: SODIUM_AUTH,\n store: new RedisStore({ client: new Redis(REDIS_URI), ttl: SESSION_TTL }),\n cookie: { maxAge: SESSION_TTL },\n });\n\n return fastify;\n};\n```\n\n### Stateless example (encrypted session with sodium not using a store)\n\nNo external store required, the entire session data is encrypted using a secret-key with\n[libsodium's crypto_secretbox_easy](https://libsodium.gitbook.io/doc/secret-key_cryptography/secretbox)\n\nHere we used a `secret` instead of providing a `key`, key derivation will happen automatically on startup.\n\n```ts\nimport createFastify, { FastifyInstance, FastifyServerOptions } from \"fastify\";\nimport fastifyCookie from \"fastify-cookie\";\nimport fastifySession from \"@mgcrea/fastify-session\";\nimport { SODIUM_SECRETBOX } from \"@mgcrea/fastify-session-sodium-crypto\";\n\nconst SESSION_TTL = 86400; // 1 day in seconds\n\nexport const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {\n const fastify = createFastify(options);\n\n fastify.register(fastifyCookie);\n fastify.register(fastifySession, {\n secret: \"a secret with minimum length of 32 characters\",\n crypto: SODIUM_SECRETBOX,\n cookie: { maxAge: SESSION_TTL },\n });\n\n return fastify;\n};\n```\n\n## Benchmarks\n\n### Session crypto sealing\n\n```sh\nnode --experimental-specifier-resolution=node --loader=ts-paths-esm-loader/transpile-only --no-warnings test/benchmark/cryptoSeal.ts\n```\n\n```txt\nSODIUM_SECRETBOX#sealJson x 333,747 ops/sec ±0.62% (91 runs sampled)\nSODIUM_AUTH#sealJson x 376,300 ops/sec ±0.50% (89 runs sampled)\nHMAC#sealJson x 264,292 ops/sec ±3.13% (85 runs sampled)\nFastest is SODIUM_AUTH#sealJson\n```\n\n### Session crypto unsealing\n\n```sh\nnode --experimental-specifier-resolution=node --loader=ts-paths-esm-loader/transpile-only --no-warnings test/benchmark/cryptoUnseal.ts\n```\n\n```txt\nSODIUM_SECRETBOX#unsealJson x 424,297 ops/sec ±0.69% (86 runs sampled)\nSODIUM_AUTH#unsealJson x 314,736 ops/sec ±0.96% (89 runs sampled)\nHMAC#unsealJson x 145,037 ops/sec ±5.67% (78 runs sampled)\nFastest is SODIUM_SECRETBOX#unsealJson\n```\n\n## Authors\n\n- [Olivier Louvignes](https://github.com/mgcrea) <>\n\n### Credits\n\nHeavily inspired from\n\n- [fastify-secure-session](https://github.com/fastify/fastify-secure-session) by\n [Matteo Collina](https://github.com/mcollina)\n- [fastify-session](https://github.com/SerayaEryn/fastify-session) by [Denis Fäcke](https://github.com/SerayaEryn)\n- [express-session](https://github.com/expressjs/session) by [Douglas Wilson](https://github.com/dougwilson)\n- [cookie-signature](https://github.com/tj/node-cookie-signature) by [TJ Holowaychuk](https://github.com/tj)\n\n## License\n\n```md\nThe MIT License\n\nCopyright (c) 2020 Olivier Louvignes \n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/@mgcrea/fastify-session.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dt/@mgcrea/fastify-session.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/@mgcrea/fastify-session.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/l/@mgcrea/fastify-session.svg?style=for-the-badge\")
\n \n ![\"build](\"https://img.shields.io/github/actions/workflow/status/mgcrea/fastify-session/main.yml?style=for-the-badge&branch=master\")
\n \n \n ![\"dependencies](\"https://img.shields.io/depfu/dependencies/github/mgcrea/fastify-session?style=for-the-badge\")
\n \n