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
|
<?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>Class: Net::SSH::UserAuth::Driver</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">Class</span><br />Net::SSH::UserAuth::Driver</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../files/lib/net/ssh/userauth/driver_rb.html">lib/net/ssh/userauth/driver.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="description"><p>
A wrapper around the transport layer that represents the functionality of
user authentication.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000167">authenticate</a></li>
<li><a href="#M000160">new</a></li>
<li><a href="#M000164">on_banner</a></li>
<li><a href="#M000165">send_message</a></li>
<li><a href="#M000163">set_auth_method_order</a></li>
<li><a href="#M000162">set_host_key_files</a></li>
<li><a href="#M000161">set_key_files</a></li>
<li><a href="#M000166">wait_for_message</a></li>
</ul>
<div class="sectiontitle">Included Modules</div>
<ul>
<li><a href="Constants.html">Net::SSH::UserAuth::Constants</a></li>
<li><a href="../Transport/Constants.html">Net::SSH::Transport::Constants</a></li>
</ul>
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class='attr-rw'>
[W]
</td>
<td class='attr-name'>key_manager</td>
<td class='attr-desc'>
The <a href="UserKeyManager.html">UserKeyManager</a> instance used by the
auth service.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>order</td>
<td class='attr-desc'>
The array of auth-method names (as strings), giving the order in which each
auth-method will be tried.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[W]
</td>
<td class='attr-name'>session</td>
<td class='attr-desc'>
The <a href="../../SSH.html">SSH</a> (transport) session to use for
communication.
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000160"></a><b>new</b>( log, buffers, methods, order )
</div>
<div class="description">
<p>
Create a <a href="Driver.html#M000160">new</a> user-auth service on top of
the given session.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000160_source')" id="l_M000160_source">show source</a> ]</p>
<div id="M000160_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 44</span>
44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">log</span>, <span class="ruby-identifier">buffers</span>, <span class="ruby-identifier">methods</span>, <span class="ruby-identifier">order</span> )
45: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log</span>
46: <span class="ruby-ivar">@buffers</span> = <span class="ruby-identifier">buffers</span>
47: <span class="ruby-ivar">@methods</span> = <span class="ruby-identifier">methods</span>
48: <span class="ruby-ivar">@on_banner</span> = <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">msg</span>,<span class="ruby-identifier">lang</span><span class="ruby-operator">|</span> }
49: <span class="ruby-ivar">@order</span> = <span class="ruby-identifier">order</span>.<span class="ruby-identifier">dup</span>
50: <span class="ruby-ivar">@allowed_auth_methods</span> = <span class="ruby-keyword kw">nil</span>
51: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000167"></a><b>authenticate</b>( next_service, username, password=nil )
</div>
<div class="description">
<p>
Processes the authentication of the given username. The
‘next_service’ parameter should be set to the <a
href="../../SSH.html">SSH</a> service that will be requested once the
authentication succeeds (usually ‘ssh-connection’).
</p>
<p>
This will return <tt>true</tt> if the user is accepted by the server, and
<tt>false</tt> otherwise.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000167_source')" id="l_M000167_source">show source</a> ]</p>
<div id="M000167_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 140</span>
140: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">authenticate</span>( <span class="ruby-identifier">next_service</span>, <span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>=<span class="ruby-keyword kw">nil</span> )
141: <span class="ruby-identifier">msg</span> = <span class="ruby-ivar">@buffers</span>.<span class="ruby-identifier">writer</span>
142: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_byte</span> <span class="ruby-constant">SERVICE_REQUEST</span>
143: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-value str">"ssh-userauth"</span>
144: <span class="ruby-identifier">send_message</span> <span class="ruby-identifier">msg</span>
145:
146: <span class="ruby-identifier">message</span> = <span class="ruby-identifier">wait_for_message</span>
147: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_type</span> <span class="ruby-operator">==</span> <span class="ruby-constant">SERVICE_ACCEPT</span>
148: <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>,
149: <span class="ruby-node">"expected SERVICE_ACCEPT, got #{message.inspect}"</span>
150: <span class="ruby-keyword kw">end</span>
151:
152: <span class="ruby-identifier">data</span> = { <span class="ruby-identifier">:password</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">password</span>,
153: <span class="ruby-identifier">:key_manager</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@key_manager</span> }
154:
155: <span class="ruby-ivar">@order</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">auth_method</span><span class="ruby-operator">|</span>
156: <span class="ruby-comment cmt"># if the server has reported a list of auth methods that are</span>
157: <span class="ruby-comment cmt"># allowed to continue, only consider those auth methods.</span>
158: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@allowed_auth_methods</span> <span class="ruby-operator">&&</span>
159: <span class="ruby-operator">!</span><span class="ruby-ivar">@allowed_auth_methods</span>.<span class="ruby-identifier">include?</span>( <span class="ruby-identifier">auth_method</span> )
160:
161: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"trying #{auth_method.inspect}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
162:
163: <span class="ruby-identifier">impl</span> = <span class="ruby-ivar">@methods</span>[ <span class="ruby-identifier">auth_method</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/-/</span>,<span class="ruby-value str">"_"</span>).<span class="ruby-identifier">intern</span> ]
164: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">impl</span>.<span class="ruby-identifier">nil?</span>
165: <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>,
166: <span class="ruby-node">"`#{auth_method}' authentication is not implemented"</span>
167: <span class="ruby-keyword kw">end</span>
168:
169: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">impl</span>.<span class="ruby-identifier">authenticate</span>( <span class="ruby-identifier">next_service</span>, <span class="ruby-identifier">username</span>, <span class="ruby-identifier">data</span> )
170: <span class="ruby-keyword kw">end</span>
171:
172: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-value str">"all authorization methods failed"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
173: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
174:
175: <span class="ruby-keyword kw">ensure</span>
176: <span class="ruby-ivar">@key_manager</span>.<span class="ruby-identifier">finish</span>
177: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000164"></a><b>on_banner</b>( &block )
</div>
<div class="description">
<p>
Specify the callback to use when the server sends a banner message at login
time.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000164_source')" id="l_M000164_source">show source</a> ]</p>
<div id="M000164_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 78</span>
78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">on_banner</span>( <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> )
79: <span class="ruby-ivar">@on_banner</span> = <span class="ruby-identifier">block</span>
80: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000165"></a><b>send_message</b>( message )
</div>
<div class="description">
<p>
Sends the message by delegating to the session‘s <a
href="Driver.html#M000165">send_message</a> method. (This is a convenience
method for the authentication implementations.)
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000165_source')" id="l_M000165_source">show source</a> ]</p>
<div id="M000165_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 85</span>
85: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_message</span>( <span class="ruby-identifier">message</span> )
86: <span class="ruby-ivar">@session</span>.<span class="ruby-identifier">send_message</span> <span class="ruby-identifier">message</span>
87: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000163"></a><b>set_auth_method_order</b>( *methods )
</div>
<div class="description">
<p>
Changes the set of authentication methods to try to the given array. <a
href="Methods.html">Methods</a> are tried in the order in which they are
listed in the array.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000163_source')" id="l_M000163_source">show source</a> ]</p>
<div id="M000163_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 72</span>
72: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_auth_method_order</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">methods</span> )
73: <span class="ruby-ivar">@order</span> = <span class="ruby-identifier">methods</span>.<span class="ruby-identifier">flatten</span>
74: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000162"></a><b>set_host_key_files</b>( files )
</div>
<div class="description">
<p>
Causes the set of on-disk host key files to be used to be set to the given
array. Any host key files that were specified previously are lost.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000162_source')" id="l_M000162_source">show source</a> ]</p>
<div id="M000162_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 64</span>
64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_host_key_files</span>( <span class="ruby-identifier">files</span> )
65: <span class="ruby-ivar">@key_manager</span>.<span class="ruby-identifier">clear_host!</span>
66: <span class="ruby-identifier">files</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@key_manager</span>.<span class="ruby-identifier">add_host_key</span> <span class="ruby-identifier">file</span> }
67: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000161"></a><b>set_key_files</b>( files )
</div>
<div class="description">
<p>
Causes the set of on-disk key files to be used to be set to the given
array. Any key files that were specified previously are lost.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000161_source')" id="l_M000161_source">show source</a> ]</p>
<div id="M000161_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 56</span>
56: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_key_files</span>( <span class="ruby-identifier">files</span> )
57: <span class="ruby-ivar">@key_manager</span>.<span class="ruby-identifier">clear!</span>
58: <span class="ruby-identifier">files</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@key_manager</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">file</span> }
59: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000166"></a><b>wait_for_message</b>()
</div>
<div class="description">
<p>
Wraps the Net::SSH::Transport::Session#wait_for_message method, doing
special checking for authentication-related messages.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000166_source')" id="l_M000166_source">show source</a> ]</p>
<div id="M000166_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/driver.rb, line 91</span>
91: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">wait_for_message</span>
92: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
93: <span class="ruby-identifier">type</span>, <span class="ruby-identifier">buffer</span> = <span class="ruby-ivar">@session</span>.<span class="ruby-identifier">wait_for_message</span>
94:
95: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
96: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_BANNER</span>
97: <span class="ruby-identifier">message</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
98: <span class="ruby-identifier">language</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
99:
100: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
101: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"got USERAUTH_BANNER (#{message}:#{language})"</span>
102: <span class="ruby-keyword kw">end</span>
103:
104: <span class="ruby-ivar">@on_banner</span>.<span class="ruby-identifier">call</span>( <span class="ruby-identifier">message</span>, <span class="ruby-identifier">language</span> )
105:
106: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_FAILURE</span>
107: <span class="ruby-identifier">authentications</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
108: <span class="ruby-ivar">@allowed_auth_methods</span> = <span class="ruby-identifier">authentications</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/,/</span>)
109: <span class="ruby-identifier">partial_success</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_bool</span>
110: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">:message_type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>,
111: <span class="ruby-identifier">:authentications</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">authentications</span>,
112: <span class="ruby-identifier">:partial_success</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">partial_success</span> )
113:
114: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_SUCCESS</span>
115: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">:message_type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span> )
116:
117: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">SERVICE_ACCEPT</span>
118: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">:message_type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>,
119: <span class="ruby-identifier">:service_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span> )
120:
121: <span class="ruby-comment cmt"># authmethod-specific codes</span>
122: <span class="ruby-keyword kw">when</span> <span class="ruby-value">60</span><span class="ruby-operator">..</span><span class="ruby-value">79</span>
123: <span class="ruby-keyword kw">return</span> <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">:message_type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>,
124: <span class="ruby-identifier">:buffer</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">buffer</span> )
125:
126: <span class="ruby-keyword kw">else</span>
127: <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>,
128: <span class="ruby-node">"unexpected message type '#{type}' (#{buffer.to_s})"</span>
129: <span class="ruby-keyword kw">end</span>
130: <span class="ruby-keyword kw">end</span>
131: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
