cookie-parser middleware

v1.4.7GitHub Changelog npm

Cookieヘッダを解析し、クッキー名でキー指定されたオブジェクトをreq.cookiesに追加します。 Optionally you may enable signed cookie support by passing a secret string, which assigns req.secret so it may be used by other middleware.

インストール

npm install cookie-parser

cookie-parser does not include its own TypeScript type definitions. If you use TypeScript, also install the community-maintained types from DefinitelyTyped as a development dependency:

npm install --save-dev @types/cookie-parser

API

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

cookieParser(secret, options)

与えられた secret と options を使用して、新しいクッキーパーサミドルウェア関数を作成します。

secret cookieへの署名に使用される文字列または配列。これはオプションで、が指定されていない場合、署名されたクッキーを解析しません。文字列が与えられた場合、このがシークレットとして使用されます。配列が指定された場合、シークレットごとにクッキーの署名を解除しようとします。
options 2 番目のオプションとして cookie.parse に渡されるオブジェクト。詳細は cookie を参照してください。
- decode クッキーの値をデコードする関数

The middleware will parse the Cookie header on the request and expose the cookie data as the property req.cookies and, if a secret was provided, as the property req.signedCookies. これらのプロパティは、クッキーの値へのクッキー名の名前値のペアです。

secret が提供されると、このモジュールは署名を解除して署名された Cookie の値を検証し、それらの値のペアを req.cookies から req.signedCookies に移動します。署名されたクッキーは、:の前に値が付いたクッキーです。署名済みクッキー失敗する署名検証は、改ざんされた値の代わりに false になります。

さらに、このモジュールは特別な「JSON Cookie」をサポートしています。これらはの前にj:が付いているクッキーです。これらの値に遭遇すると、値はが JSON.parse` の結果として公開されます。解析に失敗した場合、元の値はのままになります。

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

var app = express();
app.use(cookieParser());

app.get('/', function (req, res) {
  // Cookies that have not been signed
  console.log('Cookies: ', req.cookies);

  // Cookies that have been signed
  console.log('Signed Cookies: ', req.signedCookies);
});

app.listen(8080);

// curl command that sends an HTTP request with two cookies
// curl http://127.0.0.1:8080 --cookie "Cho=Kim;Greet=Hello"

ライセンス

MIT

cookie-parser middleware

インストール

API

cookieParser(secret, options)

cookieParser.JSONCookie(str)

cookieParser.JSONCookies(cookies)

cookieParser.signedCookie(str, secret)

cookieParser.signedCookies(cookie, secret)

例

ライセンス