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
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::Authentication::Agent - net-ssh 6.0.0.beta1</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="../Loggable.html">Net::SSH::Loggable</a>
</ul>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Agent/Comment.html">Net::SSH::Authentication::Agent::Comment</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-connect">::connect</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-add_identity">#add_identity</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-connect-21">#connect!</a>
<li ><a href="#method-i-identities">#identities</a>
<li ><a href="#method-i-negotiate-21">#negotiate!</a>
<li ><a href="#method-i-remove_all_identities">#remove_all_identities</a>
<li ><a href="#method-i-remove_identity">#remove_identity</a>
<li ><a href="#method-i-sign">#sign</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::Authentication::Agent">
<h1 id="class-Net::SSH::Authentication::Agent" class="class">
class Net::SSH::Authentication::Agent
</h1>
<section class="description">
<p>This class implements a simple client for the ssh-agent protocol. It does
not implement any specific protocol, but instead copies the behavior of the
ssh-agent functions in the OpenSSH library (3.8).</p>
<p>This means that although it behaves like a SSH1 client, it also has some
SSH2 functionality (like signing data).</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="SSH2_AGENT_ADD_IDENTITY">SSH2_AGENT_ADD_IDENTITY
<dd>
<dt id="SSH2_AGENT_ADD_ID_CONSTRAINED">SSH2_AGENT_ADD_ID_CONSTRAINED
<dd>
<dt id="SSH2_AGENT_FAILURE">SSH2_AGENT_FAILURE
<dd>
<dt id="SSH2_AGENT_IDENTITIES_ANSWER">SSH2_AGENT_IDENTITIES_ANSWER
<dd>
<dt id="SSH2_AGENT_REMOVE_ALL_IDENTITIES">SSH2_AGENT_REMOVE_ALL_IDENTITIES
<dd>
<dt id="SSH2_AGENT_REMOVE_IDENTITY">SSH2_AGENT_REMOVE_IDENTITY
<dd>
<dt id="SSH2_AGENT_REQUEST_IDENTITIES">SSH2_AGENT_REQUEST_IDENTITIES
<dd>
<dt id="SSH2_AGENT_REQUEST_VERSION">SSH2_AGENT_REQUEST_VERSION
<dd>
<dt id="SSH2_AGENT_SIGN_REQUEST">SSH2_AGENT_SIGN_REQUEST
<dd>
<dt id="SSH2_AGENT_SIGN_RESPONSE">SSH2_AGENT_SIGN_RESPONSE
<dd>
<dt id="SSH2_AGENT_VERSION_RESPONSE">SSH2_AGENT_VERSION_RESPONSE
<dd>
<dt id="SSH_AGENT_CONSTRAIN_CONFIRM">SSH_AGENT_CONSTRAIN_CONFIRM
<dd>
<dt id="SSH_AGENT_CONSTRAIN_LIFETIME">SSH_AGENT_CONSTRAIN_LIFETIME
<dd>
<dt id="SSH_AGENT_FAILURE">SSH_AGENT_FAILURE
<dd>
<dt id="SSH_AGENT_REQUEST_RSA_IDENTITIES">SSH_AGENT_REQUEST_RSA_IDENTITIES
<dd>
<dt id="SSH_AGENT_RSA_IDENTITIES_ANSWER1">SSH_AGENT_RSA_IDENTITIES_ANSWER1
<dd>
<dt id="SSH_AGENT_RSA_IDENTITIES_ANSWER2">SSH_AGENT_RSA_IDENTITIES_ANSWER2
<dd>
<dt id="SSH_AGENT_RSA_SHA2_256">SSH_AGENT_RSA_SHA2_256
<dd>
<dt id="SSH_AGENT_RSA_SHA2_512">SSH_AGENT_RSA_SHA2_512
<dd>
<dt id="SSH_AGENT_SUCCESS">SSH_AGENT_SUCCESS
<dd>
<dt id="SSH_COM_AGENT2_FAILURE">SSH_COM_AGENT2_FAILURE
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-socket" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">socket</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The underlying socket being used to communicate with the <a
href="../../SSH.html">SSH</a> agent.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-connect" class="method-detail ">
<div class="method-heading">
<span class="method-name">connect</span><span
class="method-args">(logger=nil, agent_socket_factory = nil, identity_agent = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Instantiates a new agent object, connects to a running <a
href="../../SSH.html">SSH</a> agent, negotiates the agent protocol version,
and returns the agent object.</p>
<div class="method-source-code" id="connect-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-identifier">logger</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">agent_socket_factory</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">identity_agent</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">agent</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">logger</span>)
<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">connect!</span>(<span class="ruby-identifier">agent_socket_factory</span>, <span class="ruby-identifier">identity_agent</span>)
<span class="ruby-identifier">agent</span>.<span class="ruby-identifier">negotiate!</span>
<span class="ruby-identifier">agent</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(logger=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="Agent.html">Agent</a> object, using the optional
logger instance to report status.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">logger</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">logger</span> = <span class="ruby-identifier">logger</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-add_identity" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_identity</span><span
class="method-args">(priv_key, comment, lifetime: nil, confirm: false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds the private key with comment to the agent. If lifetime is given, the
key will automatically be removed after lifetime seconds. If confirm is
true, confirmation will be required for each agent signing operation.</p>
<div class="method-source-code" id="add_identity-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_identity</span>(<span class="ruby-identifier">priv_key</span>, <span class="ruby-identifier">comment</span>, <span class="ruby-identifier">lifetime</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">confirm</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">constraints</span> = <span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">lifetime</span>
<span class="ruby-identifier">constraints</span>.<span class="ruby-identifier">write_byte</span>(<span class="ruby-constant">SSH_AGENT_CONSTRAIN_LIFETIME</span>)
<span class="ruby-identifier">constraints</span>.<span class="ruby-identifier">write_long</span>(<span class="ruby-identifier">lifetime</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">constraints</span>.<span class="ruby-identifier">write_byte</span>(<span class="ruby-constant">SSH_AGENT_CONSTRAIN_CONFIRM</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">confirm</span>
<span class="ruby-identifier">req_type</span> = <span class="ruby-identifier">constraints</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">?</span> <span class="ruby-constant">SSH2_AGENT_ADD_IDENTITY</span> <span class="ruby-operator">:</span> <span class="ruby-constant">SSH2_AGENT_ADD_ID_CONSTRAINED</span>
<span class="ruby-identifier">type</span>, = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-identifier">req_type</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">priv_key</span>.<span class="ruby-identifier">ssh_type</span>, <span class="ruby-value">:raw</span>, <span class="ruby-identifier">blob_for_add</span>(<span class="ruby-identifier">priv_key</span>),
<span class="ruby-value">:string</span>, <span class="ruby-identifier">comment</span>, <span class="ruby-value">:raw</span>, <span class="ruby-identifier">constraints</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-string">"could not add identity to agent"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH_AGENT_SUCCESS</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Closes this socket. This agent reference is no longer able to query the
agent.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 146</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">close</span>
<span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-connect-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">connect!</span><span
class="method-args">(agent_socket_factory = nil, identity_agent = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Connect to the agent process using the socket factory and socket name given
by the attribute writers. If the agent on the other end of the socket
reports that it is an SSH2-compatible agent, this will fail (it only
supports the ssh-agent distributed by OpenSSH).</p>
<div class="method-source-code" id="connect-21-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connect!</span>(<span class="ruby-identifier">agent_socket_factory</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">identity_agent</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">debug</span> { <span class="ruby-string">"connecting to ssh-agent"</span> }
<span class="ruby-ivar">@socket</span> =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">agent_socket_factory</span>
<span class="ruby-identifier">agent_socket_factory</span>.<span class="ruby-identifier">call</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">identity_agent</span>
<span class="ruby-identifier">unix_socket_class</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">identity_agent</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SSH_AUTH_SOCK'</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">unix_socket_class</span>
<span class="ruby-identifier">unix_socket_class</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'SSH_AUTH_SOCK'</span>])
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">win_platform?</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">RUBY_ENGINE</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"jruby"</span>
<span class="ruby-constant">Pageant</span><span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>.<span class="ruby-identifier">open</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotAvailable</span>, <span class="ruby-string">"Agent not configured"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">error</span> { <span class="ruby-node">"could not connect to ssh-agent: #{e.message}"</span> }
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotAvailable</span>, <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-identities" class="method-detail ">
<div class="method-heading">
<span class="method-name">identities</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return an array of all identities (public keys) known to the agent. Each
key returned is augmented with a <code>comment</code> property which is set
to the comment returned by the agent for that key.</p>
<div class="method-source-code" id="identities-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">identities</span>
<span class="ruby-identifier">type</span>, <span class="ruby-identifier">body</span> = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-constant">SSH2_AGENT_REQUEST_IDENTITIES</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-string">"could not get identity count"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">agent_failed</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-node">"bad authentication reply: #{type}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH2_AGENT_IDENTITIES_ANSWER</span>
<span class="ruby-identifier">identities</span> = []
<span class="ruby-identifier">body</span>.<span class="ruby-identifier">read_long</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">key_str</span> = <span class="ruby-identifier">body</span>.<span class="ruby-identifier">read_string</span>
<span class="ruby-identifier">comment_str</span> = <span class="ruby-identifier">body</span>.<span class="ruby-identifier">read_string</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">key</span> = <span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key_str</span>).<span class="ruby-identifier">read_key</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">error</span> { <span class="ruby-node">"ignoring invalid key: #{comment_str}"</span> }
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">key</span>.<span class="ruby-identifier">extend</span>(<span class="ruby-constant">Comment</span>)
<span class="ruby-identifier">key</span>.<span class="ruby-identifier">comment</span> = <span class="ruby-identifier">comment_str</span>
<span class="ruby-identifier">identities</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NotImplementedError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">error</span> { <span class="ruby-node">"ignoring unimplemented key:#{e.message} #{comment_str}"</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">identities</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-negotiate-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">negotiate!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Attempts to negotiate the <a href="../../SSH.html">SSH</a> agent protocol
version. Raises an error if the version could not be negotiated
successfully.</p>
<div class="method-source-code" id="negotiate-21-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">negotiate!</span>
<span class="ruby-comment"># determine what type of agent we're communicating with</span>
<span class="ruby-identifier">type</span>, <span class="ruby-identifier">body</span> = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-constant">SSH2_AGENT_REQUEST_VERSION</span>, <span class="ruby-value">:string</span>, <span class="ruby-constant">Transport</span><span class="ruby-operator">::</span><span class="ruby-constant">ServerVersion</span><span class="ruby-operator">::</span><span class="ruby-constant">PROTO_VERSION</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotAvailable</span>, <span class="ruby-string">"SSH2 agents are not yet supported"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">SSH2_AGENT_VERSION_RESPONSE</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">SSH2_AGENT_FAILURE</span>
<span class="ruby-identifier">debug</span> { <span class="ruby-node">"Unexpected response type==#{type}, this will be ignored"</span> }
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH_AGENT_RSA_IDENTITIES_ANSWER1</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH_AGENT_RSA_IDENTITIES_ANSWER2</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotAvailable</span>, <span class="ruby-node">"unknown response from agent: #{type}, #{body.to_s.inspect}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove_all_identities" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_all_identities</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes all identities from the agent.</p>
<div class="method-source-code" id="remove_all_identities-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 187</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_all_identities</span>
<span class="ruby-identifier">type</span>, = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-constant">SSH2_AGENT_REMOVE_ALL_IDENTITIES</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-string">"could not remove all identity from agent"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH_AGENT_SUCCESS</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove_identity" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_identity</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes key from the agent.</p>
<div class="method-source-code" id="remove_identity-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 181</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_identity</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-identifier">type</span>, = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-constant">SSH2_AGENT_REMOVE_IDENTITY</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_blob</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-string">"could not remove identity from agent"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH_AGENT_SUCCESS</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sign" class="method-detail ">
<div class="method-heading">
<span class="method-name">sign</span><span
class="method-args">(key, data, flags = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Using the agent and the given public key, sign the given data. The
signature is returned in SSH2 format.</p>
<div class="method-source-code" id="sign-source">
<pre><span class="ruby-comment"># File lib/net/ssh/authentication/agent.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">sign</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">flags</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">type</span>, <span class="ruby-identifier">reply</span> = <span class="ruby-identifier">send_and_wait</span>(<span class="ruby-constant">SSH2_AGENT_SIGN_REQUEST</span>, <span class="ruby-value">:string</span>, <span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">from</span>(<span class="ruby-value">:key</span>, <span class="ruby-identifier">key</span>), <span class="ruby-value">:string</span>, <span class="ruby-identifier">data</span>, <span class="ruby-value">:long</span>, <span class="ruby-identifier">flags</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-string">"agent could not sign data with requested identity"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">agent_failed</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentError</span>, <span class="ruby-node">"bad authentication response #{type}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">SSH2_AGENT_SIGN_RESPONSE</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">read_string</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>
|
