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
|
<?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::Methods::KeyboardInteractive</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::Methods::KeyboardInteractive</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../../files/lib/net/ssh/userauth/methods/keyboard-interactive_rb.html">lib/net/ssh/userauth/methods/keyboard-interactive.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>
Implements the "keyboard-interactive" <a
href="../../../SSH.html">SSH</a> authentication method.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000141">authenticate</a></li>
<li><a href="#M000140">new</a></li>
</ul>
<div class="sectiontitle">Included Modules</div>
<ul>
<li><a href="../Constants.html">Net::SSH::UserAuth::Constants</a></li>
</ul>
<div class="sectiontitle">Constants</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class="attr-name">InfoRequest</td>
<td>=</td>
<td class="attr-value">Struct.new( :name, :instruction, :password, :prompts )</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">
Represents an information request from the server
</td>
</tr>
<tr valign='top'>
<td class="attr-name">Prompt</td>
<td>=</td>
<td class="attr-value">Struct.new( :prompt, :echo )</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">
Represents a single prompt in an InfoRequest.
</td>
</tr>
<tr valign='top'>
<td class="attr-name">USERAUTH_INFO_REQUEST</td>
<td>=</td>
<td class="attr-value">60</td>
</tr>
<tr valign='top'>
<td class="attr-name">USERAUTH_INFO_RESPONSE</td>
<td>=</td>
<td class="attr-value">61</td>
</tr>
</table>
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class='attr-rw'>
[W]
</td>
<td class='attr-name'>messenger</td>
<td class='attr-desc'>
The messenger to use when communicating.
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000140"></a><b>new</b>( buffers, callback )
</div>
<div class="description">
<p>
Create a <a href="KeyboardInteractive.html#M000140">new</a> <a
href="Password.html">Password</a> authenticator. It will use the given
buffers factory to create <a
href="KeyboardInteractive.html#M000140">new</a> buffer instances. The
<tt>callback</tt> should be a proc object to use to specialize the behavior
of this authentication method.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000140_source')" id="l_M000140_source">show source</a> ]</p>
<div id="M000140_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/keyboard-interactive.rb, line 45</span>
45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">buffers</span>, <span class="ruby-identifier">callback</span> )
46: <span class="ruby-ivar">@buffers</span> = <span class="ruby-identifier">buffers</span>
47: <span class="ruby-ivar">@callback</span> = <span class="ruby-identifier">callback</span>
48: <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="M000141"></a><b>authenticate</b>( next_service, username, data={} )
</div>
<div class="description">
<p>
Attempt to <a href="KeyboardInteractive.html#M000141">authenticate</a> the
given user for the given service. The data hash must specify a
<tt>:password</tt> value, otherwise this will always return false.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000141_source')" id="l_M000141_source">show source</a> ]</p>
<div id="M000141_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/keyboard-interactive.rb, line 53</span>
53: <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">data</span>={} )
54: <span class="ruby-identifier">password</span> = <span class="ruby-identifier">data</span>[<span class="ruby-identifier">:password</span>]
55:
56: <span class="ruby-identifier">msg</span> = <span class="ruby-ivar">@buffers</span>.<span class="ruby-identifier">writer</span>
57: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_byte</span> <span class="ruby-constant">USERAUTH_REQUEST</span>
58: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-identifier">username</span>
59: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-identifier">next_service</span>
60: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-value str">"keyboard-interactive"</span>
61: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-value str">""</span>
62: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-value str">""</span>
63: <span class="ruby-ivar">@messenger</span>.<span class="ruby-identifier">send_message</span> <span class="ruby-identifier">msg</span>
64:
65: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
66: <span class="ruby-identifier">message</span> = <span class="ruby-ivar">@messenger</span>.<span class="ruby-identifier">wait_for_message</span>
67:
68: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_type</span>
69: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_SUCCESS</span>
70: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
71: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_FAILURE</span>
72: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
73: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_INFO_REQUEST</span>
74: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
75: <span class="ruby-identifier">instruction</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
76: <span class="ruby-identifier">req</span> = <span class="ruby-constant">InfoRequest</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">name</span>, <span class="ruby-identifier">instruction</span>, <span class="ruby-identifier">password</span>, [] )
77: <span class="ruby-identifier">password</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># only use the given password once</span>
78:
79: <span class="ruby-identifier">lang_tag</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
80: <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_long</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword kw">do</span>
81: <span class="ruby-identifier">prompt</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_string</span>
82: <span class="ruby-identifier">echo</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">read_bool</span>
83: <span class="ruby-identifier">req</span>.<span class="ruby-identifier">prompts</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Prompt</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">prompt</span>, <span class="ruby-identifier">echo</span> )
84: <span class="ruby-keyword kw">end</span>
85:
86: <span class="ruby-identifier">responses</span> = <span class="ruby-ivar">@callback</span>.<span class="ruby-identifier">call</span>( <span class="ruby-identifier">req</span> )
87: <span class="ruby-identifier">msg</span> = <span class="ruby-ivar">@buffers</span>.<span class="ruby-identifier">writer</span>
88: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_byte</span> <span class="ruby-constant">USERAUTH_INFO_RESPONSE</span>
89: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_long</span> <span class="ruby-identifier">responses</span>.<span class="ruby-identifier">length</span>
90: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">responses</span>)
91: <span class="ruby-ivar">@messenger</span>.<span class="ruby-identifier">send_message</span> <span class="ruby-identifier">msg</span>
92: <span class="ruby-keyword kw">else</span>
93: <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>,
94: <span class="ruby-value str">"unexpected reply in keyboard interactive: "</span> <span class="ruby-operator">+</span>
95: <span class="ruby-identifier">message</span>.<span class="ruby-identifier">inspect</span>
96: <span class="ruby-keyword kw">end</span>
97: <span class="ruby-keyword kw">end</span>
98: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
