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

   1 '\" te
   2 .\" Copyright (c) 2001, 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-HTTP-PROXY-CONNECT 1 "Oct 24, 2001"
   7 .SH NAME
   8 ssh-http-proxy-connect \- Secure Shell proxy for HTTP
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/ssh/ssh-http-proxy-connect\fR [\fB-h\fR \fIhttp_proxy_host\fR]
  13      [\fB-p\fR \fIhttp_proxy_port\fR] \fIconnect_host\fR \fIconnect_port\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 A proxy command for \fBssh\fR(1) that uses HTTP CONNECT. Typical use is where
  20 connections external to a network are only allowed via a proxy web server.
  21 .SH OPTIONS
  22 .sp
  23 .LP
  24 The following options are supported:
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fB-h\fR \fIhttp_proxy_host\fR\fR
  29 .ad
  30 .RS 22n
  31 Specifies the proxy web server through which to connect. Overrides the
  32 \fBHTTPPROXY\fR and \fBhttp_proxy\fR environment variables if they are set.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-p\fR \fIhttp_proxy_port\fR\fR
  39 .ad
  40 .RS 22n
  41 Specifies the port on which the proxy web server runs. If not specified, port
  42 80 is assumed. Overrides the \fBHTTPPROXYPORT\fR and \fBhttp_proxy\fR
  43 environment variables if they are set.
  44 .RE
  45
  46 .SH OPERANDS
  47 .sp
  48 .LP
  49 The following operands are supported:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIhttp_proxy_host\fR\fR
  54 .ad
  55 .RS 19n
  56 The host name or IP address (IPv4 or IPv6) of the proxy.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIhttp_proxy_port\fR\fR
  63 .ad
  64 .RS 19n
  65 The numeric port number to connect to on \fIhttp_proxy_host\fR.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIconnect_host\fR\fR
  72 .ad
  73 .RS 19n
  74 The name of the remote host to which the proxy web server is to connect you.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIconnect_port\fR\fR
  81 .ad
  82 .RS 19n
  83 The numeric port number of the proxy web server to connect you to on
  84 \fIhttp_proxy_host\fR.
  85 .RE
  86
  87 .SH EXAMPLES
  88 .sp
  89 .LP
  90 The recommended way to use a proxy connection command is to configure the
  91 \fBProxyCommand\fR in \fBssh_config\fR(4) (see Example 1 and Example 2).
  92 Example 3 shows how the proxy command can be specified on the command line when
  93 running \fBssh\fR(1).
  94 .LP
  95 \fBExample 1 \fRSetting the proxy from the environment
  96 .sp
  97 .LP
  98 The following example uses \fBssh-http-proxy-connect\fR in \fBssh_config\fR(4)
  99 when the proxy is set from the environment:
 100
 101 .sp
 102 .in +2
 103 .nf
 104 \fBHost playtime.foo.com
 105     ProxyCommand /usr/lib/ssh/ssh-http-proxy-connect \e
 106         playtime.foo.com 22\fR
 107 .fi
 108 .in -2
 109 .sp
 110
 111 .LP
 112 \fBExample 2 \fROverriding proxy environment variables
 113 .sp
 114 .LP
 115 The following example uses \fBssh-http-proxy-connect\fR in \fBssh_config\fR(4)
 116 to override (or if not set) proxy environment variables:
 117
 118 .sp
 119 .in +2
 120 .nf
 121 \fBHost playtime.foo.com
 122     ProxyCommand /usr/lib/ssh/ssh-http-proxy-connect -h webcache \e
 123         -p 8080 playtime.foo.com 22\fR
 124 .fi
 125 .in -2
 126 .sp
 127
 128 .LP
 129 \fBExample 3 \fRUsing the command line
 130 .sp
 131 .LP
 132 The following example uses \fBssh-http-proxy-connect\fR from the \fBssh\fR(1)
 133 command line:
 134
 135 .sp
 136 .in +2
 137 .nf
 138 example$ \fBssh -o'ProxyCommand="/usr/lib/ssh/ssh-http-proxy-connect \e
 139     -h webcache -p 8080 playtime.foo.com 22"' playtime.foo.com\fR
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .SH ENVIRONMENT VARIABLES
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBHTTPPROXY\fR\fR
 149 .ad
 150 .RS 17n
 151 Takes the \fIhttp_proxy_host\fR operand to specify the default proxy host.
 152 Overrides \fBhttp_proxy\fR if both are set.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBHTTPPROXYPORT\fR\fR
 159 .ad
 160 .RS 17n
 161 Takes the \fIhttp_proxy_port\fR operand to specify the default proxy port.
 162 Ignored if \fBHTTPPROXY\fR is not set.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBhttp_proxy\fR\fR
 169 .ad
 170 .RS 17n
 171 \fBURL\fR format for specifying proxy host and port.
 172 .RE
 173
 174 .SH EXIT STATUS
 175 .sp
 176 .LP
 177 The following exit values are returned:
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB0\fR \fR
 182 .ad
 183 .RS 6n
 184 Successful completion.
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fB1\fR \fR
 191 .ad
 192 .RS 6n
 193 An error occurred.
 194 .RE
 195
 196 .SH ATTRIBUTES
 197 .sp
 198 .LP
 199 See \fBattributes\fR(5) for descriptions of the following attributes:
 200 .sp
 201
 202 .sp
 203 .TS
 204 box;
 205 c | c
 206 l | l .
 207 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 208 _
 209 Interface Stability     Stable
 210 .TE
 211
 212 .SH SEE ALSO
 213 .sp
 214 .LP
 215 \fBssh\fR(1), \fBssh-socks5-proxy-connect\fR(1), \fBssh_config\fR(4),
 216 \fBattributes\fR(5)