ssh-socks5-proxy-connect(1)

1ssh-socks5-proxy-connect(1)      User Commands     ssh-socks5-proxy-connect(1)
2
3
4

NAME

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

SYNOPSIS

9       /usr/lib/ssh/ssh-socks5-proxy-connect
10            [-h socks5_proxy_host]
11            [-p socks5_proxy_port] connect_host connect_port
12
13

DESCRIPTION

15       A  proxy command for ssh(1) that uses SOCKS5 (RFC 1928). Typical use is
16       where connections external to a network are only allowed  via  a  socks
17       gateway server.
18
19
20       This  proxy  command  does not provide any of the SOCKS5 authentication
21       mechanisms defined in RFC 1928. Only anonymous connections  are  possi‐
22       ble.
23

OPTIONS

25       The following options are supported:
26
27       -h socks5_proxy_host    Specifies the proxy web server through which to
28                               connect. Overrides the  SOCKS5_SERVER  environ‐
29                               ment variable.
30
31
32       -p socks5_proxy_port    Specifies  the  port  on  which  the  proxy web
33                               server runs.  If  not  specified,  port  80  is
34                               assumed.  Overrides the SOCKS5_PORT environment
35                               variable.
36
37

OPERANDS

39       The following operands are supported:
40
41       socks5_proxy_host    The host name or IP address (IPv4 or IPv6) of  the
42                            proxy.
43
44
45       socks5_proxy_port    The   numeric   port   number  to  connect  to  on
46                            socks5_proxy_host.
47
48
49       connect_host         The name of the remote host  to  which  the  socks
50                            gateway is to connect you.
51
52
53       connect_port         The  numeric  port  number of the socks gateway to
54                            connect you to on connect_host.
55
56

EXAMPLES

58       The recommended way to use a proxy connection command is  to  configure
59       the  ProxyCommand in ssh_config(4) (see Example 1 and Example 2). Exam‐
60       ple 3 shows how the proxy command can be specified on the command  line
61       when running ssh(1).
62
63       Example 1 Setting the proxy from the environment
64
65
66       The  following  example  uses ssh-socks5-proxy-connect in ssh_config(4)
67       when the proxy is set from the environment:
68
69
70         Host playtime.foo.com
71             ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect \
72                 playtime.foo.com 22
73
74
75
76       Example 2 Overriding proxy environment variables
77
78
79       The following example uses ssh-socks5-proxy-connect in ssh_config(4) to
80       override (or if not set) proxy environment variables:
81
82
83         Host playtime.foo.com
84             ProxyCommand /usr/lib/ssh/ssh-socks5-proxy-connect -h socks-gw \
85                 -p 1080 playtime.foo.com 22
86
87
88
89       Example 3 Using the command line
90
91
92       The  following  example  uses  ssh-socks5-proxy-connect from the ssh(1)
93       command line:
94
95
96         example$ ssh -o'ProxyCommand=/usr/lib/ssh/ssh-socks5-proxy-connect \
97             -h socks-gw -p 1080 playtime.foo.com 22' playtime.foo.com
98
99
100

ENVIRONMENT VARIABLES

102       SOCKS5_SERVER    Takes socks5_proxy_host operand to specify the default
103                        proxy host.
104
105
106       SOCKS5_PORT      Takes   socks5_proxy_port    operand  to  specify  the
107                        default proxy port.
108
109

EXIT STATUS

111       The following exit values are returned:
112
113       0     Successful completion.
114
115
116       1     An error occurred.
117
118

ATTRIBUTES

120       See attributes(5) for descriptions of the following attributes:
121
122
123
124
125       ┌─────────────────────────────┬─────────────────────────────┐
126       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
127       ├─────────────────────────────┼─────────────────────────────┤
128       │Availability                 │SUNWsshu                     │
129       ├─────────────────────────────┼─────────────────────────────┤
130       │Interface Stability          │Stable                       │
131       └─────────────────────────────┴─────────────────────────────┘
132