Skip to content

Commit c23e3ce

Browse files
author
erjohnson
committed
Update where to store tokens information
1 parent d1ce8b8 commit c23e3ce

1 file changed

Lines changed: 9 additions & 31 deletions

File tree

articles/security/store-tokens.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,24 @@ contentType:
1010
useCase:
1111
- development
1212
---
13-
# Where to Store Tokens
14-
15-
This document explains how to securely store tokens used in token-based authentication. The following assumes a basic knowledge of JSON Web Tokens (JWTs). To learn more about JWTs see:
16-
17-
* [Auth0 Tokens](/tokens)
18-
* [JSON Web Tokens (JWT) in Auth0](/jwt)
19-
20-
## Where to Store Your JWTs
21-
22-
::: warning
23-
You __must__ [verify a JWT's signature](/tokens/id-token#verify-the-signature) before storing and using it.
24-
:::
2513

26-
With token-based authentication, you are given the choice of where to store the JWT. We strongly recommend that you store your tokens in local storage/session storage or a cookie.
27-
28-
### Web Storage (local storage/session storage)
29-
30-
Commonly, the JWT is placed in the browsers local storage and this works well for most use cases.
14+
# Where to Store Tokens
3115

32-
When logging in a user with a username and password, the response body contains the Access Token JWT. Then you need to handle this response in the client side code. This token can then be stored in localStorage or sessionStorage.
16+
This document explains how to securely store [tokens](/tokens) used in token-based authentication.
3317

34-
[Click here for an example using sessionStorage](https://github.com/auth0-blog/angular-token-auth/blob/master/auth.client.js#L31)
18+
## Do not store tokens in the browser
3519

36-
Both `localStorage` and `sessionStorage` both extend `Storage`. The only difference between them is the persistance of the data:
20+
You should not store tokens in the browser's local storage or session storage. Data stored in the browser is vulnerable to [cross-site scripting](https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)) and malicious parties can potentially steal or alter that data.
3721

38-
`localStorage` - data persists until explicitly deleted. Changes made are saved and available for all current and future visits to the site.
22+
## Store tokens when a backend is present
3923

40-
`sessionStorage` - Changes made are saved and available for the current page, as well as future visits to the site on the same window. Once the window is closed, the storage is deleted.
24+
If your application has a backend server at all, then you should use the [Authorization Code flow](/application-auth/current/server-side-web) for authentication. Native applications should use the [Authorization Code flow with Proof Key for Code Exchange](/application-auth/current/mobile-desktop).
4125

42-
#### Web Storage Disadvantages
26+
## Store tokens without a backend
4327

44-
* Unlike cookies, local storage is sandboxed to a specific domain and its data cannot be accessed by any other domain including sub-domains.
45-
* Web Storage is accessible through JavaScript on the same domain so any JavaScript running on your site will have access to web storage, and because of this can be vulnerable to cross-site scripting (XSS) attacks.
46-
* The developer must ensure that the JWT is always sent over HTTPS and never HTTP.
28+
If you have a single page application (SPA) with no corresponding backend server, your SPA should request new tokens on page load and store them in memory without any persistence. To make API calls, your SPA would then use the in-memory copy of the token.
4729

48-
### Using Cookies
30+
## Using Cookies
4931

5032
You can also use cookies to store the JWT. The exact way to set a cookie depends on the client side language you are using.
5133

@@ -72,10 +54,6 @@ This video will show you how to handle session data when building a web app. It
7254
* Cookies can be vulnerable to cross-site request forgery (CSRF or XSRF) attacks. This type of attack occurs when a malicious web site causes a user’s web browser to perform an unwanted action on a trusted site where the user is currently authenticated. This is an exploit of how the browser handles cookies. Using a web app framework’s CSRF protection makes cookies a secure option for storing a JWT. CSRF can also be partially prevented by checking the HTTP `Referer` and `Origin` header.
7355
* Can be difficult to implement if the application requires cross-domain access. Cookies have additional properties (Domain/Path) that can be modified to allow you to specify where the cookie is allowed to be sent.
7456

75-
## How to implement
76-
77-
Many of our Quickstarts demonstrate how to store tokens, and the exact implementation will be different based on the technology being used. Please refer to the Quickstarts at the top of our [Documentation Home Page](/), select the appropriate Quickstart based on your application type, and follow the code samples provided.
78-
7957
## Keep reading
8058

8159
::: next-steps

0 commit comments

Comments
 (0)