Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent runs a mesh node: it enrolls with the coordinator, keeps the WireGuard engine in sync with the netmap and serves the local API.
|
Package agent runs a mesh node: it enrolls with the coordinator, keeps the WireGuard engine in sync with the netmap and serves the local API. |
|
controlclient
Package controlclient talks to the coordinator's control service.
|
Package controlclient talks to the coordinator's control service. |
|
engine
Package engine owns the WireGuard device and keeps it in sync with the netmap pushed by the coordinator.
|
Package engine owns the WireGuard device and keeps it in sync with the netmap pushed by the coordinator. |
|
localapi
Package localapi is the agent's local control socket, used by the CLI.
|
Package localapi is the agent's local control socket, used by the CLI. |
|
magicdns
Package magicdns is the agent's DNS resolver.
|
Package magicdns is the agent's DNS resolver. |
|
magicsock
Package magicsock is a WireGuard conn.Bind that finds the best path to each peer.
|
Package magicsock is a WireGuard conn.Bind that finds the best path to each peer. |
|
netcfg
Package netcfg creates the TUN device and configures it at the OS level.
|
Package netcfg creates the TUN device and configures it at the OS level. |
|
pingsvc
Package pingsvc implements a tiny UDP echo protocol used by `transporter ping` to measure round trips through the mesh without needing raw sockets or root.
|
Package pingsvc implements a tiny UDP echo protocol used by `transporter ping` to measure round trips through the mesh without needing raw sockets or root. |
|
service
Package service installs the agent as a system service: a systemd unit on Linux, a launchd daemon on macOS, a Windows service elsewhere.
|
Package service installs the agent as a system service: a systemd unit on Linux, a launchd daemon on macOS, a Windows service elsewhere. |
|
socks5
Package socks5 is a minimal SOCKS5 server (RFC 1928): CONNECT only, no authentication.
|
Package socks5 is a minimal SOCKS5 server (RFC 1928): CONNECT only, no authentication. |
|
state
Package state persists the agent's identity between runs.
|
Package state persists the agent's identity between runs. |
|
tundev
Package tundev wraps the TUN device between the OS (or netstack) and WireGuard.
|
Package tundev wraps the TUN device between the OS (or netstack) and WireGuard. |
|
Package coordinator implements the public control server: admin API, configuration UI and (in later phases) the control plane, STUN and relay.
|
Package coordinator implements the public control server: admin API, configuration UI and (in later phases) the control plane, STUN and relay. |
|
adminapi
Package adminapi provides primitives to interact with the openapi HTTP API.
|
Package adminapi provides primitives to interact with the openapi HTTP API. |
|
control
Package control implements the agent-facing control plane.
|
Package control implements the agent-facing control plane. |
|
datalock
Package datalock marks a data directory as in use by a running coordinator, so offline operations such as restore can refuse to run.
|
Package datalock marks a data directory as in use by a running coordinator, so offline operations such as restore can refuse to run. |
|
ipam
Package ipam allocates overlay addresses from the mesh prefix.
|
Package ipam allocates overlay addresses from the mesh prefix. |
|
store
Package store persists coordinator state in SQLite.
|
Package store persists coordinator state in SQLite. |
|
Package filter is the packet filter every agent applies to traffic that arrives from the mesh.
|
Package filter is the packet filter every agent applies to traffic that arrives from the mesh. |
|
Package metrics holds the coordinator's Prometheus metrics.
|
Package metrics holds the coordinator's Prometheus metrics. |
|
Package netns keeps the agent's own traffic (control plane, relay and WireGuard's UDP socket) out of the tunnel.
|
Package netns keeps the agent's own traffic (control plane, relay and WireGuard's UDP socket) out of the tunnel. |
|
Package policy parses the mesh access-control policy and compiles it into packet-filter rules and peer visibility for each node.
|
Package policy parses the mesh access-control policy and compiles it into packet-filter rules and peer visibility for each node. |
|
proto
|
|
|
transporter/control/v1/controlv1connect
Control plane protocol between agents and the coordinator.
|
Control plane protocol between agents and the coordinator. |
|
Package relay forwards already-encrypted packets between nodes that cannot reach each other directly.
|
Package relay forwards already-encrypted packets between nodes that cannot reach each other directly. |
|
Package stun implements the small subset of STUN (RFC 5389) Transporter needs: binding requests and responses carrying XOR-MAPPED-ADDRESS, so a node can learn the public address its NAT maps its UDP socket to.
|
Package stun implements the small subset of STUN (RFC 5389) Transporter needs: binding requests and responses carrying XOR-MAPPED-ADDRESS, so a node can learn the public address its NAT maps its UDP socket to. |
|
Package version holds build metadata injected at link time.
|
Package version holds build metadata injected at link time. |
|
Package wgkey handles WireGuard Curve25519 keys.
|
Package wgkey handles WireGuard Curve25519 keys. |
Click to show internal directories.
Click to hide internal directories.