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
|
<?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::Proxy::SOCKS5</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::Proxy::SOCKS5</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../files/lib/net/ssh/proxy/socks5_rb.html">
lib/net/ssh/proxy/socks5.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>
An implementation of a socket factory that returns a socket which will
tunnel the connection through a <a href="SOCKS5.html">SOCKS5</a> proxy. It
allows explicit specification of the user and password, but if none are
given it will look in the SOCKS_USER/SOCKS_PASSWORD and
CONNECT_USER/CONNECT_PASSWORD environment variables as well.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000090">new</a>
<a href="#M000091">open</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_VERSION</td>
<td>=</td>
<td class="context-item-value">5</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_METHOD_NO_AUTH</td>
<td>=</td>
<td class="context-item-value">0</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_METHOD_GSSAPI</td>
<td>=</td>
<td class="context-item-value">1</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_METHOD_PASSWD</td>
<td>=</td>
<td class="context-item-value">2</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_METHOD_NONE</td>
<td>=</td>
<td class="context-item-value">0xFF</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_CMD_CONNECT</td>
<td>=</td>
<td class="context-item-value">1</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_ATYP_IPV4</td>
<td>=</td>
<td class="context-item-value">1</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_ATYP_DOMAIN</td>
<td>=</td>
<td class="context-item-value">3</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_ATYP_IPV6</td>
<td>=</td>
<td class="context-item-value">4</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_SUCCESS</td>
<td>=</td>
<td class="context-item-value">0</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_FAILURE</td>
<td>=</td>
<td class="context-item-value">1</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_NOT_ALLOWED</td>
<td>=</td>
<td class="context-item-value">2</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_NETWORK_UNREACHABLE</td>
<td>=</td>
<td class="context-item-value">3</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_HOST_UNREACHABLE</td>
<td>=</td>
<td class="context-item-value">4</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_REFUSED</td>
<td>=</td>
<td class="context-item-value">5</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_TTL_EXPIRED</td>
<td>=</td>
<td class="context-item-value">6</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_CMD_NOT_SUPPORTED</td>
<td>=</td>
<td class="context-item-value">7</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SOCKS_ADDR_NOT_SUPPORTED</td>
<td>=</td>
<td class="context-item-value">8</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000090" class="method-detail">
<a name="M000090"></a>
<div class="method-heading">
<a href="#M000090" class="method-signature">
<span class="method-name">new</span><span class="method-args">( proxy_host, proxy_port=1080, options={} )</span>
</a>
</div>
<div class="method-description">
<p>
Create a new proxy connection to the given proxy host and port. Optionally,
@:user@ and @:password@ options may be given to identify the username and
password with which to authenticate.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000090-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000090-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/proxy/socks5.rb, line 58</span>
58: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">proxy_host</span>, <span class="ruby-identifier">proxy_port</span>=<span class="ruby-value">1080</span>, <span class="ruby-identifier">options</span>={} )
59: <span class="ruby-ivar">@proxy_host</span> = <span class="ruby-identifier">proxy_host</span>
60: <span class="ruby-ivar">@proxy_port</span> = <span class="ruby-identifier">proxy_port</span>
61: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
62: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000091" class="method-detail">
<a name="M000091"></a>
<div class="method-heading">
<a href="#M000091" class="method-signature">
<span class="method-name">open</span><span class="method-args">( host, port )</span>
</a>
</div>
<div class="method-description">
<p>
Return a new socket connected to the given host and port via the proxy that
was requested when the socket factory was instantiated.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000091-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/proxy/socks5.rb, line 66</span>
66: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open</span>( <span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span> )
67: <span class="ruby-identifier">sock</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@proxy_host</span>, <span class="ruby-ivar">@proxy_port</span> )
68:
69: <span class="ruby-identifier">methods</span> = [ <span class="ruby-constant">SOCKS_METHOD_NO_AUTH</span> ]
70: <span class="ruby-identifier">methods</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">SOCKS_METHOD_PASSWD</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">proxy_user</span>
71:
72: <span class="ruby-identifier">packet</span> = [ <span class="ruby-constant">SOCKS_VERSION</span>, <span class="ruby-identifier">methods</span>.<span class="ruby-identifier">size</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">methods</span> ].<span class="ruby-identifier">pack</span>( <span class="ruby-value str">"C*"</span> )
73: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">packet</span>, <span class="ruby-value">0</span>
74:
75: <span class="ruby-identifier">version</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">recv</span>( <span class="ruby-value">2</span> ).<span class="ruby-identifier">unpack</span>( <span class="ruby-value str">"CC"</span> )
76: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">version</span> <span class="ruby-operator">!=</span> <span class="ruby-value">5</span>
77: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">close</span>
78: <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">Proxy</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>,
79: <span class="ruby-node">"invalid SOCKS version (#{version})"</span>
80: <span class="ruby-keyword kw">end</span>
81:
82: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">method</span> <span class="ruby-operator">==</span> <span class="ruby-constant">SOCKS_METHOD_NONE</span>
83: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">close</span>
84: <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">Proxy</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>,
85: <span class="ruby-value str">"no supported authorization methods"</span>
86: <span class="ruby-keyword kw">end</span>
87:
88: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">method</span>
89: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">SOCKS_METHOD_NO_AUTH</span>
90: <span class="ruby-comment cmt"># no method-dependent subnegotiation required</span>
91:
92: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">SOCKS_METHOD_PASSWD</span>
93: <span class="ruby-identifier">negotiate_password</span>( <span class="ruby-identifier">sock</span> )
94: <span class="ruby-keyword kw">end</span>
95:
96: <span class="ruby-identifier">packet</span> = [ <span class="ruby-constant">SOCKS_VERSION</span>, <span class="ruby-constant">SOCKS_CMD_CONNECT</span>, <span class="ruby-value">0</span> ].<span class="ruby-identifier">pack</span>( <span class="ruby-value str">"C*"</span> )
97:
98: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">host</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/</span>
99: <span class="ruby-identifier">packet</span> <span class="ruby-operator"><<</span> [ <span class="ruby-constant">SOCKS_ATYP_IPV4</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>,
100: <span class="ruby-identifier">$3</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$4</span>.<span class="ruby-identifier">to_i</span> ].<span class="ruby-identifier">pack</span>( <span class="ruby-value str">"C*"</span> )
101: <span class="ruby-keyword kw">else</span>
102: <span class="ruby-identifier">packet</span> <span class="ruby-operator"><<</span> [ <span class="ruby-constant">SOCKS_ATYP_DOMAIN</span>, <span class="ruby-identifier">host</span>.<span class="ruby-identifier">length</span>, <span class="ruby-identifier">host</span> ].<span class="ruby-identifier">pack</span>( <span class="ruby-value str">"CCA*"</span> )
103: <span class="ruby-keyword kw">end</span>
104:
105: <span class="ruby-identifier">packet</span> <span class="ruby-operator"><<</span> [ <span class="ruby-identifier">port</span> ].<span class="ruby-identifier">pack</span>( <span class="ruby-value str">"n"</span> )
106: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">packet</span>, <span class="ruby-value">0</span>
107:
108: <span class="ruby-identifier">version</span>, <span class="ruby-identifier">reply</span>, = <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">recv</span>( <span class="ruby-value">4</span> ).<span class="ruby-identifier">unpack</span>( <span class="ruby-value str">"C*"</span> )
109: <span class="ruby-identifier">len</span> = <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">recv</span>( <span class="ruby-value">1</span> )[<span class="ruby-value">0</span>]
110: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">recv</span>( <span class="ruby-identifier">len</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span> )
111:
112: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">reply</span> <span class="ruby-operator">==</span> <span class="ruby-constant">SOCKS_SUCCESS</span>
113: <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">close</span>
114: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ConnectError</span>, <span class="ruby-node">"#{reply}"</span>
115: <span class="ruby-keyword kw">end</span>
116:
117: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sock</span>
118: <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>
|
