Skip to content

Latest commit

 

History

History
executable file
·
83 lines (63 loc) · 3.59 KB

README.md

File metadata and controls

executable file
·
83 lines (63 loc) · 3.59 KB
Raw

Introduction

A p2p tunnel(based on kcptun) which establishs port forwarding channel for both clients. Need one server with public ip and one udp port for hole digging.

QuickStart

Download a corresponding one from precompiled Releases.

Server: ./p2pserver -l ":4000" 
Client_A: ./p2pclient -r "SERVER_IP:4000" -l ":10022" -t "TARGET_IP_A:22"  -k 4321
Client_B: ./p2pclient -r "SERVER_IP:4000" -l ":10022" -t "TARGET_IP_B:22"  -k 4321

The above commands will establish port forwarding channel for both Client_A and Client_B as:

Application1 -> Client_A(10022/tcp) -> Client_B -> TARGET_IP_B:(22/tcp)
Application2 -> Client_B(10022/tcp) -> Client_A -> TARGET_IP_A:(22/tcp)

which tunnels the original connection:

Application1 -> TARGET_IP_B:(22/tcp)
Application2 -> TARGET_IP_A:(22/tcp)

Install from source

$go get -u github.com/hikaricai/p2p_tun/...

Usage

root@ubuntu:~/p2p_tun# ./p2pclient -h
NAME:
   p2p_tun - client(based on kcptun)

USAGE:
   p2pclient [global options] command [command options] [arguments...]

VERSION:
   SELFBUILD

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --targettcp value, -t value      target server address (default: "127.0.0.1:22")
   --listentcp value, -l value      local listen address (default: ":12948")
   --remoteudp value, -r value      kcp server address (default: "vps:29900")
   --bindudp value, -b value        bind local udp (default: ":29900")
   --key value, -k value            p2p pair key (default: "1234")
   --passwd value                   pre-shared secret between client and server (default: "1234") [$KCPTUN_KEY]
   --crypt value                    aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, sm4, none (default: "aes")
   --mode value                     profiles: fast3, fast2, fast, normal, manual (default: "fast2")
   --conn value                     set num of UDP connections to server (default: 1)
   --autoexpire value               set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
   --mtu value                      set maximum transmission unit for UDP packets (default: 1350)
   --sndwnd value                   set send window size(num of packets) (default: 1024)
   --rcvwnd value                   set receive window size(num of packets) (default: 1024)
   --datashard value, --ds value    set reed-solomon erasure coding - datashard (default: 10)
   --parityshard value, --ps value  set reed-solomon erasure coding - parityshard (default: 3)
   --dscp value                     set DSCP(6bit) (default: 0)
   --nocomp                         disable compression
   --sockbuf value                  per-socket buffer in bytes (default: 4194304)
   --keepalive value                seconds between heartbeats (default: 10)
   --snmplog value                  collect snmp to file, aware of timeformat in golang, like: ./snmp-20060102.log
   --snmpperiod value               snmp collect period, in seconds (default: 60)
   --log value                      specify a log file to output, default goes to stderr
   --quiet                          to suppress the 'stream open/close' messages
   -c value                         config from json file, which will override the command from shell
   --help, -h                       show help
   --version, -v                    print the version

Todo

Code refactoring with Rust Lang!!!

References

  1. https://github.com/xtaci/kcptun/ --- A Stable & Secure Tunnel Based On KCP with N:M Multiplexing