You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 6-data-storage/01-cookie/article.md
+48-48
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,17 @@
2
2
3
3
Cookies are small strings of data that are stored directly in the browser. They are a part of the HTTP protocol, defined by the [RFC 6265](https://tools.ietf.org/html/rfc6265) specification.
4
4
5
-
Cookies are usually set by a web-server using the response `Set-Cookie` HTTP-header. Then, the browser automatically adds them to (almost) every request to the same domain using the `Cookie` HTTP-header.
5
+
Cookies are usually set by a webserver using the response `Set-Cookie` HTTPheader. Then, the browser automatically adds them to (almost) every request to the same domain using the `Cookie` HTTPheader.
6
6
7
7
One of the most widespread use cases is authentication:
8
8
9
-
1. Upon sign-in, the server uses the `Set-Cookie` HTTP-header in the response to set a cookie with a unique "session identifier".
10
-
2. Next time the request is sent to the same domain, the browser sends the cookie over the net using the `Cookie` HTTP-header.
9
+
1. Upon sign-in, the server uses the `Set-Cookie` HTTPheader in the response to set a cookie with a unique "session identifier".
10
+
2. Next time the request is sent to the same domain, the browser sends the cookie over the net using the `Cookie` HTTPheader.
11
11
3. So the server knows who made the request.
12
12
13
13
We can also access cookies from the browser, using `document.cookie` property.
14
14
15
-
There are many tricky things about cookies and their options. In this chapter, we'll cover them in detail.
15
+
There are many tricky things about cookies and their attributes. In this chapter, we'll cover them in detail.
16
16
17
17
## Reading from document.cookie
18
18
@@ -73,9 +73,9 @@ There are a few limitations:
73
73
- The total number of cookies per domain is limited to around 20+, the exact limit depends on the browser.
74
74
```
75
75
76
-
Cookies have several options, many of which are important and should be set.
76
+
Cookies have several attributes, many of which are important and should be set.
77
77
78
-
The options are listed after `key=value`, delimited by `;`, like this:
78
+
The attributes are listed after `key=value`, delimited by `;`, like this:
79
79
80
80
```js run
81
81
document.cookie="user=John; path=/; expires=Tue, 19 Jan 2038 03:14:07 GMT"
@@ -105,7 +105,7 @@ alert(document.cookie); // no user
105
105
106
106
...But this can be changed. If we'd like to allow subdomains like `forum.site.com` to get a cookie set at `site.com`, that's possible.
107
107
108
-
For that to happen, when setting a cookie at `site.com`, we should explicitly set the `domain`option to the root domain: `domain=site.com`. Then all subdomains will see such a cookie.
108
+
For that to happen, when setting a cookie at `site.com`, we should explicitly set the `domain`attribute to the root domain: `domain=site.com`. Then all subdomains will see such a cookie.
109
109
110
110
For example:
111
111
@@ -124,23 +124,23 @@ alert(document.cookie); // has cookie user=John
124
124
Historically, `domain=.site.com` (with a dot before `site.com`) used to work the same way, allowing access to the cookie from subdomains. Leading dots in domain names are now ignored, but some browsers may decline to set the cookie containing such dots.
125
125
```
126
126
127
-
To summarize, the `domain`option allows to make a cookie accessible at subdomains.
127
+
To summarize, the `domain`attribute allows to make a cookie accessible at subdomains.
128
128
129
129
## path
130
130
131
131
-**`path=/mypath`**
132
132
133
-
The url path prefix must be absolute. It makes the cookie accessible for pages under that path. By default, it's the current path.
133
+
The URL path prefix must be absolute. It makes the cookie accessible for pages under that path. By default, it's the current path.
134
134
135
135
If a cookie is set with `path=/admin`, it's visible on pages `/admin` and `/admin/something`, but not at `/home`, `/home/admin` or `/`.
136
136
137
-
Usually, we should set `path` to the root: `path=/` to make the cookie accessible from all website pages. If this option is not set the default is calculated using [this method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#path_default_value).
137
+
Usually, we should set `path` to the root: `path=/` to make the cookie accessible from all website pages. If this attribute is not set the default is calculated using [this method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#path_default_value).
138
138
139
139
## expires, max-age
140
140
141
-
By default, if a cookie doesn't have one of these options, it disappears when the browser/tab is closed. Such cookies are called "session cookies"
141
+
By default, if a cookie doesn't have one of these attributes, it disappears when the browser/tab is closed. Such cookies are called "session cookies"
142
142
143
-
To let cookies survive a browser close, we can set either the `expires` or `max-age`option. `max-Age` has precedence if both are set.
143
+
To let cookies survive a browser close, we can set either the `expires` or `max-age`attribute. `max-Age` has precedence if both are set.
144
144
145
145
-**`expires=Tue, 19 Jan 2038 03:14:07 GMT`**
146
146
@@ -181,7 +181,7 @@ The cookie should be transferred only over HTTPS.
181
181
182
182
That is, cookies are domain-based, they do not distinguish between the protocols.
183
183
184
-
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, the `secure` flag is the right thing.
184
+
With this attribute, 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, the `secure` flag is the right thing.
That's another security attribute `samesite`. It's designed to protect from so-called XSRF (cross-site request forgery) attacks.
194
+
This is another security attribute `samesite`. It's designed to protect from so-called XSRF (cross-site request forgery) attacks.
195
195
196
196
To understand how it works and when it's useful, let's take a look at XSRF attacks.
197
197
@@ -205,15 +205,15 @@ The browser sends cookies every time you visit the site `bank.com`, even if the
205
205
206
206

207
207
208
-
That's a so-called "Cross-Site Request Forgery" (in short, XSRF) attack.
208
+
This is a so-called "Cross-Site Request Forgery" (in short, XSRF) attack.
209
209
210
210
Real banks are protected from it of course. All forms generated by `bank.com` have a special field, a 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. The site `bank.com` checks for such a token in every form it receives.
211
211
212
212
Such a protection takes time to implement though. We need to ensure that every form has the required token field, and we must also check all requests.
213
213
214
-
### Enter cookie samesite option
214
+
### Use cookie samesite attribute
215
215
216
-
The cookie `samesite`option provides another way to protect from such attacks, that (in theory) should not require "xsrf protection tokens".
216
+
The cookie `samesite`attribute provides another way to protect from such attacks, that (in theory) should not require "xsrf protection tokens".
217
217
218
218
It has two possible values:
219
219
@@ -223,9 +223,9 @@ A cookie with `samesite=strict` is never sent if the user comes from outside the
223
223
224
224
In other words, whether a user follows a link from their email, submits a form from `evil.com`, or does any operation that originates from another domain, the cookie is not sent.
225
225
226
-
If authentication cookies have the `samesite` option, then an XSRF attack has no chance of succeeding, because a submission from `evil.com` comes without cookies. So `bank.com` will not recognize the user and will not proceed with the payment.
226
+
If authentication cookies have the `samesite=strict` attribute, then an XSRF attack has no chance of succeeding, because a submission from `evil.com` comes without cookies. So `bank.com` will not recognize the user and will not proceed with the payment.
227
227
228
-
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`.
228
+
The protection is quite reliable. Only operations that come from `bank.com` will send the `samesite=strict` cookie, e.g. a form submission from another page at `bank.com`.
229
229
230
230
Although, there's a small inconvenience.
231
231
@@ -246,36 +246,36 @@ A `samesite=lax` cookie is sent if both of these conditions are true:
246
246
247
247
2. The operation performs a top-level navigation (changes URL in the browser address bar).
248
248
249
-
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.
249
+
This is usually true, but if the navigation is performed in an `<iframe>`, then it is not top-level. Additionally, JavaScript methods for network requests do not perform any navigation.
250
250
251
251
So, what `samesite=lax` does, is to allow the most common "go to URL" operation to have cookies. E.g. opening a website link from notes that satisfy these conditions.
252
252
253
253
But anything more complicated, like a network request from another site or a form submission, loses cookies.
254
254
255
255
If that's fine for you, then adding `samesite=lax` will probably not break the user experience and add protection.
256
256
257
-
Overall, `samesite` is a great option.
257
+
Overall, `samesite` is a great attribute.
258
258
259
259
There's a drawback:
260
260
261
261
-`samesite` is ignored (not supported) by very old browsers, the year 2017 or so.
262
262
263
263
**So if we solely rely on `samesite` to provide protection, then old browsers will be vulnerable.**
264
264
265
-
But we surely can use `samesite` together with other protection measures, like xsrf tokens, to add layer of defence and then, in the future, when old browsers die out, we'll probably be able to drop xsrf tokens.
265
+
But we surely can use `samesite` together with other protection measures, like xsrf tokens, to add a layer of defence and then, in the future, when old browsers die out, we'll probably be able to drop xsrf tokens.
266
266
267
267
## httpOnly
268
268
269
-
This option has nothing to do with JavaScript, but we have to mention it for completeness.
269
+
This attribute has nothing to do with JavaScript, but we have to mention it for completeness.
270
270
271
-
The web-server uses the `Set-Cookie` header to set a cookie. Also, it may set the `httpOnly`option.
271
+
The webserver uses the `Set-Cookie` header to set a cookie. Also, it may set the `httpOnly`attribute.
272
272
273
-
This option forbids any JavaScript access to the cookie. We can't see such a cookie or manipulate it using `document.cookie`.
273
+
This attribute forbids any JavaScript access to the cookie. We can't see such a cookie or manipulate it using `document.cookie`.
274
274
275
275
This is used as a precautionary 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, hackers should not be able to inject their code into our site, but there may be bugs that let them do it.
276
276
277
277
278
-
Normally, if such a 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.
278
+
Normally, if such a thing happens, and a user visits a web-page with a hacker's JavaScript code, then that code executes and gains access to `document.cookie` with user cookies containing authentication information. That's bad.
279
279
280
280
But if a cookie is `httpOnly`, then `document.cookie` doesn't see it, so it is protected.
281
281
@@ -306,30 +306,30 @@ Here `new RegExp` is generated dynamically, to match `; name=<value>`.
306
306
307
307
Please note that a cookie value is encoded, so `getCookie` uses a built-in `decodeURIComponent` function to decode it.
308
308
309
-
### setCookie(name, value, options)
309
+
### setCookie(name, value, attributes)
310
310
311
311
Sets the cookie's `name` to the given `value` with `path=/` by default (can be modified to add other defaults):
let updatedCookie =encodeURIComponent(name) +"="+encodeURIComponent(value);
327
327
328
-
for (letoptionKeyinoptions) {
329
-
updatedCookie +="; "+optionKey;
330
-
letoptionValue=options[optionKey];
331
-
if (optionValue!==true) {
332
-
updatedCookie +="="+optionValue;
328
+
for (letattributeKeyinattributes) {
329
+
updatedCookie +="; "+attributeKey;
330
+
letattributeValue=attributes[attributeKey];
331
+
if (attributeValue!==true) {
332
+
updatedCookie +="="+attributeValue;
333
333
}
334
334
}
335
335
@@ -353,7 +353,7 @@ function deleteCookie(name) {
353
353
```
354
354
355
355
```warn header="Updating or deleting must use same path and domain"
356
-
Please note: when we update or delete a cookie, we should use exactly the same path and domain options as when we set it.
356
+
Please note: when we update or delete a cookie, we should use exactly the same path and domain attributes as when we set it.
357
357
```
358
358
359
359
Together: [cookie.js](cookie.js).
@@ -380,7 +380,7 @@ For instance:
380
380
381
381
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.
382
382
383
-
Naturally, some people don't like being tracked, so browsers allow to disable such cookies.
383
+
Naturally, some people don't like being tracked, so browsers allow them to disable such cookies.
384
384
385
385
Also, some modern browsers employ special policies for such cookies:
386
386
- Safari does not allow third-party cookies at all.
@@ -395,28 +395,28 @@ If a script sets a cookie, then no matter where the script came from -- the cook
395
395
396
396
## Appendix: GDPR
397
397
398
-
This topic is not related to JavaScript at all, just something to keep in mind when setting cookies.
398
+
This topic is not related to JavaScript at all, it is just something to keep in mind when setting cookies.
399
399
400
-
There's a legislation in Europe called GDPR, that enforces a set of rules for websites to respect the users' privacy. One of these rules is to require an explicit permission for tracking cookies from the user.
400
+
There's a legislation in Europe called GDPR, that enforces a set of rules for websites to respect the users' privacy. One of these rules is to require explicit permission for tracking cookies from the user.
401
401
402
402
Please note, that's only about tracking/identifying/authorizing cookies.
403
403
404
404
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.
405
405
406
-
But if we are going to set a cookie with an authentication session or a tracking id, then a user must allow that.
406
+
But if we are going to set a cookie with an authentication session or a tracking ID, then a user must allow that.
407
407
408
-
Websites generally have two variants of following GDPR. You must have seen them both already in the web:
408
+
Websites generally have two variants of complying with GDPR. You are likely to have seen them both on the web:
409
409
410
410
1. If a website wants to set tracking cookies only for authenticated users.
411
411
412
412
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.
413
413
414
414
2. If a website wants to set tracking cookies for everyone.
415
415
416
-
To do so legally, a website shows a modal "splash screen" for newcomers, and requires them to agree to the 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 such "must-click" modal splash screens instead of the content. But GDPR requires an explicit agreement.
416
+
To do so legally, a website shows a modal "splash screen" for newcomers and requires them to agree to the 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 such "must-click" modal splash screens instead of the content. But GDPR requires an explicit agreement.
417
417
418
418
419
-
GDPR is not only about cookies, it's about other privacy-related issues too, but that's too much beyond our scope.
419
+
GDPR is not only about cookies, it is about other privacy-related issues too, but that is beyond our scope.
420
420
421
421
422
422
## Summary
@@ -426,13 +426,13 @@ GDPR is not only about cookies, it's about other privacy-related issues too, but
426
426
- Name/value must be encoded.
427
427
- One cookie may not exceed 4KB in size. The number of cookies allowed on a domain is around 20+ (varies by browser).
428
428
429
-
Cookie options:
429
+
Cookie attributes:
430
430
-`path=/`, by default current path, makes the cookie visible only under that path.
431
431
-`domain=site.com`, by default a cookie is visible on the current domain only. If the domain is set explicitly, the cookie becomes visible on subdomains.
432
-
-`expires` or `max-age` sets the cookie expiration time. Without them the cookie dies when the browser is closed.
432
+
-`expires` or `max-age` sets the cookie expiration time. Without them, the cookie dies when the browser is closed.
433
433
-`secure` makes the cookie HTTPS-only.
434
434
-`samesite` forbids the browser to send the cookie with requests coming from outside the site. This helps to prevent XSRF attacks.
435
435
436
436
Additionally:
437
-
-Third-party cookies may be forbidden by the browser, e.g. Safari does that by default.
437
+
-The browser may forbid third-party cookies, e.g. Safari does that by default. There is also work in progress to implement this in Chrome.
438
438
- When setting a tracking cookie for EU citizens, GDPR requires to ask for permission.
0 commit comments