deps/npm/node_modules/request/node_modules/tough-cookie/README.md

   1 [RFC6265](http://tools.ietf.org/html/rfc6265) Cookies and CookieJar for Node.js
   2
   3 ![Tough Cookie](http://www.goinstant.com.s3.amazonaws.com/tough-cookie.jpg)
   4
   5 # Synopsis
   6
   7 ``` javascript
   8 var cookies = require('tough-cookie'); // note: not 'cookie', 'cookies' or 'node-cookie'
   9 var Cookie = cookies.Cookie;
  10 var cookie = Cookie.parse(header);
  11 cookie.value = 'somethingdifferent';
  12 header = cookie.toString();
  13
  14 var cookiejar = new cookies.CookieJar();
  15 cookiejar.setCookie(cookie, 'http://currentdomain.example.com/path', cb);
  16 // ...
  17 cookiejar.getCookies('http://example.com/otherpath',function(err,cookies) {
  18   res.headers['cookie'] = cookies.join('; ');
  19 });
  20 ```
  21
  22 # Installation
  23
  24 It's _so_ easy!
  25
  26 `npm install tough-cookie`
  27
  28 Requires `punycode`, which should get installed automatically for you.  Note that node.js v0.6.2+ bundles punycode by default.
  29
  30 Why the name?  NPM modules `cookie`, `cookies` and `cookiejar` were already taken.
  31
  32 # API
  33
  34 cookies
  35 =======
  36
  37 Functions on the module you get from `require('tough-cookie')`.  All can be used as pure functions and don't need to be "bound".
  38
  39 parseDate(string[,strict])
  40 -----------------
  41
  42 Parse a cookie date string into a `Date`.  Parses according to RFC6265 Section 5.1.1, not `Date.parse()`.  If strict is set to true then leading/trailing non-seperator characters around the time part will cause the parsing to fail (e.g. "Thu, 01 Jan 1970 00:00:010 GMT" has an extra trailing zero but Chrome, an assumedly RFC-compliant browser, treats this as valid).
  43
  44 formatDate(date)
  45 ----------------
  46
  47 Format a Date into a RFC1123 string (the RFC6265-recommended format).
  48
  49 canonicalDomain(str)
  50 --------------------
  51
  52 Transforms a domain-name into a canonical domain-name.  The canonical domain-name is a trimmed, lowercased, stripped-of-leading-dot and optionally punycode-encoded domain-name (Section 5.1.2 of RFC6265).  For the most part, this function is idempotent (can be run again on its output without ill effects).
  53
  54 domainMatch(str,domStr[,canonicalize=true])
  55 -------------------------------------------
  56
  57 Answers "does this real domain match the domain in a cookie?".  The `str` is the "current" domain-name and the `domStr` is the "cookie" domain-name.  Matches according to RFC6265 Section 5.1.3, but it helps to think of it as a "suffix match".
  58
  59 The `canonicalize` parameter will run the other two paramters through `canonicalDomain` or not.
  60
  61 defaultPath(path)
  62 -----------------
  63
  64 Given a current request/response path, gives the Path apropriate for storing in a cookie.  This is basically the "directory" of a "file" in the path, but is specified by Section 5.1.4 of the RFC.
  65
  66 The `path` parameter MUST be _only_ the pathname part of a URI (i.e. excludes the hostname, query, fragment, etc.).  This is the `.pathname` property of node's `uri.parse()` output.
  67
  68 pathMatch(reqPath,cookiePath)
  69 -----------------------------
  70
  71 Answers "does the request-path path-match a given cookie-path?" as per RFC6265 Section 5.1.4.  Returns a boolean.
  72
  73 This is essentially a prefix-match where `cookiePath` is a prefix of `reqPath`.
  74
  75 parse(header[,strict=false])
  76 ----------------------------
  77
  78 alias for `Cookie.parse(header[,strict])`
  79
  80 fromJSON(string)
  81 ----------------
  82
  83 alias for `Cookie.fromJSON(string)`
  84
  85 getPublicSuffix(hostname)
  86 -------------------------
  87
  88 Returns the public suffix of this hostname.  The public suffix is the shortest domain-name upon which a cookie can be set.  Returns `null` if the hostname cannot have cookies set for it.
  89
  90 For example: `www.example.com` and `www.subdomain.example.com` both have public suffix `example.com`.
  91
  92 For further information, see http://publicsuffix.org/.  This module derives its list from that site.
  93
  94 cookieCompare(a,b)
  95 ------------------
  96
  97 For use with `.sort()`, sorts a list of cookies into the recommended order given in the RFC (Section 5.4 step 2).  Longest `.path`s go first, then sorted oldest to youngest.
  98
  99 ``` javascript
 100 var cookies = [ /* unsorted array of Cookie objects */ ];
 101 cookies = cookies.sort(cookieCompare);
 102 ```
 103
 104 permuteDomain(domain)
 105 ---------------------
 106
 107 Generates a list of all possible domains that `domainMatch()` the parameter.  May be handy for implementing cookie stores.
 108
 109
 110 permutePath(path)
 111 -----------------
 112
 113 Generates a list of all possible paths that `pathMatch()` the parameter.  May be handy for implementing cookie stores.
 114
 115 Cookie
 116 ======
 117
 118 Cookie.parse(header[,strict=false])
 119 -----------------------------------
 120
 121 Parses a single Cookie or Set-Cookie HTTP header into a `Cookie` object.  Returns `undefined` if the string can't be parsed.  If in strict mode, returns `undefined` if the cookie doesn't follow the guidelines in section 4 of RFC6265.  Generally speaking, strict mode can be used to validate your own generated Set-Cookie headers, but acting as a client you want to be lenient and leave strict mode off.
 122
 123 Here's how to process the Set-Cookie header(s) on a node HTTP/HTTPS response:
 124
 125 ``` javascript
 126 if (res.headers['set-cookie'] instanceof Array)
 127   cookies = res.headers['set-cookie'].map(Cookie.parse);
 128 else
 129   cookies = [Cookie.parse(res.headers['set-cookie'])];
 130 ```
 131
 132 Cookie.fromJSON(string)
 133 -----------------------
 134
 135 Convert a JSON string to a `Cookie` object.  Does a `JSON.parse()` and converts the `.created`, `.lastAccessed` and `.expires` properties into `Date` objects.
 136
 137 Properties
 138 ==========
 139
 140   * _key_ - string - the name or key of the cookie (default "")
 141   * _value_ - string - the value of the cookie (default "")
 142   * _expires_ - `Date` - if set, the `Expires=` attribute of the cookie (defaults to the string `"Infinity"`). See `setExpires()`
 143   * _maxAge_ - seconds - if set, the `Max-Age=` attribute _in seconds_ of the cookie.  May also be set to strings `"Infinity"` and `"-Infinity"` for non-expiry and immediate-expiry, respectively.  See `setMaxAge()`
 144   * _domain_ - string - the `Domain=` attribute of the cookie
 145   * _path_ - string - the `Path=` of the cookie
 146   * _secure_ - boolean - the `Secure` cookie flag
 147   * _httpOnly_ - boolean - the `HttpOnly` cookie flag
 148   * _extensions_ - `Array` - any unrecognized cookie attributes as strings (even if equal-signs inside)
 149
 150 After a cookie has been passed through `CookieJar.setCookie()` it will have the following additional attributes:
 151
 152   * _hostOnly_ - boolean - is this a host-only cookie (i.e. no Domain field was set, but was instead implied)
 153   * _pathIsDefault_ - boolean - if true, there was no Path field on the cookie and `defaultPath()` was used to derive one.
 154   * _created_ - `Date` - when this cookie was added to the jar
 155   * _lastAccessed_ - `Date` - last time the cookie got accessed. Will affect cookie cleaning once implemented.  Using `cookiejar.getCookies(...)` will update this attribute.
 156
 157 Construction([{options}])
 158 ------------
 159
 160 Receives an options object that can contain any Cookie properties, uses the default for unspecified properties.
 161
 162 .toString()
 163 -----------
 164
 165 encode to a Set-Cookie header value.  The Expires cookie field is set using `formatDate()`, but is omitted entirely if `.expires` is `Infinity`.
 166
 167 .cookieString()
 168 ---------------
 169
 170 encode to a Cookie header value (i.e. the `.key` and `.value` properties joined with '=').
 171
 172 .setExpires(String)
 173 -------------------
 174
 175 sets the expiry based on a date-string passed through `parseDate()`.  If parseDate returns `null` (i.e. can't parse this date string), `.expires` is set to `"Infinity"` (a string) is set.
 176
 177 .setMaxAge(number)
 178 -------------------
 179
 180 sets the maxAge in seconds.  Coerces `-Infinity` to `"-Infinity"` and `Infinity` to `"Infinity"` so it JSON serializes correctly.
 181
 182 .expiryTime([now=Date.now()])
 183 -----------------------------
 184
 185 .expiryDate([now=Date.now()])
 186 -----------------------------
 187
 188 expiryTime() Computes the absolute unix-epoch milliseconds that this cookie expires. expiryDate() works similarly, except it returns a `Date` object.  Note that in both cases the `now` parameter should be milliseconds.
 189
 190 Max-Age takes precedence over Expires (as per the RFC). The `.created` attribute -- or, by default, the `now` paramter -- is used to offset the `.maxAge` attribute.
 191
 192 If Expires (`.expires`) is set, that's returned.
 193
 194 Otherwise, `expiryTime()` returns `Infinity` and `expiryDate()` returns a `Date` object for "Tue, 19 Jan 2038 03:14:07 GMT" (latest date that can be expressed by a 32-bit `time_t`; the common limit for most user-agents).
 195
 196 .TTL([now=Date.now()])
 197 ---------
 198
 199 compute the TTL relative to `now` (milliseconds).  The same precedence rules as for `expiryTime`/`expiryDate` apply.
 200
 201 The "number" `Infinity` is returned for cookies without an explicit expiry and `0` is returned if the cookie is expired.  Otherwise a time-to-live in milliseconds is returned.
 202
 203 .canonicalizedDoman()
 204 ---------------------
 205
 206 .cdomain()
 207 ----------
 208
 209 return the canonicalized `.domain` field.  This is lower-cased and punycode (RFC3490) encoded if the domain has any non-ASCII characters.
 210
 211 .validate()
 212 -----------
 213
 214 Status: *IN PROGRESS*. Works for a few things, but is by no means comprehensive.
 215
 216 validates cookie attributes for semantic correctness.  Useful for "lint" checking any Set-Cookie headers you generate.  For now, it returns a boolean, but eventually could return a reason string -- you can future-proof with this construct:
 217
 218 ``` javascript
 219 if (cookie.validate() === true) {
 220   // it's tasty
 221 } else {
 222   // yuck!
 223 }
 224 ```
 225
 226 CookieJar
 227 =========
 228
 229 Construction([store = new MemoryCookieStore()][, rejectPublicSuffixes])
 230 ------------
 231
 232 Simply use `new CookieJar()`.  If you'd like to use a custom store, pass that to the constructor otherwise a `MemoryCookieStore` will be created and used.
 233
 234
 235 Attributes
 236 ----------
 237
 238   * _rejectPublicSuffixes_ - boolean - reject cookies with domains like "com" and "co.uk" (default: `true`)
 239
 240 Since eventually this module would like to support database/remote/etc. CookieJars, continuation passing style is used for CookieJar methods.
 241
 242 .setCookie(cookieOrString, currentUrl, [{options},] cb(err,cookie))
 243 -------------------------------------------------------------------
 244
 245 Attempt to set the cookie in the cookie jar.  If the operation fails, an error will be given to the callback `cb`, otherwise the cookie is passed through.  The cookie will have updated `.created`, `.lastAccessed` and `.hostOnly` properties.
 246
 247 The `options` object can be omitted and can have the following properties:
 248
 249   * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API.  Affects HttpOnly cookies.
 250   * _secure_ - boolean - autodetect from url - indicates if this is a "Secure" API.  If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.
 251   * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies
 252   * _strict_ - boolean - default `false` - perform extra checks
 253   * _ignoreError_ - boolean - default `false` - silently ignore things like parse errors and invalid domains.  CookieStore errors aren't ignored by this option.
 254
 255 As per the RFC, the `.hostOnly` property is set if there was no "Domain=" parameter in the cookie string (or `.domain` was null on the Cookie object).  The `.domain` property is set to the fully-qualified hostname of `currentUrl` in this case.  Matching this cookie requires an exact hostname match (not a `domainMatch` as per usual).
 256
 257 .storeCookie(cookie, [{options},] cb(err,cookie))
 258 -------------------------------------------------
 259
 260 __REMOVED__ removed in lieu of the CookieStore API below
 261
 262 .getCookies(currentUrl, [{options},] cb(err,cookies))
 263 -----------------------------------------------------
 264
 265 Retrieve the list of cookies that can be sent in a Cookie header for the current url.
 266
 267 If an error is encountered, that's passed as `err` to the callback, otherwise an `Array` of `Cookie` objects is passed.  The array is sorted with `cookieCompare()` unless the `{sort:false}` option is given.
 268
 269 The `options` object can be omitted and can have the following properties:
 270
 271   * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API.  Affects HttpOnly cookies.
 272   * _secure_ - boolean - autodetect from url - indicates if this is a "Secure" API.  If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.
 273   * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies
 274   * _expire_ - boolean - default `true` - perform expiry-time checking of cookies and asynchronously remove expired cookies from the store.  Using `false` will return expired cookies and **not** remove them from the store (which is useful for replaying Set-Cookie headers, potentially).
 275   * _allPaths_ - boolean - default `false` - if `true`, do not scope cookies by path. The default uses RFC-compliant path scoping. **Note**: may not be supported by the CookieStore `fetchCookies` function (the default MemoryCookieStore supports it).
 276
 277 The `.lastAccessed` property of the returned cookies will have been updated.
 278
 279 .getCookieString(...)
 280 ---------------------
 281
 282 Accepts the same options as `.getCookies()` but passes a string suitable for a Cookie header rather than an array to the callback.  Simply maps the `Cookie` array via `.cookieString()`.
 283
 284 .getSetCookieStrings(...)
 285 -------------------------
 286
 287 Accepts the same options as `.getCookies()` but passes an array of strings suitable for Set-Cookie headers (rather than an array of `Cookie`s) to the callback.  Simply maps the cookie array via `.toString()`.
 288
 289 # CookieStore API
 290
 291 The storage model for each `CookieJar` instance can be replaced with a custom implementation.  The default is `MemoryCookieStore` which can be found in the `lib/memstore.js` file.  The API uses continuation-passing-style to allow for asynchronous stores.
 292
 293 All `domain` parameters will have been normalized before calling.
 294
 295 The Cookie store must have all of the following methods.
 296
 297 store.findCookie(domain, path, key, cb(err,cookie))
 298 ---------------------------------------------------
 299
 300 Retrieve a cookie with the given domain, path and key (a.k.a. name).  The RFC maintains that exactly one of these cookies should exist in a store.  If the store is using versioning, this means that the latest/newest such cookie should be returned.
 301
 302 Callback takes an error and the resulting `Cookie` object.  If no cookie is found then `null` MUST be passed instead (i.e. not an error).
 303
 304 store.findCookies(domain, path, cb(err,cookies))
 305 ------------------------------------------------
 306
 307 Locates cookies matching the given domain and path.  This is most often called in the context of `cookiejar.getCookies()` above.
 308
 309 If no cookies are found, the callback MUST be passed an empty array.
 310
 311 The resulting list will be checked for applicability to the current request according to the RFC (domain-match, path-match, http-only-flag, secure-flag, expiry, etc.), so it's OK to use an optimistic search algorithm when implementing this method.  However, the search algorithm used SHOULD try to find cookies that `domainMatch()` the domain and `pathMatch()` the path in order to limit the amount of checking that needs to be done.
 312
 313 As of version 0.9.12, the `allPaths` option to `cookiejar.getCookies()` above will cause the path here to be `null`.  If the path is `null`, path-matching MUST NOT be performed (i.e. domain-matching only).
 314
 315 store.putCookie(cookie, cb(err))
 316 --------------------------------
 317
 318 Adds a new cookie to the store.  The implementation SHOULD replace any existing cookie with the same `.domain`, `.path`, and `.key` properties -- depending on the nature of the implementation, it's possible that between the call to `fetchCookie` and `putCookie` that a duplicate `putCookie` can occur.
 319
 320 The `cookie` object MUST NOT be modified; the caller will have already updated the `.creation` and `.lastAccessed` properties.
 321
 322 Pass an error if the cookie cannot be stored.
 323
 324 store.updateCookie(oldCookie, newCookie, cb(err))
 325 -------------------------------------------------
 326
 327 Update an existing cookie.  The implementation MUST update the `.value` for a cookie with the same `domain`, `.path` and `.key`.  The implementation SHOULD check that the old value in the store is equivalent to `oldCookie` - how the conflict is resolved is up to the store.
 328
 329 The `.lastAccessed` property will always be different between the two objects and `.created` will always be the same.  Stores MAY ignore or defer the `.lastAccessed` change at the cost of affecting how cookies are sorted (or selected for deletion).
 330
 331 Stores may wish to optimize changing the `.value` of the cookie in the store versus storing a new cookie.  If the implementation doesn't define this method a stub that calls `putCookie(newCookie,cb)` will be added to the store object.
 332
 333 The `newCookie` and `oldCookie` objects MUST NOT be modified.
 334
 335 Pass an error if the newCookie cannot be stored.
 336
 337 store.removeCookie(domain, path, key, cb(err))
 338 ----------------------------------------------
 339
 340 Remove a cookie from the store (see notes on `findCookie` about the uniqueness constraint).
 341
 342 The implementation MUST NOT pass an error if the cookie doesn't exist; only pass an error due to the failure to remove an existing cookie.
 343
 344 store.removeCookies(domain, path, cb(err))
 345 ------------------------------------------
 346
 347 Removes matching cookies from the store.  The `path` paramter is optional, and if missing means all paths in a domain should be removed.
 348
 349 Pass an error ONLY if removing any existing cookies failed.
 350
 351 # TODO
 352
 353   * _full_ RFC5890/RFC5891 canonicalization for domains in `cdomain()`
 354     * the optional `punycode` requirement implements RFC3492, but RFC6265 requires RFC5891
 355   * better tests for `validate()`?
 356
 357 # Copyright and License
 358
 359 (tl;dr: MIT with some MPL/1.1)
 360
 361 Copyright GoInstant, Inc. and other contributors. All rights reserved.
 362 Permission is hereby granted, free of charge, to any person obtaining a copy
 363 of this software and associated documentation files (the "Software"), to
 364 deal in the Software without restriction, including without limitation the
 365 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 366 sell copies of the Software, and to permit persons to whom the Software is
 367 furnished to do so, subject to the following conditions:
 368
 369 The above copyright notice and this permission notice shall be included in
 370 all copies or substantial portions of the Software.
 371
 372 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 373 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 374 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 375 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 376 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 377 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 378 IN THE SOFTWARE.
 379
 380 Portions may be licensed under different licenses (in particular public-suffix.txt is MPL/1.1); please read the LICENSE file for full details.