xonecas.io
186
Ft

fractal-tree / files

fractal-tree / node_modules / connect / lib / middleware / csrf.js

2.7 KB
1
2/*!
3 * Connect - csrf
4 * Copyright(c) 2011 Sencha Inc.
5 * MIT Licensed
6 */
7
8/**
9 * Module dependencies.
10 */
11
12var utils = require('../utils')
13  , crypto = require('crypto');
14
15/**
16 * CRSF protection middleware.
17 *
18 * By default this middleware generates a token named "_csrf"
19 * which should be added to requests which mutate
20 * state, within a hidden form field, query-string etc. This
21 * token is validated against the visitor's `req.session._csrf`
22 * property which is re-generated per request.
23 *
24 * The default `value` function checks `req.body` generated
25 * by the `bodyParser()` middleware, `req.query` generated
26 * by `query()`, and the "X-CSRF-Token" header field.
27 *
28 * This middleware requires session support, thus should be added
29 * somewhere _below_ `session()` and `cookieParser()`.
30 *
31 * Examples:
32 *
33 *      var form = '\n\
34 *        <form action="/" method="post">\n\
35 *          <input type="hidden" name="_csrf" value="{token}" />\n\
36 *          <input type="text" name="user[name]" value="{user}" />\n\
37 *          <input type="password" name="user[pass]" />\n\
38 *          <input type="submit" value="Login" />\n\
39 *        </form>\n\
40 *      '; 
41 *      
42 *      connect(
43 *          connect.cookieParser()
44 *        , connect.session({ secret: 'keyboard cat' })
45 *        , connect.bodyParser()
46 *        , connect.csrf()
47 *      
48 *        , function(req, res, next){
49 *          if ('POST' != req.method) return next();
50 *          req.session.user = req.body.user;
51 *          next();
52 *        }
53 *      
54 *        , function(req, res){
55 *          res.setHeader('Content-Type', 'text/html');
56 *          var body = form
57 *            .replace('{token}', req.session._csrf)
58 *            .replace('{user}', req.session.user && req.session.user.name || '');
59 *          res.end(body);
60 *        }
61 *      ).listen(3000);
62 *
63 * Options:
64 *
65 *    - `value` a function accepting the request, returning the token 
66 *
67 * @param {Object} options
68 * @api public
69 */
70
71module.exports = function csrf(options) {
72  var options = options || {}
73    , value = options.value || defaultValue;
74
75  return function(req, res, next){
76    // generate CSRF token
77    var token = req.session._csrf || (req.session._csrf = utils.uid(24));
78
79    // ignore GET (for now)
80    if ('GET' == req.method) return next();
81
82    // determine value
83    var val = value(req);
84
85    // check
86    if (val != token) return utils.forbidden(res);
87    
88    next();
89  }
90};
91
92/**
93 * Default value function, checking the `req.body`
94 * and `req.query` for the CSRF token.
95 *
96 * @param {IncomingMessage} req
97 * @return {String}
98 * @api private
99 */
100
101function defaultValue(req) {
102  return (req.body && req.body._csrf)
103    || (req.query && req.query._csrf)
104    || (req.headers['x-csrf-token']);
105}