@aldy505/malibu

This is a fork of my own creation, but for CommonJS. I've updated the readme so you should be on the right track while using this one.

If your project uses ES Modules, consider using the original Malibu library.

This middleware helps web developers fight CSRF attacks. Bear in mind, by solely using this middleware, we can't guarantee your app will be free from CSRF attacks. Refer to CSRF Prevention Cheat Sheet and pillarjs/understanding-csrf for more details.

• ⚡ Framework agnostic (works with Express, Tinyhttp, Polka, and more!)
• ✨ Native ESM support Uhh, no this one is Common JS only.
• 🛠 Typescript typings out of the box
• 🚀 No legacy dependencies

Install

pnpm i @aldy505/malibu

Usage

Like all CSRF plugins, it depends on either Cookie Parser or Session middleware.

NOTE: If you are using Tinyhttp's dependencies (cookie-parser and such), don't forget to use the Common JS version. It's should be anything before v2. Otherwise, you're going to get an error.

const { App } = require('@tinyhttp/app')
const { cookieParser } = require('@tinyhttp/cookie-parser')
const { csrf } = require('malibu')

const app = new App()

const csrfProtection = csrf()
app.use(cookieParser())

// this lets you acquire CSRF token on response body
// you also have CSRF token on your cookies as _csrf
app.get('/', csrfProtection, (req, res) => {
  res.status(200).json({ token: req.csrfToken() })
})

// you may only access this if you give a previously acquired CSRF token
app.post('/', csrfProtection, (req, res) => {
  res.status(200).json({ message: 'hello' })
})

For signed cookies:

const app = new App()

const csrfProtection = csrf({ cookie: { signed: true } })
app.use(cookieParser('secret key'))

// this lets you acquire CSRF token on the response body
// you also have a CSRF token on your cookies as _csrf
app.get('/', csrfProtection, (req, res) => {
  res.status(200).json({ token: req.csrfToken() })
})

// you may only access this if you give a previously acquired CSRF token
app.post('/', csrfProtection, (req, res) => {
  res.status(200).json({ message: 'hello' })
})

With express-session:

const { App } = require('@tinyhttp/app')
const session = require('express-session')
const { csrf } = require('malibu')

const app = new App()

const csrfProtection = csrf({ middleware: 'session' })
app.use(session({ secret: 'secret key', resave: false, saveUninitialized: false }))

// this lets you acquire CSRF token on response body
app.get('/', csrfProtection, (req, res) => {
  res.status(200).json({ token: req.csrfToken() })
})

// you may only access this if you give a previously acquired CSRF token
app.post('/', csrfProtection, (req, res) => {
  res.status(200).json({ message: 'hello' })
})

For detailed example, please refer to examples

Options

Name	Type	Default	Description
middleware	string	cookie	Specifies which middleware to look for. Available options are cookie and session
cookie	CookieOptions	{ signed: false, key: '_csrf', path: '/' }	signed specifies whether the cookie is signed or unsigned, key specifies to the cookie key, path specifies the domain of the cookie. For other options please refer to @tinyhttp/cookie serializer options
sessionKey	string	session	Specifies session key name
value	(req: Request) => any	req.body._csrf, req.query._csrf, req.headers["csrf-token"], req.headers["xsrf-token"], req.headers["x-csrf-token"], req.headers["x-xsrf-token"]	Specifies where to look for the CSRF token
ignoreMethod	Array<HTTPMethod>	["GET", "HEAD", "OPTIONS"]	Specifies the HTTP Method in which CSRF protection will be disabled
saltLength	number	8	Specifies the salt length for CSRF token
secretLength	number	18	Specifies the secret length for CSRF Token

Why "malibu"?

It's one variation of a longboard used in surfing. It's a 60's style longboard, made with heavy glass, long parallel 50/50 rails, and a deep single fin. Made especially for trimming, (walking the board) and for noseriding. Not to mention, it looks cool.