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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::KeyFactory - 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>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-get">::get</a>
<li ><a href="#method-c-load_data_private_key">::load_data_private_key</a>
<li ><a href="#method-c-load_data_public_key">::load_data_public_key</a>
<li ><a href="#method-c-load_private_key">::load_private_key</a>
<li ><a href="#method-c-load_public_key">::load_public_key</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::KeyFactory">
<h1 id="class-Net::SSH::KeyFactory" class="class">
class Net::SSH::KeyFactory
</h1>
<section class="description">
<p>A factory class for returning new Key classes. It is used for obtaining <a
href="../../OpenSSL.html">OpenSSL</a> key instances via their <a
href="../SSH.html">SSH</a> names, and for loading both public and private
keys. It used used primarily by <a href="../SSH.html">Net::SSH</a> itself,
internally, and will rarely (if ever) be directly used by consumers of the
library.</p>
<pre class="ruby"><span class="ruby-identifier">klass</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">KeyFactory</span>.<span class="ruby-identifier">get</span>(<span class="ruby-string">"rsa"</span>)
<span class="ruby-identifier">assert</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">KeyFactory</span>.<span class="ruby-identifier">load_public_key</span>(<span class="ruby-string">"~/.ssh/id_dsa.pub"</span>)
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="MAP">MAP
<dd><p>Specifies the mapping of <a href="../SSH.html">SSH</a> names to <a
href="../../OpenSSL.html">OpenSSL</a> key classes.</p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-get" class="method-detail ">
<div class="method-heading">
<span class="method-name">get</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetch an <a href="../../OpenSSL.html">OpenSSL</a> key instance by its <a
href="../SSH.html">SSH</a> name. It will be a new, empty key of the given
type.</p>
<div class="method-source-code" id="get-source">
<pre><span class="ruby-comment"># File lib/net/ssh/key_factory.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-constant">MAP</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-load_data_private_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_data_private_key</span><span
class="method-args">(data, passphrase=nil, ask_passphrase=true, filename="", prompt=Prompt.default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads a private key. It will correctly determine whether the file describes
an RSA or DSA key, and will load it appropriately. The new key is returned.
If the key itself is encrypted (requiring a passphrase to use), the user
will be prompted to enter their password unless passphrase works.</p>
<div class="method-source-code" id="load_data_private_key-source">
<pre><span class="ruby-comment"># File lib/net/ssh/key_factory.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_data_private_key</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">ask_passphrase</span>=<span class="ruby-keyword">true</span>, <span class="ruby-identifier">filename</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">prompt</span>=<span class="ruby-constant">Prompt</span>.<span class="ruby-identifier">default</span>)
<span class="ruby-identifier">key_type</span> = <span class="ruby-identifier">classify_key</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">filename</span>)
<span class="ruby-identifier">encrypted_key</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">prompter</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">result</span> =
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">key_type</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">passphrase</span> <span class="ruby-operator">||</span> <span class="ruby-string">'invalid'</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">*</span><span class="ruby-identifier">key_type</span>.<span class="ruby-identifier">error_classes</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">encrypted_key</span> = <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">key_type</span>.<span class="ruby-identifier">encrypted_key?</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">e</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">encrypted_key</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">encrypted_key</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">ask_passphrase</span>
<span class="ruby-identifier">tries</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">tries</span> <span class="ruby-operator"><=</span> <span class="ruby-value">3</span>
<span class="ruby-identifier">prompter</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">prompt</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">'private_key'</span>, <span class="ruby-identifier">filename</span><span class="ruby-operator">:</span> <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">sha</span><span class="ruby-operator">:</span> <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA256</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-identifier">data</span>))
<span class="ruby-identifier">passphrase</span> = <span class="ruby-identifier">prompter</span>.<span class="ruby-identifier">ask</span>(<span class="ruby-node">"Enter passphrase for #{filename}:"</span>, <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">prompter</span>.<span class="ruby-identifier">success</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prompter</span>
<span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-load_data_public_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_data_public_key</span><span
class="method-args">(data, filename="")</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads a public key. It will correctly determine whether the file describes
an RSA or DSA key, and will load it appropriately. The new public key is
returned.</p>
<div class="method-source-code" id="load_data_public_key-source">
<pre><span class="ruby-comment"># File lib/net/ssh/key_factory.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_data_public_key</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">filename</span>=<span class="ruby-string">""</span>)
<span class="ruby-identifier">fields</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/ /</span>)
<span class="ruby-identifier">blob</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">blob</span> = <span class="ruby-identifier">fields</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">end</span> <span class="ruby-keyword">while</span> <span class="ruby-operator">!</span><span class="ruby-identifier">blob</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-regexp">/^(ssh-(rsa|dss|ed25519)|ecdsa-sha2-nistp\d+)(-cert-v01@openssh\.com)?$/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">blob</span>)
<span class="ruby-identifier">blob</span> = <span class="ruby-identifier">fields</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>, <span class="ruby-node">"public key at #{filename} is not valid"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">blob</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">blob</span> = <span class="ruby-identifier">blob</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">"m*"</span>).<span class="ruby-identifier">first</span>
<span class="ruby-identifier">reader</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">blob</span>)
<span class="ruby-identifier">reader</span>.<span class="ruby-identifier">read_key</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">PKeyError</span>, <span class="ruby-node">"not a public key #{filename.inspect}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-load_private_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_private_key</span><span
class="method-args">(filename, passphrase=nil, ask_passphrase=true, prompt=Prompt.default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads a private key from a file. It will correctly determine whether the
file describes an RSA or DSA key, and will load it appropriately. The new
key is returned. If the key itself is encrypted (requiring a passphrase to
use), the user will be prompted to enter their password unless passphrase
works.</p>
<div class="method-source-code" id="load_private_key-source">
<pre><span class="ruby-comment"># File lib/net/ssh/key_factory.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_private_key</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">passphrase</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">ask_passphrase</span>=<span class="ruby-keyword">true</span>, <span class="ruby-identifier">prompt</span>=<span class="ruby-constant">Prompt</span>.<span class="ruby-identifier">default</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">filename</span>))
<span class="ruby-identifier">load_data_private_key</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">passphrase</span>, <span class="ruby-identifier">ask_passphrase</span>, <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">prompt</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-load_public_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_public_key</span><span
class="method-args">(filename)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads a public key from a file. It will correctly determine whether the
file describes an RSA or DSA key, and will load it appropriately. The new
public key is returned.</p>
<div class="method-source-code" id="load_public_key-source">
<pre><span class="ruby-comment"># File lib/net/ssh/key_factory.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_public_key</span>(<span class="ruby-identifier">filename</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">filename</span>))
<span class="ruby-identifier">load_data_public_key</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">filename</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>
|
