Skip to content
This repository was archived by the owner on Dec 12, 2023. It is now read-only.

Commit 9c03dd3

Browse files
authored
feat: make secure attribute of session cookie configurable (#49)
* Updated readme with configurable secure attribute info * Make secure attribute for session cookie configurable
1 parent d0300b3 commit 9c03dd3

File tree

4 files changed

+13
-2
lines changed

4 files changed

+13
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,8 @@ Here's what the full _default_ module configuration looks like:
212212
storePrefix: 'sessions',
213213
// The session cookie same site policy is `lax`
214214
cookieSameSite: 'lax',
215+
// `Secure` attribute of session cookie is set to `true`
216+
cookieSecure: true,
215217
// In-memory storage is used (these are `unjs/unstorage` options)
216218
storageOptions: {
217219
driver: 'memory',

src/module.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const defaults: FilledModuleOptions = {
1818
idLength: 64,
1919
storePrefix: 'sessions',
2020
cookieSameSite: 'lax',
21+
cookieSecure: true,
2122
storageOptions: {
2223
driver: 'memory',
2324
options: {}

src/runtime/server/middleware/session/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ const SESSION_COOKIE_NAME = 'sessionId'
1111
const safeSetCookie = (event: H3Event, name: string, value: string) => setCookie(event, name, value, {
1212
// Max age of cookie in seconds
1313
maxAge: useRuntimeConfig().session.session.expiryInSeconds,
14-
// Only send cookie via HTTPs to mitigate man-in-the-middle attacks
15-
secure: true,
14+
// Wether to send cookie via HTTPs to mitigate man-in-the-middle attacks
15+
secure: useRuntimeConfig().session.session.cookieSecure,
1616
// Only send cookie via HTTP requests, do not allow access of cookie from JS to mitigate XSS attacks
1717
httpOnly: true,
1818
// Do not send cookies on many cross-site requests to mitigates CSRF and cross-site attacks, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite#lax

src/types.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ export interface SessionOptions {
5757
* @docs https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
5858
*/
5959
cookieSameSite: SameSiteOptions
60+
/**
61+
* Wether to set the `Secure` attribute for the session cookie
62+
* @default true
63+
* @example false
64+
* @type boolean
65+
* @docs https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies
66+
*/
67+
cookieSecure: boolean
6068
/**
6169
* Driver configuration for session-storage. Per default in-memory storage is used
6270
* @default { driver: 'memory', options: {} }

0 commit comments

Comments
 (0)