Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SerayaEryn/fastify-session
session plugin for fastify
https://github.com/SerayaEryn/fastify-session
fastify nodejs session
Last synced: about 2 months ago
JSON representation
session plugin for fastify
- Host: GitHub
- URL: https://github.com/SerayaEryn/fastify-session
- Owner: SerayaEryn
- License: mit
- Created: 2017-10-26T21:41:45.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T04:57:12.000Z (over 1 year ago)
- Last Synced: 2024-03-15T09:07:33.062Z (6 months ago)
- Topics: fastify, nodejs, session
- Language: JavaScript
- Homepage:
- Size: 178 KB
- Stars: 100
- Watchers: 6
- Forks: 36
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fastify - `fastify-session`
README
# fastify-session
[](https://coveralls.io/github/SerayaEryn/fastify-session?branch=master)
[](https://www.npmjs.com/package/fastify-session)
[](https://standardjs.com)
A session plugin for [fastify](http://fastify.io/).
Requires the [fastify-cookie](https://github.com/fastify/fastify-cookie) plugin.
## Install
```
npm install fastify-session
```
## Usage
```js
const fastify = require('fastify');
const fastifySession = require('fastify-session');
const fastifyCookie = require('fastify-cookie');
const app = fastify();
app.register(fastifyCookie);
app.register(fastifySession, {secret: 'a secret with minimum length of 32 characters'});
```
Store data in the session by adding it to the `session` decorator at the `request`:
```js
app.register(fastifySession, {secret: 'a secret with minimum length of 32 characters'});
app.addHook('preHandler', (request, reply, next) => {
request.session.user = {name: 'max'};
next();
})
```
**NOTE**: For all unencrypted (HTTP) connections, you need to set the `secure` cookie option to `false`. Look below for all cookie options and their details.
The `sessionStore` decorator of the `request` allows to get, save and delete sessions.
```js
app.register(fastifySession, {secret: 'a secret with minimum length of 32 characters'});
app.addHook('preHandler', (request, reply, next) => {
const session = request.session;
request.sessionStore.destroy(session.sessionId, next);
})
```
## Examples
* [Authentication](https://github.com/fastify/example/tree/master/fastify-session-authentication)
## API
### session(fastify, options, next)
The session plugin accepts the following options. It decorates the request with the `sessionStore` and a `session` object. The session data is stored server side using the configured session store.
#### options
##### secret (required)
The secret used to sign the cookie. Must be an array of strings, or a string with length 32 or greater.
If an array, the first secret is used to sign new cookies, and is the first one to be checked for incoming cookies.
Further secrets in the array are used to check incoming cookies, in the order specified.
Note that the array may be manipulated by the rest of the application during its life cycle. This can be done by storing the array in a separate variable that is later manipulated with mutating methods like unshift(), pop(), splice(), etc.
This can be used to rotate the signing secret at regular intervals. A secret should remain somewhere in the array as long as there are active sessions with cookies signed by it. Secrets management is left up to the rest of the application.
##### cookieName (optional)
The name of the session cookie. Defaults to `sessionId`.
##### cookie
The options object used to generate the `Set-Cookie` header of the session cookie. May have the following properties:
* `path` - The `Path` attribute. Defaults to `/` (the root path).
* `maxAge` - A `number` in milliseconds that specifies the `Expires` attribute by adding the specified milliseconds to the current date. If both `expires` and `maxAge` are set, then `expires` is used.
* `httpOnly` - The `boolean` value of the `HttpOnly` attribute. Defaults to true.
* `secure` - The `boolean` value of the `Secure` attribute. Set this option to false when communicating over an unencrypted (HTTP) connection. Value can be set to `auto`; in this case the `Secure` attribute will be set to false for HTTP request, in case of HTTPS it will be set to true. Defaults to true.
* `expires` - The expiration `date` used for the `Expires` attribute. If both `expires` and `maxAge` are set, then `expires` is used.
* `sameSite`- The `boolean` or `string` of the `SameSite` attribute. Using `Secure` mode with `auto` attribute will change the behaviour of the `SameSite` attribute in `http` mode. The `SameSite` attribute will automatically be set to `Lax` with a `http` request. See this [link](https://www.chromium.org/updates/same-site).
* `domain` - The `Domain` attribute.
##### store
A session store. Needs the following methods:
* set(sessionId, session, callback)
* get(sessionId, callback)
* destroy(sessionId, callback)
Compatible to stores from [express-session](https://github.com/expressjs/session).
Defaults to a simple in memory store.
**Note**: The default store should not be used in a production environment because it will leak memory.
##### saveUninitialized (optional)
Save sessions to the store, even when they are new and not modified. Defaults to `true`.
Setting this to `false` can be useful to save storage space and to comply with the EU cookie law.
##### idGenerator (optional)
Function used to generate new session IDs. Defaults to [`uid(24)`](https://github.com/crypto-utils/uid-safe).
#### request.session
Allows to access or modify the session data.
#### request.destroySession(callback)
Allows to destroy the session in the store
#### Session#touch()
Updates the `expires` property of the session.
#### Session#regenerate()
Regenerates the session by generating a new `sessionId`.
### fastify.decryptSession(sessionId, request, next)
This plugin also decorates the fastify instance with `decryptSession` in case you want to decrypt the session manually.
```js
const { sessionId } = fastify.parseCookie(cookieHeader);
const request = {}
fastify.decryptSession(sessionId, request, () => {
// request.session should be available here
})
```
## License
[MIT](./LICENSE)