# wireguard/wireguard-linux-compat architecture

> Architecture diagram of the GitHub repository wireguard/wireguard-linux-compat, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wireguard/wireguard-linux-compat
- Repository: https://github.com/wireguard/wireguard-linux-compat

## Overview

This repository is an out-of-tree Linux kernel module backport of WireGuard, a secure network tunnel. Its principal workflow is configuring a tunnel and peers through the Generic Netlink UAPI, then sending and receiving encrypted packets over UDP; the protocol includes Noise handshakes, key management, peer routing, and packet queues. The graph includes compatibility support and Zinc cryptography as internal layers. The README documents the backport but not detailed subsystem wiring, so relationships without direct excerpt evidence are omitted or marked unverified.

Main entry points: [`src/main.c`](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/main.c) (Module lifecycle), [`src/receive.c`](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/receive.c) (Packet receiving), [`src/noise.c`](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/noise.c) (Noise handshake), [`src/send.c`](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/send.c) (Packet sending)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_control["Module and configuration"]
  node_main["Module lifecycle<br/>[main.c]"]
  node_netlink["Generic Netlink<br/>[netlink.c]"]
  node_uapi["Netlink UAPI<br/>[wireguard.h]"]
  node_device["Tunnel device<br/>[device.c]"]
end

subgraph group_protocol["Peer and protocol"]
  node_peer["Peer lifecycle<br/>[peer.c]"]
  node_noise["Noise handshake<br/>[noise.c]"]
  node_cookie["Cookie checks<br/>[cookie.c]"]
  node_peerlookup["Peer lookup<br/>[peerlookup.c]"]
  node_allowedips["Allowed IP routing<br/>[allowedips.c]"]
  node_messages["Wire messages<br/>[messages.h]"]
end

subgraph group_packets["Packet transport"]
  node_send["Packet sending<br/>[send.c]"]
  node_receive["Packet receiving<br/>[receive.c]"]
  node_queueing["Packet queues<br/>[queueing.h]"]
  node_socket["UDP sockets<br/>[socket.c]"]
  node_timers["Peer timers<br/>[timers.c]"]
end

subgraph group_crypto["Cryptography"]
  node_zinc["Zinc crypto<br/>[zinc.h]"]
  node_aead["ChaCha20-Poly1305<br/>[chacha20poly1305.c]"]
  node_crypto_tests["Crypto self-tests<br/>[chacha20poly1305.c]"]
end

subgraph group_support["Compatibility support"]
  node_compat["Kernel API shims<br/>[compat.h]"]
  node_udp_compat["UDP tunnel shim"]
  node_checksum_compat["Checksum shim"]
end

node_kernel(("Kernel module"))

node_kernel -->|"loads module"| node_main
node_main -->|"initializes crypto"| node_zinc
node_main -->|"initializes device"| node_device
node_main -->|"initializes peers"| node_peer
node_main -->|"registers interface"| node_netlink
node_main -->|"initializes routing"| node_allowedips
node_noise -->|"encrypts handshake"| node_aead
node_receive -->|"consumes handshake"| node_noise
node_receive -->|"updates timers"| node_timers
node_receive -->|"sends replies"| node_send
node_receive -->|"uses packet queues"| node_queueing
node_uapi -.->|"configures tunnel"| node_netlink
node_send -.->|"transmits UDP"| node_socket
node_crypto_tests -.->|"tests implementation"| node_aead

click node_main "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/main.c"
click node_netlink "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/netlink.c"
click node_uapi "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/uapi/wireguard.h"
click node_device "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/device.c"
click node_peer "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/peer.c"
click node_noise "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/noise.c"
click node_cookie "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/cookie.c"
click node_peerlookup "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/peerlookup.c"
click node_allowedips "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/allowedips.c"
click node_messages "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/messages.h"
click node_send "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/send.c"
click node_receive "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/receive.c"
click node_queueing "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/queueing.h"
click node_socket "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/socket.c"
click node_timers "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/timers.c"
click node_zinc "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc.h"
click node_aead "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc/chacha20poly1305.c"
click node_crypto_tests "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc/selftest/chacha20poly1305.c"
click node_compat "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/compat.h"
click node_udp_compat "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/udp_tunnel/udp_tunnel_partial_compat.h"
click node_checksum_compat "https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/checksum/checksum_partial_compat.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_netlink,node_uapi,node_device toneBlue
class node_peer,node_noise,node_cookie,node_peerlookup,node_allowedips,node_messages toneAmber
class node_send,node_receive,node_queueing,node_socket,node_timers toneMint
class node_zinc,node_aead,node_crypto_tests toneRose
class node_compat,node_udp_compat,node_checksum_compat,node_kernel toneIndigo
```

## Components

### Module and configuration

- [Module lifecycle](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/main.c): `src/main.c`
- [Generic Netlink](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/netlink.c): `src/netlink.c`
- [Netlink UAPI](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/uapi/wireguard.h): `src/uapi/wireguard.h`
- [Tunnel device](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/device.c): `src/device.c`

### Peer and protocol

- [Peer lifecycle](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/peer.c): `src/peer.c`
- [Noise handshake](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/noise.c): `src/noise.c`
- [Cookie checks](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/cookie.c): `src/cookie.c`
- [Peer lookup](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/peerlookup.c): `src/peerlookup.c`
- [Allowed IP routing](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/allowedips.c): `src/allowedips.c`
- [Wire messages](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/messages.h): `src/messages.h`

### Packet transport

- [Packet sending](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/send.c): `src/send.c`
- [Packet receiving](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/receive.c): `src/receive.c`
- [Packet queues](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/queueing.h): `src/queueing.h`
- [UDP sockets](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/socket.c): `src/socket.c`
- [Peer timers](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/timers.c): `src/timers.c`

### Cryptography

- [Zinc crypto](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc.h): `src/crypto/zinc.h`
- [ChaCha20-Poly1305](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc/chacha20poly1305.c): `src/crypto/zinc/chacha20poly1305.c`
- [Crypto self-tests](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/crypto/zinc/selftest/chacha20poly1305.c): `src/crypto/zinc/selftest/chacha20poly1305.c`

### Compatibility support

- [Kernel API shims](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/compat.h): `src/compat/compat.h`
- [UDP tunnel shim](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/udp_tunnel/udp_tunnel_partial_compat.h): `src/compat/udp_tunnel/udp_tunnel_partial_compat.h`
- [Checksum shim](https://github.com/wireguard/wireguard-linux-compat/blob/master/src/compat/checksum/checksum_partial_compat.h): `src/compat/checksum/checksum_partial_compat.h`

### Other components

- **Kernel module**

## Connections

- Kernel module → Module lifecycle: loads module (evidence: `src/main.c`)
- Module lifecycle → Zinc crypto: initializes crypto (evidence: `src/main.c`)
- Module lifecycle → Tunnel device: initializes device (evidence: `src/main.c`)
- Module lifecycle → Peer lifecycle: initializes peers (evidence: `src/main.c`)
- Module lifecycle → Generic Netlink: registers interface (evidence: `src/main.c`)
- Module lifecycle → Allowed IP routing: initializes routing (evidence: `src/main.c`)
- Noise handshake → ChaCha20-Poly1305: encrypts handshake (evidence: `src/noise.c`)
- Packet receiving → Noise handshake: consumes handshake (evidence: `src/receive.c`)
- Packet receiving → Peer timers: updates timers (evidence: `src/receive.c`)
- Packet receiving → Packet sending: sends replies (evidence: `src/receive.c`)
- Packet receiving → Packet queues: uses packet queues (evidence: `src/receive.c`)
- Netlink UAPI → Generic Netlink: configures tunnel (evidence: `src/netlink.c`)
- Packet sending → UDP sockets: transmits UDP
- Crypto self-tests → ChaCha20-Poly1305: tests implementation (evidence: `src/crypto/zinc/chacha20poly1305.c`)
