net-ssh 1.0.9 → 1.0.10
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/manual-html/chapter-1.html +388 -0
- data/doc/manual-html/chapter-2.html +541 -0
- data/doc/manual-html/chapter-3.html +470 -0
- data/doc/manual-html/chapter-4.html +413 -0
- data/doc/manual-html/chapter-5.html +525 -0
- data/doc/manual-html/chapter-6.html +456 -0
- data/doc/manual-html/chapter-7.html +343 -0
- data/doc/manual-html/index.html +235 -0
- data/doc/manual-html/stylesheets/manual.css +270 -0
- data/doc/manual-html/stylesheets/ruby.css +17 -0
- data/lib/net/ssh/connection/driver.rb +25 -10
- data/lib/net/ssh/service/shell/sync.rb +1 -1
- data/lib/net/ssh/session.rb +6 -1
- data/lib/net/ssh/transport/packet-stream.rb +1 -1
- data/lib/net/ssh/transport/session.rb +2 -0
- data/lib/net/ssh/version.rb +1 -1
- metadata +16 -3
|
@@ -0,0 +1,343 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>Net::SSH Manual :: Chapter 7: Using Proxies</title>
|
|
4
|
+
<link type="text/css" rel="stylesheet" href="stylesheets/manual.css" />
|
|
5
|
+
</head>
|
|
6
|
+
|
|
7
|
+
<body>
|
|
8
|
+
<div id="banner">
|
|
9
|
+
<table border='0' cellpadding='0' cellspacing='0' width='100%'>
|
|
10
|
+
<tr><td valign='top' align='left'>
|
|
11
|
+
<div class="title">
|
|
12
|
+
<span class="product">Net::SSH—</span><br />
|
|
13
|
+
<span class="tagline">Secure Shell for Ruby</span>
|
|
14
|
+
</div>
|
|
15
|
+
</td><td valign='middle' align='right'>
|
|
16
|
+
<div class="info">
|
|
17
|
+
Net::SSH Version: <strong>1.0.10</strong><br />
|
|
18
|
+
Manual Last Updated: <strong>2006-09-09 23:59 UTC</strong>
|
|
19
|
+
</div>
|
|
20
|
+
</td></tr>
|
|
21
|
+
</table>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<table border='0' width='100%' cellpadding='0' cellspacing='0'>
|
|
25
|
+
<tr><td valign='top'>
|
|
26
|
+
|
|
27
|
+
<div id="navigation">
|
|
28
|
+
<h1>Net::SSH Manual</h1>
|
|
29
|
+
|
|
30
|
+
<h2>Chapters</h2>
|
|
31
|
+
<ol type="I">
|
|
32
|
+
|
|
33
|
+
<li>
|
|
34
|
+
<a href="chapter-1.html">
|
|
35
|
+
Introduction
|
|
36
|
+
</a>
|
|
37
|
+
|
|
38
|
+
<ol type="1">
|
|
39
|
+
|
|
40
|
+
<li><a href="chapter-1.html#s1">What is Net::SSH?</a></li>
|
|
41
|
+
|
|
42
|
+
<li><a href="chapter-1.html#s2">What isn’t Net::SSH?</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="chapter-1.html#s3">Getting Net::SSH</a></li>
|
|
45
|
+
|
|
46
|
+
<li><a href="chapter-1.html#s4">License Information</a></li>
|
|
47
|
+
|
|
48
|
+
<li><a href="chapter-1.html#s5">Support</a></li>
|
|
49
|
+
|
|
50
|
+
<li><a href="chapter-1.html#s6">About the Author</a></li>
|
|
51
|
+
|
|
52
|
+
</ol>
|
|
53
|
+
</li>
|
|
54
|
+
|
|
55
|
+
<li>
|
|
56
|
+
<a href="chapter-2.html">
|
|
57
|
+
Starting a Session
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
<ol type="1">
|
|
61
|
+
|
|
62
|
+
<li><a href="chapter-2.html#s1">Using Net::SSH.start</a></li>
|
|
63
|
+
|
|
64
|
+
<li><a href="chapter-2.html#s2">Using a Public/Private Key</a></li>
|
|
65
|
+
|
|
66
|
+
<li><a href="chapter-2.html#s3">Options</a></li>
|
|
67
|
+
|
|
68
|
+
<li><a href="chapter-2.html#s4">Using Net::SSH::Session</a></li>
|
|
69
|
+
|
|
70
|
+
</ol>
|
|
71
|
+
</li>
|
|
72
|
+
|
|
73
|
+
<li>
|
|
74
|
+
<a href="chapter-3.html">
|
|
75
|
+
Channels
|
|
76
|
+
</a>
|
|
77
|
+
|
|
78
|
+
<ol type="1">
|
|
79
|
+
|
|
80
|
+
<li><a href="chapter-3.html#s1">What are Channels?</a></li>
|
|
81
|
+
|
|
82
|
+
<li><a href="chapter-3.html#s2">Session.loop</a></li>
|
|
83
|
+
|
|
84
|
+
<li><a href="chapter-3.html#s3">Channel Types</a></li>
|
|
85
|
+
|
|
86
|
+
<li><a href="chapter-3.html#s4">Opening a Channel</a></li>
|
|
87
|
+
|
|
88
|
+
<li><a href="chapter-3.html#s5">Callbacks</a></li>
|
|
89
|
+
|
|
90
|
+
<li><a href="chapter-3.html#s6">Channel Operations</a></li>
|
|
91
|
+
|
|
92
|
+
</ol>
|
|
93
|
+
</li>
|
|
94
|
+
|
|
95
|
+
<li>
|
|
96
|
+
<a href="chapter-4.html">
|
|
97
|
+
Executing Commands
|
|
98
|
+
</a>
|
|
99
|
+
|
|
100
|
+
<ol type="1">
|
|
101
|
+
|
|
102
|
+
<li><a href="chapter-4.html#s1">Using Channels</a></li>
|
|
103
|
+
|
|
104
|
+
<li><a href="chapter-4.html#s2">Using #process.open</a></li>
|
|
105
|
+
|
|
106
|
+
<li><a href="chapter-4.html#s3">Using #process.popen3</a></li>
|
|
107
|
+
|
|
108
|
+
</ol>
|
|
109
|
+
</li>
|
|
110
|
+
|
|
111
|
+
<li>
|
|
112
|
+
<a href="chapter-5.html">
|
|
113
|
+
User Shells
|
|
114
|
+
</a>
|
|
115
|
+
|
|
116
|
+
<ol type="1">
|
|
117
|
+
|
|
118
|
+
<li><a href="chapter-5.html#s1">Introduction</a></li>
|
|
119
|
+
|
|
120
|
+
<li><a href="chapter-5.html#s2">Using Channels</a></li>
|
|
121
|
+
|
|
122
|
+
<li><a href="chapter-5.html#s3">Shell Service</a></li>
|
|
123
|
+
|
|
124
|
+
<li><a href="chapter-5.html#s4">SyncShell Service</a></li>
|
|
125
|
+
|
|
126
|
+
<li><a href="chapter-5.html#s5">Terminal Clients</a></li>
|
|
127
|
+
|
|
128
|
+
</ol>
|
|
129
|
+
</li>
|
|
130
|
+
|
|
131
|
+
<li>
|
|
132
|
+
<a href="chapter-6.html">
|
|
133
|
+
Port Forwarding
|
|
134
|
+
</a>
|
|
135
|
+
|
|
136
|
+
<ol type="1">
|
|
137
|
+
|
|
138
|
+
<li><a href="chapter-6.html#s1">Introduction</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="chapter-6.html#s2">Local-to-Remote</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="chapter-6.html#s3">Remote-to-Local</a></li>
|
|
143
|
+
|
|
144
|
+
<li><a href="chapter-6.html#s4">Direct Channels</a></li>
|
|
145
|
+
|
|
146
|
+
<li><a href="chapter-6.html#s5">Remote-to-Local Handlers</a></li>
|
|
147
|
+
|
|
148
|
+
</ol>
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
<li><strong>
|
|
152
|
+
<a href="chapter-7.html">
|
|
153
|
+
Using Proxies
|
|
154
|
+
</a>
|
|
155
|
+
</strong> <big>←</big>
|
|
156
|
+
<ol type="1">
|
|
157
|
+
|
|
158
|
+
<li><a href="chapter-7.html#s1">Introduction</a></li>
|
|
159
|
+
|
|
160
|
+
<li><a href="chapter-7.html#s2"><span class="caps">HTTP</span></a></li>
|
|
161
|
+
|
|
162
|
+
<li><a href="chapter-7.html#s3"><span class="caps">SOCKS</span></a></li>
|
|
163
|
+
|
|
164
|
+
</ol>
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
</ol>
|
|
168
|
+
|
|
169
|
+
<h2>Other Documentation</h2>
|
|
170
|
+
|
|
171
|
+
<ul>
|
|
172
|
+
<li><a href="http://net-ssh.rubyforge.org/api/index.html">Net::SSH API</a></li>
|
|
173
|
+
<li><a href="http://rubyforge.org/tracker/?atid=1842&group_id=274&func=browse">Net::SSH FAQ</a></li>
|
|
174
|
+
</ul>
|
|
175
|
+
|
|
176
|
+
<h2>Tutorials</h2>
|
|
177
|
+
<ol>
|
|
178
|
+
|
|
179
|
+
</ol>
|
|
180
|
+
|
|
181
|
+
<p align="center"><strong>More To Come...</strong></p>
|
|
182
|
+
|
|
183
|
+
<div class="license">
|
|
184
|
+
<a href="http://creativecommons.org/licenses/by-sa/2.0/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights" /></a><br />
|
|
185
|
+
This manual is licensed under a <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons License</a>.
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
</td><td valign='top' width="100%">
|
|
190
|
+
|
|
191
|
+
<div id="content">
|
|
192
|
+
|
|
193
|
+
<div class="top"><div class="prevnext">
|
|
194
|
+
|
|
195
|
+
<a href="chapter-6.html">Previous (6. Port Forwarding)</a> |
|
|
196
|
+
|
|
197
|
+
<a href="index.html">Up</a>
|
|
198
|
+
|
|
199
|
+
</div></div>
|
|
200
|
+
|
|
201
|
+
<h1>7. Using Proxies</h1>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<h2>
|
|
206
|
+
<a name="s1"></a>
|
|
207
|
+
7.1. Introduction
|
|
208
|
+
</h2>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="section">
|
|
213
|
+
<p>Many times, you may find yourself behind a firewall, unable to <span class="caps">SSH</span> out. In such instances, you can often take advantage of your existing proxies to tunnel an <span class="caps">SSH</span> connection through your firewall.</p>
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<h2>
|
|
219
|
+
<a name="s2"></a>
|
|
220
|
+
7.2. <span class="caps">HTTP</span>
|
|
221
|
+
</h2>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<div class="section">
|
|
226
|
+
<p>If you have an <span class="caps">HTTP</span> proxy running, you may be able to use it to your advantage. The following snippet demonstrates how to tunnel an <span class="caps">SSH</span> connection through an <span class="caps">HTTP</span> proxy:</p>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<div class='figure'>
|
|
230
|
+
<span class='caption'>Tunnelling an SSH connection over HTTP [ruby]</span>
|
|
231
|
+
<div class='body'><table border='0' cellpadding='0' cellspacing='0'><tr><td class='lineno'>1<br />2<br />3<br />4<br />5<br />6<br />7<br />8<br />9<br />10<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh</span><span class="punct">'</span>
|
|
232
|
+
<span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh/proxy/http</span><span class="punct">'</span>
|
|
233
|
+
|
|
234
|
+
<span class="ident">proxy_host</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my.proxy.com</span><span class="punct">'</span>
|
|
235
|
+
<span class="ident">proxy_port</span> <span class="punct">=</span> <span class="number">8080</span>
|
|
236
|
+
<span class="ident">proxy</span> <span class="punct">=</span> <span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">::</span><span class="constant">Proxy</span><span class="punct">::</span><span class="constant">HTTP</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span> <span class="ident">proxy_host</span><span class="punct">,</span> <span class="ident">proxy_port</span> <span class="punct">)</span>
|
|
237
|
+
|
|
238
|
+
<span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">.</span><span class="ident">start</span><span class="punct">(</span> <span class="punct">'</span><span class="string">host</span><span class="punct">',</span> <span class="symbol">:proxy</span> <span class="punct">=></span> <span class="ident">proxy</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
239
|
+
<span class="punct">...</span>
|
|
240
|
+
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<p>As you can see, you first create an instance of the proxy you want to use. (This flexibility allows for other proxy types to be supported, although at present only <span class="caps">HTTP</span> and <span class="caps">SOCKS</span> are available.)</p>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<p>Once you’ve created your proxy, you just start your <span class="caps">SSH</span> session, as usual, except you also pass a <code>:proxy</code> option. The proxy will then be used to obtain a connection to the remote host.</p>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<p>Note: If your proxy does not allow connects to be made to other hosts on port 22, then you’ll have to do some magic to allow <span class="caps">SSH</span> connections on your remote host on ports other than 22. Port forwarding on that remote host (from itself, to itself), can help you there.</p>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<p>For instance, if your proxy disallows connections to any port except (say) 443, you could run the following command on the remote host:</p>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<div class='figure'>
|
|
256
|
+
<span class='caption'>Forwarding a port using the ssh command [shell]</span>
|
|
257
|
+
<div class='body'><link rel='stylesheet' type='text/css' href='stylesheets/shell.css' /><div class='shell'><pre>ssh -gL 443:localhost:22 localhost</pre></div></div></div>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<p>Then, as long as that command is running, port 443 will always be forwarded to port 22. Naturally, this means that you must run this command while you have access to the box; if you can’t access that machine in the first place (ie, because you’re behind a firewall), then it does you no good.</p>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<h3>Proxy Authentication</h3>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<p>Some proxies require authentication. Net::SSH supports these proxies as well. If you specify the user name either as a <code>:user</code> option to the <span class="caps">HTTP</span> proxy constructor, or in the <code>HTTP_PROXY_USER</code> or <code>CONNECT_USER</code> environment variables, that name will be used to authenticate with the proxy. Likewise, the password may be given either via the <code>:password</code> constructor option, or via the <code>HTTP_PROXY_PASSWORD</code> or <code>CONNECT_PASSWORD</code> environment variables.</p>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<div class='figure'>
|
|
270
|
+
<span class='caption'>Using HTTP proxy authentication [ruby]</span>
|
|
271
|
+
<div class='body'><table border='0' cellpadding='0' cellspacing='0'><tr><td class='lineno'>1<br />2<br />3<br />4<br />5<br />6<br />7<br />8<br />9<br />10<br />11<br />12<br />13<br />14<br />15<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh</span><span class="punct">'</span>
|
|
272
|
+
<span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh/proxy/http</span><span class="punct">'</span>
|
|
273
|
+
|
|
274
|
+
<span class="ident">proxy_host</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my.proxy.com</span><span class="punct">'</span>
|
|
275
|
+
<span class="ident">proxy_port</span> <span class="punct">=</span> <span class="number">8080</span>
|
|
276
|
+
<span class="ident">proxy_user</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my-name</span><span class="punct">'</span>
|
|
277
|
+
<span class="ident">proxy_password</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my-password</span><span class="punct">'</span>
|
|
278
|
+
|
|
279
|
+
<span class="ident">proxy</span> <span class="punct">=</span> <span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">::</span><span class="constant">Proxy</span><span class="punct">::</span><span class="constant">HTTP</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span> <span class="ident">proxy_host</span><span class="punct">,</span> <span class="ident">proxy_port</span><span class="punct">,</span>
|
|
280
|
+
<span class="symbol">:user</span> <span class="punct">=></span> <span class="ident">proxy_user</span><span class="punct">,</span>
|
|
281
|
+
<span class="symbol">:password</span> <span class="punct">=></span> <span class="ident">proxy_password</span> <span class="punct">)</span>
|
|
282
|
+
|
|
283
|
+
<span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">.</span><span class="ident">start</span><span class="punct">(</span> <span class="punct">'</span><span class="string">host</span><span class="punct">',</span> <span class="symbol">:proxy</span> <span class="punct">=></span> <span class="ident">proxy</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
284
|
+
<span class="punct">...</span>
|
|
285
|
+
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<p>Note that currently, only basic authentication is supported; in the future, digest authentication may be added for proxies that support it.</p>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<h2>
|
|
294
|
+
<a name="s3"></a>
|
|
295
|
+
7.3. <span class="caps">SOCKS</span>
|
|
296
|
+
</h2>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<div class="section">
|
|
301
|
+
<p>In addition to the <span class="caps">HTTP</span> proxy, Net::SSH also supports <span class="caps">SOCKS</span> proxies (both versions 4 and 5). Their usage is almost identical to the <span class="caps">HTTP</span> version (except <span class="caps">SOCKS4</span> does not use passwords, just user names):</p>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<div class='figure'>
|
|
305
|
+
<span class='caption'>Using SOCKS proxies [ruby]</span>
|
|
306
|
+
<div class='body'><table border='0' cellpadding='0' cellspacing='0'><tr><td class='lineno'>1<br />2<br />3<br />4<br />5<br />6<br />7<br />8<br />9<br />10<br />11<br />12<br />13<br />14<br />15<br />16<br />17<br />18<br />19<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh</span><span class="punct">'</span>
|
|
307
|
+
<span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh/proxy/socks4</span><span class="punct">'</span>
|
|
308
|
+
<span class="ident">require</span> <span class="punct">'</span><span class="string">net/ssh/proxy/socks5</span><span class="punct">'</span>
|
|
309
|
+
|
|
310
|
+
<span class="ident">proxy_host</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my.proxy.com</span><span class="punct">'</span>
|
|
311
|
+
<span class="ident">proxy_port</span> <span class="punct">=</span> <span class="number">1080</span>
|
|
312
|
+
<span class="ident">proxy_user</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my-name</span><span class="punct">'</span>
|
|
313
|
+
<span class="ident">proxy_password</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">my-password</span><span class="punct">'</span>
|
|
314
|
+
|
|
315
|
+
<span class="ident">socks4</span> <span class="punct">=</span> <span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">::</span><span class="constant">Proxy</span><span class="punct">::</span><span class="constant">SOCKS4</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span> <span class="ident">proxy_host</span><span class="punct">,</span> <span class="ident">proxy_port</span><span class="punct">,</span>
|
|
316
|
+
<span class="symbol">:user</span> <span class="punct">=></span> <span class="ident">proxy_user</span> <span class="punct">)</span>
|
|
317
|
+
|
|
318
|
+
<span class="ident">socks5</span> <span class="punct">=</span> <span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">::</span><span class="constant">Proxy</span><span class="punct">::</span><span class="constant">SOCKS5</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span> <span class="ident">proxy_host</span><span class="punct">,</span> <span class="ident">proxy_port</span><span class="punct">,</span>
|
|
319
|
+
<span class="symbol">:user</span> <span class="punct">=></span> <span class="ident">proxy_user</span><span class="punct">,</span>
|
|
320
|
+
<span class="symbol">:password</span> <span class="punct">=></span> <span class="ident">proxy_password</span><span class="punct">)</span>
|
|
321
|
+
|
|
322
|
+
<span class="constant">Net</span><span class="punct">::</span><span class="constant">SSH</span><span class="punct">.</span><span class="ident">start</span><span class="punct">(</span> <span class="punct">'</span><span class="string">host</span><span class="punct">',</span> <span class="symbol">:proxy</span> <span class="punct">=></span> <span class="ident">socks4</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
323
|
+
<span class="punct">...</span>
|
|
324
|
+
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<div class="bottom"><div class="prevnext">
|
|
330
|
+
|
|
331
|
+
<a href="chapter-6.html">Previous (6. Port Forwarding)</a> |
|
|
332
|
+
|
|
333
|
+
<a href="index.html">Up</a>
|
|
334
|
+
|
|
335
|
+
</div></div>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
</div>
|
|
339
|
+
|
|
340
|
+
</td></tr>
|
|
341
|
+
</table>
|
|
342
|
+
</body>
|
|
343
|
+
</html>
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>Net::SSH Manual</title>
|
|
4
|
+
<link type="text/css" rel="stylesheet" href="stylesheets/manual.css" />
|
|
5
|
+
</head>
|
|
6
|
+
|
|
7
|
+
<body>
|
|
8
|
+
<div id="banner">
|
|
9
|
+
<table border='0' cellpadding='0' cellspacing='0' width='100%'>
|
|
10
|
+
<tr><td valign='top' align='left'>
|
|
11
|
+
<div class="title">
|
|
12
|
+
<span class="product">Net::SSH—</span><br />
|
|
13
|
+
<span class="tagline">Secure Shell for Ruby</span>
|
|
14
|
+
</div>
|
|
15
|
+
</td><td valign='middle' align='right'>
|
|
16
|
+
<div class="info">
|
|
17
|
+
Net::SSH Version: <strong>1.0.10</strong><br />
|
|
18
|
+
Manual Last Updated: <strong>2006-09-09 23:59 UTC</strong>
|
|
19
|
+
</div>
|
|
20
|
+
</td></tr>
|
|
21
|
+
</table>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<table border='0' width='100%' cellpadding='0' cellspacing='0'>
|
|
25
|
+
<tr><td valign='top'>
|
|
26
|
+
|
|
27
|
+
<div id="navigation">
|
|
28
|
+
<h1>Net::SSH Manual</h1>
|
|
29
|
+
|
|
30
|
+
<h2>Chapters</h2>
|
|
31
|
+
<ol type="I">
|
|
32
|
+
|
|
33
|
+
<li>
|
|
34
|
+
<a href="chapter-1.html">
|
|
35
|
+
Introduction
|
|
36
|
+
</a>
|
|
37
|
+
|
|
38
|
+
<ol type="1">
|
|
39
|
+
|
|
40
|
+
<li><a href="chapter-1.html#s1">What is Net::SSH?</a></li>
|
|
41
|
+
|
|
42
|
+
<li><a href="chapter-1.html#s2">What isn’t Net::SSH?</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="chapter-1.html#s3">Getting Net::SSH</a></li>
|
|
45
|
+
|
|
46
|
+
<li><a href="chapter-1.html#s4">License Information</a></li>
|
|
47
|
+
|
|
48
|
+
<li><a href="chapter-1.html#s5">Support</a></li>
|
|
49
|
+
|
|
50
|
+
<li><a href="chapter-1.html#s6">About the Author</a></li>
|
|
51
|
+
|
|
52
|
+
</ol>
|
|
53
|
+
</li>
|
|
54
|
+
|
|
55
|
+
<li>
|
|
56
|
+
<a href="chapter-2.html">
|
|
57
|
+
Starting a Session
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
<ol type="1">
|
|
61
|
+
|
|
62
|
+
<li><a href="chapter-2.html#s1">Using Net::SSH.start</a></li>
|
|
63
|
+
|
|
64
|
+
<li><a href="chapter-2.html#s2">Using a Public/Private Key</a></li>
|
|
65
|
+
|
|
66
|
+
<li><a href="chapter-2.html#s3">Options</a></li>
|
|
67
|
+
|
|
68
|
+
<li><a href="chapter-2.html#s4">Using Net::SSH::Session</a></li>
|
|
69
|
+
|
|
70
|
+
</ol>
|
|
71
|
+
</li>
|
|
72
|
+
|
|
73
|
+
<li>
|
|
74
|
+
<a href="chapter-3.html">
|
|
75
|
+
Channels
|
|
76
|
+
</a>
|
|
77
|
+
|
|
78
|
+
<ol type="1">
|
|
79
|
+
|
|
80
|
+
<li><a href="chapter-3.html#s1">What are Channels?</a></li>
|
|
81
|
+
|
|
82
|
+
<li><a href="chapter-3.html#s2">Session.loop</a></li>
|
|
83
|
+
|
|
84
|
+
<li><a href="chapter-3.html#s3">Channel Types</a></li>
|
|
85
|
+
|
|
86
|
+
<li><a href="chapter-3.html#s4">Opening a Channel</a></li>
|
|
87
|
+
|
|
88
|
+
<li><a href="chapter-3.html#s5">Callbacks</a></li>
|
|
89
|
+
|
|
90
|
+
<li><a href="chapter-3.html#s6">Channel Operations</a></li>
|
|
91
|
+
|
|
92
|
+
</ol>
|
|
93
|
+
</li>
|
|
94
|
+
|
|
95
|
+
<li>
|
|
96
|
+
<a href="chapter-4.html">
|
|
97
|
+
Executing Commands
|
|
98
|
+
</a>
|
|
99
|
+
|
|
100
|
+
<ol type="1">
|
|
101
|
+
|
|
102
|
+
<li><a href="chapter-4.html#s1">Using Channels</a></li>
|
|
103
|
+
|
|
104
|
+
<li><a href="chapter-4.html#s2">Using #process.open</a></li>
|
|
105
|
+
|
|
106
|
+
<li><a href="chapter-4.html#s3">Using #process.popen3</a></li>
|
|
107
|
+
|
|
108
|
+
</ol>
|
|
109
|
+
</li>
|
|
110
|
+
|
|
111
|
+
<li>
|
|
112
|
+
<a href="chapter-5.html">
|
|
113
|
+
User Shells
|
|
114
|
+
</a>
|
|
115
|
+
|
|
116
|
+
<ol type="1">
|
|
117
|
+
|
|
118
|
+
<li><a href="chapter-5.html#s1">Introduction</a></li>
|
|
119
|
+
|
|
120
|
+
<li><a href="chapter-5.html#s2">Using Channels</a></li>
|
|
121
|
+
|
|
122
|
+
<li><a href="chapter-5.html#s3">Shell Service</a></li>
|
|
123
|
+
|
|
124
|
+
<li><a href="chapter-5.html#s4">SyncShell Service</a></li>
|
|
125
|
+
|
|
126
|
+
<li><a href="chapter-5.html#s5">Terminal Clients</a></li>
|
|
127
|
+
|
|
128
|
+
</ol>
|
|
129
|
+
</li>
|
|
130
|
+
|
|
131
|
+
<li>
|
|
132
|
+
<a href="chapter-6.html">
|
|
133
|
+
Port Forwarding
|
|
134
|
+
</a>
|
|
135
|
+
|
|
136
|
+
<ol type="1">
|
|
137
|
+
|
|
138
|
+
<li><a href="chapter-6.html#s1">Introduction</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="chapter-6.html#s2">Local-to-Remote</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="chapter-6.html#s3">Remote-to-Local</a></li>
|
|
143
|
+
|
|
144
|
+
<li><a href="chapter-6.html#s4">Direct Channels</a></li>
|
|
145
|
+
|
|
146
|
+
<li><a href="chapter-6.html#s5">Remote-to-Local Handlers</a></li>
|
|
147
|
+
|
|
148
|
+
</ol>
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
<li>
|
|
152
|
+
<a href="chapter-7.html">
|
|
153
|
+
Using Proxies
|
|
154
|
+
</a>
|
|
155
|
+
|
|
156
|
+
<ol type="1">
|
|
157
|
+
|
|
158
|
+
<li><a href="chapter-7.html#s1">Introduction</a></li>
|
|
159
|
+
|
|
160
|
+
<li><a href="chapter-7.html#s2"><span class="caps">HTTP</span></a></li>
|
|
161
|
+
|
|
162
|
+
<li><a href="chapter-7.html#s3"><span class="caps">SOCKS</span></a></li>
|
|
163
|
+
|
|
164
|
+
</ol>
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
</ol>
|
|
168
|
+
|
|
169
|
+
<h2>Other Documentation</h2>
|
|
170
|
+
|
|
171
|
+
<ul>
|
|
172
|
+
<li><a href="http://net-ssh.rubyforge.org/api/index.html">Net::SSH API</a></li>
|
|
173
|
+
<li><a href="http://rubyforge.org/tracker/?atid=1842&group_id=274&func=browse">Net::SSH FAQ</a></li>
|
|
174
|
+
</ul>
|
|
175
|
+
|
|
176
|
+
<h2>Tutorials</h2>
|
|
177
|
+
<ol>
|
|
178
|
+
|
|
179
|
+
</ol>
|
|
180
|
+
|
|
181
|
+
<p align="center"><strong>More To Come...</strong></p>
|
|
182
|
+
|
|
183
|
+
<div class="license">
|
|
184
|
+
<a href="http://creativecommons.org/licenses/by-sa/2.0/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights" /></a><br />
|
|
185
|
+
This manual is licensed under a <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons License</a>.
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
</td><td valign='top' width="100%">
|
|
190
|
+
|
|
191
|
+
<div id="content">
|
|
192
|
+
|
|
193
|
+
<p class="product-manual">Product Manual</p>
|
|
194
|
+
|
|
195
|
+
<p align="center">
|
|
196
|
+
<img src=""
|
|
197
|
+
alt="Net::SSH: Secure Shell for Ruby" />
|
|
198
|
+
</p>
|
|
199
|
+
|
|
200
|
+
<p align="center">
|
|
201
|
+
|
|
202
|
+
Project Page: <a href="http://rubyforge.org/projects/net-ssh">http://rubyforge.org/projects/net-ssh</a><br />
|
|
203
|
+
|
|
204
|
+
User Manual: <a href="http://net-ssh.rubyforge.org">http://net-ssh.rubyforge.org</a><br />
|
|
205
|
+
|
|
206
|
+
API Documentation: <a href="http://net-ssh.rubyforge.org/api">http://net-ssh.rubyforge.org/api</a><br />
|
|
207
|
+
|
|
208
|
+
</p>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<p align="center"><strong>Recent Updates to This Manual</strong></p>
|
|
212
|
+
<table border='0' cellpadding='0' cellspacing='0' align='center'><tr><td>
|
|
213
|
+
<ul>
|
|
214
|
+
|
|
215
|
+
<li>Removed documentation indicating that ruby-password will be used if present (it won't)</li>
|
|
216
|
+
|
|
217
|
+
<li>Removed links to the wiki (which wasn't being used) and the faq (which never existed)</li>
|
|
218
|
+
|
|
219
|
+
</ul>
|
|
220
|
+
</table>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<p class="copyright">
|
|
224
|
+
Copyright © 2004-2006
|
|
225
|
+
Jamis Buck
|
|
226
|
+
(<a href="mailto:jamis@jamisbuck.org">jamis@jamisbuck.org</a>)
|
|
227
|
+
</p>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
</td></tr>
|
|
233
|
+
</table>
|
|
234
|
+
</body>
|
|
235
|
+
</html>
|