Express使用進階：cookie-parser中間件實現深刻剖析

文章導讀

cookie-parser是Express的中間件，用來實現cookie的解析，是官方腳手架內置的中間件之一。

它的使用很是簡單，但在使用過程當中偶爾也會遇到問題。通常都是由於對Express + cookie-parser的簽名、驗證機制不瞭解致使的。

本文深刻講解Express + cookie-parser的簽名和驗證的實現機制，以及cookie簽名是如何加強網站的安全性的。

文本同步收錄於GitHub主題系列《Nodejs學習筆記》

入門例子：cookie設置與解析

先從最簡單的例子來看下cookie-parser的使用，這裏採用默認配置。

1. cookie設置：使用Express的內置方法res.cookie()。
2. cookie解析：使用cookie-parser中間件。

var express = require('express');
var cookieParser = require('cookie-parser');
var app = express();

app.use(cookieParser());

app.use(function (req, res, next) {
  console.log(req.cookies.nick); // 第二次訪問，輸出chyingp
  next();
});

app.use(function (req, res, next) {  
  res.cookie('nick', 'chyingp');
  res.end('ok');
});

app.listen(3000);
複製代碼

在當前場景下，cookie-parser中間件大體實現以下：

app.use(function (req, res, next) {
  req.cookies = cookie.parse(req.headers.cookie);
  next();
});
複製代碼

進階例子：cookie簽名與解析

出於安全的考慮，咱們一般須要對cookie進行簽名。

例子改寫以下，有幾個注意點：

1. cookieParser初始化時，傳入secret做爲簽名的祕鑰。
2. 設置cookie時，將signed設置爲true，表示對即將設置的cookie進行簽名。
3. 獲取cookie時，能夠經過req.cookies，也能夠經過req.signedCookies獲取。

var express = require('express');
var cookieParser = require('cookie-parser');
var app = express();

// 初始化中間件，傳入的第一個參數爲singed secret
app.use(cookieParser('secret'));

app.use(function (req, res, next) {
  console.log(req.cookies.nick); // chyingp
  console.log(req.signedCookies.nick); // chyingp
  next();
});

app.use(function (req, res, next) {  
  // 傳入第三個參數 {signed: true}，表示要對cookie進行摘要計算
  res.cookie('nick', 'chyingp', {signed: true});
  res.end('ok');
});

app.listen(3000);
複製代碼

簽名前的cookie值爲chyingp，簽名後的cookie值爲s%3Achyingp.uVofnk6k%2B9mHQpdPlQeOfjM8B5oa6mppny9d%2BmG9rD0，decode後爲s:chyingp.uVofnk6k+9mHQpdPlQeOfjM8B5oa6mppny9d+mG9rD0。

下面就來分析下，cookie的簽名、解析是如何實現的。

cookie簽名、驗證明現剖析

Express完成cookie值的簽名，cookie-parser實現簽名cookie的解析。二者共用同一個祕鑰。

cookie簽名

Express對cookie的設置（包括簽名），都是經過res.cookie()這個方法實現的。

精簡後的代碼以下：

res.cookie = function (name, value, options) {  
  var secret = this.req.secret;
  var signed = opts.signed;

  // 若是 options.signed 爲true，則對cookie進行簽名
  if (signed) {
    val = 's:' + sign(val, secret);
  }

  this.append('Set-Cookie', cookie.serialize(name, String(val), opts));

  return this;
};
複製代碼

sign爲簽名函數。僞代碼以下，其實就是把cookie的原始值，跟hmac後的值拼接起來。

敲黑板劃重點：簽名後的cookie值，包含了原始值。

function sign (val, secret) {
  return val + '.' + hmac(val, secret);
}
複製代碼

這裏的secret哪來的呢？是cookie-parser初始化的時候傳入的。以下僞代碼所示：

var cookieParser = function (secret) {
  return function (req, res, next) {
    req.secret = secret;
    // ...
    next();
  };
};

app.use(cookieParser('secret'));
複製代碼

簽名cookie解析

知道了cookie簽名的機制後，如何"解析"簽名cookie就很清楚了。這個階段，中間件主要作了兩件事：

1. 將簽名cookie對應的原始值提取出來
2. 驗證簽名cookie是否合法

實現代碼以下：

// str：簽名後的cookie，好比 "s:chyingp.uVofnk6k+9mHQpdPlQeOfjM8B5oa6mppny9d+mG9rD0"
// secret：祕鑰，好比 "secret"
function signedCookie(str, secret) {

  // 檢查是否 s: 開頭，確保只對簽過名的cookie進行解析
  if (str.substr(0, 2) !== 's:') {
    return str;
  }

  // 校驗簽名的值是否合法，如合法，返回true，不然，返回false
  var val = unsign(str.slice(2), secret);
  
  if (val !== false) {
    return val;
  }

  return false;
}
複製代碼

判斷、提取cookie原始值比較簡單。只是是unsign方法名比較有迷惑性。

通常只會對簽名進行合法校驗，並無所謂的反簽名。

unsign方法的代碼以下：

1. 首先，從傳入的cookie值中，分別提取出原始值A一、簽名值B1。
2. 其次，用一樣的祕鑰對A1進行簽名，獲得A2。
3. 最後，根據A二、B1是否相等，判斷簽名是否合法。

exports.unsign = function(val, secret){
  var str = val.slice(0, val.lastIndexOf('.'))
    , mac = exports.sign(str, secret);
  
  return sha1(mac) == sha1(val) ? str : false;
};
複製代碼

cookie簽名的做用

主要是出於安全考慮，防止cookie被篡改，加強安全性。

舉個小例子來看下cookie簽名是如何實現防篡改的。

基於前面的例子展開。假設網站經過nick這個cookie來區分當前登陸的用戶是誰。在前面例子中，登陸用戶的cookie中，nick對應的值以下：(decode後的)

s:chyingp.uVofnk6k+9mHQpdPlQeOfjM8B5oa6mppny9d+mG9rD0
複製代碼

此時，有人試圖修改這個cookie值，來達到僞造身份的目的。好比修改爲xiaoming：

s:xiaoming.uVofnk6k+9mHQpdPlQeOfjM8B5oa6mppny9d+mG9rD0
複製代碼

當網站收到請求，對簽名cookie進行解析，發現簽名驗證不經過。由此可判斷，cookie是僞造的。

hmac("xiaoming", "secret") !== "uVofnk6k+9mHQpdPlQeOfjM8B5oa6mppny9d+mG9rD0"
複製代碼

簽名就必定可以確保安全嗎

固然不是。

上個小節的例子，僅經過nick這個cookie的值來判斷登陸的是哪一個用戶，這是一個很是糟糕的設計。雖然在祕鑰未知的狀況下，很難僞造簽名cookie。但用戶名相同的狀況下，簽名也是相同的。這種狀況下，實際上是很容易僞造的。

另外，開源組件的算法是公開的，所以祕鑰的安全性就成了關鍵，要確保祕鑰不泄露。

還有不少，這裏不展開。

小結

本文主要對Express + cookie-parser的簽名和解析機制進行相對深刻的介紹。

很多相似的總結文章中，把cookie的簽名說成了加密，這是一個常見的錯誤，讀者朋友須要注意一下。

簽名部分的介紹，稍微涉及一些簡單的安全知識，對這塊不熟悉的同窗能夠留言交流。爲講解方便，部分段落、用詞可能不夠嚴謹。若有錯漏，敬請指出。

相關連接

https://github.com/expressjs/cookie-parser

https://github.com/chyingp/nodejs-learning-guide