ssh-socks5-proxy-connect(1)

NAME

     ssh-socks5-proxy-connect - Secure Shell proxy for SOCKS5

SYNOPSIS

     /usr/lib/ssh/ssh-socks5-proxy-connect [-h socks5_proxy_host]
     [-p socks5_proxy_port] connect_host connect_port

DESCRIPTION

     A proxy command for ssh(1) that uses SOCKS5 (RFC 1928). Typ-
     ical use is where connections external to a network are only
     allowed via a socks gateway server.

     This proxy command  does  not  provide  any  of  the  SOCKS5
     authentication   mechanisms   defined   in  RFC  1928.  Only
     anonymous connections are possible.

OPTIONS

     The following options are supported:

     -h socks5_proxy_host
           Specifies the proxy web server through which  to  con-
           nect.  Overrides  the  SOCKS5_SERVER environment vari-
           able.

     -p socks5_proxy_port
           Specifies the port on which the proxy web server runs.
           If  not  specified,  port 80 is assumed. Overrides the
           SOCKS5_PORT environment variable.

OPERANDS

     The following operands are supported:

     socks5_proxy_host
           The host name or IP address  (IPv4  or  IPv6)  of  the
           proxy.

     socks5_proxy_port
           The   numeric   port   number   to   connect   to   on
           socks5_proxy_host.

     connect_host
           The name of the remote host to which the socks gateway
           is to connect you.

     connect_port
           The numeric port number of the socks gateway  to  con-
           nect you to on connect_host.

EXAMPLES

     The recommended way to use a proxy connection command is  to
     configure  the  ProxyCommand in ssh_config(4) (see Example 1
     and Example 2). Example 3 shows how the proxy command can be
     specified on the command line when running ssh(1).

     Example 1: Setting the proxy from the environment

     The  following  example  uses  ssh-socks5-proxy-connect   in
     ssh_config(4) when the proxy is set from the environment:

     Host playtime.foo.com
         ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect \
             playtime.foo.com 22

     Example 2: Overriding proxy environment variables

     The  following  example  uses  ssh-socks5-proxy-connect   in
     ssh_config(4)  to override (or if not set) proxy environment
     variables:

     Host playtime.foo.com
         ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect -h socks-gw \
             -p 1080 playtime.foo.com 22

     Example 3: Using the command line

     The following example uses ssh-socks5-proxy-connect from the
     ssh(1) command line:

     example$ ssh -o'ProxyCommand=/usr/lib/ssh/ssh-socks5-proxy-connect \
         -h socks-gw -p 1080 playtime.foo.com 22' playtime.foo.com

ENVIRONMENT VARIABLES

     SOCKS5_SERVER
           Takes socks5_proxy_host operand to specify the default
           proxy host.

     SOCKS5_PORT
           Takes  socks5_proxy_port   operand  to   specify   the
           default proxy port.

EXIT STATUS

     The following exit values are returned:

     0     Successful completion.

     1     An error occurred.

ATTRIBUTES

     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | SUNWsshu                    |
    |_____________________________|_____________________________|
    | Interface Stability         | Stable                      |
    |_____________________________|_____________________________|

SEE ALSO

     ssh(1),  ssh-http-proxy-connect(1),  ssh_config(4),   attri-
     butes(5)