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