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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::Test::Packet - net-ssh 4.2.0</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_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="class">
<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="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Transport/Constants.html">Net::SSH::Transport::Constants</a>
<li><a class="include" href="../Connection/Constants.html">Net::SSH::Connection::Constants</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-register_channel_request">::register_channel_request</a>
<li ><a href="#method-c-registered_channel_requests">::registered_channel_requests</a>
<li ><a href="#method-i-instantiate-21">#instantiate!</a>
<li ><a href="#method-i-local-3F">#local?</a>
<li ><a href="#method-i-remote-3F">#remote?</a>
<li ><a href="#method-i-types">#types</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::Test::Packet">
<h1 id="class-Net::SSH::Test::Packet" class="class">
class Net::SSH::Test::Packet
</h1>
<section class="description">
<p>This is an abstract class, not to be instantiated directly, subclassed by
<a href="LocalPacket.html">Net::SSH::Test::LocalPacket</a> and <a
href="RemotePacket.html">Net::SSH::Test::RemotePacket</a>. It implements
functionality common to those subclasses.</p>
<p>These packets are not true packets, in that they don't represent what
was actually sent between the hosst; rather, they represent what was
expected to be sent, as dictated by the script (Net::SSH::Test::Script).
Thus, though they are defined with data elements, these data elements are
used to either validate data that was sent by the local host
(Net::SSH::Test::LocalPacket) or to mimic the sending of data by the remote
host (Net::SSH::Test::RemotePacket).</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(type, *args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ceate a new packet of the given <code>type</code>, and with
<code>args</code> being a list of data elements in the order expected for
packets of the given <code>type</code> (see <a
href="Packet.html#method-i-types">types</a>).</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-ivar">@type</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">upcase</span>)
<span class="ruby-ivar">@data</span> = <span class="ruby-identifier">args</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-register_channel_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">register_channel_request</span><span
class="method-args">(request, extra_parts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Register a custom channel request. extra_parts is an array of types of
extra parameters</p>
<div class="method-source-code" id="register_channel_request-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">register_channel_request</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">extra_parts</span>)
<span class="ruby-ivar">@registered_requests</span> <span class="ruby-operator">||=</span> {}
<span class="ruby-ivar">@registered_requests</span>[<span class="ruby-identifier">request</span>] = {<span class="ruby-identifier">extra_parts</span><span class="ruby-operator">:</span> <span class="ruby-identifier">extra_parts</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-registered_channel_requests" class="method-detail ">
<div class="method-heading">
<span class="method-name">registered_channel_requests</span><span
class="method-args">(request)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="registered_channel_requests-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">registered_channel_requests</span>(<span class="ruby-identifier">request</span>)
<span class="ruby-ivar">@registered_requests</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@registered_requests</span>[<span class="ruby-identifier">request</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-instantiate-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">instantiate!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Instantiates the packets data elements. When the packet was first defined,
some elements may not have been fully realized, and were described as Proc
objects rather than atomic types. This invokes those Proc objects and
replaces them with their returned values. This allows for values like <a
href="Channel.html#method-i-remote_id">Net::SSH::Test::Channel#remote_id</a>
to be used in scripts before the remote_id is known (since it is only known
after a channel has been confirmed open).</p>
<div class="method-source-code" id="instantiate-21-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">instantiate!</span>
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">map!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">call</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">i</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-local-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">local?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The default for <code>local?</code> is false. Subclasses should override as
necessary.</p>
<div class="method-source-code" id="local-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 45</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">local?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remote-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">remote?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The default for <code>remote?</code> is false. Subclasses should override
as necessary.</p>
<div class="method-source-code" id="remote-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-types" class="method-detail ">
<div class="method-heading">
<span class="method-name">types</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of symbols describing the data elements for packets of the
same type as this packet. These types are used to either validate sent
packets (Net::SSH::Test::LocalPacket) or build received packets
(Net::SSH::Test::RemotePacket).</p>
<p>Not all packet types are defined here. As new packet types are required
(e.g., a unit test needs to test that the remote host sent a packet that is
not implemented here), the description of that packet should be added.
Unsupported packet types will otherwise raise an exception.</p>
<div class="method-source-code" id="types-source">
<pre><span class="ruby-comment"># File lib/net/ssh/test/packet.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">types</span>
<span class="ruby-ivar">@types</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">case</span> <span class="ruby-ivar">@type</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">KEXINIT</span> <span class="ruby-keyword">then</span>
[<span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>,
<span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:string</span>,
<span class="ruby-value">:bool</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">NEWKEYS</span> <span class="ruby-keyword">then</span> []
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_OPEN</span> <span class="ruby-keyword">then</span> [<span class="ruby-value">:string</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_OPEN_CONFIRMATION</span> <span class="ruby-keyword">then</span> [<span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_DATA</span> <span class="ruby-keyword">then</span> [<span class="ruby-value">:long</span>, <span class="ruby-value">:string</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_EXTENDED_DATA</span> <span class="ruby-keyword">then</span> [<span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:string</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_EOF</span>, <span class="ruby-constant">CHANNEL_CLOSE</span>, <span class="ruby-constant">CHANNEL_SUCCESS</span>, <span class="ruby-constant">CHANNEL_FAILURE</span> <span class="ruby-keyword">then</span> [<span class="ruby-value">:long</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">CHANNEL_REQUEST</span>
<span class="ruby-identifier">parts</span> = [<span class="ruby-value">:long</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:bool</span>]
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">1</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"exec"</span>, <span class="ruby-string">"subsystem"</span>,<span class="ruby-string">"shell"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-value">:string</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"exit-status"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-value">:long</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"pty-req"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-value">:string</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:long</span>, <span class="ruby-value">:string</span>])
<span class="ruby-keyword">when</span> <span class="ruby-string">"env"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">contact</span>([<span class="ruby-value">:string</span>,<span class="ruby-value">:string</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Packet</span>.<span class="ruby-identifier">registered_channel_requests</span>(<span class="ruby-ivar">@data</span>[<span class="ruby-value">1</span>])
<span class="ruby-identifier">raise</span> <span class="ruby-node">"don't know what to do about #{@data[1]} channel request"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">request</span>
<span class="ruby-identifier">parts</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">request</span>[<span class="ruby-value">:extra_parts</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"don't know how to parse packet type #{@type}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
