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
|
<?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: Net::SSH::UserAuth::Methods::Password</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Net::SSH::UserAuth::Methods::Password</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../../files/lib/net/ssh/userauth/methods/password_rb.html">
lib/net/ssh/userauth/methods/password.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Implements the "password" <a href="../../../SSH.html">SSH</a>
authentication method.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000137">authenticate</a>
<a href="#M000136">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>
<div id="includes-list">
<span class="include-name"><a href="../Constants.html">Net::SSH::UserAuth::Constants</a></span>
</div>
</div>
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">messenger</td>
<td class="context-item-value"> [W] </td>
<td class="context-item-desc">
The messenger to use when communicating.
</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000136" class="method-detail">
<a name="M000136"></a>
<div class="method-heading">
<a href="#M000136" class="method-signature">
<span class="method-name">new</span><span class="method-args">( buffers )</span>
</a>
</div>
<div class="method-description">
<p>
Create a new <a href="Password.html">Password</a> authenticator. It will
use the given buffers factory to create new buffer instances.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000136-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/password.rb, line 34</span>
34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">buffers</span> )
35: <span class="ruby-ivar">@buffers</span> = <span class="ruby-identifier">buffers</span>
36: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000137" class="method-detail">
<a name="M000137"></a>
<div class="method-heading">
<a href="#M000137" class="method-signature">
<span class="method-name">authenticate</span><span class="method-args">( next_service, username, data={} )</span>
</a>
</div>
<div class="method-description">
<p>
Attempt to authenticate the given user for the given service. The data hash
must specify a <tt>:password</tt> value, otherwise this will always return
false.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000137-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/password.rb, line 41</span>
41: <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>={} )
42: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">data</span>[<span class="ruby-identifier">:password</span>]
43:
44: <span class="ruby-identifier">msg</span> = <span class="ruby-ivar">@buffers</span>.<span class="ruby-identifier">writer</span>
45: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_byte</span> <span class="ruby-constant">USERAUTH_REQUEST</span>
46: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-identifier">username</span>
47: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-identifier">next_service</span>
48: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-value str">"password"</span>
49: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_bool</span> <span class="ruby-keyword kw">false</span>
50: <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">write_string</span> <span class="ruby-identifier">data</span>[<span class="ruby-identifier">:password</span>]
51: <span class="ruby-ivar">@messenger</span>.<span class="ruby-identifier">send_message</span> <span class="ruby-identifier">msg</span>
52:
53: <span class="ruby-identifier">message</span> = <span class="ruby-ivar">@messenger</span>.<span class="ruby-identifier">wait_for_message</span>
54:
55: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_type</span>
56: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_SUCCESS</span>
57: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
58: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">USERAUTH_FAILURE</span>, <span class="ruby-constant">USERAUTH_PASSWD_CHANGEREQ</span>
59: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
60: <span class="ruby-keyword kw">else</span>
61: <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>,
62: <span class="ruby-node">"unexpected reply to USERAUTH_REQUEST: #{message.inspect}"</span>
63: <span class="ruby-keyword kw">end</span>
64: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
