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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>Module: Net::SSH::Transport::OSSL</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
// ]]>
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Module</span><br />Net::SSH::Transport::OSSL</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../files/lib/net/ssh/transport/ossl/buffer-factory_rb.html">lib/net/ssh/transport/ossl/buffer-factory.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/buffer_rb.html">lib/net/ssh/transport/ossl/buffer.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/cipher-factory_rb.html">lib/net/ssh/transport/ossl/cipher-factory.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/digest-factory_rb.html">lib/net/ssh/transport/ossl/digest-factory.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/hmac_rb.html">lib/net/ssh/transport/ossl/hmac/hmac.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/md5-96_rb.html">lib/net/ssh/transport/ossl/hmac/md5-96.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/md5_rb.html">lib/net/ssh/transport/ossl/hmac/md5.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/none_rb.html">lib/net/ssh/transport/ossl/hmac/none.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/services_rb.html">lib/net/ssh/transport/ossl/hmac/services.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/sha1-96_rb.html">lib/net/ssh/transport/ossl/hmac/sha1-96.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac/sha1_rb.html">lib/net/ssh/transport/ossl/hmac/sha1.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/hmac-factory_rb.html">lib/net/ssh/transport/ossl/hmac-factory.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/key-factory_rb.html">lib/net/ssh/transport/ossl/key-factory.rb</a>
<a href="../../../../files/lib/net/ssh/transport/ossl/services_rb.html">lib/net/ssh/transport/ossl/services.rb</a>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000014">register_services</a></li>
<li><a href="#M000015">version_check</a></li>
</ul>
<div class="sectiontitle">Classes and Modules</div>
Module <a href="OSSL/HMAC.html" class="link">Net::SSH::Transport::OSSL::HMAC</a><br />
Module <a href="OSSL/ReaderBufferImpl.html" class="link">Net::SSH::Transport::OSSL::ReaderBufferImpl</a><br />
Class <a href="OSSL/Buffer.html" class="link">Net::SSH::Transport::OSSL::Buffer</a><br />
Class <a href="OSSL/BufferFactory.html" class="link">Net::SSH::Transport::OSSL::BufferFactory</a><br />
Class <a href="OSSL/CipherFactory.html" class="link">Net::SSH::Transport::OSSL::CipherFactory</a><br />
Class <a href="OSSL/DigestFactory.html" class="link">Net::SSH::Transport::OSSL::DigestFactory</a><br />
Class <a href="OSSL/HMACFactory.html" class="link">Net::SSH::Transport::OSSL::HMACFactory</a><br />
Class <a href="OSSL/KeyFactory.html" class="link">Net::SSH::Transport::OSSL::KeyFactory</a><br />
Class <a href="OSSL/ReaderBuffer.html" class="link">Net::SSH::Transport::OSSL::ReaderBuffer</a><br />
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000014"></a><b>register_services</b>( container )
</div>
<div class="description">
<p>
Register all <a href="../../../OpenSSL.html">OpenSSL</a>-related services.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000014_source')" id="l_M000014_source">show source</a> ]</p>
<div id="M000014_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/transport/ossl/services.rb, line 25</span>
25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register_services</span>( <span class="ruby-identifier">container</span> )
26: <span class="ruby-comment cmt"># make sure the user has a valid Ruby and OpenSSL installed.</span>
27: <span class="ruby-identifier">version_check</span>
28:
29: <span class="ruby-comment cmt"># Register all OpenSSL services in the :ossl namespace.</span>
30: <span class="ruby-identifier">container</span>.<span class="ruby-identifier">namespace_define</span> <span class="ruby-identifier">:ossl</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
31:
32: <span class="ruby-comment cmt"># The list of known sources of HMAC algorithm implementations.</span>
33: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">hmac_algorithm_sources</span> { <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span> }
34: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/hmac/services'</span>, <span class="ruby-node">"#{self}::HMAC"</span>
35:
36: <span class="ruby-comment cmt"># The hash mapping SSH2 cipher names to OpenSSL cipher names.</span>
37: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">cipher_names</span> <span class="ruby-keyword kw">do</span>
38: <span class="ruby-constant">Hash</span>[ <span class="ruby-value str">"3des-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"des-ede3-cbc"</span>,
39: <span class="ruby-value str">"blowfish-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"bf-cbc"</span>,
40: <span class="ruby-value str">"aes256-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"aes-256-cbc"</span>,
41: <span class="ruby-value str">"aes192-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"aes-192-cbc"</span>,
42: <span class="ruby-value str">"aes128-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"aes-128-cbc"</span>,
43: <span class="ruby-value str">"idea-cbc"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"idea-cbc"</span>,
44: <span class="ruby-value str">"none"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"none"</span> ]
45: <span class="ruby-keyword kw">end</span>
46:
47: <span class="ruby-comment cmt"># The hash mapping key names to OpenSSL key implementations.</span>
48: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">key_names</span> <span class="ruby-keyword kw">do</span>
49: <span class="ruby-constant">Hash</span>[ <span class="ruby-value str">"dh"</span> =<span class="ruby-operator">></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">DH</span>,
50: <span class="ruby-value str">"rsa"</span> =<span class="ruby-operator">></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>,
51: <span class="ruby-value str">"dsa"</span> =<span class="ruby-operator">></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">DSA</span> ]
52: <span class="ruby-keyword kw">end</span>
53:
54: <span class="ruby-comment cmt"># The hash mapping digest names to OpenSSL digest implementations.</span>
55: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">digest_names</span> <span class="ruby-keyword kw">do</span>
56: <span class="ruby-constant">Hash</span>[ <span class="ruby-value str">"sha1"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>,
57: <span class="ruby-value str">"md5"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span> ]
58: <span class="ruby-keyword kw">end</span>
59:
60: <span class="ruby-comment cmt"># The factory for converting cipher names to cipher implementations.</span>
61: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">cipher_factory</span>( <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
62: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/cipher-factory'</span>
63: <span class="ruby-identifier">svc</span> = <span class="ruby-constant">CipherFactory</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">c</span>.<span class="ruby-identifier">cipher_names</span> )
64: <span class="ruby-identifier">svc</span>.<span class="ruby-identifier">identity_cipher</span> = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">identity_cipher</span>
65: <span class="ruby-identifier">svc</span>
66: <span class="ruby-keyword kw">end</span>
67:
68: <span class="ruby-comment cmt"># The factory for converting HMAC names to HMAC implementations.</span>
69: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">hmac_factory</span>( <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
70: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/hmac-factory'</span>
71: <span class="ruby-constant">HMACFactory</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">c</span>.<span class="ruby-identifier">hmac_algorithm_sources</span> )
72: <span class="ruby-keyword kw">end</span>
73:
74: <span class="ruby-comment cmt"># The factory for obtaining OpenSSL-specific buffer implementations.</span>
75: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">buffer_factory</span> <span class="ruby-keyword kw">do</span>
76: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/buffer-factory'</span>
77: <span class="ruby-constant">BufferFactory</span>.<span class="ruby-identifier">new</span>
78: <span class="ruby-keyword kw">end</span>
79:
80: <span class="ruby-comment cmt"># The factory for converting key names to key implementations.</span>
81: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">key_factory</span>( <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> ) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
82: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/key-factory'</span>
83: <span class="ruby-identifier">svc</span> = <span class="ruby-constant">KeyFactory</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">c</span>.<span class="ruby-identifier">key_names</span> )
84: <span class="ruby-identifier">svc</span>.<span class="ruby-identifier">buffers</span> = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">buffer_factory</span>
85: <span class="ruby-identifier">svc</span>.<span class="ruby-identifier">prompter</span> = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">prompter</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">knows_key?</span>( <span class="ruby-identifier">:prompter</span> )
86: <span class="ruby-identifier">svc</span>
87: <span class="ruby-keyword kw">end</span>
88:
89: <span class="ruby-comment cmt"># The factory for creating OpenSSL::BN (big number) instances.</span>
90: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">bn_factory</span> { <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">BN</span> }
91:
92: <span class="ruby-comment cmt"># The factory for converting digest names to digest implementations.</span>
93: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">digest_factory</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
94: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/transport/ossl/digest-factory'</span>
95: <span class="ruby-constant">DigestFactory</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">c</span>.<span class="ruby-identifier">digest_names</span> )
96: <span class="ruby-keyword kw">end</span>
97:
98: <span class="ruby-keyword kw">end</span>
99:
100: <span class="ruby-comment cmt"># Register each of the factories defined above in the corresponding</span>
101: <span class="ruby-comment cmt"># factory map, under the :ossl key.</span>
102: <span class="ruby-identifier">container</span>.<span class="ruby-identifier">define</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
103: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">cipher_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">cipher_factory</span>
104: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">hmac_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">hmac_factory</span>
105: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">key_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">key_factory</span>
106: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">buffer_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">buffer_factory</span>
107: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">bn_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">bn_factory</span>
108: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">digest_factories</span>[<span class="ruby-identifier">:ossl</span>] = <span class="ruby-identifier">b</span>.<span class="ruby-identifier">ossl</span>.<span class="ruby-identifier">digest_factory</span>
109: <span class="ruby-keyword kw">end</span>
110: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000015"></a><b>version_check</b>()
</div>
<div class="description">
<p>
Tries to make sure that the correct minimum versions of libraries are
installed.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000015_source')" id="l_M000015_source">show source</a> ]</p>
<div id="M000015_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/transport/ossl/services.rb, line 115</span>
115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">version_check</span>
116: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">RUBY_VERSION</span> <span class="ruby-operator"><</span> <span class="ruby-value str">"1.8.2"</span>
117: <span class="ruby-keyword kw">unless</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">DH</span>.<span class="ruby-identifier">instance_methods</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">"p"</span>
118: <span class="ruby-identifier">warn</span> <span class="ruby-value str">"Your OpenSSL module (the Ruby module, not the library)\n"</span> <span class="ruby-operator">+</span>
119: <span class="ruby-value str">"is too old. Please go to the Net::SSH downloads page\n"</span> <span class="ruby-operator">+</span>
120: <span class="ruby-value str">"and install the most recent snapshot of the OpenSSL\n"</span> <span class="ruby-operator">+</span>
121: <span class="ruby-value str">"module.\n\n"</span> <span class="ruby-operator">+</span>
122: <span class="ruby-value str">" http://rubyforge.org/projects/net-ssh"</span>
123: <span class="ruby-identifier">abort</span>
124: <span class="ruby-keyword kw">end</span>
125: <span class="ruby-keyword kw">end</span>
126:
127: <span class="ruby-comment cmt"># make sure that the OpenSSL library itself is at least version 0.9.7</span>
128: <span class="ruby-identifier">match</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">OPENSSL_VERSION</span>.<span class="ruby-identifier">match</span>(
129: <span class="ruby-regexp re">/OpenSSL (\d+)\.(\d+)\.(\d+)(.*?) /</span> )
130: <span class="ruby-identifier">major</span> = <span class="ruby-identifier">match</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span>
131: <span class="ruby-identifier">minor</span> = <span class="ruby-identifier">match</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span>
132: <span class="ruby-identifier">tiny</span> = <span class="ruby-identifier">match</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span>
133: <span class="ruby-identifier">patch</span> = <span class="ruby-identifier">match</span>[<span class="ruby-value">4</span>]
134:
135: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">major</span> <span class="ruby-operator"><</span> <span class="ruby-value">1</span> <span class="ruby-operator">&&</span> ( <span class="ruby-identifier">minor</span> <span class="ruby-operator"><</span> <span class="ruby-value">9</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">minor</span> <span class="ruby-operator">==</span> <span class="ruby-value">9</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">tiny</span> <span class="ruby-operator"><</span> <span class="ruby-value">7</span> )
136: <span class="ruby-identifier">ver</span> = <span class="ruby-node">"#{major}.#{minor}.#{tiny}#{patch}"</span>
137: <span class="ruby-identifier">warn</span> <span class="ruby-value str">"Your OpenSSL library (the library itself, not the Ruby\n"</span> <span class="ruby-operator">+</span>
138: <span class="ruby-node">"module) is version #{ver}, too old to use with Net::SSH.\n"</span> <span class="ruby-operator">+</span>
139: <span class="ruby-value str">"Please upgrade to at least version 0.9.7 and then rebuild\n"</span> <span class="ruby-operator">+</span>
140: <span class="ruby-value str">"your Ruby OpenSSL module."</span>
141: <span class="ruby-identifier">abort</span>
142: <span class="ruby-keyword kw">end</span>
143: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
