Node.js防范csrf攻击

csurf

Node.js 防范csrf攻击中间件

需要session中间件(如:express-session)或者cookie中间件(cookie-parser)首先被初始化

  1. 如果设置cookie选项为非false的值,需在此模块之前引用cookie-parser

  2. 除此之外,在此模块之前还须使用session中间件,列如:

    • express-session
    • cookie-session

安装

通过npm安装:

npm install csurf

API

var csurf = require('csurf')

csurf([options])

为CSRF令牌创建和验证,创建一个中间件,中间件加入 req.csrfToken() 函数创建一个应该被添加到请求中的令牌,这些令牌是随时变化的,在隐藏表单字段中,query-string等。令牌根据访问者的session和cookie来验证。

options

csurf函数具有可选项 options 对象, 此对象包含以下任意键:

  1. cookie

确定用户的令牌秘密是否存在cookie或 req.session 中。默认是 false

当cookie设置成 true , 然后模块会改变行为并不在使用 req.session。意味着不需要使用session中间件。相反,在此组件之前,只需使用 cookie-parser 中间件。

var csurf = require('csurf');

csurf({cookie:true})

当cookie设置成一个对象,cookie的秘密存储被启用,该对象包含此功能的可选项(当设置 true, 默认选项被使用)。这些选项包含以下任意键:

csurf({cookie:{
    key: '_csrf',
    path: '/'
}})
  • key - 用于存储令牌的cookie名称(默认:_csrf)

  • path - cookie的路径(默认:/)

其他选项参考 res.cookie

  1. ignoreMethods

一组用于禁用CSRF令牌检查的方法。默认 [GET,'HEAD','OPTIONS']

csurf({
    ignoreMethods: [GET,'HEAD','OPTIONS']
})
  1. sessionKey

确定位于session对象上的 req 上的的属性("key")。默认 session (比如:req.session)。来自框架的CSRF令牌被存储并且像 req[sessionKey].csrfSecret 来获取。

如果 cookie 的选项不是false,那么这个选项无效。

  1. value

为了验证会提供中间件函数来调用读取来自请求的令牌。此函数 value(req) 被调用。并且它预期的以一个字符串返回令牌。

默认值是来自以下顺序读取令牌的函数:

  • req.body._csrf - 通常通过 body-parser 模块产生。
  • req.query._csrf - express.js内置的,通过它获取来自URL的查询字符串
  • req.headers['csrf-token'] - CSRF-Token HTTP请求头
  • req.headers['xsrf-token'] - XSRF-Token HTTP请求头
  • req.headers['x-csrf-token'] - X-CSRF-Token HTTP请求头
  • req.headers['x-xsrf-token'] - X-XSRF-Token HTTP请求头

示例

express

需分别在服务端和客户端操作。

以下是服务端代码示例,生成一个需要CSRF令牌发布的表单:

var express = require('express'),             // express框架
    bodyparser = require('body-parser'),      // 使用POST,需要引入此中间件来解析URL编码体
    cookieParser = require('cookie-parser'),  // cookie中间件,csurf需依赖它
    csrf = require('csurf');                  // csurf中间件


// 设置路由中间件
var csrfProtection = csrf({cookie:true}),
    parseForm = bodyParser.urlencodeed({extended:false});

// 创建epxress app
var app = express();

// cookies
// 需要它,因为 csrfProtection 中"cookie"设置的是true,需要依赖cookie
app.use(cookieParser());

app.get('/form', csrfProtection, function (req, res) {
    // 把 csrfToken 传递给视图
    res.render('send', { csrfToken: req.csrfToken() })
})

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

以下是客户端代码示例,(依赖模板语言,此处用handlebars为例),设置 csrfToken 值作为隐藏域字段名为 _csrf 的值:

<form action="/process" method="POST">
    <input type="hidden" name="_csrf" value="{{csrfToken}}">
    
    Favorite color: <input type="text" name="favoriteColor">
    <button type="submit">Submit</button>
</form>

忽略路由

注意:

  • 允许本网站以外请求并不需要验证的,可以禁用CSRF验证。

  • 不要只对你自己的网站请求启用CSRF验证。

  • 一个存在的session,即使它属于认证用户,不足于满足防范CSRF攻击。

以下是如何�请求理由的示例,以便某些路由不验证有效的CSRF令牌。

var express = require('express'),             // express框架
    bodyparser = require('body-parser'),      // 使用POST,需要引入此中间件来解析URL编码体
    cookieParser = require('cookie-parser'),  // cookie中间件,csurf需依赖它
    csrf = require('csurf');                  // csurf中间件


var app = express()

// 创建api路由
var api = function(){
    var router = new express.Router()

    router.post('/getProfile', function (req, res) {
        res.send('这里没有csrf')
    })

    return router
}

// 在crsf被创建前使用api中间件,不会csrf验证
app.use('/api', api)

// 在 "/api" 后, 现在加入crsf和其他中间件
app.use(bodyParser.urlencoded({ extended: false }))
app.use(cookieParser())
app.use(csrf({ cookie: true }))

app.get('/form', function (req, res) {
    // 把 csrfToken 传递给视图
    res.render('send', { csrfToken: req.csrfToken() })
})

自定义错误处理

当CSRF令牌验证失败,抛出一个错误 err.code === 'EBADCSRFTOKEN'。这能用于显示自定义错误信息。

var express = require('express'),             // express框架
    bodyparser = require('body-parser'),      // 使用POST,需要引入此中间件来解析URL编码体
    cookieParser = require('cookie-parser'),  // cookie中间件,csurf需依赖它
    csrf = require('csurf');                  // csurf中间件

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

// 错误处理
app.use(function (err, req, res, next) {
    if (err.code !== 'EBADCSRFTOKEN') return next(err)

    // CSRF验证失败
    res.status(403)
    res.send('form tampered with')
})
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容