net-ssh 1.1.4 → 2.0.0

data/doc/manual/parts/0027.txt

@@ -1,37 +0,0 @@
-Sometimes it might be nice to programmatically simulate a network connection on a local port and have it forwarded to the remote host. You can do this by means of the @#direct_channel@ method.
-
-The @#direct_channel@ method looks similar to @#local@: the first three parameters are the local port to simulate the connection from, and the remote host and port that the connection should be forwarded to. The fourth parameter, however, is a _handler_, an object that is used as a callback for a variety of different events.
-
-The handler for the @#direct_channel@ method may implement any of the following callbacks (all are optional, though you probably want to implement at least one or two of them):
-
-table(list).
-|_. Callback |_. Description |
-|=^. @confirm@ | This is invoked when the channel has been opened and the remote host has confirmed it. This accepts four parameters: the channel itself, the local port, remote host, and remote port. (In this way, the same handler may be used for multiple forward requests.)|
-|=^. @process@ | After the channel has been confirmed, this is invoked, to process the channel. This callback will be invoked in a new Thread, so that if your handler needs to listen to a socket and then send data received from it over the channel, it can do so without blocking the main loop. The callback accepts a single parameter, the channel handle itself.|
-|=^. @on_close@ | This is called when the channel over which this forwarded connection is being processed has been closed. The callback accepts a single parameter, the channel itself.|
-|=^. @on_eof@ | When the remote machine indicates it will send no more data, this callback will be invoked. It accepts a single parameter, the channel itself.|
-|=^. @on_receive@ | This is invoked when data is received from the remote machine. It accepts two parameters: the channel handle, and the data that was received.|
-
-For example, the following example pretends to be a client that has connected to the local host on a forwarded port:
-
-{{{lang=ruby,number=true,caption=Using a handler object to mimic a forwarded port
-class Handler
-  def on_receive( channel, data )
-    puts "got data: #{data.inspect}"
-    channel.send_data "subsequent request"
-  end
-
-  def process( channel )
-    channel.send_data "initial request"
-  end
-end
-
-Net::SSH.start( 'host' ) do |session|
-  session.forward.direct_channel( 1234, 'somewhere.else.net',
-    4321, Handler.new )
-
-  session.loop
-end
-}}}
-
-The local port number for @#direct_channel@ has no real purpose, other than to report to the SSH server that the "virtual" connection occurred on that port.

data/doc/manual/parts/0028.txt

@@ -1,16 +0,0 @@
-You can use handlers going in the other direction, too. If you want to programmatically process forwarded data from a remote host, you can use the @#remote@ method.  This takes two parameters, with an optional third parameter. The two required parameters are the handler to use, and the remote port that should be listened to. The optional parameter is the remote bind address, which defaults to '127.0.0.1'.
-
-(Incidentally, if the port is 0, a new port will be allocated for you automatically by the server.)
-
-Whenever connections are received on the remote port, they will be forwarded to the handler, which may implement the following callbacks:
-
-table(list).
-|_. Callback |_. Description |
-|=^. @error@ | This is invoked if the forward could not be initiated. It accepts a single parameter, which is the error message. |
-|=^. @on_close@ | This is invoked when the channel that was assigned to process this forwarded connection has been closed. The callback takes one parameter: the channel itself. |
-|=^. @on_eof@ | This is invoked when the remote end of the connection has promised not to send any more data. The local end of the channel may continue to send data, however. This callback takes on parameter: the channel itself.|
-|=^. @on_open@ | This is invoked when a new connection is received over the forwarded channel. It accepts five parameters: the channel object, the connected address, the connected port, the originator address, and the originator port. |
-|=^. @on_receive@ | This is invoked when data is received over the channel from the remote connection. It accepts two parameters: the channel object, and the data that was received. |
-|=^. @setup@ | This is invoked immediately after the forward request has been acknowledged as successful. It accepts a single parameter, which is the port that was assigned to this forward. If the port parameter to @#remote@ was not 0, then that same value will be passed to the callback. Otherwise, the newly allocated port number will be passed to the callback. |
-
-Note that the @on_receive@ handler is required--all other callbacks may remain unimplemented by the handler.

data/doc/manual/parts/0029.txt

@@ -1 +0,0 @@
-Many times, you may find yourself behind a firewall, unable to SSH out. In such instances, you can often take advantage of your existing proxies to tunnel an SSH connection through your firewall.

data/doc/manual/parts/0030.txt

@@ -1,52 +0,0 @@
-If you have an HTTP proxy running, you may be able to use it to your advantage.  The following snippet demonstrates how to tunnel an SSH connection through an HTTP proxy:
-
-{{{lang=ruby,number=true,caption=Tunnelling an SSH connection over HTTP
-require 'net/ssh'
-require 'net/ssh/proxy/http'
-
-proxy_host = 'my.proxy.com'
-proxy_port = 8080
-proxy = Net::SSH::Proxy::HTTP.new( proxy_host, proxy_port )
-
-Net::SSH.start( 'host', :proxy => proxy ) do |session|
-  ...
-end
-}}}
-
-As you can see, you first create an instance of the proxy you want to use. (This flexibility allows for other proxy types to be supported, although at present only HTTP and SOCKS are available.)
-
-Once you've created your proxy, you just start your SSH session, as usual, except you also pass a @:proxy@ option. The proxy will then be used to obtain a connection to the remote host.
-
-Note: If your proxy does not allow connects to be made to other hosts on port 22, then you'll have to do some magic to allow SSH connections on your remote host on ports other than 22. Port forwarding on that remote host (from itself, to itself), can help you there.
-
-For instance, if your proxy disallows connections to any port except (say) 443, you could run the following command on the remote host:
-
-{{{lang=shell,caption=Forwarding a port using the ssh command
-ssh -gL 443:localhost:22 localhost
-}}}
-
-Then, as long as that command is running, port 443 will always be forwarded to port 22.  Naturally, this means that you must run this command while you have access to the box; if you can't access that machine in the first place (ie, because you're behind a firewall), then it does you no good.
-
-h3. Proxy Authentication
-
-Some proxies require authentication. Net::SSH supports these proxies as well. If you specify the user name either as a @:user@ option to the HTTP proxy constructor, or in the @HTTP_PROXY_USER@ or @CONNECT_USER@ environment variables, that name will be used to authenticate with the proxy. Likewise, the password may be given either via the @:password@ constructor option, or via the @HTTP_PROXY_PASSWORD@ or @CONNECT_PASSWORD@ environment variables.
-
-{{{lang=ruby,number=true,caption=Using HTTP proxy authentication
-require 'net/ssh'
-require 'net/ssh/proxy/http'
-
-proxy_host = 'my.proxy.com'
-proxy_port = 8080
-proxy_user = 'my-name'
-proxy_password = 'my-password'
-
-proxy = Net::SSH::Proxy::HTTP.new( proxy_host, proxy_port,
-            :user => proxy_user,
-            :password => proxy_password )
-
-Net::SSH.start( 'host', :proxy => proxy ) do |session|
-  ...
-end
-}}}
-
-Note that currently, only basic authentication is supported; in the future, digest authentication may be added for proxies that support it.

data/doc/manual/parts/0031.txt

@@ -1,25 +0,0 @@
-In addition to the HTTP proxy, Net::SSH also supports SOCKS proxies (both versions 4 and 5). Their usage is almost identical to the HTTP version (except SOCKS4 does not use passwords, just user names):
-
-{{{lang=ruby,number=true,caption=Using SOCKS proxies 
-require 'net/ssh'
-require 'net/ssh/proxy/socks4'
-require 'net/ssh/proxy/socks5'
-
-proxy_host = 'my.proxy.com'
-proxy_port = 1080
-proxy_user = 'my-name'
-proxy_password = 'my-password'
-
-socks4 = Net::SSH::Proxy::SOCKS4.new( proxy_host, proxy_port,
-            :user => proxy_user )
-
-socks5 = Net::SSH::Proxy::SOCKS5.new( proxy_host, proxy_port,
-            :user => proxy_user,
-            :password => proxy_password)
-
-Net::SSH.start( 'host', :proxy => socks4 ) do |session|
-  ...
-end
-}}}
-
-

data/doc/manual/stylesheets/manual.css

@@ -1,270 +0,0 @@
-body {
-  background: #FFF;
-  font-family: sans-serif;
-  color: #000;
-  margin: 0px;
-}
-
-a {
-  color: #00F;
-  text-decoration: none;
-}
-
-a:hover {
-  text-decoration: underline;
-}
-
-.product-manual {
-  text-align: center;
-  font-size: x-large;
-  font-variant: small-caps;
-  font-weight: bold;
-  color: #005;
-}
-
-.copyright {
-  text-align: center;
-  font-size: small;
-  font-style: italic;
-  color: #005;
-  margin-top: 1in;
-}
-
-#banner {
-  background: #005;
-  color: #FFF;
-  border-bottom: 1px solid #000;
-  padding-top: 0.5em;
-  padding-bottom: 0.5em;
-  padding-left: 1em;
-  margin-bottom: 1em;
-}
-
-#banner .title {
-  font-size: x-large;
-}
-
-#banner .title:first-letter {
-  font-size: 250%;
-  font-weight: normal;
-  float: left;
-  margin-top: -7px;
-  margin-bottom: -7px;
-}
-
-#banner .product {
-  font-weight: bold;
-  color: #FF7;
-  letter-spacing: 0.5em;
-}
-
-#banner .tagline {
-  font-style: italic;
-  font-size: large;
-  letter-spacing: 0.1em;
-  color: #FFF;
-}
-
-#banner .info {
-  color: white;
-  font-size: small;
-  padding-right: 1em;
-}
-
-#content {
-  margin-left: 0cm;
-  margin-right: 1cm;
-}
-
-#navigation {
-  font-size: x-small;
-  border-right: 2px groove black;
-  border-top: 2px groove black;
-  margin-right: 1em;
-  width: 200px;
-  height: 100%;
-  background: #FFD;
-}
-
-#navigation ul, #navigation ol {
-  margin-left: 1.2em;
-  padding-left: 1.2em;
-}
-
-#navigation .license {
-  font-size: x-small;
-  text-align: center;
-  border-top: 1px dashed #005;
-  margin-top: 2em;
-  padding: 1em;
-}
-
-.section {
-  margin-bottom: 1em;
-}
-
-.section p {
-  text-align: justify;
-}
-
-#content h1 {
-  background: #005;
-  color: #FFF;
-  font-size: x-large;
-  font-weight: bold;
-  font-variant: small-caps;
-  padding: 0.5em;
-  border: 1px solid #000;
-  margin-top: 0px;
-  margin-bottom: 1em;
-}
-
-#content h2 {
-  background: #005;
-  color: #FFF;
-  font-size: large;
-  font-weight: bold;
-  font-variant: small-caps;
-  padding: 0.25em;
-  padding-left: 0.5em;
-  border: 1px solid #000;
-  margin-bottom: 1em;
-}
-
-#content h3 {
-  background: #FFD;
-  color: #000;
-  font-size: normal;
-  font-weight: bold;
-  font-variant: small-caps;
-  padding: 0.25em;
-  padding-left: 0.5em;
-  border: 1px dotted #000;
-  margin-bottom: 1em;
-}
-
-#content h4 {
-  background: #FFE;
-  color: #000;
-  font-size: normal;
-  font-weight: bold;
-  font-variant: small-caps;
-  padding: 0.25em;
-  padding-left: 0.5em;
-  border: 1px dotted #777;
-  margin-bottom: 1em;
-}
-
-#navigation h1 {
-  margin: 0px;
-  padding: 1em;
-  color: #005;
-  background: transparent;
-  font-weight: bold;
-  font-size: 150%;
-  font-variant: small-caps;
-  text-align: center;
-}
-
-#navigation h2 {
-  margin: 0px;
-  margin-bottom: 1em;
-  padding: 0.5em;
-  border-top: 1px dashed #005;
-  border-bottom: 1px dashed #005;
-  color: #005;
-  background: transparent;
-  font-weight: bold;
-  font-size: 125%;
-  font-variant: small-caps;
-  text-align: center;
-}
-
-table.list {
-  margin: 2em;
-  border: 1px solid black;
-  background: #FFD;
-  padding: 0px;
-  border-spacing: 0px;
-}
-
-table.list th {
-  border-bottom: 1px solid #005;
-  padding-bottom: 5px;
-  background: #008;
-  color: white;
-  padding: 0.5em;
-  text-align: left;
-}
-
-table.list td {
-  padding: 0.2em;
-  text-align: left;
-  vertical-align: top;
-  border-bottom: 1px solid;
-}
-
-.prevnext {
-  padding: 0.5em 1em 0.5em 1em;
-  background: #557;
-  color: #FFF;
-  font-size: small;
-  font-weight: bold;
-  border: 1px solid #000;
-}
-
-.prevnext a {
-  color: #FF0;
-}
-
-.top .prevnext {
-  margin: 0 0 1em 0;
-  text-align: left;
-}
-
-.bottom .prevnext {
-  margin: 1em 0 0 0;
-  text-align: right;
-}
-
-.figure {
-  border: 1px solid black;
-  line-height: normal;
-  background: #FFD;
-  margin: 2em;
-}
-
-.figure .caption {
-  background: #008;
-  color: white;
-  font-weight: bold;
-  font-size: small;
-  padding: 4px 24px 4px 8px;
-  margin-left: -4px;
-  border: 1px dotted #77F;
-}
-
-.figure table {
-  padding-top: 0.8em;
-  padding-bottom: 0.5em;
-}
-
-.figure .body {
-  padding-left: 1em;
-}
-
-.figure pre {
-  padding: 0px;
-  background: transparent;
-  border: none;
-  font-size: small;
-  font-family: monospace;
-}
-
-.figure .lineno {
-  text-align: right;
-  color: #B00;
-  font-family: monospace;
-  font-size: small;
-  padding-right: 1em;
-}

data/doc/manual/stylesheets/ruby.css

@@ -1,17 +0,0 @@
-.ruby .normal {}
-.ruby .comment { color: #005; font-style: italic; }
-.ruby .keyword { color: #A00; font-weight: bold; }
-.ruby .method { color: #077; }
-.ruby .class { color: #074; }
-.ruby .module { color: #050; }
-.ruby .punct { color: #447; font-weight: bold; }
-.ruby .symbol { color: #099; }
-.ruby .string { color: #944; }
-.ruby .char { color: #F07; }
-.ruby .ident { color: #004; }
-.ruby .constant { color: #07F; }
-.ruby .regex { color: #B66; }
-.ruby .number { color: #D55; }
-.ruby .attribute { color: #377; }
-.ruby .global { color: #3B7; }
-.ruby .expr { color: #227; }

data/doc/manual/tutorial.erb

@@ -1,30 +0,0 @@
-<h1>Tutorial #<%= object.index %>. <%= object.title %></h1>
-
-<p>The sources for this tutorial may be found in the <tt>tutorial/<%= "%02d" % object.index %></tt>
-directory of the Copland distribution.</p>
-
-<% if object.intro %>
-
-  <h2>Introduction</h2>
-
-  <%= object.intro.to_html %>
-
-<% end %>
-
-<h2>Steps</h2>
-
-<ol>
-<% object.steps.each do |step| %>
-
-<li><%= step.to_html %></li>
-
-<% end %>
-</ol>
-
-<% if object.summary %>
-
-  <h2>Summary</h2>
-
-  <%= object.summary.to_html %>
-
-<% end %>