From: Gabriel Staples Date: Mon, 26 Sep 2016 14:19:32 -0400 Subject: Add markdown version of README Applied-Upstream: commit:43a77abf7f4336a56bbf8e44f85f99acd5afb2a2 --- README | 110 ++++++++++++++++++++++++++++++++++---------------------------- README.md | 69 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 130 insertions(+), 49 deletions(-) create mode 100644 README.md diff --git a/README b/README index 22d759a..8027151 100644 --- a/README +++ b/README @@ -1,61 +1,73 @@ -httptunnel creates a bidirectional virtual data path tunnelled in HTTP -requests. The requests can be sent via an HTTP proxy if so desired. +ABOUT -This can be useful for users behind restrictive firewalls. If WWW -access is allowed through an HTTP proxy, it's possible to use -httptunnel and, say, telnet or PPP to connect to a computer outside -the firewall. +httptunnel creates a bidirectional virtual data path tunnelled in HTTP +requests. The requests can be sent via an HTTP proxy if so desired. -If you still don't understand what this is all about, maybe you -can find some useful information in the FAQ file. +This can be useful for users behind restrictive firewalls. If WWW +access is allowed through an HTTP proxy, it's possible to use +httptunnel and, say, telnet or PPP to connect to a computer outside +the firewall. -This program is mostly intended for technically oriented users. -They should know what to do. +If you still don't understand what this is all about, maybe you +can find some useful information in the FAQ file. -Read INSTALL for instructions on how to build a released version. -If you build the development repository, run ./autogen.sh first. +This program is mostly intended for technically-oriented users. +They should know what to do. -httptunnel is free software. See COPYING for terms and conditions. -If you like it, I would appreciate if you sent a post card to: - Lars Brinkhoff - Kopmansgatan 2 - 411 13 Goteborg - Sweden +INSTALL + +Read INSTALL for instructions on how to build a released version. +If you build the development repository, run `./autogen.sh` first. -Information and/or latest release should be available from these places: - http://www.nocrew.org/software/httptunnel.html - http://www.gnu.org/software/httptunnel/httptunnel.html - ftp://ftp.gnu.org/pub/gnu/httptunnel +LICENSE + +httptunnel is free software. See COPYING for terms and conditions. +If you like it, I would appreciate if you sent a post card to: +> Lars Brinkhoff +> Kopmansgatan 2 +> 411 13 Goteborg +> Sweden -I take no responsibility for what you do with this software. It has -the potential to do dangerous things, like disabling the protection -you system administrator has set up for the local network. Read the -DISCLAIMER file. +Information and/or latest release should be available from these places: + * http://www.nocrew.org/software/httptunnel.html + * http://www.gnu.org/software/httptunnel/httptunnel.html + * ftp://ftp.gnu.org/pub/gnu/httptunnel -There are two programs: hts and htc. hts is the httptunnel server -and htc is the client. hts should be installed on a computer outside -the HTTP proxy, and htc should be installed on your local computer. +I take no responsibility for what you do with this software. It has +the potential to do dangerous things, like disabling the protection +you system administrator has set up for the local network. Read the +DISCLAIMER file. -Documentation about how to use the programs should be searched in this -order: - source code - --help output - FAQ - README +USAGE & DOCUMENTATION + +There are two programs: `hts` and `htc`. `hts` is the *httptunnel server* +and `htc` is the *client*. `hts` should be installed on a computer outside +the HTTP proxy, and `htc` should be installed on your local computer. -Having said that, here's a (probably outdated) example: - At host REMOTE, start hts like this: - hts -F localhost:23 8888 - At host LOCAL, start htc like this: - htc -F 2323 -P PROXY:8000 REMOTE:8888 - or, if using a buffering HTTP proxy: - htc -F 2323 -P PROXY:8000 -B 48K REMOTE:8888 +Documentation about how to use the programs should be searched in this +order: + 1. source code + 2. --help output + 3. FAQ + 4. README - Now you can do this at host LOCAL: - telnet localhost 2323 - and you will hopefully get a login prompt from host REMOTE. +Having said that, here's a (possibly outdated) example: + * start httptunnel server: + * At host REMOTE, start `hts` like this: + `hts -F localhost:23 8888` (set up httptunnel server to listen on port 8888 and forward to localhost:23) + * start httptunnel client: + * At host LOCAL, start `htc` like this: + `htc -F 2323 -P PROXY_ADDRESS:8000 REMOTE_IP:8888` (set up httptunnel client to forward localhost:2323 to REMOTE_IP:8888 via a local proxy at PROXY_ADDRESS:8000) + * or, if using a buffering HTTP proxy: + `htc -F 2323 -P PROXY_ADDRESS:8000 -B 48K REMOTE_IP:8888` + * Now you can do this at host LOCAL: + `telnet localhost 2323` (telnet in to REMOTE_IP:8888 via your httptunnel you just configured above on port localhost:2323) + ...and you will hopefully get a login prompt from host REMOTE_IP. -See also - http://metalab.unc.edu/LDP/HOWTO/mini/Firewall-Piercing.html -which is a good introduction to firewall piercing. It also has -describes one way to use httptunnel. +EXTERNAL HELP, EXAMPLES, & LINKS + + * https://sergvergara.files.wordpress.com/2011/04/http_tunnel.pdf - excellent httptunnel tutorial, examples, & info + * http://sebsauvage.net/punching/ - another excellent example + * https://daniel.haxx.se/docs/sshproxy.html - more useful info + * http://neophob.com/2006/10/gnu-httptunnel-v33-windows-binaries/ - httptunnel Win32 binaries (download here) + * [Google search for "http tunnel v3.3"](https://www.google.com/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8#q=http%20tunnel%20v3.3) - brings up lots of good links to httptunnel (this search seems to work better than searching for "httptunnel" alone since the latter brings up many generic search results or results pertaining to other tools) diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f6ce0d --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +#About +httptunnel creates a bidirectional virtual data path tunnelled in HTTP +requests. The requests can be sent via an HTTP proxy if so desired. + +This can be useful for users behind restrictive firewalls. If WWW +access is allowed through an HTTP proxy, it's possible to use +httptunnel and, say, telnet or PPP to connect to a computer outside +the firewall. + +If you still don't understand what this is all about, maybe you +can find some useful information in the FAQ file. + +This program is mostly intended for technically-oriented users. +They should know what to do. + +#Install +Read INSTALL for instructions on how to build a released version. +If you build the development repository, run `./autogen.sh` first. + +#License +httptunnel is free software. See COPYING for terms and conditions. +If you like it, I would appreciate if you sent a post card to: +> Lars Brinkhoff +> Kopmansgatan 2 +> 411 13 Goteborg +> Sweden + +Information and/or latest release should be available from these places: + * http://www.nocrew.org/software/httptunnel.html + * http://www.gnu.org/software/httptunnel/httptunnel.html + * ftp://ftp.gnu.org/pub/gnu/httptunnel + +I take no responsibility for what you do with this software. It has +the potential to do dangerous things, like disabling the protection +you system administrator has set up for the local network. Read the +DISCLAIMER file. + +#Usage & Documentation +There are two programs: `hts` and `htc`. `hts` is the *httptunnel server* +and `htc` is the *client*. `hts` should be installed on a computer outside +the HTTP proxy, and `htc` should be installed on your local computer. + +Documentation about how to use the programs should be searched in this +order: + 1. source code + 2. --help output + 3. FAQ + 4. README + +Having said that, here's a (possibly outdated) example: + * start httptunnel server: + * At host REMOTE, start `hts` like this: + `hts -F localhost:23 8888` (set up httptunnel server to listen on port 8888 and forward to localhost:23) + * start httptunnel client: + * At host LOCAL, start `htc` like this: + `htc -F 2323 -P PROXY_ADDRESS:8000 REMOTE_IP:8888` (set up httptunnel client to forward localhost:2323 to REMOTE_IP:8888 via a local proxy at PROXY_ADDRESS:8000) + * or, if using a buffering HTTP proxy: + `htc -F 2323 -P PROXY_ADDRESS:8000 -B 48K REMOTE_IP:8888` + * Now you can do this at host LOCAL: + `telnet localhost 2323` (telnet in to REMOTE_IP:8888 via your httptunnel you just configured above on port localhost:2323) + ...and you will hopefully get a login prompt from host REMOTE_IP. + +#External help, examples, & links + + * https://sergvergara.files.wordpress.com/2011/04/http_tunnel.pdf - excellent httptunnel tutorial, examples, & info + * http://sebsauvage.net/punching/ - another excellent example + * https://daniel.haxx.se/docs/sshproxy.html - more useful info + * http://neophob.com/2006/10/gnu-httptunnel-v33-windows-binaries/ - httptunnel Win32 binaries (download here) + * [Google search for "http tunnel v3.3"](https://www.google.com/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8#q=http%20tunnel%20v3.3) - brings up lots of good links to httptunnel (this search seems to work better than searching for "httptunnel" alone since the latter brings up many generic search results or results pertaining to other tools)