add documentation about token rotation (#8435)

Related to #6064 and #6993 this adds documentation about token rotation.
This commit is contained in:
Roberto Dip 2022-10-26 11:51:28 -03:00 committed by GitHub
parent 49e910270b
commit defe1d03f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -32,7 +32,28 @@ For information on how to set the custom transparency link via a YAML configurat
## Securing Fleet Desktop
Requests sent by Fleet Desktop and the web page that opens when clicking on the "My Device" tray item use a [Random (Version 4) UUID](https://www.rfc-editor.org/rfc/rfc4122.html#section-4.4) token to uniquely identify each host.
The server uses this token to authenticate requests that give host information. Fleet uses the following methods to secure access to this information.
**Rate Limiting**
To prevent brute-forcing, Fleet rate-limits the endpoints used by Fleet Desktop on a per-IP basis. If an IP requests more than 720 invalid UUIDs in a one-hour interval, Fleet will return HTTP error code 429.
**Token Rotation**
```
In Fleet v4.22.0, token rotation for Fleet Desktop was introduced.
```
Starting with Fleet v4.22.0, the server will reject any token older than one hour since it was issued. This helps Fleet protect against unintentionally leaked or brute-forced tokens.
As a consequence, Fleet Desktop will issue a new token if the current token is:
- Rejected by the server
- Older than one hour
This change is imperceptible to users, as clicking on the "My Device" tray item always uses a valid token. If a user visits an address with an expired token, they will get a message instructing them to click on the tray item again.
<meta name="title" value="Fleet Desktop">
<meta name="pageOrderInSection" value="450">