🏄‍♂️ Nuxt Cross-Site Request Forgery (CSRF) Prevention using Web Crypto API (requires Node.js 19+)

Create a middleware for CSRF token creation and validation in serverless environments.

This fork is compatible with Cloudflare Workers.

Setup

1yarn add nuxt3-csurf # yarn
2npm i nuxt3-csurf # npm

Usage

The only thing you need to do to use the module in the default configuration is to register the module in the modules array in nuxt.config.ts:

1// nuxt.config.js
2{
3  modules: [
4    "nuxt3-csurf",
5  ],
6  csurf: { // optional
7    https: false, // default true if in production
8    cookieKey: '', // "__Host-csrf" if https is true otherwise just "csrf"
9    cookie: { // CookieSerializeOptions from unjs/cookie-es
10      path: '/',
11      httpOnly: true,
12      sameSite: 'strict'
13    },
14    methodsToProtect: ['POST', 'PUT', 'PATCH'], // the request methods we want CSRF protection for
15    excludedUrls: ['/nocsrf1', ['/nocsrf2/.*', 'i']], // any URLs we want to exclude from CSRF protection
16    encryptSecret: /** JsonWebKey object */, // random key by default
17    encryptAlgorithm: 'AES-CBC'
18  } 
19}

useCsrfFetch

This composable provides a convenient wrapper around useFetch. It automatically adds the CSRF token in headers.

1const { data, pending, error, refresh } = useCsrfFetch('/api/login', { query: param1: 'value1' })

$csrfFetch

This helper provides a convenient wrapper around $fetch. It automatically adds the CSRF token in headers.

1const { $csrfFetch } = useNuxtApp()
2const { data } = await $csrfFetch('/api/login', { method: 'POST', body: …, headers: … })

useCsrf

Use this composable if you need to access to the CSRF token value.

1const { csrf } = useCsrf()
2console.log(csrf) // something like: mo4+MrFaeXP7fhAie0o2qw==:tLUaqtHW6evx/coGQVAhtGAR+v6cxgFtrqmkOsuAMag8PHRnMwpbGGUO0TPJjL+4

Credits

• inspired by tiny-csrf and expressjs/csurf
• see OWASP CSRF cheatsheet