Skip to content

Commit

Permalink
GITBOOK-113: MFA sequence diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
defguard-community authored and gitbook-bot committed Jan 25, 2024
1 parent befd438 commit 43fa911
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 13 deletions.
Binary file added .gitbook/assets/image (23).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (24).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/mfa.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 23 additions & 13 deletions help/desktop-client/architecture.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
# Architecture

## Communication with Defguard
WireGuard by itself does not have a concept of MFA or any additional authorization aside from validating peers cryptographically by their public and pre-shared keys. 

Client uses the [proxy ](https://github.com/DefGuard/proxy)to bridge communication between itself and Defguard. 
Desktop Client MFA functionality is build entirely in defguard as a layer above the WireGuard protocol. Below is a brief explanation of its architecture and the authorization process itself.

```mermaid fullWidth="false"
stateDiagram
DesktopClient --> Proxy
Proxy --> DesktopClient
Proxy --> Defguard
Defguard --> Proxy
```
## Pre-shared keys

Temporary access to proxy endpoints is granted via token authorization.
Our additional authorization is enabled by using [pre-shared keys](https://www.wireguard.com/protocol/#key-exchange-and-data-packets). They are similar to peer public keys but while public keys identify a specific device and are static, pre-shared keys can be safely rotated.

{% hint style="info" %}
Token lifespan can be configured via environment variables. You can learn more in[#enrollment-configuration](../../features/setting-up-your-instance/configuration.md#enrollment-configuration "mention")
{% endhint %}
When you configure your defguard location to require MFA it tells the Gateway to not add any peers (clients) to the WireGuard interface unless they are authorized and have a pre-shared key assigned.

On the other side a Client must have a valid pre-shared key (received after successful authorization) to establish a connection to the Gateway.

In typical REST API terms the pre-shared key can be thought of as an analogue to a session token.

## Authorization process

To enable MFA functionality Desktop Client uses the [proxy ](https://github.com/DefGuard/proxy)to bridge communication between itself and defguard Core. Below is a diagram of the authorization process that is performed each time the Client initiates a connection to an MFA-enabled location:

<figure><img src="../../.gitbook/assets/mfa.png" alt=""><figcaption></figcaption></figure>

## Disconnecting peers

Since the WireGuard protocol is by definition stateless, there's no native concept of "connection" which would allow us to detect disconnected peers and remove them from the Gateway.

As a workaround we use the `latest handshake` parameter available for each peer on a WireGuard interface. For each WireGuard connection both sides negotiate a "[mini-session](https://www.wireguard.com/protocol/#dos-mitigation)" about every 2 minutes. We can therefore assume that if the `latest handshake` value is more than 3 minutes (as a buffer for potential delays) the client has disconnected.

If a disconnected device is detected we mark it as unauthorized, delete the pre-shared key and remove the peer from Gateway interface, thus enforcing a "logout" for our MFA session.

0 comments on commit 43fa911

Please sign in to comment.