1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>net-ssh 4.1.0</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script src="./js/jquery.js"></script>
<script src="./js/darkfish.js"></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="file">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="nav-section">
<h3>Pages</h3>
<ul class="link-list">
<li><a href="./CHANGES_txt.html">CHANGES</a>
<li><a href="./LICENSE_txt.html">LICENSE</a>
<li><a href="./README_rdoc.html">README</a>
<li><a href="./THANKS_txt.html">THANKS</a>
</ul>
</div>
<div id="classindex-section" class="nav-section">
<h3>Class and Module Index</h3>
<ul class="link-list">
<li><a href="./DL.html">DL</a>
<li><a href="./DL/Fiddle.html">DL::Fiddle</a>
<li><a href="./Net.html">Net</a>
<li><a href="./Net/SSH.html">Net::SSH</a>
<li><a href="./Net/SSH/Authentication.html">Net::SSH::Authentication</a>
<li><a href="./Net/SSH/Authentication/Agent.html">Net::SSH::Authentication::Agent</a>
<li><a href="./Net/SSH/Authentication/Agent/Comment.html">Net::SSH::Authentication::Agent::Comment</a>
<li><a href="./Net/SSH/Authentication/AgentError.html">Net::SSH::Authentication::AgentError</a>
<li><a href="./Net/SSH/Authentication/AgentNotAvailable.html">Net::SSH::Authentication::AgentNotAvailable</a>
<li><a href="./Net/SSH/Authentication/Certificate.html">Net::SSH::Authentication::Certificate</a>
<li><a href="./Net/SSH/Authentication/Constants.html">Net::SSH::Authentication::Constants</a>
<li><a href="./Net/SSH/Authentication/DisallowedMethod.html">Net::SSH::Authentication::DisallowedMethod</a>
<li><a href="./Net/SSH/Authentication/ED25519.html">Net::SSH::Authentication::ED25519</a>
<li><a href="./Net/SSH/Authentication/ED25519/PrivKey.html">Net::SSH::Authentication::ED25519::PrivKey</a>
<li><a href="./Net/SSH/Authentication/ED25519/PubKey.html">Net::SSH::Authentication::ED25519::PubKey</a>
<li><a href="./Net/SSH/Authentication/ED25519/SigningKeyFromFile.html">Net::SSH::Authentication::ED25519::SigningKeyFromFile</a>
<li><a href="./Net/SSH/Authentication/ED25519Loader.html">Net::SSH::Authentication::ED25519Loader</a>
<li><a href="./Net/SSH/Authentication/KeyManager.html">Net::SSH::Authentication::KeyManager</a>
<li><a href="./Net/SSH/Authentication/KeyManagerError.html">Net::SSH::Authentication::KeyManagerError</a>
<li><a href="./Net/SSH/Authentication/Methods.html">Net::SSH::Authentication::Methods</a>
<li><a href="./Net/SSH/Authentication/Methods/Abstract.html">Net::SSH::Authentication::Methods::Abstract</a>
<li><a href="./Net/SSH/Authentication/Methods/Hostbased.html">Net::SSH::Authentication::Methods::Hostbased</a>
<li><a href="./Net/SSH/Authentication/Methods/KeyboardInteractive.html">Net::SSH::Authentication::Methods::KeyboardInteractive</a>
<li><a href="./Net/SSH/Authentication/Methods/None.html">Net::SSH::Authentication::Methods::None</a>
<li><a href="./Net/SSH/Authentication/Methods/Password.html">Net::SSH::Authentication::Methods::Password</a>
<li><a href="./Net/SSH/Authentication/Methods/Publickey.html">Net::SSH::Authentication::Methods::Publickey</a>
<li><a href="./Net/SSH/Authentication/Pageant.html">Net::SSH::Authentication::Pageant</a>
<li><a href="./Net/SSH/Authentication/Pageant/Socket.html">Net::SSH::Authentication::Pageant::Socket</a>
<li><a href="./Net/SSH/Authentication/Pageant/Win.html">Net::SSH::Authentication::Pageant::Win</a>
<li><a href="./Net/SSH/Authentication/Pageant/Win/LibC.html">Net::SSH::Authentication::Pageant::Win::LibC</a>
<li><a href="./Net/SSH/Authentication/Pageant/Win/LibC/FFI.html">Net::SSH::Authentication::Pageant::Win::LibC::FFI</a>
<li><a href="./Net/SSH/Authentication/Pageant/Win/LibC/FFI/Library.html">Net::SSH::Authentication::Pageant::Win::LibC::FFI::Library</a>
<li><a href="./Net/SSH/Authentication/Session.html">Net::SSH::Authentication::Session</a>
<li><a href="./Net/SSH/AuthenticationFailed.html">Net::SSH::AuthenticationFailed</a>
<li><a href="./Net/SSH/Buffer.html">Net::SSH::Buffer</a>
<li><a href="./Net/SSH/BufferedIo.html">Net::SSH::BufferedIo</a>
<li><a href="./Net/SSH/ChannelOpenFailed.html">Net::SSH::ChannelOpenFailed</a>
<li><a href="./Net/SSH/ChannelRequestFailed.html">Net::SSH::ChannelRequestFailed</a>
<li><a href="./Net/SSH/Compat.html">Net::SSH::Compat</a>
<li><a href="./Net/SSH/Config.html">Net::SSH::Config</a>
<li><a href="./Net/SSH/Connection.html">Net::SSH::Connection</a>
<li><a href="./Net/SSH/Connection/Channel.html">Net::SSH::Connection::Channel</a>
<li><a href="./Net/SSH/Connection/Constants.html">Net::SSH::Connection::Constants</a>
<li><a href="./Net/SSH/Connection/EventLoop.html">Net::SSH::Connection::EventLoop</a>
<li><a href="./Net/SSH/Connection/Keepalive.html">Net::SSH::Connection::Keepalive</a>
<li><a href="./Net/SSH/Connection/Session.html">Net::SSH::Connection::Session</a>
<li><a href="./Net/SSH/Connection/Session/NilChannel.html">Net::SSH::Connection::Session::NilChannel</a>
<li><a href="./Net/SSH/Connection/Session/StringWithExitstatus.html">Net::SSH::Connection::Session::StringWithExitstatus</a>
<li><a href="./Net/SSH/Connection/SingleSessionEventLoop.html">Net::SSH::Connection::SingleSessionEventLoop</a>
<li><a href="./Net/SSH/Connection/Term.html">Net::SSH::Connection::Term</a>
<li><a href="./Net/SSH/ConnectionTimeout.html">Net::SSH::ConnectionTimeout</a>
<li><a href="./Net/SSH/Disconnect.html">Net::SSH::Disconnect</a>
<li><a href="./Net/SSH/Exception.html">Net::SSH::Exception</a>
<li><a href="./Net/SSH/ForwardedBufferedIo.html">Net::SSH::ForwardedBufferedIo</a>
<li><a href="./Net/SSH/HostKeyError.html">Net::SSH::HostKeyError</a>
<li><a href="./Net/SSH/HostKeyMismatch.html">Net::SSH::HostKeyMismatch</a>
<li><a href="./Net/SSH/HostKeyUnknown.html">Net::SSH::HostKeyUnknown</a>
<li><a href="./Net/SSH/HostKeys.html">Net::SSH::HostKeys</a>
<li><a href="./Net/SSH/KeyFactory.html">Net::SSH::KeyFactory</a>
<li><a href="./Net/SSH/KeyFactory/OpenSSL.html">Net::SSH::KeyFactory::OpenSSL</a>
<li><a href="./Net/SSH/KeyFactory/OpenSSL/PKey.html">Net::SSH::KeyFactory::OpenSSL::PKey</a>
<li><a href="./Net/SSH/KnownHosts.html">Net::SSH::KnownHosts</a>
<li><a href="./Net/SSH/KnownHosts/OpenSSL.html">Net::SSH::KnownHosts::OpenSSL</a>
<li><a href="./Net/SSH/KnownHosts/OpenSSL/PKey.html">Net::SSH::KnownHosts::OpenSSL::PKey</a>
<li><a href="./Net/SSH/Loggable.html">Net::SSH::Loggable</a>
<li><a href="./Net/SSH/Packet.html">Net::SSH::Packet</a>
<li><a href="./Net/SSH/Prompt.html">Net::SSH::Prompt</a>
<li><a href="./Net/SSH/Prompt/Prompter.html">Net::SSH::Prompt::Prompter</a>
<li><a href="./Net/SSH/Proxy.html">Net::SSH::Proxy</a>
<li><a href="./Net/SSH/Proxy/Command.html">Net::SSH::Proxy::Command</a>
<li><a href="./Net/SSH/Proxy/ConnectError.html">Net::SSH::Proxy::ConnectError</a>
<li><a href="./Net/SSH/Proxy/Error.html">Net::SSH::Proxy::Error</a>
<li><a href="./Net/SSH/Proxy/HTTP.html">Net::SSH::Proxy::HTTP</a>
<li><a href="./Net/SSH/Proxy/HTTPS.html">Net::SSH::Proxy::HTTPS</a>
<li><a href="./Net/SSH/Proxy/HTTPS/SSLSocketCompatibility.html">Net::SSH::Proxy::HTTPS::SSLSocketCompatibility</a>
<li><a href="./Net/SSH/Proxy/Jump.html">Net::SSH::Proxy::Jump</a>
<li><a href="./Net/SSH/Proxy/SOCKS4.html">Net::SSH::Proxy::SOCKS4</a>
<li><a href="./Net/SSH/Proxy/SOCKS5.html">Net::SSH::Proxy::SOCKS5</a>
<li><a href="./Net/SSH/Proxy/UnauthorizedError.html">Net::SSH::Proxy::UnauthorizedError</a>
<li><a href="./Net/SSH/Service.html">Net::SSH::Service</a>
<li><a href="./Net/SSH/Service/Forward.html">Net::SSH::Service::Forward</a>
<li><a href="./Net/SSH/Test.html">Net::SSH::Test</a>
<li><a href="./Net/SSH/Test/Channel.html">Net::SSH::Test::Channel</a>
<li><a href="./Net/SSH/Test/Extensions.html">Net::SSH::Test::Extensions</a>
<li><a href="./Net/SSH/Test/Extensions/BufferedIo.html">Net::SSH::Test::Extensions::BufferedIo</a>
<li><a href="./Net/SSH/Test/Extensions/Channel.html">Net::SSH::Test::Extensions::Channel</a>
<li><a href="./Net/SSH/Test/Extensions/IO.html">Net::SSH::Test::Extensions::IO</a>
<li><a href="./Net/SSH/Test/Extensions/IO/ClassMethods.html">Net::SSH::Test::Extensions::IO::ClassMethods</a>
<li><a href="./Net/SSH/Test/Extensions/PacketStream.html">Net::SSH::Test::Extensions::PacketStream</a>
<li><a href="./Net/SSH/Test/Kex.html">Net::SSH::Test::Kex</a>
<li><a href="./Net/SSH/Test/LocalPacket.html">Net::SSH::Test::LocalPacket</a>
<li><a href="./Net/SSH/Test/Packet.html">Net::SSH::Test::Packet</a>
<li><a href="./Net/SSH/Test/RemotePacket.html">Net::SSH::Test::RemotePacket</a>
<li><a href="./Net/SSH/Test/Script.html">Net::SSH::Test::Script</a>
<li><a href="./Net/SSH/Test/Socket.html">Net::SSH::Test::Socket</a>
<li><a href="./Net/SSH/Timeout.html">Net::SSH::Timeout</a>
<li><a href="./Net/SSH/Transport.html">Net::SSH::Transport</a>
<li><a href="./Net/SSH/Transport/Algorithms.html">Net::SSH::Transport::Algorithms</a>
<li><a href="./Net/SSH/Transport/Algorithms/OpenSSL.html">Net::SSH::Transport::Algorithms::OpenSSL</a>
<li><a href="./Net/SSH/Transport/Algorithms/OpenSSL/PKey.html">Net::SSH::Transport::Algorithms::OpenSSL::PKey</a>
<li><a href="./Net/SSH/Transport/CTR.html">Net::SSH::Transport::CTR</a>
<li><a href="./Net/SSH/Transport/CipherFactory.html">Net::SSH::Transport::CipherFactory</a>
<li><a href="./Net/SSH/Transport/Constants.html">Net::SSH::Transport::Constants</a>
<li><a href="./Net/SSH/Transport/HMAC.html">Net::SSH::Transport::HMAC</a>
<li><a href="./Net/SSH/Transport/HMAC/Abstract.html">Net::SSH::Transport::HMAC::Abstract</a>
<li><a href="./Net/SSH/Transport/HMAC/MD5.html">Net::SSH::Transport::HMAC::MD5</a>
<li><a href="./Net/SSH/Transport/HMAC/MD5/OpenSSL.html">Net::SSH::Transport::HMAC::MD5::OpenSSL</a>
<li><a href="./Net/SSH/Transport/HMAC/MD5/OpenSSL/Digest.html">Net::SSH::Transport::HMAC::MD5::OpenSSL::Digest</a>
<li><a href="./Net/SSH/Transport/HMAC/MD5_96.html">Net::SSH::Transport::HMAC::MD5_96</a>
<li><a href="./Net/SSH/Transport/HMAC/None.html">Net::SSH::Transport::HMAC::None</a>
<li><a href="./Net/SSH/Transport/HMAC/RIPEMD160.html">Net::SSH::Transport::HMAC::RIPEMD160</a>
<li><a href="./Net/SSH/Transport/HMAC/RIPEMD160/OpenSSL.html">Net::SSH::Transport::HMAC::RIPEMD160::OpenSSL</a>
<li><a href="./Net/SSH/Transport/HMAC/RIPEMD160/OpenSSL/Digest.html">Net::SSH::Transport::HMAC::RIPEMD160::OpenSSL::Digest</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA1.html">Net::SSH::Transport::HMAC::SHA1</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA1/OpenSSL.html">Net::SSH::Transport::HMAC::SHA1::OpenSSL</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA1/OpenSSL/Digest.html">Net::SSH::Transport::HMAC::SHA1::OpenSSL::Digest</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA1_96.html">Net::SSH::Transport::HMAC::SHA1_96</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA2_256.html">Net::SSH::Transport::HMAC::SHA2_256</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA2_256_96.html">Net::SSH::Transport::HMAC::SHA2_256_96</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA2_512.html">Net::SSH::Transport::HMAC::SHA2_512</a>
<li><a href="./Net/SSH/Transport/HMAC/SHA2_512_96.html">Net::SSH::Transport::HMAC::SHA2_512_96</a>
<li><a href="./Net/SSH/Transport/IdentityCipher.html">Net::SSH::Transport::IdentityCipher</a>
<li><a href="./Net/SSH/Transport/Kex.html">Net::SSH::Transport::Kex</a>
<li><a href="./Net/SSH/Transport/Kex/DiffieHellmanGroup14SHA1.html">Net::SSH::Transport::Kex::DiffieHellmanGroup14SHA1</a>
<li><a href="./Net/SSH/Transport/Kex/DiffieHellmanGroup1SHA1.html">Net::SSH::Transport::Kex::DiffieHellmanGroup1SHA1</a>
<li><a href="./Net/SSH/Transport/Kex/DiffieHellmanGroupExchangeSHA1.html">Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA1</a>
<li><a href="./Net/SSH/Transport/Kex/DiffieHellmanGroupExchangeSHA256.html">Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA256</a>
<li><a href="./Net/SSH/Transport/Kex/EcdhSHA2NistP256.html">Net::SSH::Transport::Kex::EcdhSHA2NistP256</a>
<li><a href="./Net/SSH/Transport/Kex/EcdhSHA2NistP384.html">Net::SSH::Transport::Kex::EcdhSHA2NistP384</a>
<li><a href="./Net/SSH/Transport/Kex/EcdhSHA2NistP521.html">Net::SSH::Transport::Kex::EcdhSHA2NistP521</a>
<li><a href="./Net/SSH/Transport/KeyExpander.html">Net::SSH::Transport::KeyExpander</a>
<li><a href="./Net/SSH/Transport/PacketStream.html">Net::SSH::Transport::PacketStream</a>
<li><a href="./Net/SSH/Transport/ServerVersion.html">Net::SSH::Transport::ServerVersion</a>
<li><a href="./Net/SSH/Transport/Session.html">Net::SSH::Transport::Session</a>
<li><a href="./Net/SSH/Transport/State.html">Net::SSH::Transport::State</a>
<li><a href="./Net/SSH/Verifiers.html">Net::SSH::Verifiers</a>
<li><a href="./Net/SSH/Verifiers/Lenient.html">Net::SSH::Verifiers::Lenient</a>
<li><a href="./Net/SSH/Verifiers/Null.html">Net::SSH::Verifiers::Null</a>
<li><a href="./Net/SSH/Verifiers/Secure.html">Net::SSH::Verifiers::Secure</a>
<li><a href="./Net/SSH/Verifiers/Strict.html">Net::SSH::Verifiers::Strict</a>
<li><a href="./Net/SSH/Version.html">Net::SSH::Version</a>
<li><a href="./OpenSSL.html">OpenSSL</a>
<li><a href="./OpenSSL/BN.html">OpenSSL::BN</a>
<li><a href="./OpenSSL/Digest.html">OpenSSL::Digest</a>
<li><a href="./OpenSSL/PKey.html">OpenSSL::PKey</a>
<li><a href="./OpenSSL/PKey/DH.html">OpenSSL::PKey::DH</a>
<li><a href="./OpenSSL/PKey/DSA.html">OpenSSL::PKey::DSA</a>
<li><a href="./OpenSSL/PKey/EC.html">OpenSSL::PKey::EC</a>
<li><a href="./OpenSSL/PKey/OpenSSL.html">OpenSSL::PKey::OpenSSL</a>
<li><a href="./OpenSSL/PKey/OpenSSL/PKey.html">OpenSSL::PKey::OpenSSL::PKey</a>
<li><a href="./OpenSSL/PKey/OpenSSL/PKey/OpenSSL.html">OpenSSL::PKey::OpenSSL::PKey::OpenSSL</a>
<li><a href="./OpenSSL/PKey/OpenSSL/PKey/OpenSSL/PKey.html">OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey</a>
<li><a href="./OpenSSL/PKey/OpenSSL/PKey/OpenSSL/PKey/ECError.html">OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey::ECError</a>
<li><a href="./OpenSSL/PKey/PKey.html">OpenSSL::PKey::PKey</a>
<li><a href="./OpenSSL/PKey/RSA.html">OpenSSL::PKey::RSA</a>
<li><a href="./String.html">String</a>
</ul>
</div>
</div>
</nav>
<main role="main">
<p><a href="https://badge.fury.io/rb/net-ssh"><img
src="https://badge.fury.io/rb/net-ssh.svg" alt="Gem Version" /></a> <a
href="https://gitter.im/net-ssh/net-ssh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img
src="https://badges.gitter.im/net-ssh/net-ssh.svg" alt="Join the chat at
https://gitter.im/net-ssh/net-ssh"></a> <a
href="https://travis-ci.org/net-ssh/net-ssh"><img
src="https://travis-ci.org/net-ssh/net-ssh.svg?branch=master" alt="Build
Status" /></a> <a href="https://codecov.io/gh/net-ssh/net-ssh"><img
src="https://codecov.io/gh/net-ssh/net-ssh/branch/master/graph/badge.svg"
alt="Coverage status" /></a></p>
<h1 id="label-Net-3A-3ASSH+4.x"><a href="Net/SSH.html">Net::SSH</a> 4.x<span><a href="#label-Net-3A-3ASSH+4.x">¶</a> <a href="#top">↑</a></span></h1>
<ul><li>
<p>Docs: <a
href="http://net-ssh.github.com/net-ssh">net-ssh.github.com/net-ssh</a></p>
</li><li>
<p>Issues: <a
href="https://github.com/net-ssh/net-ssh/issues">github.com/net-ssh/net-ssh/issues</a></p>
</li><li>
<p>Codes: <a
href="https://github.com/net-ssh/net-ssh">github.com/net-ssh/net-ssh</a></p>
</li><li>
<p>Email: net-ssh@solutious.com</p>
</li></ul>
<p><em>As of v2.6.4, all gem releases are signed. See INSTALL.</em></p>
<h2 id="label-DESCRIPTION-3A">DESCRIPTION:<span><a href="#label-DESCRIPTION-3A">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="Net/SSH.html">Net::SSH</a> is a pure-Ruby implementation of the
SSH2 client protocol. It allows you to write programs that invoke and
interact with processes on remote servers, via SSH2.</p>
<h2 id="label-FEATURES-3A">FEATURES:<span><a href="#label-FEATURES-3A">¶</a> <a href="#top">↑</a></span></h2>
<ul><li>
<p>Execute processes on remote servers and capture their output</p>
</li><li>
<p>Run multiple processes in parallel over a single SSH connection</p>
</li><li>
<p>Support for SSH subsystems</p>
</li><li>
<p>Forward local and remote ports via an SSH connection</p>
</li></ul>
<h2 id="label-SYNOPSIS-3A">SYNOPSIS:<span><a href="#label-SYNOPSIS-3A">¶</a> <a href="#top">↑</a></span></h2>
<p>In a nutshell:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'net/ssh'</span>
<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-string">'host'</span>, <span class="ruby-string">'user'</span>, :<span class="ruby-identifier">password</span> =<span class="ruby-operator">></span> <span class="ruby-string">"password"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># capture all stderr and stdout output from a remote process</span>
<span class="ruby-identifier">output</span> = <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec!</span>(<span class="ruby-string">"hostname"</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">output</span>
<span class="ruby-comment"># capture only stdout matching a particular pattern</span>
<span class="ruby-identifier">stdout</span> = <span class="ruby-string">""</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec!</span>(<span class="ruby-string">"ls -l /home/jamis"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">channel</span>, <span class="ruby-identifier">stream</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">stdout</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span> <span class="ruby-operator">==</span> :<span class="ruby-identifier">stdout</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">stdout</span>
<span class="ruby-comment"># run multiple processes in parallel to completion</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"sed ..."</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"awk ..."</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"rm -rf ..."</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span>
<span class="ruby-comment"># open a new channel and configure a minimal set of callbacks, then run</span>
<span class="ruby-comment"># the event loop until the channel finishes (closes)</span>
<span class="ruby-identifier">channel</span> = <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">open_channel</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"/usr/local/bin/ruby /path/to/file.rb"</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">"could not execute command"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">success</span>
<span class="ruby-comment"># "on_data" is called when the process writes something to stdout</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># "on_extended_data" is called when the process writes something to stderr</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">on_extended_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">on_close</span> { <span class="ruby-identifier">puts</span> <span class="ruby-string">"done!"</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">wait</span>
<span class="ruby-comment"># forward connections on local port 1234 to port 80 of www.capify.org</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">forward</span>.<span class="ruby-identifier">local</span>(<span class="ruby-value">1234</span>, <span class="ruby-string">"www.capify.org"</span>, <span class="ruby-value">80</span>)
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span> { <span class="ruby-keyword">true</span> }
<span class="ruby-keyword">end</span>
</pre>
<p>See <a href="Net/SSH.html">Net::SSH</a> for more documentation, and links
to further information.</p>
<h2 id="label-REQUIREMENTS-3A">REQUIREMENTS:<span><a href="#label-REQUIREMENTS-3A">¶</a> <a href="#top">↑</a></span></h2>
<p>The only requirement you might be missing is the <a
href="OpenSSL.html">OpenSSL</a> bindings for Ruby. These are built by
default on most platforms, but you can verify that they're built and
installed on your system by running the following command line:</p>
<pre>ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION'</pre>
<p>If that spits out something like “OpenSSL 0.9.8g 19 Oct 2007”, then
you're set. If you get an error, then you'll need to see about
rebuilding ruby with <a href="OpenSSL.html">OpenSSL</a> support, or (if
your platform supports it) installing the <a
href="OpenSSL.html">OpenSSL</a> bindings separately.</p>
<p>Lastly, if you want to run the tests or use any of the Rake tasks,
you'll need Mocha and other dependencies listed in Gemfile</p>
<h2 id="label-INSTALL-3A">INSTALL:<span><a href="#label-INSTALL-3A">¶</a> <a href="#top">↑</a></span></h2>
<ul><li>
<p>gem install net-ssh (might need sudo privileges)</p>
</li></ul>
<p>NOTE: If you are running on jruby on windows you need to install
jruby-pageant manually (gemspec doesn't allow for platform specific
dependencies).</p>
<p>However, in order to be sure the code you're installing hasn't been
tampered with, it's recommended that you verify the <a
href="http://docs.rubygems.org/read/chapter/21">signature</a>. To do this,
you need to add my public key as a trusted certificate (you only need to do
this once):</p>
<pre># Add the public key as a trusted certificate
# (You only need to do this once)
$ curl -O https://raw.githubusercontent.com/net-ssh/net-ssh/master/net-ssh-public_cert.pem
$ gem cert --add net-ssh-public_cert.pem</pre>
<p>Then, when install the gem, do so with high security:</p>
<pre>$ gem install net-ssh -P HighSecurity</pre>
<p>If you don't add the public key, you'll see an error like
“Couldn't verify data signature”. If you're still having trouble
let me know and I'll give you a hand.</p>
<p>For ed25519 public key auth support your bundle file should contain
“`rbnacl-libsodium“`, “`rbnacl“`, “`bcrypt_pbkdf“` dependencies.</p>
<h2 id="label-RUBY+SUPPORT">RUBY SUPPORT<span><a href="#label-RUBY+SUPPORT">¶</a> <a href="#top">↑</a></span></h2>
<ul><li>
<p>Ruby 1.8.x is supported up until the net-ssh 2.5.1 release.</p>
</li><li>
<p>Ruby 1.9.x is supported up until the net-ssh 2.9.x release.</p>
</li><li>
<p>Current net-ssh releases require Ruby 2.0 or later.</p>
</li></ul>
<h2 id="label-RUNNING+TESTS">RUNNING TESTS<span><a href="#label-RUNNING+TESTS">¶</a> <a href="#top">↑</a></span></h2>
<p>Run the test suite from the net-ssh directory with the following command:</p>
<pre class="ruby"><span class="ruby-identifier">bundle</span> <span class="ruby-identifier">exec</span> <span class="ruby-identifier">rake</span> <span class="ruby-identifier">test</span>
</pre>
<p>Run a single test file like this:</p>
<pre>ruby -Ilib -Itest test/transport/test_server_version.rb</pre>
<p>To run integration tests see test/integration/README.txt</p>
<h3 id="label-BUILDING+GEM">BUILDING GEM<span><a href="#label-BUILDING+GEM">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">rake</span> <span class="ruby-identifier">build</span>
</pre>
<h3 id="label-GEM+SIGNING+-28for+maintainers-29">GEM SIGNING (for maintainers)<span><a href="#label-GEM+SIGNING+-28for+maintainers-29">¶</a> <a href="#top">↑</a></span></h3>
<p>If you have the net-ssh private signing key, you will be able to create
signed release builds. Make sure the private key path matches the
`signing_key` path set in `net-ssh.gemspec` and tell rake to sign the gem
by setting the `NET_SSH_BUILDGEM_SIGNED` flag:</p>
<pre>NET_SSH_BUILDGEM_SIGNED=true rake build</pre>
<p>For time to time, the public certificate associated to the private key
needs to be renewed. You can do this with the following command:</p>
<pre>gem cert --build netssh@solutious.com --private-key path/2/net-ssh-private_key.pem
mv gem-public_cert.pem net-ssh-public_cert.pem
gem cert --add net-ssh-public_cert.pem</pre>
<h2 id="label-LICENSE-3A">LICENSE:<span><a href="#label-LICENSE-3A">¶</a> <a href="#top">↑</a></span></h2>
<p>(The MIT License)</p>
<p>Copyright © 2008 Jamis Buck</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the
following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
