| 1 | .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sp \" Vertical space (when we can't use .PP) |
| 6 | .if t .sp .5v |
| 7 | .if n .sp |
| 8 | .. |
| 9 | .de Vb \" Begin verbatim text |
| 10 | .ft CW |
| 11 | .nf |
| 12 | .ne \\$1 |
| 13 | .. |
| 14 | .de Ve \" End verbatim text |
| 15 | .ft R |
| 16 | .fi |
| 17 | .. |
| 18 | .\" Set up some character translations and predefined strings. \*(-- will |
| 19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 23 | .\" nothing in troff, for use with C<>. |
| 24 | .tr \(*W- |
| 25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 26 | .ie n \{\ |
| 27 | . ds -- \(*W- |
| 28 | . ds PI pi |
| 29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 31 | . ds L" "" |
| 32 | . ds R" "" |
| 33 | . ds C` "" |
| 34 | . ds C' "" |
| 35 | 'br\} |
| 36 | .el\{\ |
| 37 | . ds -- \|\(em\| |
| 38 | . ds PI \(*p |
| 39 | . ds L" `` |
| 40 | . ds R" '' |
| 41 | 'br\} |
| 42 | .\" |
| 43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
| 44 | .ie \n(.g .ds Aq \(aq |
| 45 | .el .ds Aq ' |
| 46 | .\" |
| 47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 50 | .\" output yourself in some meaningful fashion. |
| 51 | .ie \nF \{\ |
| 52 | . de IX |
| 53 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 54 | .. |
| 55 | . nr % 0 |
| 56 | . rr F |
| 57 | .\} |
| 58 | .el \{\ |
| 59 | . de IX |
| 60 | .. |
| 61 | .\} |
| 62 | .\" ======================================================================== |
| 63 | .\" |
| 64 | .IX Title "corkscrew 1" |
| 65 | .TH corkscrew 1 "2013-05-23" "corkscrew" "Networking" |
| 66 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 67 | .\" way too many mistakes in technical documents. |
| 68 | .if n .ad l |
| 69 | .nh |
| 70 | .SH "NAME" |
| 71 | corkscrew \- Tunnel TCP connections through HTTP proxies |
| 72 | .SH "SYNOPSIS" |
| 73 | .IX Header "SYNOPSIS" |
| 74 | .Vb 1 |
| 75 | \& corkscrew PROXY PROXYPORT TARGETHOST TARGETPORT [AUTH_FILE] |
| 76 | .Ve |
| 77 | .SH "DESCRIPTION" |
| 78 | .IX Header "DESCRIPTION" |
| 79 | corkscrew is a simple tool to tunnel \s-1TCP\s0 connections through an \s-1HTTP\s0 |
| 80 | proxy supporting the \s-1CONNECT\s0 method. It reads stdin and writes to std\- |
| 81 | out during the connection, just like netcat. It can be used for |
| 82 | instance to connect to an \s-1SSH\s0 server running on a remote 443 port |
| 83 | through a strict \s-1HTTPS\s0 proxy. |
| 84 | .IP "\s-1PROXY\s0" 4 |
| 85 | .IX Item "PROXY" |
| 86 | The name of the host running the \s-1HTTP\s0 proxy. |
| 87 | .IP "\s-1PROXYPORT\s0" 4 |
| 88 | .IX Item "PROXYPORT" |
| 89 | The port on which to connect on the proxy. |
| 90 | .IP "\s-1TARGET\s0" 4 |
| 91 | .IX Item "TARGET" |
| 92 | The host to reach through the proxy. |
| 93 | .IP "\s-1TARGETPORT\s0" 4 |
| 94 | .IX Item "TARGETPORT" |
| 95 | The port to connect to on the target host. |
| 96 | .IP "\s-1AUTH_\s0 \s-1FILE\s0" 4 |
| 97 | .IX Item "AUTH_ FILE" |
| 98 | The auth file is made of one single line containing your username and |
| 99 | password in the form |
| 100 | .Sp |
| 101 | .Vb 1 |
| 102 | \& username:password |
| 103 | .Ve |
| 104 | .SH "OPTIONS" |
| 105 | .IX Header "OPTIONS" |
| 106 | None. |
| 107 | .SH "EXAMPLES" |
| 108 | .IX Header "EXAMPLES" |
| 109 | The common usage of corkscrew is to put the following line in |
| 110 | ~/.ssh/ssh_config: |
| 111 | .PP |
| 112 | .Vb 1 |
| 113 | \& ProxyCommand corkscrew proxy proxyport %h %p [<path to auth_file>] |
| 114 | .Ve |
| 115 | .PP |
| 116 | This will let the ssh connection go through the proxy with the help of |
| 117 | corkscrew. |
| 118 | .SH "ENVIRONMENT" |
| 119 | .IX Header "ENVIRONMENT" |
| 120 | None. |
| 121 | .SH "FILES" |
| 122 | .IX Header "FILES" |
| 123 | None. |
| 124 | .SH "SEE ALSO" |
| 125 | .IX Header "SEE ALSO" |
| 126 | \&\fIssh_config\fR\|(5) |
| 127 | .SH "AUTHORS" |
| 128 | .IX Header "AUTHORS" |
| 129 | Program was written by Pat Padgett <agroman@agroman.net>. |
| 130 | .PP |
| 131 | This manual page was written by Laurent Fousse <laurent@komite.net> for |
| 132 | the Debian \s-1GNU\s0 system (but may be used by others). Updated by Jari |
| 133 | Aalto <jari.aalto@cante.net>. Released under license \s-1GNU\s0 \s-1GPL\s0 version 2 |
| 134 | or (at your option) any later version. For more information about |
| 135 | license, visit <http://www.gnu.org/copyleft/gpl.html>. |