wireguard-negotiator/README.md

30 lines
819 B
Markdown
Raw Normal View History

2019-12-19 19:48:52 +08:00
2019-12-19 18:03:15 +08:00
# wireguard-negotiator
2019-12-19 19:48:52 +08:00
2019-12-19 18:03:15 +08:00
A not-very-secure manual WireGuard negotiator
2019-12-19 19:48:52 +08:00
## Purpose
`wireguard-negotiator` is built for scenarios where a simple mechanism to exchange and manually accept WireGuard keys is needed. This makes it slightly easier to provision a group of Linux WireGuard peers that peer with a "server".
In summary:
* Manage "client" keys
* Exchange keys over HTTP(S)
2019-12-19 20:52:27 +08:00
* Exchange IP addressing (DHCP-like)
2019-12-19 19:48:52 +08:00
* Manually gate new peers
2019-12-19 20:52:27 +08:00
* Sets up network interface on the "client"
2019-12-19 19:48:52 +08:00
* Generate Ansible INI inventory
2019-12-19 20:52:27 +08:00
The primary scenario this tool is going to be used for is to manage machines using Ansible within an unknown LAN behind NAT. I am planning to use it for FOSSASIA Summit 2020.
2019-12-19 19:48:52 +08:00
## Limitations
* Linux-only
* Manages existing config files only
* Removing peers is a manual process
# Usage
> TODO