net-ssh 0.9.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/doc/manual/manual.rb +2 -2
- data/doc/manual/parts/intro_what_is.txt +0 -2
- data/lib/net/ssh/connection/channel.rb +42 -3
- data/lib/net/ssh/service/forward/driver.rb +1 -1
- data/lib/net/ssh/service/forward/local-network-handler.rb +10 -13
- data/lib/net/ssh/service/forward/remote-network-handler.rb +5 -3
- data/lib/net/ssh/transport/packet-stream.rb +25 -11
- data/lib/net/ssh/transport/session.rb +10 -2
- data/lib/net/ssh/userauth/driver.rb +7 -0
- data/lib/net/ssh/userauth/methods/services.rb +14 -9
- data/lib/net/ssh/version.rb +2 -2
- data/test/connection/tc_channel.rb +2 -2
- data/test/proxy/tc_http.rb +1 -1
- data/test/proxy/tc_socks4.rb +1 -1
- data/test/proxy/tc_socks5.rb +1 -1
- data/test/service/forward/tc_remote_network_handler.rb +5 -2
- metadata +2 -14
- data/doc/manual-html/chapter-1.html +0 -368
- data/doc/manual-html/chapter-2.html +0 -496
- data/doc/manual-html/chapter-3.html +0 -452
- data/doc/manual-html/chapter-4.html +0 -393
- data/doc/manual-html/chapter-5.html +0 -505
- data/doc/manual-html/chapter-6.html +0 -432
- data/doc/manual-html/chapter-7.html +0 -331
- data/doc/manual-html/index.html +0 -243
- data/doc/manual-html/stylesheets/manual.css +0 -265
- data/doc/manual-html/stylesheets/ruby.css +0 -17
|
@@ -1,505 +0,0 @@
|
|
|
1
|
-
<html>
|
|
2
|
-
<head>
|
|
3
|
-
<title>Net::SSH Manual :: Chapter 5: User Shells</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>0.9.0</strong><br />
|
|
18
|
-
Manual Last Updated: <strong>2005-01-11 21:39 GMT</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><strong>
|
|
112
|
-
<a href="chapter-5.html">
|
|
113
|
-
User Shells
|
|
114
|
-
</a>
|
|
115
|
-
</strong> <big>←</big>
|
|
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
|
-
<div class="top"><div class="prevnext">
|
|
194
|
-
|
|
195
|
-
<a href="chapter-4.html">Previous (4. Executing Commands)</a> |
|
|
196
|
-
|
|
197
|
-
<a href="index.html">Up</a>
|
|
198
|
-
|
|
199
|
-
| <a href="chapter-6.html">Next (6. Port Forwarding)</a>
|
|
200
|
-
|
|
201
|
-
</div></div>
|
|
202
|
-
|
|
203
|
-
<h1>5. User Shells</h1>
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<h2>
|
|
208
|
-
<a name="s1"></a>
|
|
209
|
-
5.1. Introduction
|
|
210
|
-
</h2>
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
<div class="section">
|
|
215
|
-
<p>A user’s <em>shell</em> is the environment in which commands are executed on a remote machine. There are a variety of different shells, including <a href="http://www.gnu.org/software/bash/bash.html">bash</a>, csh, tcsh, <a href="http://www.kornshell.com/">ksh</a>, and many others.</p>
|
|
216
|
-
|
|
217
|
-
<p>A shell may be executed like any other program, and when run, it (more-or-less) enters a read-execute-prompt cycle in which the user may interactively run commands.</p>
|
|
218
|
-
|
|
219
|
-
<p><span class="caps">SSH</span> has special support for shells, allowing you to start a shell on a channel and have all subsequent data sent to that channel interpreted as the user’s input to the shell. Also, <span class="caps">SSH</span> supports pty’s (<em>pseudo-tty</em>’s, or terminals), which allow the shell to act as if it were running locally on the users own machine.</p>
|
|
220
|
-
|
|
221
|
-
<p>Because a shell is just a program, you can always start a shell simply by executing it (as described in the previous chapter). However, you can also take advantage of <span class="caps">SSH</span>’s builtin shell support to execute the user’s preferred shell. This chapter will discuss this approach.</p>
|
|
222
|
-
</div>
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
<h2>
|
|
227
|
-
<a name="s2"></a>
|
|
228
|
-
5.2. Using Channels
|
|
229
|
-
</h2>
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
<div class="section">
|
|
234
|
-
<p>At the lowest level, starting a shell is a matter of sending a “shell” request over a channel.</p>
|
|
235
|
-
|
|
236
|
-
<div class='figure'>
|
|
237
|
-
<span class='caption'>Sending a shell request [ruby]</span>
|
|
238
|
-
<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 />20<br />21<br />22<br />23<br />24<br />25<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><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="ident">host</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
239
|
-
|
|
240
|
-
<span class="ident">session</span><span class="punct">.</span><span class="ident">open_channel</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">channel</span><span class="punct">|</span>
|
|
241
|
-
|
|
242
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_success</span> <span class="keyword">do</span>
|
|
243
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell was started successfully!</span><span class="punct">"</span>
|
|
244
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">send_data</span> <span class="punct">"</span><span class="string">exit</span><span class="expr">\n</span><span class="punct">"</span> <span class="comment"># tell the shell to exit</span>
|
|
245
|
-
<span class="keyword">end</span>
|
|
246
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_failure</span> <span class="keyword">do</span>
|
|
247
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell could not be started!</span><span class="punct">"</span>
|
|
248
|
-
<span class="keyword">end</span>
|
|
249
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_data</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">ch</span><span class="punct">,</span><span class="ident">data</span><span class="punct">|</span>
|
|
250
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">recieved </span><span class="expr">#{data}</span><span class="string"> from shell</span><span class="punct">"</span>
|
|
251
|
-
<span class="keyword">end</span>
|
|
252
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_close</span> <span class="keyword">do</span>
|
|
253
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell terminated</span><span class="punct">"</span>
|
|
254
|
-
<span class="keyword">end</span>
|
|
255
|
-
|
|
256
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">send_request</span> <span class="punct">"</span><span class="string">shell</span><span class="punct">",</span> <span class="constant">nil</span><span class="punct">,</span> <span class="constant">true</span>
|
|
257
|
-
|
|
258
|
-
<span class="keyword">end</span>
|
|
259
|
-
|
|
260
|
-
<span class="ident">session</span><span class="punct">.</span><span class="ident">loop</span>
|
|
261
|
-
|
|
262
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
263
|
-
|
|
264
|
-
<p>The <code>#send_request</code> method accepts three parameters—the name of the request (in this case, “shell”), any additional data to send with the request (none, in this case), and whether or not you want the server to reply with the success or failure of the request. In general, it is a good idea to ask for the server to reply, so that you know when you can start sending data to the shell.</p>
|
|
265
|
-
|
|
266
|
-
<p>If you want to open a pty before starting the shell, you can use the #request_pty method of the channel:</p>
|
|
267
|
-
|
|
268
|
-
<div class='figure'>
|
|
269
|
-
<span class='caption'>Opening a pty on a channel [ruby]</span>
|
|
270
|
-
<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 />20<br />21<br />22<br />23<br />24<br />25<br />26<br />27<br />28<br />29<br />30<br />31<br />32<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><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="ident">host</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
271
|
-
|
|
272
|
-
<span class="ident">session</span><span class="punct">.</span><span class="ident">open_channel</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">channel</span><span class="punct">|</span>
|
|
273
|
-
|
|
274
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_success</span> <span class="keyword">do</span>
|
|
275
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">pty was requested successfully!</span><span class="punct">"</span>
|
|
276
|
-
|
|
277
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_success</span> <span class="keyword">do</span>
|
|
278
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell was started successfully!</span><span class="punct">"</span>
|
|
279
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">send_data</span> <span class="punct">"</span><span class="string">exit</span><span class="expr">\n</span><span class="punct">"</span> <span class="comment"># tell the shell to exit</span>
|
|
280
|
-
<span class="keyword">end</span>
|
|
281
|
-
|
|
282
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">send_request</span> <span class="punct">"</span><span class="string">shell</span><span class="punct">",</span> <span class="constant">nil</span><span class="punct">,</span> <span class="constant">true</span>
|
|
283
|
-
<span class="keyword">end</span>
|
|
284
|
-
|
|
285
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_failure</span> <span class="keyword">do</span>
|
|
286
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell could not be started!</span><span class="punct">"</span>
|
|
287
|
-
<span class="keyword">end</span>
|
|
288
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_data</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">ch</span><span class="punct">,</span><span class="ident">data</span><span class="punct">|</span>
|
|
289
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">recieved </span><span class="expr">#{data}</span><span class="string"> from shell</span><span class="punct">"</span>
|
|
290
|
-
<span class="keyword">end</span>
|
|
291
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">on_close</span> <span class="keyword">do</span>
|
|
292
|
-
<span class="ident">puts</span> <span class="punct">"</span><span class="string">shell terminated</span><span class="punct">"</span>
|
|
293
|
-
<span class="keyword">end</span>
|
|
294
|
-
|
|
295
|
-
<span class="ident">channel</span><span class="punct">.</span><span class="ident">request_pty</span> <span class="symbol">:want_reply</span> <span class="punct">=></span> <span class="constant">true</span>
|
|
296
|
-
|
|
297
|
-
<span class="keyword">end</span>
|
|
298
|
-
|
|
299
|
-
<span class="ident">session</span><span class="punct">.</span><span class="ident">loop</span>
|
|
300
|
-
|
|
301
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
302
|
-
|
|
303
|
-
<p>First, the pty is requested (with an indicator to the server that it should return a “success” or “failure” notification). When the pty is successfully opened, the “on_success” callback is changed, and the shell is then requested.</p>
|
|
304
|
-
|
|
305
|
-
<p>It’s a lot of hoops to jump through, but it gives you the finest-grained control over opening a shell. For most things, though, you can live with less control. For those tasks, there are the <em>shell</em> and <em>sync</em> services.</p>
|
|
306
|
-
</div>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
<h2>
|
|
311
|
-
<a name="s3"></a>
|
|
312
|
-
5.3. Shell Service
|
|
313
|
-
</h2>
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
<div class="section">
|
|
318
|
-
<p>To make interacting with shells, simpler, version 0.9 of Net::SSH introduced the <em>shell service</em>. This allows you to open a shell (with or without a pty), send a series of commands to the shell, and then wait for the output from the shell.</p>
|
|
319
|
-
|
|
320
|
-
<div class='figure'>
|
|
321
|
-
<span class='caption'>Using the shell service [ruby]</span>
|
|
322
|
-
<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 />20<br />21<br />22<br />23<br />24<br />25<br />26<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><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">localhost</span><span class="punct">'</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
323
|
-
|
|
324
|
-
<span class="ident">shell</span> <span class="punct">=</span> <span class="ident">session</span><span class="punct">.</span><span class="ident">shell</span><span class="punct">.</span><span class="ident">open</span>
|
|
325
|
-
|
|
326
|
-
<span class="comment"># script what we want to do</span>
|
|
327
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">pwd</span>
|
|
328
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">cd</span> <span class="punct">"</span><span class="string">/</span><span class="punct">"</span>
|
|
329
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">pwd</span>
|
|
330
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">test</span> <span class="punct">"</span><span class="string">-e foo</span><span class="punct">"</span>
|
|
331
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">cd</span> <span class="punct">"</span><span class="string">/really/bogus/directory</span><span class="punct">"</span>
|
|
332
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">send_data</span> <span class="punct">"</span><span class="string">/sbin/ifconfig</span><span class="expr">\n</span><span class="punct">"</span>
|
|
333
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">pwd</span>
|
|
334
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">ruby</span> <span class="punct">"</span><span class="string">-v</span><span class="punct">"</span>
|
|
335
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">cd</span> <span class="punct">"</span><span class="string">/usr/lib</span><span class="punct">"</span>
|
|
336
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">pwd</span>
|
|
337
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">exit</span>
|
|
338
|
-
|
|
339
|
-
<span class="comment"># give the above commands sufficient time to terminate</span>
|
|
340
|
-
<span class="ident">sleep</span> <span class="number">0.5</span>
|
|
341
|
-
|
|
342
|
-
<span class="comment"># display the output</span>
|
|
343
|
-
<span class="global">$stdout</span><span class="punct">.</span><span class="ident">print</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stdout</span> <span class="keyword">while</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stdout?</span>
|
|
344
|
-
<span class="global">$stderr</span><span class="punct">.</span><span class="ident">puts</span> <span class="punct">"</span><span class="string">-- stderr: --</span><span class="punct">"</span>
|
|
345
|
-
<span class="global">$stderr</span><span class="punct">.</span><span class="ident">print</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stderr</span> <span class="keyword">while</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stderr?</span>
|
|
346
|
-
|
|
347
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
348
|
-
|
|
349
|
-
<p>Any unrecognized method that is sent to the shell object is interpreted as a command to send to the server. To explicitly send a command, use the <code>#send_data</code> method (but remember to add a newline!). The <code>#send_data</code> method may also be used to send data to any process running in the shell as that process’ <code>stdin</code> stream.</p>
|
|
350
|
-
|
|
351
|
-
<p>You can also specify that a pty should be allocated for this shell:</p>
|
|
352
|
-
|
|
353
|
-
<div class='figure'>
|
|
354
|
-
<span class='caption'>Allocating a pty for the shell [ruby]</span>
|
|
355
|
-
<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 /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><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">localhost</span><span class="punct">'</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
356
|
-
|
|
357
|
-
<span class="ident">shell</span> <span class="punct">=</span> <span class="ident">session</span><span class="punct">.</span><span class="ident">shell</span><span class="punct">.</span><span class="ident">open</span><span class="punct">(</span> <span class="symbol">:pty</span> <span class="punct">=></span> <span class="constant">true</span> <span class="punct">)</span>
|
|
358
|
-
|
|
359
|
-
<span class="comment"># or</span>
|
|
360
|
-
|
|
361
|
-
<span class="ident">shell</span> <span class="punct">=</span> <span class="ident">session</span><span class="punct">.</span><span class="ident">shell</span><span class="punct">.</span><span class="ident">open</span><span class="punct">(</span> <span class="symbol">:pty</span> <span class="punct">=></span> <span class="punct">{</span> <span class="punct">...</span> <span class="punct">}</span> <span class="punct">)</span>
|
|
362
|
-
|
|
363
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
364
|
-
|
|
365
|
-
<p>If you give a hash for the <code>:pty</code> option, it must be a map of the options that describe the new pty. See the <span class="caps">API</span> documentation for the Channel#request_pty method for more information.</p>
|
|
366
|
-
|
|
367
|
-
<p>Note that this is still an asynchronous approach. You send all the commands through the pipe and then wait for the output. (And be sure to give sufficient time or the processes to terminate!) This is fine for scripts that you just want to throw at the server, but many times you want a more interactive interface, for executing a command and receiving its output before moving on.</p>
|
|
368
|
-
</div>
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
<h2>
|
|
373
|
-
<a name="s4"></a>
|
|
374
|
-
5.4. SyncShell Service
|
|
375
|
-
</h2>
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
<div class="section">
|
|
380
|
-
<p>The SyncShell service allows you to execute commands on the shell and block until they finish. It is not fool-proof—it has to use some tricks to accomplish this task, and some commands may foul it up. But for most tasks, it works admirably.</p>
|
|
381
|
-
|
|
382
|
-
<div class='figure'>
|
|
383
|
-
<span class='caption'>Using the SyncShell service [ruby]</span>
|
|
384
|
-
<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 />20<br />21<br />22<br />23<br />24<br />25<br />26<br />27<br />28<br />29<br />30<br />31<br />32<br />33<br />34<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><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">localhost</span><span class="punct">'</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
385
|
-
|
|
386
|
-
<span class="ident">shell</span> <span class="punct">=</span> <span class="ident">session</span><span class="punct">.</span><span class="ident">shell</span><span class="punct">.</span><span class="ident">sync</span>
|
|
387
|
-
|
|
388
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">pwd</span>
|
|
389
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">stdout</span>
|
|
390
|
-
|
|
391
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">test</span> <span class="punct">"</span><span class="string">-e foo</span><span class="punct">"</span>
|
|
392
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">status</span>
|
|
393
|
-
|
|
394
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">cd</span> <span class="punct">"</span><span class="string">/really/bogus/directory</span><span class="punct">"</span>
|
|
395
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">stderr</span>
|
|
396
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">status</span>
|
|
397
|
-
|
|
398
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">ruby</span> <span class="punct">"</span><span class="string">-v</span><span class="punct">"</span>
|
|
399
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">stdout</span>
|
|
400
|
-
|
|
401
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">cd</span> <span class="punct">"</span><span class="string">/usr/lib</span><span class="punct">"</span>
|
|
402
|
-
|
|
403
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">ls</span> <span class="punct">"</span><span class="string">-l</span><span class="punct">"</span>
|
|
404
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">stdout</span>
|
|
405
|
-
|
|
406
|
-
<span class="ident">out</span> <span class="punct">=</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">send_command</span><span class="punct">(</span> <span class="punct">"</span><span class="string">bc</span><span class="punct">",</span> <span class="punct"><<</span><span class="constant">CMD</span><span class="string"> )
|
|
407
|
-
5+5
|
|
408
|
-
10*2
|
|
409
|
-
scale=5
|
|
410
|
-
3/4
|
|
411
|
-
quit
|
|
412
|
-
</span><span class="constant">CMD</span>
|
|
413
|
-
<span class="ident">p</span> <span class="ident">out</span><span class="punct">.</span><span class="ident">stdout</span>
|
|
414
|
-
|
|
415
|
-
<span class="ident">p</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">exit</span>
|
|
416
|
-
|
|
417
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
418
|
-
|
|
419
|
-
<p>The result of executing each command is an object that encapsulates the <code>stdout</code> and <code>stderr</code> streams, and the exit status of the command.</p>
|
|
420
|
-
|
|
421
|
-
<p>To explicitly execute a command, use the <code>#send_command</code> instead of <code>#send_data</code>—otherwise, the command will be executed asynchronously, which is not what you want. Also, if you pass a second parameter to the <code>#send_command</code> method, it is interpreted as the <code>stdin</code> data to send to the new process.</p>
|
|
422
|
-
</div>
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
<h2>
|
|
427
|
-
<a name="s5"></a>
|
|
428
|
-
5.5. Terminal Clients
|
|
429
|
-
</h2>
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
<div class="section">
|
|
434
|
-
<p>Using the shell service and pty’s, you can now create a simple <span class="caps">SSH</span> terminal client. (You’ll also want to download and install the <a href="http://arika.org/ruby/termios">ruby-termios</a> library so that your input is not interpreted in a linewise fashion.)</p>
|
|
435
|
-
|
|
436
|
-
<div class='figure'>
|
|
437
|
-
<span class='caption'>A simple SSH terminal client in Ruby [ruby]</span>
|
|
438
|
-
<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 />20<br />21<br />22<br />23<br />24<br />25<br />26<br />27<br />28<br />29<br />30<br />31<br />32<br />33<br />34<br />35<br />36<br />37<br />38<br />39<br />40<br />41<br />42<br />43<br />44<br />45<br /></td><td width='100%'><link rel='stylesheet' type='text/css' href='stylesheets/ruby.css' /><div class='ruby'><pre><span class="keyword">begin</span>
|
|
439
|
-
<span class="ident">require</span> <span class="punct">'</span><span class="string">termios</span><span class="punct">'</span>
|
|
440
|
-
<span class="keyword">rescue</span> <span class="constant">LoadError</span>
|
|
441
|
-
<span class="keyword">end</span>
|
|
442
|
-
|
|
443
|
-
<span class="keyword">def </span><span class="method">stdin_buffer</span><span class="punct">(</span> <span class="ident">enable</span> <span class="punct">)</span>
|
|
444
|
-
<span class="keyword">return</span> <span class="keyword">unless</span> <span class="keyword">defined?</span><span class="punct">(</span> <span class="constant">Termios</span> <span class="punct">)</span>
|
|
445
|
-
<span class="ident">attr</span> <span class="punct">=</span> <span class="constant">Termios</span><span class="punct">::</span><span class="ident">getattr</span><span class="punct">(</span> <span class="global">$stdin</span> <span class="punct">)</span>
|
|
446
|
-
<span class="keyword">if</span> <span class="ident">enable</span>
|
|
447
|
-
<span class="ident">attr</span><span class="punct">.</span><span class="ident">c_lflag</span> <span class="punct">|=</span> <span class="constant">Termios</span><span class="punct">::</span><span class="constant">ICANON</span> <span class="punct">|</span> <span class="constant">Termios</span><span class="punct">::</span><span class="constant">ECHO</span>
|
|
448
|
-
<span class="keyword">else</span>
|
|
449
|
-
<span class="ident">attr</span><span class="punct">.</span><span class="ident">c_lflag</span> <span class="punct">&=</span> ~<span class="punct">(</span><span class="constant">Termios</span><span class="punct">::</span><span class="constant">ICANON</span><span class="punct">|</span><span class="constant">Termios</span><span class="punct">::</span><span class="constant">ECHO</span><span class="punct">)</span>
|
|
450
|
-
<span class="keyword">end</span>
|
|
451
|
-
<span class="constant">Termios</span><span class="punct">::</span><span class="ident">setattr</span><span class="punct">(</span> <span class="global">$stdin</span><span class="punct">,</span> <span class="constant">Termios</span><span class="punct">::</span><span class="constant">TCSANOW</span><span class="punct">,</span> <span class="ident">attr</span> <span class="punct">)</span>
|
|
452
|
-
<span class="keyword">end</span>
|
|
453
|
-
|
|
454
|
-
<span class="ident">host</span> <span class="punct">=</span> <span class="constant">ARGV</span><span class="punct">.</span><span class="ident">shift</span> <span class="keyword">or</span> <span class="ident">abort</span> <span class="punct">"</span><span class="string">You must specify the [user@]host to connect to</span><span class="punct">"</span>
|
|
455
|
-
<span class="keyword">if</span> <span class="ident">host</span> <span class="punct">=~</span> <span class="punct">/</span><span class="regex">@</span><span class="punct">/</span>
|
|
456
|
-
<span class="ident">user</span><span class="punct">,</span> <span class="ident">host</span> <span class="punct">=</span> <span class="ident">host</span><span class="punct">.</span><span class="ident">match</span><span class="punct">(</span> <span class="punct">/</span><span class="regex">(.*?)@(.*)</span><span class="punct">/</span> <span class="punct">)[</span><span class="number">1</span><span class="punct">,</span><span class="number">2</span><span class="punct">]</span>
|
|
457
|
-
<span class="keyword">else</span>
|
|
458
|
-
<span class="ident">user</span> <span class="punct">=</span> <span class="constant">ENV</span><span class="punct">['</span><span class="string">USER</span><span class="punct">']</span> <span class="punct">||</span> <span class="constant">ENV</span><span class="punct">['</span><span class="string">USER_NAME</span><span class="punct">']</span>
|
|
459
|
-
<span class="keyword">end</span>
|
|
460
|
-
|
|
461
|
-
<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="ident">host</span><span class="punct">,</span> <span class="ident">user</span> <span class="punct">)</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">session</span><span class="punct">|</span>
|
|
462
|
-
|
|
463
|
-
<span class="keyword">begin</span>
|
|
464
|
-
<span class="ident">stdin_buffer</span> <span class="constant">false</span>
|
|
465
|
-
|
|
466
|
-
<span class="ident">shell</span> <span class="punct">=</span> <span class="ident">session</span><span class="punct">.</span><span class="ident">shell</span><span class="punct">.</span><span class="ident">open</span><span class="punct">(</span> <span class="symbol">:pty</span> <span class="punct">=></span> <span class="constant">true</span> <span class="punct">)</span>
|
|
467
|
-
|
|
468
|
-
<span class="ident">loop</span> <span class="keyword">do</span>
|
|
469
|
-
<span class="keyword">break</span> <span class="keyword">unless</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">open?</span>
|
|
470
|
-
<span class="keyword">if</span> <span class="constant">IO</span><span class="punct">.</span><span class="ident">select</span><span class="punct">([</span><span class="global">$stdin</span><span class="punct">],</span><span class="constant">nil</span><span class="punct">,</span><span class="constant">nil</span><span class="punct">,</span><span class="number">0.01</span><span class="punct">)</span>
|
|
471
|
-
<span class="ident">data</span> <span class="punct">=</span> <span class="global">$stdin</span><span class="punct">.</span><span class="ident">sysread</span><span class="punct">(</span><span class="number">1</span><span class="punct">)</span>
|
|
472
|
-
<span class="ident">shell</span><span class="punct">.</span><span class="ident">send_data</span> <span class="ident">data</span>
|
|
473
|
-
<span class="keyword">end</span>
|
|
474
|
-
|
|
475
|
-
<span class="global">$stdout</span><span class="punct">.</span><span class="ident">print</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stdout</span> <span class="keyword">while</span> <span class="ident">shell</span><span class="punct">.</span><span class="ident">stdout?</span>
|
|
476
|
-
<span class="global">$stdout</span><span class="punct">.</span><span class="ident">flush</span>
|
|
477
|
-
<span class="keyword">end</span>
|
|
478
|
-
<span class="keyword">ensure</span>
|
|
479
|
-
<span class="ident">stdin_buffer</span> <span class="constant">true</span>
|
|
480
|
-
<span class="keyword">end</span>
|
|
481
|
-
|
|
482
|
-
<span class="keyword">end</span></pre></div></td></tr></table></div></div>
|
|
483
|
-
|
|
484
|
-
<p>The above code is also available as an example script in the Net::SSH distribution (<code>examples/ssh-client.rb</code>).</p>
|
|
485
|
-
</div>
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
<div class="bottom"><div class="prevnext">
|
|
490
|
-
|
|
491
|
-
<a href="chapter-4.html">Previous (4. Executing Commands)</a> |
|
|
492
|
-
|
|
493
|
-
<a href="index.html">Up</a>
|
|
494
|
-
|
|
495
|
-
| <a href="chapter-6.html">Next (6. Port Forwarding)</a>
|
|
496
|
-
|
|
497
|
-
</div></div>
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
</div>
|
|
501
|
-
|
|
502
|
-
</td></tr>
|
|
503
|
-
</table>
|
|
504
|
-
</body>
|
|
505
|
-
</html>
|