Skip to content

Latest commit

 

History

History
165 lines (125 loc) · 5.16 KB

README.md

File metadata and controls

165 lines (125 loc) · 5.16 KB
Raw

tcptunnel

tcptunnel(mt) is a simple mutithread TCP port forwarder. The implementation based on tcptunnel project from http://www.vakuumverpackt.de/tcptunnel/. The goal of rewrite is to provide ability of multithread operation. This implementation is command-line compatible with original (provides superset of options). Also, some features added (like pipe timeout) to support more stable operation on long runs.

Build status

Help

$ tcptunnel --help
TCP/IP connection tunneling utility
Usage: tcptunnel [options]

Options:
  --version
  --help

  --local-port=PORT    local port to listen at
  --remote-port=PORT   remote port to connect to
  --remote-host=HOST   remote host to connect to
  --bind-address=IP    bind address to listen at
  --client-address=IP  only accept connections from this IP address
  --buffer-size=BYTES  buffer size [default 32K]
  --fork               fork-based concurrency (same as --concurrency=fork)
  --log                turns on log    (same as --log-level=1 --log-data=bin)
  --stay-alive         stay alive after first request  (turns on concurrency)
  --log-level=LEVEL    logging: 0=off,1=brief,2=full              [default 0]
  --concurrency=MODEL  concurrency model: none,fork,threads    [default none]
  --pipe-timeout=N     pipe data transfer timeout in sec (0=none) [default 0]
  --log-data=MODE      dump pipe data mode: none,hex,bin       [default:none]

Example:
tcptunnel --remote-port=80 --local-port=9980 --remote-host=acme.com --stay-alive --log-level=2

Building

For Unix/Linux

$ git clone https://github.com/openlab-vn-ua/tcptunnelm.git
$ cd tcptunnelmt
$ ./configure
$ make
$ ./tcptunnel --version
$ ./tcptunnel --help

For Mac OS X

You will need the Command Line Tools for Xcode to build tcptunnel under Mac OS X.

$ uname -mrs
Darwin 12.5.0 x86_64

$ git clone https://github.com/openlab-vn-ua/tcptunnelmt.git
$ cd tcptunnelmt
$ ./configure --prefix=/usr/bin
$ make
$ ./tcptunnel --version
$ ./tcptunnel --help
$ file tcptunnel
tcptunnel: Mach-O 64-bit executable x86_64

For Mac OS X (Homebrew)

TBD

For Windows (Cygwin)

You will need the Cygwin environment for Windows from http://www.cygwin.com/ with the following additional packages installed:

  • gcc
  • git
  • make
$ uname -a
CYGWIN_NT-6.1-WOW64 computer 1.7.25(0.270/5/3) 2013-08-31 20:39 i686 Cygwin

$ git clone git://github.com/openlab-vn-ua/tcptunnelmt.git
$ cd tcptunnelmt
$ ./configure
$ make

$ ./tcptunnel --version
$ ./tcptunnel --help
$ file tcptunnel.exe
tcptunnel.exe: PE32 executable (console) Intel 80386, for MS Windows

For Windows (MinGW32+MSYS)

You will need MinGW32 to compile tcptunnel on Windows. Please see http://www.mingw.org/ for more details. You need to install at least following components:

  • mingw32-developer-toolkit-bin AKA An MSYS intallation for MinGW Developers (meta) // tested ver20130723
  • msys-base-bin AKA Basic MSYS Installation (meta) // tested ver20130722
  • mingw32-gcc-g++-bin AKA GNU C++ Compiller // tested ver 9.2.0-2
  • mingw32-pthreads-w32-dev AKA POSIX threading library for Win32 // tested ver 2.10-pre-20160821-1

Launch msys shell (usually, via something alike C:\MinGW\msys\1.0\msys.bat), then run shell commands.

Notes: After fresh install of MinGW, folder /usr/local/bin may be missing, so you may need to create it via mkdir -p /usr/local/bin, unless you use afletrnaive install location via --prefix option for configure.

$ uname -a
MINGW32_NT-6.1 computer 1.0.19(0.48/3/2) 2016-07-13 17:45 i686 Msys
$ [ -d /usr/local/bin ] || mkdir -p /usr/local/bin

$ git clone https://github.com/openlab-vn-ua/tcptunnelmt.git
$ cd tcptunnelmt
$ ./configure
$ make -f Makefile
$ file tcptunnel.exe
tcptunnel.exe: PE32 executable (console) Intel 80386, for MS Windows

Linux to cross compile for Windows (MinGW32)

You will need MinGW32 to cross-compile tcptunnel. Please see http://www.mingw.org/ for more details. If you are using a Debian-based distribution then you will need to install the following packages:

  • mingw32
  • mingw32-binutils
  • mingw32-runtime
$ apt-get install mingw32 mingw32-binutils mingw32-runtime
$ git clone https://github.com/openlab-vn-ua/tcptunnelmt.git
$ cd tcptunnelmt
$ ./configure
$ make -f Makefile.MinGW32
$ file tcptunnel.exe
tcptunnel.exe: PE32 executable (console) Intel 80386, for MS Windows

NOTE: This need to be tested, but it should work.

General Notes

The MinGW32-based version does not support the fork-based concurrent client handling. It supports threads concurency mode only (this seems more effective under Windows). If you specify --fork options, MinGW32 version will fallback to threads concurency mode. If (for smore reason) you need explicit fork-based concurency feature under Windows, then you should use the Cygwin-based version.

ChangeLog

See ChangeLog.

License

This software released under the GPL The initial version was written by Clemens Fuchslocher, released under the GPL.