multiaddr powered pipes
This is a simple program, much like netcat or telnet, that sets up pipes between multiaddrs.
For now, use go get to install it:
go get -u github.com/multiformats/ma-pipe/ma-pipe
ma-pipe --version # should work
Please file an issue if there is a problem with the install.
ma-pipe sets up simple pipes based on multiaddrs. It has four modes:
listenwill listen on 2 given multiaddrs, accept 1 conn each, and pipe the connection togetherdialwill dial to 2 given multiaddrs, and pipe the connection togetherfwdwill listen on 1 multiaddr, accept 1 conn, then dial the other given multiaddrproxywill listen on 1 multiaddr, accept 1 conn, read a multiaddr from the conn, and dial it
Notes:
ma-pipesupports "zero" listen multiaddrs (egma-pipe proxy /ip4/0.0.0.0/tcp/0)ma-pipesupports the/unix/stdiomultiaddr (egma-pipe fwd /unix/stdio /ip4/127.0.0.1/tcp/1234)
> ma-pipe --help
USAGE
ma-pipe <mode> <multiaddrs>...
ma-pipe listen <listen-multiaddr1> <listen-multiaddr2>
ma-pipe dial <dial-multiaddr1> <dial-multiaddr2>
ma-pipe fwd <listen-multiaddr> <dial-multiaddr>
ma-pipe proxy <listen-multiaddr>
OPTIONS
-h, --help display this help message
-v, --version display the version of the program
-t, --trace <dir> save a trace of the connection to <dir>
-e, --tee tee the connection to stdio
--bandwidth <bandwidth> introduce a bandwidth cap (eg 1MB/s)
EXAMPLES
# listen on two multiaddrs, accept 1 conn each, and pipe them
ma-pipe listen /ip4/127.0.0.1/tcp/1234 /ip4/127.0.0.1/tcp/1234
# dial to both multiaddrs, and pipe them
ma-pipe dial /ip4/127.0.0.1/tcp/1234 /ip4/127.0.0.1/tcp/1234
# listen on one multiaddr, accept 1 conn, dial to the other, and pipe them
ma-pipe fwd /ip4/127.0.0.1/tcp/1234 /ip4/127.0.0.1/tcp/1234
# listen on one multiaddr, accept 1 conn.
# read the first line, parse a multiaddr, dial that multiaddr, and pipe them
ma-pipe proxy /ip4/127.0.0.1/tcp/1234
# ma-pipe supports "zero" listen multiaddrs
ma-pipe proxy /ip4/0.0.0.0/tcp/0
# ma-pipe supports the /unix/stdio multiaddr
ma-pipe fwd /unix/stdio /ip4/127.0.0.1/tcp/1234
# ma-pipe supports the --tee option to inspect conn in stdio
ma-pipe --tee fwd /ip4/0.0.0.0/tcp/0 /ip4/127.0.0.1/tcp/1234
# ma-pipe allows throttling connections with a bandwidth max
ma-pipe --bandwidth 1MB/s listen /ip4/127.0.0.1/tcp/1234 /ip4/127.0.0.1/tcp/1234
The -e, --tee option allows the user to inspect the connection in stdio, as it happens.
> ma-pipe --tee listen /ip4/127.0.0.1/tcp/64829 /ip4/127.0.0.1/tcp/64830
# listening on /ip4/127.0.0.1/tcp/64829
# listening on /ip4/127.0.0.1/tcp/64830
# accepted /ip4/127.0.0.1/tcp/64830 /ip4/127.0.0.1/tcp/64853
# accepted /ip4/127.0.0.1/tcp/64829 /ip4/127.0.0.1/tcp/64855
# piping /ip4/127.0.0.1/tcp/64853 to /ip4/127.0.0.1/tcp/64855
> Hello there
< Hi!
> How's it going?
< Well, and you?The -t, --trace option allows the user to specify a directory to capture a trace of the connection. Three files will be written:
<trace-dir>/ma-pipe-trace-<date>-<pid>-a2bfor one side of the (duplex) connection.<trace-dir>/ma-pipe-trace-<date>-<pid>-b2afor the other side of the (duplex) connection.<trace-dir>/ma-pipe-trace-<date>-<pid>-ctlfor control messages.
> tree mytraces
mytraces
├── ma-pipe-trace-2016-09-12-03:35:31Z-14088-a2b
├── ma-pipe-trace-2016-09-12-03:35:31Z-14088-b2a
└── ma-pipe-trace-2016-09-12-03:35:31Z-14088-ctl
The --bandwidth option allows users to specify rate-limiting through a maximum bandwidth. The flag uses go-humanize to read formats like 1MB/s and 4Bps.
> time head -c 16777216 /dev/urandom | ./ma-pipe --bandwidth 1MB/s fwd /unix/stdio /ip4/127.0.0.1/tcp/5432
...
./ma-pipe --bandwidth 1MB/s fwd /unix/stdio /ip4/127.0.0.1/tcp/5432 0.09s user 0.39s system 2% cpu 16.056 total
> time head -c 16777216 /dev/urandom | ./ma-pipe --bandwidth 4MB/s fwd /unix/stdio /ip4/127.0.0.1/tcp/5432
...
./ma-pipe --bandwidth 4MB/s fwd /unix/stdio /ip4/127.0.0.1/tcp/5432 0.20s user 0.37s system 14% cpu 4.062 total
Captain: @jbenet.
Contributions welcome. Please check out the issues.
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
MIT © 2016 Protocol Labs Inc.