usr/src/man/man1/ssh-socks5-proxy-connect.1

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SSH-SOCKS5-PROXY-CONNECT 1 "Oct 30, 2002"
   7 .SH NAME
   8 ssh-socks5-proxy-connect \- Secure Shell proxy for SOCKS5
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/ssh/ssh-socks5-proxy-connect\fR
  13      [\fB-h\fR \fIsocks5_proxy_host\fR]
  14      [\fB-p\fR \fIsocks5_proxy_port\fR] \fIconnect_host\fR \fIconnect_port\fR
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 A proxy command for \fBssh\fR(1) that uses SOCKS5 (RFC 1928). Typical use is
  21 where connections external to a network are only allowed via a socks gateway
  22 server.
  23 .sp
  24 .LP
  25 This proxy command does not provide any of the SOCKS5 authentication mechanisms
  26 defined in RFC 1928. Only anonymous connections are possible.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 The following options are supported:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-h\fR \fIsocks5_proxy_host\fR\fR
  35 .ad
  36 .RS 24n
  37 Specifies the proxy web server through which to connect. Overrides the
  38 \fBSOCKS5_SERVER\fR environment variable.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-p\fR \fIsocks5_proxy_port\fR\fR
  45 .ad
  46 .RS 24n
  47 Specifies the port on which the proxy web server runs. If not specified, port
  48 80 is assumed. Overrides the \fBSOCKS5_PORT\fR environment variable.
  49 .RE
  50
  51 .SH OPERANDS
  52 .sp
  53 .LP
  54 The following operands are supported:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIsocks5_proxy_host\fR\fR
  59 .ad
  60 .RS 21n
  61 The host name or IP address (IPv4 or IPv6) of the proxy.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fIsocks5_proxy_port\fR\fR
  68 .ad
  69 .RS 21n
  70 The numeric port number to connect to on \fIsocks5_proxy_host\fR.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fIconnect_host\fR\fR
  77 .ad
  78 .RS 21n
  79 The name of the remote host to which the socks gateway is to connect you.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIconnect_port\fR\fR
  86 .ad
  87 .RS 21n
  88 The numeric port number of the socks gateway to connect you to on
  89 \fIconnect_host\fR.
  90 .RE
  91
  92 .SH EXAMPLES
  93 .sp
  94 .LP
  95 The recommended way to use a proxy connection command is to configure the
  96 \fBProxyCommand\fR in \fBssh_config\fR(4) (see Example 1 and Example 2).
  97 Example 3 shows how the proxy command can be specified on the command line when
  98 running \fBssh\fR(1).
  99 .LP
 100 \fBExample 1 \fRSetting the proxy from the environment
 101 .sp
 102 .LP
 103 The following example uses \fBssh-socks5-proxy-connect\fR in
 104 \fBssh_config\fR(4) when the proxy is set from the environment:
 105
 106 .sp
 107 .in +2
 108 .nf
 109 \fBHost playtime.foo.com
 110     ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect \e
 111         playtime.foo.com 22\fR
 112 .fi
 113 .in -2
 114 .sp
 115
 116 .LP
 117 \fBExample 2 \fROverriding proxy environment variables
 118 .sp
 119 .LP
 120 The following example uses \fBssh-socks5-proxy-connect\fR in
 121 \fBssh_config\fR(4) to override (or if not set) proxy environment variables:
 122
 123 .sp
 124 .in +2
 125 .nf
 126 \fBHost playtime.foo.com
 127     ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect -h socks-gw \e
 128         -p 1080 playtime.foo.com 22\fR
 129 .fi
 130 .in -2
 131 .sp
 132
 133 .LP
 134 \fBExample 3 \fRUsing the command line
 135 .sp
 136 .LP
 137 The following example uses \fBssh-socks5-proxy-connect\fR from the \fBssh\fR(1)
 138 command line:
 139
 140 .sp
 141 .in +2
 142 .nf
 143 example$ \fBssh -o'ProxyCommand=/usr/lib/ssh/ssh-socks5-proxy-connect \e
 144     -h socks-gw -p 1080 playtime.foo.com 22' playtime.foo.com\fR
 145 .fi
 146 .in -2
 147 .sp
 148
 149 .SH ENVIRONMENT VARIABLES
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBSOCKS5_SERVER\fR\fR
 154 .ad
 155 .RS 17n
 156 Takes \fIsocks5_proxy_host\fR operand to specify the default proxy host.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBSOCKS5_PORT\fR\fR
 163 .ad
 164 .RS 17n
 165 Takes \fIsocks5_proxy_port \fR operand to specify the default proxy port.
 166 .RE
 167
 168 .SH EXIT STATUS
 169 .sp
 170 .LP
 171 The following exit values are returned:
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fB0\fR \fR
 176 .ad
 177 .RS 6n
 178 Successful completion.
 179 .RE
 180
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fB1\fR \fR
 185 .ad
 186 .RS 6n
 187 An error occurred.
 188 .RE
 189
 190 .SH ATTRIBUTES
 191 .sp
 192 .LP
 193 See \fBattributes\fR(5) for descriptions of the following attributes:
 194 .sp
 195
 196 .sp
 197 .TS
 198 box;
 199 c | c
 200 l | l .
 201 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 202 _
 203 Interface Stability     Stable
 204 .TE
 205
 206 .SH SEE ALSO
 207 .sp
 208 .LP
 209 \fBssh\fR(1), \fBssh-http-proxy-connect\fR(1), \fBssh_config\fR(4),
 210 \fBattributes\fR(5)