csurf
nuxt-csurf

用于 Nuxt 的跨站请求伪造 (CSRF) 防护
340.5K 次下载87 颗星v1.6.5
morgbnmorgbn

nuxt-oa-social-card

npm versionnpm downloadsLicenseNuxt

Nuxt Csurf

跨站请求伪造 (CSRF) 防护。
为 CSRF 令牌的创建和验证创建中间件。

✅ 支持 Node.js 服务器和无服务器环境
✅ 支持通用和客户端渲染 (ssr: true|false)
✅ 路由级配置
✅ TypeScript
❌ 由于某些限制，不支持静态托管和 nitro 预渲染 *

安装

npx nuxi@latest module add csurf

全局配置

// nuxt.config.js
export default defineNuxtConfig({
  modules: ['nuxt-csurf'],
  csurf: { // optional
    https: false, // default true if in production
    cookieKey: '', // "__Host-csrf" if https is true otherwise just "csrf"
    cookie: { // CookieSerializeOptions from unjs/cookie-es
      path: '/',
      httpOnly: true,
      sameSite: 'strict'
    },
    methodsToProtect: ['POST', 'PUT', 'PATCH'], // the request methods we want CSRF protection for
    encryptSecret: /** a 32 bits secret */, // for stateless server (like serverless runtime), random bytes by default
    encryptAlgorithm: 'aes-256-cbc', // by default 'aes-256-cbc' (node), 'AES-CBC' (serverless)
    addCsrfTokenToEventCtx: true, // default false, to run useCsrfFetch on server set it to true
    headerName: 'csrf-token' // the header where the csrf token is stored
  } 
})

按路由配置

要启用按路由配置，请使用如下所示的 routeRules

export default defineNuxtConfig({
  routeRules: {
    '/api/nocsrf': {
      csurf: false
    },
    '/api/test': {
      csurf: {
        methodsToProtect: ['POST'] // protect POST request only
      }
    }
  }
})

useCsrfFetch

此可组合项提供了一个便捷的 useFetch 包装器。它会自动在请求头中添加 CSRF 令牌。

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

$csrfFetch

此辅助函数提供了一个便捷的 $fetch 包装器。它会自动在请求头中添加 CSRF 令牌。

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

useCsrf

如果您需要访问 CSRF 令牌值，请使用此可组合项。

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

在 localhost 上尝试生产环境 (yarn preview)

NITRO_CSURF_HTTPS=false
NITRO_CSURF_COOKIE_KEY=csrf

限制

CSRF 令牌值存储在 DOM 中，如 Owasp 的 CSRF 备忘录 中所述。因此，对于每个新的页面请求，都必须生成 DOM，而这对于静态站点（或预渲染路由）来说是不适用的。参见错误 #42

鸣谢