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
|
<?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::PublicKey</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::PublicKey</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../../files/lib/net/ssh/userauth/methods/publickey_rb.html">lib/net/ssh/userauth/methods/publickey.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 "publickey" <a href="../../../SSH.html">SSH</a>
authentication method.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000134">authenticate</a></li>
<li><a href="#M000133">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">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 instance to use to send and receive messages
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[W]
</td>
<td class='attr-name'>session_id</td>
<td class='attr-desc'>
The session id of the current <a href="../../../SSH.html">SSH</a> session
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000133"></a><b>new</b>( buffers )
</div>
<div class="description">
<p>
Create a <a href="PublicKey.html#M000133">new</a> <a
href="PublicKey.html">PublicKey</a> instance that uses the given buffer
factory to produce <a href="PublicKey.html#M000133">new</a> buffer
instances.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000133_source')" id="l_M000133_source">show source</a> ]</p>
<div id="M000133_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/publickey.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">buffers</span> )
38: <span class="ruby-ivar">@buffers</span> = <span class="ruby-identifier">buffers</span>
39: <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="M000134"></a><b>authenticate</b>( next_service, username, data={} )
</div>
<div class="description">
<p>
Attempts to perform public-key authentication for the given username,
trying each identity known to the key manager. If any of them succeed,
returns <tt>true</tt>, otherwise returns <tt>false</tt>. The data hash must
contain a <a href="../UserKeyManager.html">UserKeyManager</a> instance
under the <tt>:key_manager</tt> key.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000134_source')" id="l_M000134_source">show source</a> ]</p>
<div id="M000134_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/methods/publickey.rb, line 46</span>
46: <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>={} )
47: <span class="ruby-identifier">key_manager</span> = <span class="ruby-identifier">data</span>[<span class="ruby-identifier">:key_manager</span>]
48: <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">key_manager</span>
49:
50: <span class="ruby-identifier">key_manager</span>.<span class="ruby-identifier">identities</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">identity</span><span class="ruby-operator">|</span>
51: <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">authenticate_with</span>( <span class="ruby-identifier">identity</span>, <span class="ruby-identifier">next_service</span>,
52: <span class="ruby-identifier">username</span>, <span class="ruby-identifier">key_manager</span> )
53: <span class="ruby-keyword kw">end</span>
54:
55: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
56:
57: <span class="ruby-keyword kw">ensure</span>
58: <span class="ruby-identifier">key_manager</span>.<span class="ruby-identifier">finish</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">key_manager</span>
59: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
