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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::Proxy::SOCKS4 - net-ssh 6.0.0.beta1</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/jquery.js"></script>
<script src="../../../js/darkfish.js"></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-open">#open</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::Proxy::SOCKS4">
<h1 id="class-Net::SSH::Proxy::SOCKS4" class="class">
class Net::SSH::Proxy::SOCKS4
</h1>
<section class="description">
<p>An implementation of a <a href="SOCKS4.html">SOCKS4</a> proxy. To use it,
instantiate it, then pass the instantiated object via the :proxy key to <a
href="../../SSH.html#method-c-start">Net::SSH.start</a>:</p>
<pre>require 'net/ssh/proxy/socks4'
proxy = Net::SSH::Proxy::SOCKS4.new('proxy.host', proxy_port, :user => 'user')
Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
...
end</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CONNECT">CONNECT
<dd><p>The packet type for connection requests</p>
<dt id="GRANTED">GRANTED
<dd><p>The status code for a successful connection</p>
<dt id="VERSION">VERSION
<dd><p>The SOCKS protocol version used by this class</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">options</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The additional options that were given to the proxy's constructor.</p>
</div>
</div>
<div id="attribute-i-proxy_host" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">proxy_host</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The proxy's host name or IP address, as given to the constructor.</p>
</div>
</div>
<div id="attribute-i-proxy_port" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">proxy_port</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The proxy's port number.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(proxy_host, proxy_port=1080, options={})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new proxy connection to the given proxy host and port. Optionally,
a :user key may be given to identify the username with which to
authenticate.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ssh/proxy/socks4.rb, line 41</span>
<span class="ruby-keyword">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>={})
<span class="ruby-ivar">@proxy_host</span> = <span class="ruby-identifier">proxy_host</span>
<span class="ruby-ivar">@proxy_port</span> = <span class="ruby-identifier">proxy_port</span>
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-open" class="method-detail ">
<div class="method-heading">
<span class="method-name">open</span><span
class="method-args">(host, port, connection_options)</span>
<span class="method-click-advice">click to toggle source</span>
</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>
<div class="method-source-code" id="open-source">
<pre><span class="ruby-comment"># File lib/net/ssh/proxy/socks4.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">open</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">connection_options</span>)
<span class="ruby-identifier">socket</span> = <span class="ruby-constant">Socket</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-identifier">proxy_host</span>, <span class="ruby-identifier">proxy_port</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>,
<span class="ruby-identifier">connect_timeout</span><span class="ruby-operator">:</span> <span class="ruby-identifier">connection_options</span>[<span class="ruby-value">:timeout</span>])
<span class="ruby-identifier">ip_addr</span> = <span class="ruby-constant">IPAddr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Resolv</span>.<span class="ruby-identifier">getaddress</span>(<span class="ruby-identifier">host</span>))
<span class="ruby-identifier">packet</span> = [<span class="ruby-constant">VERSION</span>, <span class="ruby-constant">CONNECT</span>, <span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">ip_addr</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:user</span>]].<span class="ruby-identifier">pack</span>(<span class="ruby-string">"CCnNZ*"</span>)
<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">packet</span>, <span class="ruby-value">0</span>
<span class="ruby-identifier">version</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">ip</span> = <span class="ruby-identifier">socket</span>.<span class="ruby-identifier">recv</span>(<span class="ruby-value">8</span>).<span class="ruby-identifier">unpack</span>(<span class="ruby-string">"CCnN"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">GRANTED</span>
<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">close</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ConnectError</span>, <span class="ruby-node">"error connecting to proxy (#{status})"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">socket</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
