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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>README.rdoc</title>
<meta content='text/html; charset=US-ASCII' http-equiv='Content-Type'>
<link href='../css/style.css' media='screen' rel='stylesheet' type='text/css'>
<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) {
var code = document.getElementById(id)
code.style.display = code.style.display != 'block' ? 'block' : 'none'
return true
}
// Make codeblocks hidden by default
document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
//]]>
</script>
</head>
<body class='page'>
<div class='file' id='wrapper'>
<div class='header'>
<h1 class='name'>README.rdoc</h1>
<div class='paths'>
README.rdoc
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>2013-02-06 07:55:57 -0800</span>
</div>
</div>
<div id='content'>
<div id='text'>
<div id='description'>
<h1 id="label-Net%3A%3ASSH%3A%3AGateway"><a href="../classes/Net/SSH/Gateway.html">Net::SSH::Gateway</a></h1>
<ul><li>
<p>Docs: <a
href="http://net-ssh.github.com/net-ssh-gateway">net-ssh.github.com/net-ssh-gateway</a></p>
</li><li>
<p>Issues: <a
href="https://github.com/net-ssh/net-ssh-gateway/issues">github.com/net-ssh/net-ssh-gateway/issues</a></p>
</li><li>
<p>Codes: <a
href="https://github.com/net-ssh/net-ssh-gateway">github.com/net-ssh/net-ssh-gateway</a></p>
</li><li>
<p>Email: net-ssh@solutious.com</p>
</li></ul>
<p><em>As of v1.1.1, all gem releases are signed. See INSTALL.</em></p>
<h2 id="label-DESCRIPTION%3A">DESCRIPTION:</h2>
<p><a href="../classes/Net/SSH/Gateway.html">Net::SSH::Gateway</a> is a
library for programmatically tunnelling connections to servers via a single
"gateway" host. It is useful for establishing <a
href="../classes/Net/SSH.html">Net::SSH</a> connections to servers behind
firewalls, but can also be used to forward ports and establish connections
of other types, like HTTP, to servers with restricted access.</p>
<h2 id="label-FEATURES%3A">FEATURES:</h2>
<ul><li>
<p>Easily manage forwarded ports</p>
</li><li>
<p>Establish <a href="../classes/Net/SSH.html">Net::SSH</a> connections
through firewalls</p>
</li></ul>
<h2 id="label-SYNOPSIS%3A">SYNOPSIS:</h2>
<p>In a nutshell:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'net/ssh/gateway'</span>

<span class="ruby-identifier">gateway</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">Gateway</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'host'</span>, <span class="ruby-string">'user'</span>)

<span class="ruby-identifier">gateway</span>.<span class="ruby-identifier">ssh</span>(<span class="ruby-string">"host.private"</span>, <span class="ruby-string">"user"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
 <span class="ruby-identifier">puts</span> <span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">exec!</span>(<span class="ruby-string">"hostname"</span>)
<span class="ruby-keyword">end</span>

<span class="ruby-identifier">gateway</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">"host.private"</span>, <span class="ruby-value">80</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">port</span><span class="ruby-operator">|</span>
 <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get_print</span>(<span class="ruby-string">"127.0.0.1"</span>, <span class="ruby-string">"/path"</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-keyword">end</span>

<span class="ruby-identifier">gateway</span>.<span class="ruby-identifier">shutdown!</span>

<span class="ruby-comment"># As of 1.1.0, you can also specify the wait time for the</span>
<span class="ruby-comment"># gateway thread with the :loop_wait option.</span>
<span class="ruby-identifier">gateway</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">Gateway</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'host'</span>, <span class="ruby-string">'user'</span>, :<span class="ruby-identifier">loop_wait</span> =<span class="ruby-operator">></span> <span class="ruby-value">0.001</span>)</pre>
<p>See <a href="../classes/Net/SSH/Gateway.html">Net::SSH::Gateway</a> for
more documentation.</p>
<h2 id="label-REQUIREMENTS%3A">REQUIREMENTS:</h2>
<ul><li>
<p>net-ssh (version 2)</p>
</li></ul>
<p>If you want to run the tests or use any of the Rake tasks, you'll need:</p>
<ul><li>
<p>Echoe (for the Rakefile)</p>
</li><li>
<p>Mocha (for the tests)</p>
</li></ul>
<h2 id="label-INSTALL%3A">INSTALL:</h2>
<ul><li>
<p>gem install net-ssh-gateway</p>
</li></ul>
<p>However, in order to be sure the code you're installing hasn't been
tampered with, it's recommended that you verify the <a
href="http://docs.rubygems.org/read/chapter/21">signiture</a>. To do this,
you need to add my public key as a trusted certificate (you only need to do
this once):</p>
<pre># Add the public key as a trusted certificate
# (You only need to do this once)
$ curl -O https://raw.github.com/net-ssh/net-ssh/master/gem-public_cert.pem
$ gem cert --add gem-public_cert.pem</pre>
<p>Then, when install the gem, do so with high security:</p>
<pre>$ gem install net-ssh-gateway -P HighSecurity</pre>
<p>If you don't add the public key, you'll see an error like "Couldn't verify
data signature". If you're still having trouble let me know and I'll give
you a hand.</p>
<h2 id="label-LICENSE%3A">LICENSE:</h2>
<p>(The MIT License)</p>
<p>Copyright (c) 2008 Jamis Buck <jamis@37signals.com></p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the 'Software'),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.</p>
</div>
<div id='context'>
</div>
</div>
</div>
<div id='footer-push'></div>
</div>
<div id='footer'>
<a target="docwin" href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
</div>
</body>
</html>
|
