Tough Cookie ·

A Node.js implementation of RFC6265 for cookie parsing, storage, and retrieval.

Getting Started

Install Tough Cookie using npm:

1npm install tough-cookie

or yarn:

1yarn add tough-cookie

Usage

1import { Cookie, CookieJar } from 'tough-cookie'
2
3// parse a `Cookie` request header
4const reqCookies = 'ID=298zf09hf012fh2; csrf=u32t4o3tb3gg43; _gat=1'.split(';').map(Cookie.parse)
5// generate a `Cookie` request header
6const cookieHeader = reqCookies.map(cookie => cookie.cookieString()).join(';')
7
8// parse a Set-Cookie response header
9const resCookie = Cookie.parse('foo=bar; Domain=example.com; Path=/; Expires=Tue, 21 Oct 2025 00:00:00 GMT')
10// generate a Set-Cookie response header
11const setCookieHeader = cookie.toString()
12
13// store and retrieve cookies
14const cookieJar = new CookieJar() // uses the in-memory store by default
15await cookieJar.setCookie(resCookie, 'https://example.com/')
16const matchingCookies = await cookieJar.getCookies('https://example.com/')

[!IMPORTANT] For more detailed usage information, refer to the API docs.

RFC6265bis

Support for RFC6265bis is being developed. As these revisions to RFC6252 are still in Active Internet-Draft state, the areas of support that follow are subject to change.

SameSite Cookies

This change makes it possible for servers, and supporting clients, to mitigate certain types of CSRF attacks by disallowing SameSite cookies from being sent cross-origin.

Example

1import { CookieJar } from 'tough-cookie'
2
3const cookieJar = new CookieJar() // uses the in-memory store by default
4
5// storing cookies with various SameSite attributes
6await cookieJar.setCookie('strict=authorized; SameSite=strict', 'http://example.com/index.html')
7await cookieJar.setCookie('lax=okay; SameSite=lax', 'http://example.com/index.html')
8await cookieJar.setCookie('normal=whatever', 'http://example.com/index.html')
9
10// retrieving cookies using a SameSite context
11const laxCookies = await cookieJar.getCookies('http://example.com/index.html', {
12  // the first cookie (strict=authorized) will not be returned if the context is 'lax'
13  // but the other two cookies will be returned
14  sameSiteContext: 'lax',
15})

[!NOTE] It is highly recommended that you read RFC6265bis - Section 8.8 for more details on SameSite cookies, security considerations, and defense in depth.

Cookie Prefixes

Cookie prefixes are a way to indicate that a given cookie was set with a set of attributes simply by inspecting the first few characters of the cookie's name.

Two prefixes are defined:

• "__Secure-"

  If a cookie's name begins with a case-sensitive match for the string __Secure-, then the cookie was set with a "Secure" attribute.

• "__Host-"

  If a cookie's name begins with a case-sensitive match for the string __Host-, then the cookie was set with a "Secure" attribute, a "Path" attribute with a value of "/", and no "Domain" attribute.

If prefixSecurity is enabled for CookieJar, then cookies that match the prefixes defined above but do not obey the attribute restrictions are not added.

You can define this functionality by passing in the prefixSecurity option to CookieJar. It can be one of 3 values:

1. silent: (default) Enable cookie prefix checking but silently fail to add the cookie if conditions are not met.
2. strict: Enable cookie prefix checking and error out if conditions are not met.
3. unsafe-disabled: Disable cookie prefix checking.

If ignoreError is passed in as true when setting a cookie then the error is silent regardless of the prefixSecurity option (assuming it's enabled).

Example

1import { CookieJar, MemoryCookieStore } from 'tough-cookie'
2
3const cookieJar = new CookieJar(new MemoryCookieStore(), {
4  prefixSecurity: 'silent'
5})
6
7// this cookie will be silently ignored since the url is insecure (http)
8await cookieJar.setCookie(
9  '__Secure-SID=12345; Domain=example.com; Secure;',
10  'http://example.com',
11)
12
13// this cookie will be stored since the url is secure (https)
14await cookieJar.setCookie(
15  '__Secure-SID=12345; Domain=example.com; Secure;',
16  'https://example.com',
17)

[!NOTE] It is highly recommended that you read RFC6265bis - Section 4.1.3 for more details on Cookie Prefixes.

Node.js Version Support

We follow the Node.js release schedule and support all versions that are in Active LTS or Maintenance. We will always do a major release when dropping support for older versions of node, and we will do so in consultation with our community.