doc/manual-html/chapter-2.html in net-ssh-1.0.10 vs doc/manual-html/chapter-2.html in net-ssh-1.1.0

- old
+ new

@@ -12,12 +12,12 @@ <span class="product">Net::SSH&mdash;</span><br /> <span class="tagline">Secure Shell for Ruby</span> </div> </td><td valign='middle' align='right'> <div class="info"> - Net::SSH Version: <strong>1.0.10</strong><br /> - Manual Last Updated: <strong>2006-09-09 23:59 UTC</strong> + Net::SSH Version: <strong>1.1.0</strong><br /> + Manual Last Updated: <strong>2007-05-01 04:05 UTC</strong> </div> </td></tr> </table> </div> @@ -376,10 +376,13 @@ <p>On Windows, the pageant process will be detected automatically, if it is running.</p> <p>A future version of Net::SSH may include it&#8217;s own agent implementation as well, to make using an agent on a variety of platforms simpler.</p> + + + <p>Agent forwarding is available, and may be requested with the :forward_agent option to Net::SSH.start. Agents are not forwarded by default.</p> </div> <h2> @@ -427,10 +430,14 @@ <tr> <td style="vertical-align:top;text-align:center;"><code>:encryption</code> </td> <td> This is the cipher algorithm to use when sending/receiving data to/from the remote server. It defaults to <code>3des-cbc</code>. Other valid algorithms supported by Net::SSH are <code>aes128-cbc</code>, <code>blowfish-cbc</code>, <code>aes256-cbc</code>, <code>aes192-cbc</code>, <code>idea-cbc</code>, and <code>none</code>. Note that the values you specify here are only <em>suggestions</em>, 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. </td> </tr> <tr> + <td style="vertical-align:top;text-align:center;"><code>:forward_agent</code> </td> + <td> Set to a true value to request that the local authentication agent be forwarded to the remote host. By default the agent will not be forwarded. </td> + </tr> + <tr> <td style="vertical-align:top;text-align:center;"><code>:hmac</code> </td> <td> This specifies the &#8220;message authentication code&#8221; (MAC) algorithm to use to ensure that each packet transmitted and recieved is authentic. This defaults to <code>hmac-md5</code>. Other valid algorithms supported by Net::SSH are <code>hmac-sha1</code>, <code>hmac-md5-96</code>, <code>hmac-md5-sha1</code>, and <code>none</code>. Note that the values you specify here are only <em>suggestions</em>, 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. </td> </tr> <tr> <td style="vertical-align:top;text-align:center;"><code>:host_key</code> </td> @@ -453,9 +460,13 @@ <td> 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.</td> </tr> <tr> <td style="vertical-align:top;text-align:center;"><code>:log</code> </td> <td> 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 <span class="caps">STDERR</span>.</td> + </tr> + <tr> + <td style="vertical-align:top;text-align:center;"><code>:paranoid</code> </td> + <td> Controls how Net::SSH responds to a server key that it does not recognize. The default, <code>true</code>, will result in all keys being accepted the first time they are seen for a particular host, and then an exception being raised if the key ever changes. However, no host key verification will be done if the connection appears to be tunneled over a locally forwarded port. If set to <code>false</code>, no server key verification is done. You can also set this to <code>:very</code>, in which case errors are raised even if the connection appears to be tunneled.</td> </tr> <tr> <td style="vertical-align:top;text-align:center;"><code>:port</code> </td> <td> 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 <code>start</code>, rather than as an option, but you <em>can</em> specify it this way, if you prefer.</td> </tr>