@sailshq/csurf

A fork of the now deprecated csurf package with ongoing maintenance from the Sails core team.

Node.js [CSRF][wikipedia-csrf] protection middleware.

Requires either a session middleware or cookie-parser to be initialized first.

* If you are setting the "cookie" option to a non-false value,
then you must use cookie-parser
before this module.
* Otherwise, you must use a session middleware before this module. For example:
- express-session
- cookie-session

If you have questions on how this module is implemented, please read
Understanding CSRF.

Deprecated

This npm module is currently deprecated due to the large influx of security vulunerability reports
received, most of which are simply exploiting the underlying limitations of CSRF itself. The Express.js
project does not have the resources to put into this module, which is largely unnecessary for modern
SPA-based applications.

Please instead use an alternative CSRF protection package if you do need one: https://www.npmjs.com/search?q=express%20csrf

Installation

This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:

``sh
$ npm install csurf
`

API

`js
var csurf = require('csurf')
`

$3

Create a middleware for CSRF token creation and validation. This middleware
adds a req.csrfToken() function to make a token which should be added to
requests which mutate state, within a hidden form field, query-string etc.
This token is validated against the visitor's session or csrf cookie.

#### Options

The csurf function takes an optional options object that may contain
any of the following keys:

##### cookie

Determines if the token secret for the user should be stored in a cookie
or in req.session. Storing the token secret in a cookie implements
the [double submit cookie pattern][owsap-csrf-double-submit].
Defaults to false.

When set to true (or an object of options for the cookie), then the module
changes behavior and no longer uses req.session. This means you _are no
longer required to use a session middleware_. Instead, you do need to use the
cookie-parser middleware in
your app before this middleware.

When set to an object, cookie storage of the secret is enabled and the
object contains options for this functionality (when set to true, the
defaults for the options are used). The options may contain any of the
following keys:

- key - the name of the cookie to use to store the token secret
(defaults to '_csrf').
- path - the path of the cookie (defaults to '/').
- signed - indicates if the cookie should be signed (defaults to false).
- secure - marks the cookie to be used with HTTPS only (defaults to
false).
- maxAge - the number of seconds after which the cookie will expire
(defaults to session length).
- httpOnly - flags the cookie to be accessible only by the web server
(defaults to false).
- sameSite - sets the same site policy for the cookie(defaults to
false). This can be set to 'strict', 'lax', 'none', or true
(which maps to 'strict').
- domain - sets the domain the cookie is valid on(defaults to current
domain).

##### ignoreMethods

An array of the methods for which CSRF token checking will disabled.
Defaults to ['GET', 'HEAD', 'OPTIONS'].

##### sessionKey

Determines what property ("key") on req the session object is located.
Defaults to 'session' (i.e. looks at req.session). The CSRF secret
from this library is stored and read as req[sessionKey].csrfSecret.

If the "cookie" option is not false, then this option does
nothing.

##### value

Provide a function that the middleware will invoke to read the token from
the request for validation. The function is called as value(req) and is
expected to return the token as a string.

The default value is a function that reads the token from the following
locations, in order:

- req.body._csrf - typically generated by the body-parser module.
- req.query._csrf - a built-in from Express.js to read from the URL
query string.
- req.headers['csrf-token'] - the CSRF-Token HTTP request header.
- req.headers['xsrf-token'] - the XSRF-Token HTTP request header.
- req.headers['x-csrf-token'] - the X-CSRF-Token HTTP request header.
- req.headers['x-xsrf-token'] - the X-XSRF-Token HTTP request header.

Example

$3

The following is an example of some server-side code that generates a form
that requires a CSRF token to post back.

`js
var cookieParser = require('cookie-parser')
var csrf = require('csurf')
var bodyParser = require('body-parser')
var express = require('express')

// setup route middlewares
var csrfProtection = csrf({ cookie: true })
var parseForm = bodyParser.urlencoded({ extended: false })

// create express app
var app = express()

// parse cookies
// we need this because "cookie" is true in csrfProtection
app.use(cookieParser())

app.get('/form', csrfProtection, function (req, res) {
// pass the csrfToken to the view
res.render('send', { csrfToken: req.csrfToken() })
})

app.post('/process', parseForm, csrfProtection, function (req, res) {
res.send('data is being processed')
})
`

Inside the view (depending on your template language; handlebars-style
is demonstrated here), set the csrfToken value as the value of a hidden
input field named _csrf:

`html





Favorite color:
Submit



`

#### Using AJAX

When accessing protected routes via ajax both the csrf token will need to be
passed in the request. Typically this is done using a request header, as adding
a request header can typically be done at a central location easily without
payload modification.

The CSRF token is obtained from the req.csrfToken() call on the server-side.
This token needs to be exposed to the client-side, typically by including it in
the initial page content. One possibility is to store it in an HTML tag,
where value can then be retrieved at the time of the request by JavaScript.

The following can be included in your view (handlebar example below), where the
csrfToken value came from req.csrfToken():

`html

`

The following is an example of using the
Fetch API to post
to the /process route with the CSRF token from the tag on the page:

`js
// Read the CSRF token from the tag
var token = document.querySelector('meta[name="csrf-token"]').getAttribute('content')

// Make a request using the Fetch API
fetch('/process', {
credentials: 'same-origin', // <-- includes cookies in the request
headers: {
'CSRF-Token': token // <-- is the csrf token as a header
},
method: 'POST',
body: {
favoriteColor: 'blue'
}
})
`

#### Single Page Application (SPA)

Many SPA frameworks like Angular have CSRF support built in automatically.
Typically they will reflect the value from a specific cookie, like
XSRF-TOKEN (which is the case for Angular).

To take advantage of this, set the value from req.csrfToken() in the cookie
used by the SPA framework. This is only necessary to do on the route that
renders the page (where res.render or res.sendFile is called in Express,
for example).

The following is an example for Express of a typical SPA response:

`js
app.all('*', function (req, res) {
res.cookie('XSRF-TOKEN', req.csrfToken())
res.render('index')
})
`

$3

Note CSRF checks should only be disabled for requests that you expect to
come from outside of your website. Do not disable CSRF checks for requests
that you expect to only come from your website. An existing session, even if
it belongs to an authenticated user, is not enough to protect against CSRF
attacks.

The following is an example of how to order your routes so that certain endpoints
do not check for a valid CSRF token.

`js
var cookieParser = require('cookie-parser')
var csrf = require('csurf')
var bodyParser = require('body-parser')
var express = require('express')

// create express app
var app = express()

// create api router
var api = createApiRouter()

// mount api before csrf is appended to the app stack
app.use('/api', api)

// now add csrf and other middlewares, after the "/api" was mounted
app.use(bodyParser.urlencoded({ extended: false }))
app.use(cookieParser())
app.use(csrf({ cookie: true }))

app.get('/form', function (req, res) {
// pass the csrfToken to the view
res.render('send', { csrfToken: req.csrfToken() })
})

app.post('/process', function (req, res) {
res.send('csrf was required to get here')
})

function createApiRouter () {
var router = new express.Router()

router.post('/getProfile', function (req, res) {
res.send('no csrf to get here')
})

return router
}
`

$3

When the CSRF token validation fails, an error is thrown that has
err.code === 'EBADCSRFTOKEN'. This can be used to display custom
error messages.

`js
var bodyParser = require('body-parser')
var cookieParser = require('cookie-parser')
var csrf = require('csurf')
var express = require('express')

var app = express()
app.use(bodyParser.urlencoded({ extended: false }))
app.use(cookieParser())
app.use(csrf({ cookie: true }))

// error handler
app.use(function (err, req, res, next) {
if (err.code !== 'EBADCSRFTOKEN') return next(err)

// handle CSRF token errors here
res.status(403)
res.send('form tampered with')
})
``

References

- [Cross-side request forgery on Wikipedia][wikipedia-csrf]
- [OWASP Cross-Site Request Forgery Prevention Cheat Sheet][owsap-csrf]

[owsap-csrf]: https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html
[owsap-csrf-double-submit]: https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html#double-submit-cookie
[wikipedia-csrf]: https://en.wikipedia.org/wiki/Cross-site_request_forgery

License

MIT

[coveralls-image]: https://badgen.net/coveralls/c/github/expressjs/csurf/master
[coveralls-url]: https://coveralls.io/r/expressjs/csurf?branch=master
[node-url]: https://nodejs.org/en/download
[npm-downloads-image]: https://badgen.net/npm/dm/csurf
[npm-url]: https://npmjs.org/package/csurf
[npm-version-image]: https://badgen.net/npm/v/csurf
[github-actions-ci-image]: https://badgen.net/github/checks/expressjs/csurf/master?label=ci
[github-actions-ci-url]: https://github.com/expressjs/csurf/actions/workflows/ci.yml