2
0
mirror of https://github.com/dadevel/wg-netns synced 2024-10-30 21:20:12 +00:00
wg-netns/README.md

147 lines
3.5 KiB
Markdown
Raw Normal View History

2020-11-15 15:43:35 +00:00
# wg-netns
2021-05-28 09:31:21 +00:00
[wg-quick](https://git.zx2c4.com/wireguard-tools/about/src/man/wg-quick.8) with support for Linux network namespaces.
A simple Python script that implements the steps described at [wireguard.com/netns](https://www.wireguard.com/netns/#ordinary-containerization).
2020-11-15 15:43:35 +00:00
## Setup
Requirements:
2020-11-15 21:41:42 +00:00
- Python 3.7 or newer
2021-05-28 09:31:21 +00:00
- `ip` from iproute2
- `wg` from wireguard-tools
2020-11-15 15:43:35 +00:00
2021-05-28 09:31:21 +00:00
Installation:
2020-11-15 15:43:35 +00:00
~~~ bash
2021-05-28 09:31:21 +00:00
git clone --depth 1 https://github.com/dadevel/wg-netns.git
sudo ./wg-netns/setup.sh
2020-11-15 15:43:35 +00:00
~~~
## Usage
First, create a configuration profile.
You can find two examples below.
`./mini.json`:
~~~ json
{
"name": "ns-example",
"interfaces": [
{
"name": "wg-example",
"address": ["10.10.10.192/32", "fc00:dead:beef::192/128"],
"private-key": "4bvaEZHI...",
"peers": [
{
"public-key": "bELgMXGt...",
"endpoint": "vpn.example.com:51820",
"allowed-ips": ["0.0.0.0/0", "::/0"]
}
]
}
]
}
~~~
`./maxi.json`:
~~~ json
{
"name": "ns-example",
"dns-server": ["10.10.10.1", "10.10.10.2"],
"pre-up": "some shell command",
"post-up": "some shell command",
"pred-own": "some shell command",
"post-down": "some shell command",
"interfaces": [
{
"name": "wg-site-a",
"address": ["10.10.11.172/32", "fc00:dead:beef:1::172/128"],
"listen-port": 51821,
"fwmark": 51821,
"private-key": "nFkQQjN+...",
"mtu": 1420,
"peers": [
{
"public-key": "Kx+wpJpj...",
"preshared-key": "5daskLoW...",
"endpoint": "a.example.com:51821",
"persistent-keepalive": 25,
"allowed-ips": ["10.10.11.0/24", "fc00:dead:beef:1::/64"]
}
]
},
{
"name": "wg-site-b",
"address": ["10.10.12.172/32", "fc00:dead:beef:2::172/128"],
"listen-port": 51822,
"fwmark": 51822,
"private-key": "guYPuE3X...",
"mtu": 1420,
"peers": [
{
"public-key": "NvZMoyrg...",
"preshared-key": "cFQuyIX/...",
"endpoint": "b.example.com:51822",
"persistent-keepalive": 25,
"allowed-ips": ["10.10.12.0/24", "fc00:dead:beef:2::/64"]
}
]
}
]
}
~~~
Now it's time to setup your new network namespace and all associated wireguard interfaces.
~~~ bash
wg-netns up ./example.json
~~~
You can verify the success with a combination of `ip` and `wg`.
~~~ bash
ip netns exec ns-example wg show
~~~
2020-11-15 15:43:35 +00:00
Or you can spawn a shell inside the netns.
2020-11-15 15:43:35 +00:00
~~~ bash
ip netns exec ns-example bash -i
2020-11-15 15:43:35 +00:00
~~~
Or connect a container to it.
~~~ bash
podman run -it --rm --network ns:/var/run/netns/ns-example docker.io/alpine wget -O - https://ipinfo.io
2020-11-15 15:43:35 +00:00
~~~
Or do whatever else you want.
### System Service
2020-11-15 21:41:42 +00:00
You can find a `wg-quick@.service` equivalent at [wg-netns@.service](./wg-netns@.service).
2020-11-15 16:13:46 +00:00
### Port Forwarding
With `socat` you can forward TCP traffic from outside a network namespace to a port inside a network namespace.
~~~ bash
socat tcp-listen:$LHOST,reuseaddr,fork "exec:ip netns exec $NETNS socat stdio 'tcp-connect:$RHOST',nofork"
~~~
Example: All connections to port 1234/tcp in the main netns are forwarded into the *ns-example* namespace to port 5678/tcp.
~~~ bash
# terminal 1, create netns and start http server inside
wg-netns up ns-example
hello > ./hello.txt
ip netns exec ns-example python3 -m http.server 5678
# terminal 2, setup port forwarding
socat tcp-listen:1234,reuseaddr,fork "exec:ip netns exec ns-example socat stdio 'tcp-connect:127.0.0.1:5678',nofork"
# terminal 3, test access
curl http://127.0.0.1:1234/hello.txt
~~~