Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nknorg/nkn-tunnel
Tunnel tcp through NKN client.
https://github.com/nknorg/nkn-tunnel
nkn nkn-client tunneling
Last synced: 4 days ago
JSON representation
Tunnel tcp through NKN client.
- Host: GitHub
- URL: https://github.com/nknorg/nkn-tunnel
- Owner: nknorg
- License: apache-2.0
- Created: 2020-01-11T05:33:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T22:25:35.000Z (8 months ago)
- Last Synced: 2024-08-01T22:41:58.997Z (3 months ago)
- Topics: nkn, nkn-client, tunneling
- Language: Go
- Homepage:
- Size: 149 KB
- Stars: 118
- Watchers: 5
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NKN Tunnel
[](LICENSE) [](https://goreportcard.com/report/github.com/nknorg/nkn-tunnel) [](https://travis-ci.org/nknorg/nkn-tunnel) [](#contributing)
Tunnel any TCP applications through NKN client or Tuna. A few advantages:
- Network agnostic: Neither sender nor receiver needs to have public IP address
or port forwarding. NKN tunnel only establish outbound (websocket)
connections, so Internet access is all they need on both side.
- Top level security: All data are end to end authenticated and encrypted. No
one else in the world except sender and receiver can see or modify the content
of the data. The same public key is used for both routing and encryption,
eliminating the possibility of man in the middle attack.
- Decent performance: By aggregating multiple overlay paths concurrently, one
can get ~100ms end to end latency and 10+mbps end to end throughput between
international devices using the default NKN client mode, or much lower latency
and higher throughput using Tuna mode.
- Everything is open source and decentralized. The default NKN client mode is
free (If you are curious, node relay traffic for clients for free to earn
mining rewards in NKN blockchain), while Tuna mode requires listener to pay
NKN token directly to Tuna service providers.
A diagram of the default NKN client mode:
```
A - ... - X
/ \
Alice <--> TCP <--> NKN client - B - ... - Y - NKN client <--> TCP <--> Bob
\ /
C - ... - Z
```
A diagram of the Tuna mode:
```
A
/ \
Alice <--> TCP <--> NKN Tuna client - B - NKN Tuna client <--> TCP <--> Bob
\ /
C
```
## Build
```shell
go build -o nkn-tunnel bin/main.go
```
## Basic Usage
"Server" side:
```shell
./nkn-tunnel -to 127.0.0.1:8080 -s
```
and you will see an output like `Listening at xxx` where `xxx` is the server
listening address.
"Client" side:
```shell
./nkn-tunnel -from 127.0.0.1:8081 -to
```
Now any TCP connection to client port 8081 will be forwarded to server port
8080.
## Tuna Mode
Add `-tuna` on both side of the tunnel to use Tuna mode, which has much better
performance but requires listener to pay NKN token directly to Tuna service
providers.
## Turn on UDP under Tuna Mode
When using Tuna mode, add `-udp` to turn on UDP communication on both side to support UDP communication.
## Contributing
**Can I submit a bug, suggestion or feature request?**
Yes. Please open an issue for that.
**Can I contribute patches?**
Yes, we appreciate your help! To make contributions, please fork the repo, push
your changes to the forked repo with signed-off commits, and open a pull request
here.
Please sign off your commit. This means adding a line "Signed-off-by: Name
" at the end of each commit, indicating that you wrote the code and have
the right to pass it on as an open source patch. This can be done automatically
by adding -s when committing:
```shell
git commit -s
```
## Community
- [Forum](https://forum.nkn.org/)
- [Discord](https://discord.gg/c7mTynX)
- [Telegram](https://t.me/nknorg)
- [Reddit](https://www.reddit.com/r/nknblockchain/)
- [Twitter](https://twitter.com/NKN_ORG)