@faranglao/sveltekit-security-headers

SvelteKit Security Headers

Enhance visitor security in SvelteKit based web applications.

Add those missing HTTP response headers with sveltekit-security-headers.

Installation

npm install @faranglao/sveltekit-security-headers

Getting Started

To add HTTP response headers to your application install the package and export the SvelteKitSecurityHeaders().handle function.

The SvelteKitSecurityHeaders().handle function is a SvelteKit Server Hook that is exported in src/hooks.server.ts.

// samples/securityheaders/hooks.server.ts
// copy to src/hooks.server.ts
import { SvelteKitSecurityHeaders } from '@faranglao/sveltekit-security-headers';

export const handle = SvelteKitSecurityHeaders().handle;

Then run the web application using npm run dev.

The handle function will add the following headers to your sites HTTP traffic.

# Headers added to HTTP Response
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Referrer-Policy: strict-origin-when-cross-origin
Permissions-Policy: geolocation=(), camera=(), microphone=()

Security Headers

Having already delivered over 250 million scans the Security Headers site is a useful tool for analyzing HTTP headers.

The scan returns a score from an A+ grade down to an F grade. You can find more information on scoring on Scott Helme's Security Headers blog.

With minimal configuration SvelteKitSecurityHeaders().handle will add those missing HTTP headers required to achieve an A grade score on securityheaders.com

Customizing Response Headers

The SvelteKitSecurityHeaders().handle function makes it possible to fully customize the HTTP response headers returned from your application.

The code below shows how to apply both pre-configured headers and add customer values to your HTTP responses.

// samples/custom/hooks.server.ts
// copy to src/hooks.server.ts
import { SvelteKitSecurityHeaders, RuleSet } from '@faranglao/sveltekit-security-headers';

export const handle = SvelteKitSecurityHeaders({
  headers: [
    // remove any duplicates with a Set
    ...new Set([
      ...RuleSet.SecurityHeaders,
      ...RuleSet.SvelteKitSpecific,
      ...RuleSet.OwaspRecommendedMinimal,

      // Access-Control-Allow-Origin header to allow requests
      // from your domain .. override value
      {
        name: 'Access-Control-Allow-Origin',
        value: 'https://sveltekit-security-headers.vercel.app'
      }

      // .. add custom headers
    ])
  ],
  verbose: true
}).handle;

Multiple Server Hooks

The following code sample shows how to use the sequence helper function to wrap existing server hook code and invoke the SvelteKitSecurityHeaders().handle function.

// samples/sequence/hooks.server.ts
// copy to src/hooks.server.ts
import type { Handle } from '@sveltejs/kit';
import { sequence } from '@sveltejs/kit/hooks';
import { SvelteKitSecurityHeaders } from '@faranglao/sveltekit-security-headers';

export const handle: Handle = sequence(
  /* existing Hook code , */
  SvelteKitSecurityHeaders().handle
);

Source Code

Source code for the sveltekit-security-headers package is maintained on GitHub.