Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arkq/wg-tcp-tunnel
WireGuard TCP tunneling
https://github.com/arkq/wg-tcp-tunnel
boost-asio ngrok tunnel websocket wireguard
Last synced: about 1 month ago
JSON representation
WireGuard TCP tunneling
- Host: GitHub
- URL: https://github.com/arkq/wg-tcp-tunnel
- Owner: arkq
- License: mit
- Created: 2023-11-13T22:52:00.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-19T10:57:12.000Z (about 1 year ago)
- Last Synced: 2024-07-02T20:45:15.124Z (7 months ago)
- Topics: boost-asio, ngrok, tunnel, websocket, wireguard
- Language: C++
- Homepage:
- Size: 86.9 KB
- Stars: 14
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WireGuard TCP tunneling
## About
This project is a simple UDP-over-TCP tunneling. The main purpose of it is to
allow [WireGuard](https://www.wireguard.com/) to work over TCP.
```mermaid
flowchart RL
subgraph "Peer B (client)"
A[WireGuard] <--UDP--> B[TCP2UDP]
end
B --TCP--> C
subgraph "Peer A (server)"
C[UDP2TCP] <--UDP--> D[WireGuard]
end
```
## Installation
### Dependencies
This project is based on [Boost.Asio](https://www.boost.org/), so in order to
build it you need to have Boost installed. Also, you need to have CMake and a
C++ compiler that supports C++17.
On Debian-based systems all dependencies can be installed by running:
```sh
sudo apt install \
libboost-dev libboost-log-dev libboost-program-options-dev libssl-dev \
cmake g++
```
On [Termux](https://termux.dev/), one can get all dependencies by running:
```sh
pkg install \
boost boost-headers openssl \
cmake clang
```
### Building
```sh
cmake -S . -B build \
-DCMAKE_BUILD_TYPE=Release \
-DENABLE_SYSTEMD=ON \
-DENABLE_WEBSOCKET=ON \
-DENABLE_NGROK=ON
cmake --build build
sudo cmake --install build
```
## Usage
### Server Side
On the server side (the side that has a public IP address) you can run the
`wg-tcp-tunnel` as follows:
```sh
wg-tcp-tunnel --src-tcp=0.0.0.0:51820 --dst-udp=127.0.0.1:51820
```
This will tell the `wg-tcp-tunnel` to listen on all interfaces on port 51820
for TCP connections and forward them to the local WireGuard instance. This
repository contains a [systemd](https://systemd.io/) service file that can be
used to run the `wg-tcp-tunnel` as a service. By default, that service will
do exactly the same as the command above.
### Client Side
On the client side one can run the `wg-tcp-tunnel` as follows:
```sh
wg-tcp-tunnel --src-udp=127.0.0.1:51822 --dst-tcp=:51820
```
This will tell the `wg-tcp-tunnel` to listen on the loopback interface on port
51822 for UDP connections and forward them to the server's public IP address
over TCP. Then in the WireGuard configuration file one needs to specify the
peer's endpoint address as `Endpoint = 127.0.0.1:51822`. Simple as that.
When configured with `-DENABLE_NGROK=ON`, the `wg-tcp-tunnel` also provides
support for getting NGROK endpoint and using it as a destination address. In
order to use this feature, one needs to specify the `--ngrok-api-key=KEY` and
`--ngrok-dst-tcp-endpoint=ENDPOINT` options. For more information about these
options, please refer to the `--help` output.
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
for details.