429 lines
19 KiB
Markdown
429 lines
19 KiB
Markdown
# Cookies, document.cookie
|
|
|
|
Cookies are small strings of data that are stored directly in the browser. They are a part of HTTP protocol, defined by [RFC 6265](https://tools.ietf.org/html/rfc6265) specification.
|
|
|
|
Cookies are usually set by a web-server using response `Set-Cookie` HTTP-header. Then the browser automatically adds them to (almost) every request to the same domain using `Cookie` HTTP-header.
|
|
|
|
One of the most widespread use cases is authentication:
|
|
|
|
1. Upon sign in, the server uses `Set-Cookie` HTTP-header in the response to set a cookie with a unique "session identifier".
|
|
2. Next time when the request is set to the same domain, the browser sends the over the net using `Cookie` HTTP-header.
|
|
3. So the server knows who made the request.
|
|
|
|
We can also access cookies from the browser, using `document.cookie` property.
|
|
|
|
There are many tricky things about cookies and their options. In this chapter we'll cover them in detail.
|
|
|
|
## Reading from document.cookie
|
|
|
|
```online
|
|
Does your browser store any cookies from this site? Let's see:
|
|
```
|
|
|
|
```offline
|
|
Assuming you're on a website, it's possible to see the cookies from it, like this:
|
|
```
|
|
|
|
```js run
|
|
// At javascript.info, we use Google Analytics for statistics,
|
|
// so there should be some cookies
|
|
alert( document.cookie ); // cookie1=value1; cookie2=value2;...
|
|
```
|
|
|
|
|
|
The value of `document.cookie` consists of `name=value` pairs, delimited by `; `. Each one is a separate cookie.
|
|
|
|
To find a particular cookie, we can split `document.cookie` by `; `, and then find the right name. We can use either a regular expression or array functions to do that.
|
|
|
|
We leave it as an exercise for the reader. Also, at the end of the chapter you'll find helper functions to manipulate cookies.
|
|
|
|
## Writing to document.cookie
|
|
|
|
We can write to `document.cookie`. But it's not a data property, it's an accessor (getter/setter). An assignment to it is treated specially.
|
|
|
|
**A write operation to `document.cookie` updates only cookies mentioned in it, but doesn't touch other cookies.**
|
|
|
|
For instance, this call sets a cookie with the name `user` and value `John`:
|
|
|
|
```js run
|
|
document.cookie = "user=John"; // update only cookie named 'user'
|
|
alert(document.cookie); // show all cookies
|
|
```
|
|
|
|
If you run it, then probably you'll see multiple cookies. That's because `document.cookie=` operation does not overwrite all cookies. It only sets the mentioned cookie `user`.
|
|
|
|
Technically, name and value can have any characters, to keep the valid formatting they should be escaped using a built-in `encodeURIComponent` function:
|
|
|
|
```js run
|
|
// special characters (spaces), need encoding
|
|
let name = "my name";
|
|
let value = "John Smith"
|
|
|
|
// encodes the cookie as my%20name=John%20Smith
|
|
document.cookie = encodeURIComponent(name) + '=' + encodeURIComponent(value);
|
|
|
|
alert(document.cookie); // ...; my%20name=John%20Smith
|
|
```
|
|
|
|
|
|
```warn header="Limitations"
|
|
There are few limitations:
|
|
- The `name=value` pair, after `encodeURIComponent`, should not exceed 4kb. So we can't store anything huge in a cookie.
|
|
- The total number of cookies per domain is limited to around 20+, the exact limit depends on a browser.
|
|
```
|
|
|
|
Cookies have several options, many of them are important and should be set.
|
|
|
|
The options are listed after `key=value`, delimited by `;`, like this:
|
|
|
|
```js run
|
|
document.cookie = "user=John; path=/; expires=Tue, 19 Jan 2038 03:14:07 GMT"
|
|
```
|
|
|
|
## path
|
|
|
|
- **`path=/mypath`**
|
|
|
|
The url path prefix, the cookie will be accessible for pages under that path. Must be absolute. By default, it's the current path.
|
|
|
|
If a cookie is set with `path=/admin`, it's visible at pages `/admin` and `/admin/something`, but not at `/home` or `/adminpage`.
|
|
|
|
Usually, we should set `path` to the root: `path=/` to make the cookie accessible from all website pages.
|
|
|
|
## domain
|
|
|
|
- **`domain=site.com`**
|
|
|
|
A domain where the cookie is accessible. In practice though, there are limitations. We can't set any domain.
|
|
|
|
By default, a cookie is accessible only at the domain that set it. So, if the cookie was set by `site.com`, we won't get it `other.com`.
|
|
|
|
...But what's more tricky, we also won't get the cookie at a subdomain `forum.site.com`!
|
|
|
|
```js
|
|
// at site.com
|
|
document.cookie = "user=John"
|
|
|
|
// at forum.site.com
|
|
alert(document.cookie); // no user
|
|
```
|
|
|
|
**There's no way to let a cookie be accessible from another 2nd-level domain, so `other.com` will never receive a cookie set at `site.com`.**
|
|
|
|
It's a safety restriction, to allow us to store sensitive data in cookies, that should be available only on one site.
|
|
|
|
...But if we'd like to allow subdomains like `forum.site.com` get a cookie, that's possible. When setting a cookie at `site.com`, we should explicitly set `domain` option to the root domain: `domain=site.com`:
|
|
|
|
```js
|
|
// at site.com
|
|
// make the cookie accessible on any subdomain *.site.com:
|
|
document.cookie = "user=John; domain=site.com"
|
|
|
|
// later
|
|
|
|
// at forum.site.com
|
|
alert(document.cookie); // has cookie user=John
|
|
```
|
|
|
|
For historical reasons, `domain=.site.com` (a dot before `site.com`) also works the same way, allowing access to the cookie from subdomains. That's an old notation, should be used if we need to support very old browsers.
|
|
|
|
So, `domain` option allows to make a cookie accessible at subdomains.
|
|
|
|
## expires, max-age
|
|
|
|
By default, if a cookie doesn't have one of these options, it disappears when the browser is closed. Such cookies are called "session cookies"
|
|
|
|
To let cookies survive browser close, we can set either `expires` or `max-age` option.
|
|
|
|
- **`expires=Tue, 19 Jan 2038 03:14:07 GMT`**
|
|
|
|
Cookie expiration date, when the browser will delete it automatically.
|
|
|
|
The date must be exactly in this format, in GMT timezone. We can use `date.toUTCString` to get it. For instance, we can set the cookie to expire in 1 day:
|
|
|
|
```js
|
|
// +1 day from now
|
|
let date = new Date(Date.now() + 86400e3);
|
|
date = date.toUTCString();
|
|
document.cookie = "user=John; expires=" + date;
|
|
```
|
|
|
|
If we set `expires` to a date in the past, the cookie is deleted.
|
|
|
|
- **`max-age=3600`**
|
|
|
|
An alternative to `expires`, specifies the cookie expiration in seconds from the current moment.
|
|
|
|
If zero or negative, then the cookie is deleted:
|
|
|
|
```js
|
|
// cookie will die +1 hour from now
|
|
document.cookie = "user=John; max-age=3600";
|
|
|
|
// delete cookie (let it expire right now)
|
|
document.cookie = "user=John; max-age=0";
|
|
```
|
|
|
|
## secure
|
|
|
|
- **`secure`**
|
|
|
|
The cookie should be transferred only over HTTPS.
|
|
|
|
**By default, if we set a cookie at `http://site.com`, then it also appears at `https://site.com` and vice versa.**
|
|
|
|
That is, cookies are domain-based, they do not distinguish between the protocols.
|
|
|
|
With this option, if a cookie is set by `https://site.com`, then it doesn't appear when the same site is accessed by HTTP, as `http://site.com`. So if a cookie has sensitive content that should never be sent over unencrypted HTTP, then the flag is the right thing.
|
|
|
|
```js
|
|
// assuming we're on https:// now
|
|
// set the cookie secure (only accessible if over HTTPS)
|
|
document.cookie = "user=John; secure";
|
|
```
|
|
|
|
## samesite
|
|
|
|
That's another security attribute `samesite`. It's designed to protect from so-called XSRF (cross-site request forgery) attacks.
|
|
|
|
To understand how it works and when it's useful, let's take a look at XSRF attacks.
|
|
|
|
### XSRF attack
|
|
|
|
Imagine, you are logged into the site `bank.com`. That is: you have an authentication cookie from that site. Your browser sends it to `bank.com` with every request, so that it recognizes you and performs all sensitive financial operations.
|
|
|
|
Now, while browsing the web in another window, you accidentally come to another site `evil.com`. That site has JavaScript code that submits a form `<form action="https://bank.com/pay">` to `bank.com` with fields that initiate a transaction to the hacker's account.
|
|
|
|
The browser sends cookies every time you visit the site `bank.com`, even if the form was submitted from `evil.com`. So the bank recognizes you and actually performs the payment.
|
|
|
|
|
|
|
|
That's called a "Cross-Site Request Forgery" (in short, XSRF) attack.
|
|
|
|
Real banks are protected from it of course. All forms generated by `bank.com` have a special field, so called "XSRF protection token", that an evil page can't generate or extract from a remote page (it can submit a form there, but can't get the data back). And the site `bank.com` checks for such token in every form it receives.
|
|
|
|
But such protection takes time to implement: we need to ensure that every form has the token field, and we must also check all requests.
|
|
|
|
### Enter cookie samesite option
|
|
|
|
The cookie `samesite` option provides another way to protect from such attacks, that (in theory) should not require "xsrf protection tokens".
|
|
|
|
It has two possible values:
|
|
|
|
- **`samesite=strict` (same as `samesite` without value)**
|
|
|
|
A cookie with `samesite=strict` is never sent if the user comes from outside the same site.
|
|
|
|
In other words, whether a user follows a link from their mail or submits a form from `evil.com`, or does any operation that originates from another domain, the cookie is not sent.
|
|
|
|
If authentication cookies have `samesite` option, then XSRF attack has no chances to succeed, because a submission from `evil.com` comes without cookies. So `bank.com` will not recognize the user and will not proceed with the payment.
|
|
|
|
The protection is quite reliable. Only operations that come from `bank.com` will send the `samesite` cookie, e.g. a form submission from another page at `bank.com`.
|
|
|
|
Although, there's a small inconvenience.
|
|
|
|
When a user follows a legitimate link to `bank.com`, like from their own notes, they'll be surprised that `bank.com` does not recognize them. Indeed, `samesite=strict` cookies are not sent in that case.
|
|
|
|
We could work around that by using two cookies: one for "general recognition", only for the purposes of saying: "Hello, John", and the other one for data-changing operations with `samesite=strict`. Then a person coming from outside of the site will see a welcome, but payments must be initiated from the bank website, for the second cookie to be sent.
|
|
|
|
- **`samesite=lax`**
|
|
|
|
A more relaxed approach that also protects from XSRF and doesn't break user experience.
|
|
|
|
Lax mode, just like `strict`, forbids the browser to send cookies when coming from outside the site, but adds an exception.
|
|
|
|
A `samesite=lax` cookie is sent if both of these conditions are true:
|
|
1. The HTTP method is "safe" (e.g. GET, but not POST).
|
|
|
|
The full list of safe HTTP methods is in the [RFC7231 specification](https://tools.ietf.org/html/rfc7231). Basically, these are the methods that should be used for reading, but not writing the data. They must not perform any data-changing operations. Following a link is always GET, the safe method.
|
|
|
|
2. The operation performs top-level navigation (changes URL in the browser address bar).
|
|
|
|
That's usually true, but if the navigation is performed in an `<iframe>`, then it's not top-level. Also, JavaScript methods for network requests do not perform any navigation, hence they don't fit.
|
|
|
|
So, what `samesite=lax` does is basically allows a most common "go to URL" operation to have cookies. E.g. opening a website link from notes satisfies these conditions.
|
|
|
|
But anything more complicated, like a network request from another site or a form submittion loses cookies.
|
|
|
|
If that's fine for you, then adding `samesite=lax` will probably not break the user experience and add protection.
|
|
|
|
Overall, `samesite` is a great option, but it has an important drawback:
|
|
- `samesite` is ignored (not supported) by old browsers, year 2017 or so.
|
|
|
|
**So if we solely rely on `samesite` to provide protection, then old browsers will be vulnerable.**
|
|
|
|
But we surely can use `samesite` together with other protection measures, like xsrf tokens, to add an additional layer of defence and then, in the future, when old browsers die out, we'll probably be able to drop xsrf tokens.
|
|
|
|
## httpOnly
|
|
|
|
This option has nothing to do with JavaScript, but we have to mention it for completeness.
|
|
|
|
The web-server uses `Set-Cookie` header to set a cookie. And it may set the `httpOnly` option.
|
|
|
|
This option forbids any JavaScript access to the cookie. We can't see such cookie or manipulate it using `document.cookie`.
|
|
|
|
That's used as a precaution measure, to protect from certain attacks when a hacker injects his own JavaScript code into a page and waits for a user to visit that page. That shouldn't be possible at all, a hacker should not be able to inject their code into our site, but there may be bugs that let hackers do it.
|
|
|
|
|
|
Normally, if such thing happens, and a user visits a web-page with hacker's JavaScript code, then that code executes and gains access to `document.cookie` with user cookies containing authentication information. That's bad.
|
|
|
|
But if a cookie is `httpOnly`, then `document.cookie` doesn't see it, so it is protected.
|
|
|
|
## Appendix: Cookie functions
|
|
|
|
Here's a small set of functions to work with cookies, more convenient than a manual modification of `document.cookie`.
|
|
|
|
There exist many cookie libraries for that, so these are for demo purposes. Fully working though.
|
|
|
|
|
|
### getCookie(name)
|
|
|
|
The shortest way to access cookie is to use a [regular expression](info:regular-expressions).
|
|
|
|
The function `getCookie(name)` returns the cookie with the given `name`:
|
|
|
|
```js
|
|
// returns the cookie with the given name,
|
|
// or undefined if not found
|
|
function getCookie(name) {
|
|
let matches = document.cookie.match(new RegExp(
|
|
"(?:^|; )" + name.replace(/([\.$?*|{}\(\)\[\]\\\/\+^])/g, '\\$1') + "=([^;]*)"
|
|
));
|
|
return matches ? decodeURIComponent(matches[1]) : undefined;
|
|
}
|
|
```
|
|
|
|
Here `new RegExp` is generated dynamically, to match `; name=<value>`.
|
|
|
|
Please note that a cookie value is encoded, so `getCookie` uses a built-in `decodeURIComponent` function to decode it.
|
|
|
|
### setCookie(name, value, options)
|
|
|
|
Sets the cookie `name` to the given `value` with `path=/` by default (can be modified to add other defaults):
|
|
|
|
```js run
|
|
function setCookie(name, value, options = {}) {
|
|
|
|
options = {
|
|
path: '/',
|
|
// add other defaults here if necessary
|
|
...options
|
|
};
|
|
|
|
if (options.expires.toUTCString) {
|
|
options.expires = options.expires.toUTCString();
|
|
}
|
|
|
|
let updatedCookie = encodeURIComponent(name) + "=" + encodeURIComponent(value);
|
|
|
|
for (let optionKey in options) {
|
|
updatedCookie += "; " + optionKey;
|
|
let optionValue = options[optionKey];
|
|
if (optionValue !== true) {
|
|
updatedCookie += "=" + optionValue;
|
|
}
|
|
}
|
|
|
|
document.cookie = updatedCookie;
|
|
}
|
|
|
|
// Example of use:
|
|
setCookie('user', 'John', {secure: true, 'max-age': 3600});
|
|
```
|
|
|
|
### deleteCookie(name)
|
|
|
|
To delete a cookie, we can call it with a negative expiration date:
|
|
|
|
```js
|
|
function deleteCookie(name) {
|
|
setCookie(name, "", {
|
|
'max-age': -1
|
|
})
|
|
}
|
|
```
|
|
|
|
```warn header="Updating or deleting must use same path and domain"
|
|
Please note: when we update or delete a cookie, we should use exactly the same path and domain options as when we set it.
|
|
```
|
|
|
|
Together: [cookie.js](cookie.js).
|
|
|
|
|
|
## Appendix: Third-party cookies
|
|
|
|
A cookie is called "third-party" if it's placed by domain other than the page user is visiting.
|
|
|
|
For instance:
|
|
1. A page at `site.com` loads a banner from another site: `<img src="https://ads.com/banner.png">`.
|
|
2. Along with the banner, the remote server at `ads.com` may set `Set-Cookie` header with cookie like `id=1234`. Such cookie originates from `ads.com` domain, and will only be visible at `ads.com`:
|
|
|
|
|
|
|
|
3. Next time when `ads.com` is accessed, the remote server gets the `id` cookie and recognizes the user:
|
|
|
|
|
|
|
|
4. What's even more important, when the users moves from `site.com` to another site `other.com` that also has a banner, then `ads.com` gets the cookie, as it belongs to `ads.com`, thus recognizing the visitor and tracking him as he moves between sites:
|
|
|
|
|
|
|
|
|
|
Third-party cookies are traditionally used for tracking and ads services, due to their nature. They are bound to the originating domain, so `ads.com` can track the same user between different sites, if they all access it.
|
|
|
|
Naturally, some people don't like being tracked, so browsers allow to disable such cookies.
|
|
|
|
Also, some modern browsers employ special policies for such cookies:
|
|
- Safari does not allow third-party cookies at all.
|
|
- Firefox comes with a "black list" of third-party domains where it blocks third-party cookies.
|
|
|
|
|
|
```smart
|
|
If we load a script from a third-party domain, like `<script src="https://google-analytics.com/analytics.js">`, and that script uses `document.cookie` to set a cookie, then such cookie is not third-party.
|
|
|
|
If a script sets a cookie, then no matter where the script came from -- the cookie belongs to the domain of the current webpage.
|
|
```
|
|
|
|
## Appendix: GDPR
|
|
|
|
This topic is not related to JavaScript at all, just something to keep in mind when setting cookies.
|
|
|
|
There's a legislation in Europe called GDPR, that enforces a set of rules for websites to respect users' privacy. And one of such rules is to require an explicit permission for tracking cookies from a user.
|
|
|
|
Please note, that's only about tracking/identifying/authorizing cookies.
|
|
|
|
So, if we set a cookie that just saves some information, but neither tracks nor identifies the user, then we are free to do it.
|
|
|
|
But if we are going to set a cookie with an authentication session or a tracking id, then a user must allow that.
|
|
|
|
Websites generally have two variants of following GDPR. You must have seen them both already in the web:
|
|
|
|
1. If a website wants to set tracking cookies only for authenticated users.
|
|
|
|
To do so, the registration form should have a checkbox like "accept the privacy policy" (that describes how cookies are used), the user must check it, and then the website is free to set auth cookies.
|
|
|
|
2. If a website wants to set tracking cookies for everyone.
|
|
|
|
To do so legally, a website shows a modal "splash screen" for newcomers, and require them to agree for cookies. Then the website can set them and let people see the content. That can be disturbing for new visitors though. No one likes to see "must-click" modal splash screens instead of the content. But GDPR requires an explicit agreement.
|
|
|
|
|
|
GDPR is not only about cookies, it's about other privacy-related issues too, but that's too much beyond our scope.
|
|
|
|
|
|
## Summary
|
|
|
|
`document.cookie` provides access to cookies
|
|
- write operations modify only cookies mentioned in it.
|
|
- name/value must be encoded.
|
|
- one cookie up to 4kb, 20+ cookies per site (depends on a browser).
|
|
|
|
Cookie options:
|
|
- `path=/`, by default current path, makes the cookie visible only under that path.
|
|
- `domain=site.com`, by default a cookie is visible on current domain only, if set explicitly to the domain, makes the cookie visible on subdomains.
|
|
- `expires` or `max-age` sets cookie expiration time, without them the cookie dies when the browser is closed.
|
|
- `secure` makes the cookie HTTPS-only.
|
|
- `samesite` forbids the browser to send the cookie with requests coming from outside the site, helps to prevent XSRF attacks.
|
|
|
|
Additionally:
|
|
- Third-party cookies may be forbidden by the browser, e.g. Safari does that by default.
|
|
- When setting a tracking cookie for EU citizens, GDPR requires to ask for permission.
|