svelte-kit-cookie-session v3.4.1

Svelte Kit Cookie Session

⚒️ Encrypted "stateless" cookie sessions for SvelteKit

This SvelteKit backend utility allows you to create a session to be stored in the browser cookies via a encrypted seal. This provides strong client/"stateless" sessions.

The seal stored on the client contains the session data, not your server, making it a "stateless" session from the server point of view. This is a different take than express-session where the cookie contains a session ID to then be used to map data on the server-side.

📚  Table of Contents

1. Upgrading
2. Installation
3. Usage
4. Initializing
5. Secret Rotation
6. Setting the Session
7. Accessing the Session
8. Destroying the Session
9. Refreshing the Session

By default the cookie has an ⏰ expiration time of 7 days, set via expires which should be a number in days.

Upgrading

:warning: SvelteKit removed support for getSession and the session store!

You can upgrade by creating a +layout.server.js file at the root and returning the session data from there.

src/routes/+layout.server.ts

/** @type {import('./$types').LayoutServerLoad} */
export const load = ({ locals }) => {
	return {
		session: locals.session.data // You can also use your old `getSession` function if you wish.
	};
};

You'll now have access to the session data by using $page.data.session or via the parent function from other +page.server.js load functions.

<script>
	import { page } from '$app/stores';
	$: session = $page.data.session;
</script>

Installation

Install into dependencies

npm i svelte-kit-cookie-session

yarn add svelte-kit-cookie-session

Update your app.d.ts file to look something like:

/// <reference types="@sveltejs/kit" />

interface SessionData {
	views: number;
}

// See https://kit.svelte.dev/docs#typescript
// for information about these interfaces
declare namespace App {
	interface Locals {
		session: import('svelte-kit-cookie-session').Session<SessionData>;
	}

	interface PageData {
		session: SessionData;
	}

	interface Platform {}

	interface PrivateEnv {}

	interface PublicEnv {}
}

Usage

You can find some examples in the src/routes/tests folder Tests.

The secret is a private key or list of private keys you must pass at runtime, it should be at least 32 characters long. Use Password Generator to generate strong secrets.

⚠️ You should always store secrets in secret environment variables on your platform.

Initializing

src/hooks.ts || src/hooks/index.ts

import { handleSession } from 'svelte-kit-cookie-session';

// You can do it like this, without passing a own handle function
export const handle = handleSession({
	// Optional initial state of the session, default is an empty object {}
	// init: (event) => ({
	// 	views: 0
	// }),
	// chunked: true // Optional, default is false - if true, the session will be chunked into multiple cookies avoiding the browser limit for cookies
	secret: 'SOME_COMPLEX_SECRET_AT_LEAST_32_CHARS'
});

// Or pass your handle function as second argument to handleSession

export const handle = handleSession(
	{
		secret: 'SOME_COMPLEX_SECRET_AT_LEAST_32_CHARS'
	},
	({ event, resolve }) => {
		// event.locals is populated with the session `event.locals.session`

		// Do anything you want here
		return resolve(event);
	}
);

In case you're using sequence(), do this

const sessionHandler = handleSession({
	secret: 'SOME_COMPLEX_SECRET_AT_LEAST_32_CHARS'
});
export const handle = sequence(sessionHandler, ({ resolve, event }) => {
	// event.locals is populated with the session `event.locals.session`
	// event.locals is also populated with all parsed cookies by handleSession, it would cause overhead to parse them again - `event.locals.cookies`.
	// Do anything you want here
	return resolve(event);
});

Secret rotation

is supported. It allows you to change the secret used to sign and encrypt sessions while still being able to decrypt sessions that were created with a previous secret.

This is useful if you want to:

• rotate secrets for better security every two (or more, or less) weeks
• change the secret you previously used because it leaked somewhere (😱)

Then you can use multiple secrets:

Week 1:

export const handle = handleSession({
	secret: 'SOME_COMPLEX_SECRET_AT_LEAST_32_CHARS'
});

Week 2:

export const handle = handleSession({
	secret: [
		{
			id: 2,
			secret: 'SOME_OTHER_COMPLEX_SECRET_AT_LEAST_32_CHARS'
		},
		{
			id: 1,
			secret: 'SOME_COMPLEX_SECRET_AT_LEAST_32_CHARS'
		}
	]
});

Notes:

• id is required so that we do not have to try every secret in the list when decrypting (the id is part of the cookies value).
• The secret used to encrypt session data is always the first one in the array, so when rotating to put a new secret, it must be first in the array list
• Even if you do not provide an array at first, you can always move to array based secret afterwards, knowing that your first password (string) was given {id:1} automatically.

Setting The Session

Setting the session can be done in two ways, either via the set method or via the update method.

If the session already exists, the data get's updated but the expiration time stays the same

src/routes/counter/+page.server.js

/** @type {import('@sveltejs/kit').Actions} */
export const actions = {
	default: async ({ locals }) => {
		const { counter = 0 } = locals.session.data;

		await locals.session.set({ counter: counter + 1 });

		return {};
	}
};

Sometimes you don't want to get the session data first only to increment a counter or some other value, that's where the update method comes in to play

src/routes/counter/+page.server.ts

/** @type {import('@sveltejs/kit').Actions} */
export const actions = {
	default: async ({ locals, request }) => {
		await locals.session.update(({ count }) => ({ count: count ? count + 1 : 0 }));
		return {};
	}
};

Accessing The Session

After initializing the session, your locals will be filled with a session object, we automatically set the cookie if you set the session via locals.session.set({}) to something and receive the current data via locals.session.data only.

src/routes/+layout.server.js

/** @type {import('@sveltejs/kit').LayoutServerLoad} */
export function load({ locals, request }) {
	return {
		session: locals.session.data
	};
}

src/routes/+page.svelte

<script>
	import { page } from '$app/stores';
	$: session = $page.data.session;
</script>

src/routes/auth/login/+page.server.js

/** @type {import('@sveltejs/kit').PageData} */
export function load({ parent, locals }) {
	const { session } = await parent();
	// or
	// locals.session.data.session;


	// Already logged in:
	if(session.userId) {
		throw redirect(302, '/')
	}

	return {};
}

Destroying the Session

src/routes/logout/+page.server.js

/** @type {import('@sveltejs/kit').Actions} */
export const actions = {
	default: async () => {
		await locals.session.destroy();
		return {};
	}
};

Refresh the session with the same data but renew the expiration date

src/routes/refresh/+page.server.js

/** @type {import('@sveltejs/kit').Actions} */
export const actions = {
	default: async () => {
		await locals.session.refresh(/** Optional new expiration time in days */);
		return {};
	}
};

Refresh the session expiration on every request Rolling -> default is false!

You can also specify a percentage from 1 to 100 which refreshes the session when a percentage of the expiration date is met.

Note this currently only fires if a session is already existing

handleSession({
	rolling: true // or 1-100 for percentage o the expiry date met,
});