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
|
<?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::Pageant::Socket</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::Pageant::Socket</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../../files/lib/net/ssh/userauth/pageant_rb.html">lib/net/ssh/userauth/pageant.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>
This is the pseudo-socket implementation that mimics the interface of a
socket, translating each request into a Windows messaging call to the
pageant daemon. This allows pageant support to be implemented simply by
replacing the socket factory used by the <a href="../Agent.html">Agent</a>
class.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000130">close</a></li>
<li><a href="#M000127">new</a></li>
<li><a href="#M000126">open</a></li>
<li><a href="#M000131">read</a></li>
<li><a href="#M000128">send</a></li>
<li><a href="#M000129">send_query</a></li>
</ul>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000127"></a><b>new</b>()
</div>
<div class="description">
<p>
Create a <a href="Socket.html#M000127">new</a> instance that communicates
with the running pageant instance. If no such instance is running, this
will cause an error.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000127_source')" id="l_M000127_source">show source</a> ]</p>
<div id="M000127_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 108</span>
108: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
109: <span class="ruby-ivar">@win</span> = <span class="ruby-constant">Win</span>.<span class="ruby-identifier">findWindow</span>( <span class="ruby-value str">"Pageant"</span>, <span class="ruby-value str">"Pageant"</span> )
110:
111: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@win</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
112: <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>,
113: <span class="ruby-value str">"pageant process not running"</span>
114: <span class="ruby-keyword kw">end</span>
115:
116: <span class="ruby-ivar">@res</span> = <span class="ruby-keyword kw">nil</span>
117: <span class="ruby-ivar">@pos</span> = <span class="ruby-value">0</span>
118: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000126"></a><b>open</b>( location=nil )
</div>
<div class="description">
<p>
The factory method for creating a <a href="Socket.html#M000127">new</a> <a
href="Socket.html">Socket</a> instance. The location parameter is ignored,
and is only needed for compatibility with the general <a
href="Socket.html">Socket</a> interface.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000126_source')" id="l_M000126_source">show source</a> ]</p>
<div id="M000126_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 102</span>
102: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">open</span>( <span class="ruby-identifier">location</span>=<span class="ruby-keyword kw">nil</span> )
103: <span class="ruby-identifier">new</span>
104: <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="M000130"></a><b>close</b>()
</div>
<div class="description">
<p>
Conceptually <a href="Socket.html#M000130">close</a> the socket. This
doesn‘t really do anthing significant, but merely complies with the
<a href="Socket.html">Socket</a> interface.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000130_source')" id="l_M000130_source">show source</a> ]</p>
<div id="M000130_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 173</span>
173: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
174: <span class="ruby-ivar">@res</span> = <span class="ruby-keyword kw">nil</span>
175: <span class="ruby-ivar">@pos</span> = <span class="ruby-value">0</span>
176: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000131"></a><b>read</b>(n = nil)
</div>
<div class="description">
<p>
Reads <tt>n</tt> bytes from the cached result of the last query. If
<tt>n</tt> is <tt>nil</tt>, returns all remaining data from the last query.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000131_source')" id="l_M000131_source">show source</a> ]</p>
<div id="M000131_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 180</span>
180: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>(<span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">nil</span>)
181: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@res</span>
182: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">nil?</span>
183: <span class="ruby-identifier">start</span>, <span class="ruby-ivar">@pos</span> = <span class="ruby-ivar">@pos</span>, <span class="ruby-ivar">@res</span>.<span class="ruby-identifier">size</span>
184: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@res</span>[<span class="ruby-identifier">start</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
185: <span class="ruby-keyword kw">else</span>
186: <span class="ruby-identifier">start</span>, <span class="ruby-ivar">@pos</span> = <span class="ruby-ivar">@pos</span>, <span class="ruby-ivar">@pos</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">n</span>
187: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@res</span>[<span class="ruby-identifier">start</span>, <span class="ruby-identifier">n</span>]
188: <span class="ruby-keyword kw">end</span>
189: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000128"></a><b>send</b>( data, *args )
</div>
<div class="description">
<p>
Forwards the data to <a href="Socket.html#M000129">send_query</a>, ignoring
any arguments after the first. Returns 0.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000128_source')" id="l_M000128_source">show source</a> ]</p>
<div id="M000128_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 122</span>
122: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>( <span class="ruby-identifier">data</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
123: <span class="ruby-ivar">@res</span> = <span class="ruby-identifier">send_query</span>( <span class="ruby-identifier">data</span> )
124: <span class="ruby-ivar">@pos</span> = <span class="ruby-value">0</span>
125: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000129"></a><b>send_query</b>( query )
</div>
<div class="description">
<p>
Packages the given query string and sends it to the pageant process via the
Windows messaging subsystem. The result is cached, to be returned
piece-wise when <a href="Socket.html#M000131">read</a> is called.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000129_source')" id="l_M000129_source">show source</a> ]</p>
<div id="M000129_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/userauth/pageant.rb, line 130</span>
130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_query</span>( <span class="ruby-identifier">query</span> )
131: <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">nil</span>
132: <span class="ruby-identifier">filemap</span> = <span class="ruby-value">0</span>
133: <span class="ruby-identifier">ptr</span> = <span class="ruby-keyword kw">nil</span>
134: <span class="ruby-identifier">id</span> = <span class="ruby-constant">DL</span><span class="ruby-operator">::</span><span class="ruby-constant">PtrData</span>.<span class="ruby-identifier">malloc</span>( <span class="ruby-constant">DL</span>.<span class="ruby-identifier">sizeof</span>(<span class="ruby-value str">"L"</span>) )
135:
136: <span class="ruby-identifier">mapname</span> = <span class="ruby-value str">"PageantRequest%08x\000"</span> <span class="ruby-operator">%</span> <span class="ruby-constant">Win</span>.<span class="ruby-identifier">getCurrentThreadId</span>()
137: <span class="ruby-identifier">filemap</span> = <span class="ruby-constant">Win</span>.<span class="ruby-identifier">createFileMapping</span>(<span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">INVALID_HANDLE_VALUE</span>,
138: <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">NULL</span>,
139: <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">PAGE_READWRITE</span>, <span class="ruby-value">0</span>,
140: <span class="ruby-constant">AGENT_MAX_MSGLEN</span>, <span class="ruby-identifier">mapname</span>)
141: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">filemap</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
142: <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>,
143: <span class="ruby-value str">"Creation of file mapping failed"</span>
144: <span class="ruby-keyword kw">end</span>
145:
146: <span class="ruby-identifier">ptr</span> = <span class="ruby-constant">Win</span>.<span class="ruby-identifier">mapViewOfFile</span>( <span class="ruby-identifier">filemap</span>, <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">FILE_MAP_WRITE</span>, <span class="ruby-value">0</span>, <span class="ruby-value">0</span>,
147: <span class="ruby-constant">AGENT_MAX_MSGLEN</span> )
148:
149: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">null?</span>
150: <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>, <span class="ruby-value str">"Mapping of file failed"</span>
151: <span class="ruby-keyword kw">end</span>
152:
153: <span class="ruby-identifier">ptr</span>[<span class="ruby-value">0</span>] = <span class="ruby-identifier">query</span>
154:
155: <span class="ruby-identifier">cds</span> = [<span class="ruby-constant">AGENT_COPYDATA_ID</span>, <span class="ruby-identifier">mapname</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">mapname</span>].
156: <span class="ruby-identifier">pack</span>(<span class="ruby-value str">"LLp"</span>).<span class="ruby-identifier">to_ptr</span>
157: <span class="ruby-identifier">succ</span> = <span class="ruby-constant">Win</span>.<span class="ruby-identifier">sendMessageTimeout</span>( <span class="ruby-ivar">@win</span>, <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">WM_COPYDATA</span>, <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">NULL</span>,
158: <span class="ruby-identifier">cds</span>, <span class="ruby-constant">Win</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTO_NORMAL</span>, <span class="ruby-value">5000</span>, <span class="ruby-identifier">id</span> )
159:
160: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">succ</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
161: <span class="ruby-identifier">retlen</span> = <span class="ruby-value">4</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-value">4</span>).<span class="ruby-identifier">unpack</span>(<span class="ruby-value str">"N"</span>)[<span class="ruby-value">0</span>]
162: <span class="ruby-identifier">res</span> = <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-identifier">retlen</span>)
163: <span class="ruby-keyword kw">end</span>
164:
165: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">res</span>
166: <span class="ruby-keyword kw">ensure</span>
167: <span class="ruby-constant">Win</span>.<span class="ruby-identifier">unmapViewOfFile</span>( <span class="ruby-identifier">ptr</span> ) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">ptr</span>.<span class="ruby-identifier">null?</span>
168: <span class="ruby-constant">Win</span>.<span class="ruby-identifier">closeHandle</span>( <span class="ruby-identifier">filemap</span> ) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">filemap</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
169: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
