2018-12-21 11:20:43 +01:00
|
|
|
<!DOCTYPE html>
|
2008-07-16 09:54:19 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
2019-05-25 13:41:47 +02:00
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
2008-07-16 09:54:19 +00:00
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2018-12-21 11:20:43 +01:00
|
|
|
<html lang="en">
|
2008-07-16 09:54:19 +00:00
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|
|
|
|
<title>SSHSESSION Task</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="sshsession">SSHSESSION</h2>
|
2018-03-04 15:17:41 +01:00
|
|
|
<p><em>Since Apache Ant 1.8.0</em></p>
|
2008-07-16 09:54:19 +00:00
|
|
|
<h3>Description</h3>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>A Task which establishes an SSH connection with a remote machine running SSH daemon, optionally
|
|
|
|
|
establishes any number of local or remote tunnels over that connection, then executes any nested
|
|
|
|
|
tasks before taking down the connection.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p><strong>Note</strong>: This task depends on external libraries not included in the Ant
|
|
|
|
|
distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more
|
|
|
|
|
information. This task has been tested with JSCh 0.1.33 and above and won't work with versions of
|
|
|
|
|
JSCh earlier than 0.1.28.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>See also the <a href="sshexec.html">sshexec</a> and <a href="scp.html">scp</a> tasks</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2008-07-16 09:54:19 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>host</td>
|
|
|
|
|
<td>The hostname or IP address of the remote host to which you wish to connect.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>username</td>
|
|
|
|
|
<td>The username on the remote host to which you are connecting.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>port</td>
|
|
|
|
|
<td>The port to connect to on the remote host.</td>
|
|
|
|
|
<td>No; defaults to <q>22</q></td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>localtunnels</td>
|
|
|
|
|
<td>A comma-delimited list of colon-delimited <samp>lport:rhost:rport</samp> triplets defining
|
|
|
|
|
local port forwarding.<br/>If nested <a href="#LocalTunnel">localtunnel</a> elements are also
|
2008-07-16 09:54:19 +00:00
|
|
|
provided, both sets of tunnels will be established.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>remotetunnels</td>
|
|
|
|
|
<td>A comma-delimited list of colon-delimited <samp>rport:lhost:lport</samp> triplets defining
|
2018-03-02 08:23:45 +01:00
|
|
|
remote port forwarding.<br/> If nested <a href="#RemoteTunnel">remotetunnel</a> elements are
|
2008-07-16 09:54:19 +00:00
|
|
|
also provided, both sets of tunnels will be established.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>trust</td>
|
|
|
|
|
<td>This trusts all unknown hosts if set to <q>yes</q>
|
|
|
|
|
or <q>true</q>.<br/><strong>Note</strong>: If you set this to <q>false</q> (the default), the
|
|
|
|
|
host you connect to must be listed in your <var>knownhosts</var> file, this also implies that
|
|
|
|
|
the file exists.</td>
|
|
|
|
|
<td>No; defaults to <q>no</q></td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>knownhosts</td>
|
|
|
|
|
<td>This sets the known hosts file to use to validate the identity of the remote host. This must
|
|
|
|
|
be a SSH2 format file. SSH1 format is not supported.</td>
|
|
|
|
|
<td>No; defaults to <q>${user.home}/.ssh/known_hosts</q></td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>failonerror</td>
|
|
|
|
|
<td>Whether to halt the build if the command does not complete successfully.</td>
|
|
|
|
|
<td>No; defaults to <q>true</q></td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>password</td>
|
|
|
|
|
<td>The password.</td>
|
|
|
|
|
<td>Yes, unless you are using key based authentication or the password has been given in the
|
|
|
|
|
file or <var>todir</var> attribute</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keyfile</td>
|
|
|
|
|
<td>Location of the file holding the private key.</td>
|
|
|
|
|
<td>Yes, if you are using key based authentication</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>passphrase</td>
|
|
|
|
|
<td>Passphrase for your private key.</td>
|
|
|
|
|
<td>No; defaults to an empty string</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
2019-10-24 17:00:21 +02:00
|
|
|
<tr>
|
|
|
|
|
<td>sshConfig</td>
|
|
|
|
|
<td>Location of the file holding the OpenSSH style configuration (e.g. <code>${user.home}/.ssh/config</code>).
|
|
|
|
|
The username and the key file are read from the configuration file,
|
|
|
|
|
unless they are already specified in the task parameters.
|
|
|
|
|
<em>since Ant 1.10.8</em></td>
|
|
|
|
|
<td>No</td>
|
|
|
|
|
</tr>
|
2008-07-16 09:54:19 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>timeout</td>
|
|
|
|
|
<td>Give up if the connection cannot be established within the specified time (given in
|
|
|
|
|
milliseconds).</td>
|
|
|
|
|
<td>No; defaults to <q>0</q> which means <q>never</q></td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h4 id="LocalTunnel">localtunnel</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Optionally, any number of <code>localtunnel</code> elements can be used to define local port
|
|
|
|
|
forwarding over the SSH connection. If the <var>localtunnels</var> parameter was also specified,
|
|
|
|
|
both sets of tunnels will be established.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2008-07-16 09:54:19 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>lport</td>
|
|
|
|
|
<td>The number of the local port to be forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>rhost</td>
|
|
|
|
|
<td>The hostname or IP address of the remote host to which the local port should be
|
|
|
|
|
forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>rport</td>
|
|
|
|
|
<td>The number of the port on the remote host to which the local port should be forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h4 id="RemoteTunnel">remotetunnel</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Optionally, any number of <code>remotetunnel</code> elements can be used to define remote port
|
|
|
|
|
forwarding over the SSH connection. If the <var>remotetunnels</var> parameter was also specified,
|
|
|
|
|
both sets of tunnels will be established.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2008-07-16 09:54:19 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>rport</td>
|
|
|
|
|
<td>The number of the remote port to be forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>lhost</td>
|
|
|
|
|
<td>The hostname or IP address of the local host to which the remote port should be
|
|
|
|
|
forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>lport</td>
|
|
|
|
|
<td>The number of the port on the local host to which the remote port should be forwarded.</td>
|
|
|
|
|
<td>Yes</td>
|
2008-07-16 09:54:19 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
2021-03-07 10:43:26 +01:00
|
|
|
|
|
|
|
|
<h4 id="additionalConfig">additionalConfig</h4>
|
|
|
|
|
|
|
|
|
|
<p><em>since Ant 1.10.10</em></p>
|
|
|
|
|
|
|
|
|
|
<p>Adds configuration settings for the JSch Session created that are
|
|
|
|
|
not directly supported by specific Ant attributes.</p>
|
|
|
|
|
|
|
|
|
|
<table class="attr">
|
|
|
|
|
<tr>
|
|
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>key</td>
|
|
|
|
|
<td>The key of the configuration setting.</td>
|
|
|
|
|
<td>Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>value</td>
|
|
|
|
|
<td>The value of the configuration setting.</td>
|
|
|
|
|
<td>Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h4 id="Sequential">sequential</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The <code>sequential</code> element is a required parameter. It is a container for nested Tasks
|
|
|
|
|
which are to be executed once the SSH connection is established and all local and/or remote tunnels
|
|
|
|
|
established.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
|
|
|
|
|
<h3>Examples</h3>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Connect to a remote machine using password authentication, forward the local CVS port to the
|
|
|
|
|
remote host, and execute a CVS command locally, which can use the tunnel.</p>
|
|
|
|
|
|
2008-07-16 09:54:19 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<sshsession host="somehost"
|
|
|
|
|
username="dude"
|
|
|
|
|
password="yo"
|
|
|
|
|
localtunnels="2401:localhost:2401">
|
|
|
|
|
<sequential>
|
|
|
|
|
<cvs command="update ${cvs.parms} ${module}"
|
|
|
|
|
cvsRoot="${cvs.root}"
|
|
|
|
|
dest="${local.root}"
|
|
|
|
|
failonerror="true"/>
|
|
|
|
|
</sequential>
|
|
|
|
|
</sshsession></pre>
|
|
|
|
|
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Do the same thing using nested <code>localtunnel</code> element.</p>
|
|
|
|
|
|
2008-07-16 09:54:19 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<sshsession host="somehost"
|
|
|
|
|
username="dude"
|
|
|
|
|
password="yo">
|
|
|
|
|
<localtunnel lport="2401" rhost="localhost" rport="2401"/>
|
|
|
|
|
<sequential>
|
|
|
|
|
<cvs command="update ${cvs.parms} ${module}"
|
|
|
|
|
cvsRoot="${cvs.root}"
|
|
|
|
|
dest="${local.root}"
|
|
|
|
|
failonerror="true"/>
|
|
|
|
|
</sequential>
|
|
|
|
|
</sshsession></pre>
|
|
|
|
|
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Connect to a remote machine using key authentication, forward port 1080 to port 80 of an intranet
|
|
|
|
|
server which is not directly accessible, then run a <code>get</code> task using that tunnel.</p>
|
|
|
|
|
|
2008-07-16 09:54:19 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<sshsession host="somehost"
|
|
|
|
|
username="dude"
|
|
|
|
|
keyfile="${user.home}/.ssh/id_dsa"
|
|
|
|
|
passphrase="yo its a secret"/>
|
|
|
|
|
<LocalTunnel lport="1080" rhost="intranet.mycomp.com" rport="80"/>
|
|
|
|
|
<sequential>
|
|
|
|
|
<get src="http://localhost:1080/somefile" dest="temp/somefile"/>
|
|
|
|
|
</sequential>
|
|
|
|
|
</sshsession></pre>
|
|
|
|
|
|
|
|
|
|
<p><strong>Security Note</strong>: Hardcoding passwords or passphrases and/or usernames
|
|
|
|
|
in <code>sshsession</code> task can be a serious security hole. Consider using variable substitution
|
|
|
|
|
and include the password on the command line. For example:</p>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
2008-07-16 09:54:19 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<sshsession host="somehost"
|
|
|
|
|
username="${username}"
|
|
|
|
|
password="${password}"
|
|
|
|
|
localtunnels="2401:localhost:2401">
|
|
|
|
|
<sequential>
|
|
|
|
|
<sometask/>
|
|
|
|
|
</sequential>
|
|
|
|
|
</sshsession></pre>
|
|
|
|
|
|
|
|
|
|
<p>Invoking Ant with the following command line:</p>
|
2018-03-10 20:17:33 +01:00
|
|
|
<pre class="input">ant -Dusername=me -Dpassword=mypassword target1 target2</pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>is slightly better, but the username/password is exposed to all users on an Unix system (via
|
2018-03-10 20:17:33 +01:00
|
|
|
the <kbd>ps</kbd> command). The best approach is to use the <code><input></code> task and/or
|
2018-02-28 07:58:59 +01:00
|
|
|
retrieve the password from a (secured) <samp>.properties</samp> file.</p>
|
2008-07-16 09:54:19 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
