net-ssh 0.5.0

data/doc/manual/parts/forward_local.txt

@@ -0,0 +1,18 @@
+Forwarding a local connection to a remote destination is simply a matter of invoking the @#local@ method of the @#forward@ service. The simplest version of the method just takes three parameters: the local port to listen on, and the remote host and port to forward the connection to:
+
+<pre>
+  Net::SSH.start( 'host' ) do |session|
+    session.forward.local( 1234, 'www.google.com', 80 )
+    session.loop
+  end
+</pre>
+
+In the above example, then, any connection received on port 1234 will be forwarded to port 80 on "www.google.com". This means that if you were to point a browser at "http://localhost:1234", it would pull up "Google":http://www.google.com.
+
+By default, only connections _from the local host_ are accepted. This is because the default bind address is 127.0.0.1. You can specify any bind address you want (including 0.0.0.0 to allow connections from anywhere) by specifying that address as the first parameter to @#local@, with the local port number immediately following.
+
+<pre>
+  session.forward.local( '0.0.0.0', 1234, 'www.google.com', 80 )
+</pre>
+
+In this configuration, anyone from anywhere can connect to your machine on port 1234 and be forwarded to Google.

data/doc/manual/parts/forward_remote.txt

@@ -0,0 +1,14 @@
+Forwarding remote connections to the local host is also straightforward; simply call the @#remote_to@ method of the @#forward@ service. This takes three (or four) parameters: the local port and host to be forwarded to (in that order), and the remote port to listen on. The fourth parameter is optional, and is the bind address on the remote machine; this defaults to "127.0.0.1".
+
+<pre>
+  Net::SSH.start( 'host' ) do |session|
+    session.forward.remote_to( 80, 'www.google.com', 1234 )
+    session.loop
+  end
+</pre>
+
+The above example causes any connection on port 1234 of the remote machine (_from_ the remote machine) to be forwarded via the local host to port 80 at www.google.com.  To make things a bit more open, you could specify a bind address of 0.0.0.0:
+
+<pre>
+  session.forward.remote_to( 80, 'www.google.com', 1234, '0.0.0.0' )
+</pre>

data/doc/manual/parts/intro_author.txt

@@ -0,0 +1 @@
+Net::SSH was written by "Jamis Buck":mailto:jgb3@email.byu.edu. Feel free to send him compliments, candy, money, praise, or new feature patches--he likes all those things. You can send him questions and suggestions, too, if you really want to. However, for bug reports and general feature requests, please use the trackers on the "Net::SSH project page":http://rubyforge.org/projects/net-ssh.

data/doc/manual/parts/intro_getting.txt

@@ -0,0 +1,39 @@
+h3. Prerequisites:
+
+In order to use Net::SSH, you must be using a supported version of Ruby's OpenSSL module. The version distributed with Ruby 1.8.1 and earlier is not sufficient, and is lacking several features that Net::SSH relies on. If you are using Ruby 1.8.1 (or earlier), you should either upgrade to 1.8.2, or download and install an updated version of the OpenSSL module. You can download a usable snapshot from the "Net::SSH downloads page":http://rubyforge.org/projects/net-ssh.
+
+Furthermore, you must make sure that Ruby's OpenSSL module has been compiled against _at least_ version 0.9.7 of the OpenSSL library. Prior versions lacked functionality that Net::SSH depends on (notably, the 'padding' property of ciphers).
+
+Optionally, you can install the "ruby-termios":http://raa.ruby-lang.org/project/ruby-termios and "ruby-password":http://raa.ruby-lang.org/project/ruby-password modules. If you do, then the ruby-password module will be used when prompting you for the passphrases needed to load your keys (if your keys have passphrases).
+
+h3. Using "RubyGems":http://rubygems.rubyforge.org
+
+If you have "RubyGems":http://rubygems.rubyforge.org installed, installing Net::SSH is simple:
+
+<pre>
+  gem install net-ssh
+</pre>
+
+You still need to make sure you have a working version of Ruby's OpenSSL module, but other than that, you should be good to go!
+
+h3. Using "rpa-base":http://rpa-base.rubyforge.org
+
+If you have "rpa-base":http://rpa-base.rubyforge.org installed:
+
+<pre>
+  rpa install net-ssh
+</pre>
+
+As with the gem install, you still need to make sure you have a working version of Ruby's OpenSSL module, but other than that, you should be good to go!
+
+h3. Doing it the hard way
+
+If you don't have "RubyGems":http://rubygems.rubyforge.org or "rpa-base":http://rpa-base.rubyforge.org, or if you just prefer to install things by hand, you can always go to the "Net::SSH downloads page":http://rubyforge.org/projects/net-ssh and grab the package of your choice: @tar.gz@, @tar.bz2@, or @zip@.
+
+Then, unpack the archive and run the @setup.rb@ script:
+
+<pre>
+  ruby setup.rb config
+  ruby setup.rb setup
+  ruby setup.rb install
+</pre>

data/doc/manual/parts/intro_license.txt

@@ -0,0 +1,6 @@
+Net::SSH is made available under either the BSD license, or the same license Ruby (which, by extension, also allows the GPL as a permissable license as well). You can view the full text of any of these licenses in the @doc@ subdirectory of the Net::SSH distrubtion. The texts of the BSD and GPL licenses are also available online: "BSD":http://www.opensource.org/licenses/bsd-license.php and "GPL":http://www.opensource.org/licenses/gpl-license.php.
+
+This manual (in any form, be it source or otherwise) and the scripts and templates used to generate it, are all distributed under the "Creative Commons":http://creativecommons.org "Attribution-ShareAlike":http://creativecommons.org/licenses/by-sa/2.0 license.
+
+If you desire permission to use either Net::SSH or the manual in a manner incompatible with these licenses, please contact the copyright holder ("Jamis Buck":mailto:jgb3@email.byu.edu) in order to negotiate a more compatible license.
+

data/doc/manual/parts/intro_support.txt

@@ -0,0 +1,7 @@
+Mailing lists, bug trackers, feature requests, and public forums are all available (courtesty of "RubyForge":http://rubyforge.org) at the "Net::SSH project page":http://rubyforge.org/projects/net-ssh.
+
+h3. Mailing Lists
+
+|_. *List Name* |_. -- |_. *Description* |
+|^=. "net-ssh-users":http://rubyforge.org/pipermail/net-ssh-users|^=. "subscribe / unsubscribe":http://rubyforge.org/mailman/listinfo/net-ssh-users| The Net::SSH users list is devoted to the discussion of and questions about the usage of the Net::SSH module. If you can't quite figure out how to get a feature of Net::SSH to work, this is the list you would go to in order to ask your questions.|
+|^=. "net-ssh-devel":http://rubyforge.org/pipermail/net-ssh-devel|^=. "subscribe / unsubscribe":http://rubyforge.org/mailman/listinfo/net-ssh-devel| The Net::SSH developers list is devoted to the discussion of Net::SSH's implementation. If you have created a patch that you would like to discuss, or if you would like to discuss a new feature, this is the list for you.|

data/doc/manual/parts/intro_what_is.txt

@@ -0,0 +1,7 @@
+Net::SSH is a pure-Ruby implementation of the SSH2 client protocol. It supports the following features:
+
+* User authentication via explicit username/password, or using a public-key/private-key pair.
+
+* Port forwarding, both from the local host to a remote computer via the remote host, and from the remote host to the local host.
+
+* Execute processes on the remote machine, both interactively and non-interactively ("batch").

data/doc/manual/parts/intro_what_is_not.txt

@@ -0,0 +1,3 @@
+Net::SSH is only a _client_ implementation, not a server. Given sufficient motivation and encouragement from the community, perhaps it will someday include an SSH server, but as of right now, it does not.
+
+Furthermore, it is only an _SSH2_ client. This means that it cannot connect to SSH servers that only understand the older SSH1 protocol.

data/doc/manual/parts/proxy_http.txt

@@ -0,0 +1,52 @@
+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:
+
+<pre>
+  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
+</pre>
+
+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:
+
+<pre>
+  ssh -gL 443:localhost:22 localhost
+</pre>
+
+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.
+
+<pre>
+  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
+</pre>
+
+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/proxy_intro.txt

@@ -0,0 +1 @@
+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/proxy_socks.txt

@@ -0,0 +1,23 @@
+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):
+
+<pre>
+  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
+</pre>

data/doc/manual/parts/session_key.txt

@@ -0,0 +1,66 @@
+Just as with the "OpenSSH":http://www.openssh.org version of the @ssh@ utilities, Net::SSH supports authentication using public/private keys.
+
+h3. I don't know what public/private keys are... Explain, please?
+
+Public key/private key encryption is just one way of hiding information from prying eyes. The idea is that you have two tokens: a _public key_, and a _private key_.  The private key is yours alone--you never let _anyone_ else see it. The _public key_, on the other hand, is distributable. You give it to anyone that you want to be able to communicate with you securely.
+
+The remote party uses your public key to encrypt information. Anything encrypted with your public key may only be decrypted with the corresponding private key, and since you have the only copy of that, you can rest easily knowing that no one can easily intercept your communications!
+
+Net::SSH allows you to define a private key, which it will then attempt to use during authentication with the remote server. If the remote server has a copy of the corresponding public key, you will be able to log into that remote server without having to specify a password. Not only is this convenient, but for Ruby scripts, it is much more secure, since you don't have to hard-code your password in your script.
+
+h3. Setting up public/private keys
+
+Net::SSH, by default, will use the private keys that you have set up for use with ssh. These keys are called "id_dsa" and "id_rsa", and are located under your home directory, either in a ".ssh" subdirectory, or a ".ssh2" subdirectory.
+
+The "id_dsa" key is the preferred key (since it uses the stronger DSA encryption), but both DSA and RSA are supported.
+
+To create these keys, you can use the "ssh-keygen" utility from "OpenSSH":http://www.openssh.org. Alternatively, if you have the Net::SSH::Utilities package installed, you can use the "rb-keygen" utility (which is a pure-Ruby implementation of most of the functionality of ssh-keygen).
+
+<pre>
+  ssh-keygen -t dsa
+</pre>
+
+
+(If you would rather use an RSA key, replace "dsa" with "rsa" in the command given above.)
+
+Accept all the defaults when prompted. You will also be asked for a passphrase. This passphrase is an additional level of protection, which prevents anyone from being able to use your private key without knowing the passphrase. Unfortunately, it also means that you have to enter the passphrase every time you use your key.  It is up to you what price you want to pay for security, but if you _can_ leave the passphrase blank. In this case, anyone that has a copy of your private key can use it, but it's a little more convenient to deal with.
+
+Once you create your keys, you then need to set up your account on each remote server so that it knows about your public key. To do this, log into the remote server and edit (or create) the file (in your home directory) ".ssh/authorized_keys". Just copy the contents of your public key (in your local machine's home directory, called ".ssh/id_dsa.pub" or ".ssh/id_rsa.pub") into the "authorized_keys" file on a line of its own. Then save the file and logout.  Everything _should_ now be set up.
+
+(Note: if you have an SSH client installed, it will typically have its own key generation utility. You can use that instead, if you prefer.)
+
+h3. Connecting using public/private keys
+
+Public/private keys are always tried before the explicit password authentication, even if you provide a password. Thus, if you _only_ want to use public/private key authentication, simply remove the password from the argument list. If you can successfully obtain a session handle, then your keys are set up correctly!
+
+<pre>
+  Net::SSH.start( 'host', 'user' ) do |session|
+    ...
+  end
+</pre>
+
+Furthermore, if your @USER@ environment variable is set to the username that you want to log into the remote machine as, you can even leave the @username@ parameter off:
+
+<pre>
+  Net::SSH.start( 'host' ) do |session|
+    ...
+  end
+</pre>
+
+h3. Using keys with passphrases
+
+When you use a private key that was created with a passphrase, you will be prompted to enter the passphrase when the key is loaded. This may make such a key inappropriate for use in automated environments, but it is certainly more secure than the use of unprotected private keys.
+
+If you have the "ruby-termios":http://raa.ruby-lang.org/project/ruby-termios and "ruby-password":http://raa.ruby-lang.org/project/ruby-password modules installed, the ruby-password module will be used when prompting for passphrases. Otherwise, a generic message (courtesy of the OpenSSL library) will be presented, which will not be very informative.
+
+h3. Using an SSH agent
+
+Most SSH clients come with what is called an _agent_. This is a program that is continually running, and which keeps track of all of a user's keys. When an SSH client needs to perform an operation using one of the user's keys, it requests the operation via the agent, rather than performing the operation itself directly with a key.  
+
+The benefit of this is what is known as _single sign-on_. If any of your keys have a passphrase, this allows you to enter the passphrase _once_ (when the key is loaded by the agent), and then any SSH program you use will never prompt you for that passphrase again.
+
+Net::SSH includes support for interfacing with an SSH agent. Currently, only Unix-ish systems are supported (due to issues with interprocess communication on Windows). Eventually, perhaps an interface will be created to the "PuTTY agent (pageant)":http://www.chiark.greenend.org.uk/~sgtatham/putty/, but don't hold your breath. (It's not very easy to interface with.)
+
+To allow your Net::SSH programs to interface with a running agent, simply make sure that the @SSH_AGENT_SOCK@ environment variable is set to the location of the Unix domain socket that the agent is listening to. Also, make sure you have added all of your keys to the agent (typically by running the @ssh-add@ utility.
+
+A future version of Net::SSH may include it's own agent implementation as well, to make using an agent on a variety of platforms simpler.

data/doc/manual/parts/session_options.txt

@@ -0,0 +1,42 @@
+There are various additional options that you can specify when connecting. These options allow you to specify such things as the cipher algorithm to use, whether or not the data stream will be compressed, or explicit paths to the private keys to use.
+
+
+Options are specified as a hash in the last parameter to the @start@ method. If using the keyword parameters version of the @start@ method, the options hash is whatever is left after processing the @:username@, @:password@, and @:port@ options.
+
+The complete list of available options, and their valid values, is given in the following table.
+
+table(list).
+|_. Option |_. Description |
+|^=. @:auth_methods@ | This is the list of authorization methods to try. It defaults to "publickey", "keyboard-interactive", "password", and "hostbased". (These are also the only authorization methods that are supported.) If you want them to be tried in a different order, or if you don't want certain methods to be used, you can specify your own list via this option.|
+|^=. @:compression@ | The compression algorithm to use when compressing the data stream. Valid values are @none@ and @zlib@. The default is @none@.|
+|^=. @:compression_level@ | This is only used when the compression algorithm is @zlib@. It is an integer value from 0 to 9, representing the quality of the compression. A 0 is no compression, and a 9 is most compression. The default is 6.|
+|^=. @:container@ | This is the dependency injection container to use when registering all of the services that Net::SSH uses internally. If unspecified (the default) a new container will be created. This option allows you to reuse a single container for multiple application components.|
+|^=. @:crypto_backend@ | This is the cryptography backend to use. It defaults to @:ossl@, which specifies the OpenSSL cryptography engine. Currently, this is the only supported backend, but in the future others may be provided, and this is how they would be selected.|
+|^=. @:encryption@ | This is the cipher algorithm to use when sending/receiving data to/from the remote server. It defaults to @3des-cbc@. Other valid algorithms supported by Net::SSH are @aes128-cbc@, @blowfish-cbc@, @aes256-cbc@, @aes192-cbc@, @idea-cbc@, and @none@. Note that the values you specify here are only _suggestions_, and if the server you are contacting cannot use your recommended algorithm, a fallback algorithm will be used (typically chosen in the order the algorithms were listed, above). This option may take an array, if you want to specify the order of the fallback algorithms to try, as well. |
+|^=. @:hmac@ | This specifies the "message authentication code" (MAC) algorithm to use to ensure that each packet transmitted and recieved is authentic. This defaults to @hmac-md5@. Other valid algorithms supported by Net::SSH are @hmac-sha1@, @hmac-md5-96@, @hmac-md5-sha1@, and @none@. Note that the values you specify here are only _suggestions_, and if the server you are contacting cannot use your recommended algorithm, a fallback algorithm will be used (typically chosen in the order the algorithms were listed, above).  This option may take an array, if you want to specify the order of the fallback algorithms to try, as well. |
+|^=. @:host_key@ | This specifies the host key type that should be used when negotiating keys with the server. This defaults to @ssh-dss@, but may also be @ssh-rsa@. As with some other option types, the value you specify is only a recommendation, not a commandment, and if the server cannot honor the key type you specified, a fallback will be chosen from among the other supported types. If you wish to specify the fallback algorithms to try, you may pass an array as the value of this option, which contains (in order) the key types to try. |
+|^=. @:host_keys@ | This is an array of file names that contain the private keys which identify the host your script is running on. These default to @/etc/ssh/ssh_host_dsa_key@ and @/etc/ssh/ssh_host_rsa_key@ (which are both typically only readable by root). These keys are only used in hostbased authentication.|
+|^=. @:kex@ | This specifies the "key-exchange" (KEX) algorithm to use when exchanging keys. Two algorithms are currently supported: @diffie-hellman-group-exchange-sha1@, and @diffie-hellman-group1-sha1@. The default is @diffie-hellman-group-exchange-sha1@.|
+|^=. @:keys@ | This specifies the list of private key files to use _instead_ of the defaults (@$HOME/.ssh/id_dsa@, @$HOME/.ssh2/id_dsa@, @$HOME/.ssh/id_rsa@, and @$HOME/.ssh2/id_rsa@). The value of this option should be an array of strings.|
+|^=. @:languages@ | This option specifies the preferred language (or languages) that should be used when communicating error messages. It has no effect on Net::SSH, but may cause the server (if it supports your suggested language) to send errors in the language you request. The default is empty.|
+|^=. @:log@ | Specifies either a string or an IO object. If it is a string, it names the file that all log messages should be written to. Otherwise, the messages will be written to the IO object directly. Defaults to STDERR.|
+|^=. @:port@ | This is the port number that should be used to connect to the remote machine. If you wish to specify the port, you are generally better off specifying it as the second parameter to @start@, rather than as an option, but you _can_ specify it this way, if you prefer.|
+|^=. @:registry_options@ | If the @:container@ option is not specified, a new container will be created. This option specifies a hash of additional options that may be used to configure the new container (registry). By default, it is empty.|
+|^=. @:verbose@ | Specifies how verbose the logging should be. Valid values are @:fatal@, @:error@, @:warn@, @:info@, and @:debug@. Defaults to @:warn@. WARNING: selecting @:debug@ will result in LOTS of output! (Further customization of verbosity can be accomplished by specifying which Net::SSH components should have which logging levels, via the @:registry_options@ option.)|
+
+For example, the following code snippet will connect to the given remote host, and requests that the @ssh-rsa@ host key type be used, with the @blowfish-cbc@ cipher algorithm, and requests that the given private key file be used. Also, the data stream will be compressed.
+
+<pre>
+  require 'net/ssh'
+  require 'logger'
+
+  Net::SSH.start(
+    'host', 'user',
+    :host_key => "ssh-rsa",
+    :encryption => "blowfish-cbc",
+    :keys => [ "/tmp/temporary-key" ],
+    :compression => "zlib"
+  ) do |session|
+    ...
+  end
+</pre>

data/doc/manual/parts/session_session.txt

@@ -0,0 +1,14 @@
+Alternatively, you can use Net::SSH::Session to start your SSH sessions. The @Net::SSH.start@ interface described above is simply a convenience for creating a new Session object explicitly.
+
+<pre>
+  require 'net/ssh'
+
+  Net::SSH::Session.new(
+    'host', 'username', 'password',
+    :compression => "zlib"
+  ) do |session|
+    ...
+  end
+</pre>
+
+Note that Net::SSH::Session#new accepts the same parameters as Net::SSH.start, and may also be called without a block.

data/doc/manual/parts/session_start.txt

@@ -0,0 +1,49 @@
+Before you can do anything with Net::SSH, you need to require the @net/ssh@ module:
+
+<pre>
+  require 'net/ssh'
+</pre>
+
+Once you have required the @net/ssh@ module, you can begin an SSH session by calling @Net::SSH.start@.  This may be used in one of two ways. If called without a block, it will return a reference to the new session as an instance of a @Net::SSH::Session@. Used this way, you must explicitly close the session when you are finished with it.
+
+<pre>
+  session = Net::SSH.start( 'host', 'user', 'passwd' )
+  ...
+  session.close
+</pre>
+
+The other approach involves attaching a block to the start method. When used this way, the new session is passed to the block, and the session is automatically closed when the block exits.
+
+<pre>
+  Net::SSH.start( 'host', 'user', 'passwd' ) do |session|
+    ...
+  end
+</pre>
+
+If you need to specify a different port on the host to connect to (the default is 22), you can specify it immediately after the @host@ parameter, like so:
+
+<pre>
+  Net::SSH.start( 'host', 1234, 'user', 'passwd' ) do |session|
+    ...
+  end
+</pre>
+
+h3. Using Keyword Arguments
+
+Some people prefer using keyword arguments for functions with more than a couple of parameters. The @start@ method supports this approach as well, although the @host@ parameter is always positional and always comes first.
+
+<pre>
+  Net::SSH.start( 'host',
+                  :password=>'passwd', 
+                  :port=>1234,
+                  :username=>'user',
+                  ... ) do |session|
+    ...
+  end
+</pre>
+
+(More about the "@...@" stuff, later.)
+
+h3. Failed Authentication
+
+If the username and/or password given to @start@ are incorrect, authentication will fail. If authentication fails, a @Net::SSH::AuthenticationFailed@ exception will be raised.

data/doc/manual/tutorial.erb

@@ -0,0 +1,30 @@
+<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 %>

data/examples/channel-demo.rb

@@ -0,0 +1,81 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SSH Secure Shell Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SSH
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-ssh website : http://net-ssh.rubyforge.org
+# project website: http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../lib"
+require 'net/ssh'
+
+# This assumes three things:
+#
+# 1) That you have an SSH server running on your local machine,
+# 2) That the USER environment variable is set to your user name, and
+# 3) That you have public and private keys conigured so that you can log into
+#    your machine via SSH without being prompted for a password.
+#
+# If #2 or #3 are not true, you can add your user-name and password as the
+# second and third parameters (respectively) to Net::SSH.start.
+
+Net::SSH.start( 'localhost' ) do |session|
+
+  # Note: two things here,
+  #
+  # 1) open_channel does not immediately invoke the associated block. It only
+  #    calls the block after the server has confirmed that the channel is valid.
+  # 2) channel.exec does not block--it just sends the request to the server and
+  #    returns.
+  #
+  # For these two reasons, you MUST call session.loop, so that packets get
+  # processed and dispatched to the appropriate channel for handling.
+
+  def exec( command )
+    lambda do |channel|
+      channel.exec command
+      channel.on_data do |ch,data|
+        ch[:data] ||= ""
+        ch[:data] << data
+      end
+      channel.on_extended_data do |ch,type,data|
+        ch[:extended_data] ||= []
+        ch[:extended_data][type] ||= ""
+        ch[:extended_data][type] << data
+      end
+    end
+  end
+
+  channels = []
+  channels.push session.open_channel( &exec( "echo $HOME" ) )
+  channels.push session.open_channel( &exec( "ls -la /" ) )
+  channels.push session.open_channel( &exec( "bogus-command" ) )
+
+  # Process packets from the server and route them to the appropriate channel
+  # for handling.
+
+  session.loop
+
+  # Display the results.
+
+  channels.each do |c|
+    puts "----------------------------------"
+    if c.valid?
+      puts c[:data]
+      if c[:extended_data] && c[:extended_data][1]
+        puts "-- stderr: --"
+        puts c[:extended_data][1]
+      end
+    else
+      puts "channel was not opened: #{c.reason} (#{c.reason_code})"
+    end
+  end
+end