New task sshsession. PR 43083. Submitted by David S. Johnson

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@677219 13f79535-47bb-0310-9956-ffa450edef68
17 years ago · e56206c3c5
--- a/+ 1
+++ b/+ 1
@@ -60,6 +60,7 @@ Dave Brosius
 David A. Herman
 David Crossley
 David Gärtner
 David S. Johnson
 David Kavanagh
 David LeRoy
 David Maclean
--- a/+ 4
+++ b/+ 4
@@ -175,6 +175,10 @@ Other changes:
   files.
   Bugzilla Issue 33939.

 * the new task sshsession can run multiple tasks in the presence of
   an SSH session providing (local and remote) tunnels.
   Bugzilla Issue 43083.

 Changes from Ant 1.7.0 TO Ant 1.7.1
 =============================================

--- a/contributors.xml
+++ b/contributors.xml
@@ -263,6 +263,11 @@
    <first>David</first>
    <last>G&#228;rtner</last>
  </name>
  <name>
    <first>David</first>
    <middle>S.</middle>
    <last>Johnson</last>
  </name>
  <name>
    <first>David</first>
    <last>Kavanagh</last>
--- a/docs/manual/OptionalTasks/sshsession.html
+++ b/docs/manual/OptionalTasks/sshsession.html
@@ -0,0 +1,288 @@
 <!--
   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

       http://www.apache.org/licenses/LICENSE-2.0

   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.
 -->
 <html>

 <head>
 <meta http-equiv="Content-Language" content="en-us">
 <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
 <title>SSHSESSION Task</title>
 </head>

 <body>

 <h2><a name="sshsession">SSHSESSION</a></h2>
 <h3>Description</h3>

 <p><em>since Ant 1.8.0</em></p>

 <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>

 <p><b>Note:</b> 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>

 <p>See also the <a href="sshexec.html">sshexec</a>
 and <a href="scp.html">scp</a> tasks</p>

 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">host</td>
    <td valign="top">The hostname or IP address of the remote host to which you wish to connect.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">username</td>
    <td valign="top">The username on the remote host to which you are connecting.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">port</td>
    <td valign="top">The port to connect to on the remote host.</td>
    <td valian="top" align="center">No, defaults to 22.</td>
  </tr>
  <tr>
  <tr>
    <td valign="top">localtunnels</td>
    <td valign="top">A comma-delimited list of
      colon-delimited <code>lport:rhost:rport</code> triplets defining
      local port forwarding.<br>  If
      nested <a href="#LocalTunnel">localtunnel</a> elements are also
      provided, both sets of tunnels will be established.</td>
    <td valian="top" align="center">No</td>
  </tr>
  <tr>
    <td valign="top">remotetunnels</td>
    <td valign="top">A comma-delimited list of
      colon-delimited <code>rport:lhost:lport</code> triplets defining
      remote port forwarding.<br>  If
      nested <a href="#RemoteTunnel">remotetunnel</a> elements are
      also provided, both sets of tunnels will be established.</td>
    <td valian="top" align="center">No</td>
  </tr>
  <tr>
    <td valign="top">trust</td>
    
    <td valign="top">This trusts all unknown hosts if set to yes/true.<br>
      <strong>Note</strong> If you set this to false (the default), the
      host you connect to must be listed in your knownhosts file, this
      also implies that the file exists.</td>
    <td valian="top" align="center">No, defaults to No.</td>
  </tr>
  <tr>
    <td valign="top">knownhosts</td>
    <td valign="top">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 valian="top" align="center">No, defaults to
      ${user.home}/.ssh/known_hosts.</td>
  </tr>
  <tr>
    <td valign="top">failonerror</td>
    <td valign="top">Whether to halt the build if the command does not complete successfully.
    </td>
    <td valign="top" align="center">No; defaults to true.</td>
  </tr>
  <tr>
    <td valign="top">password</td>
    <td valign="top">The password.</td>
    <td valign="top" align="center">Not if you are using key based
      authentication or the password has been given in the file or
      todir attribute.</td>
  </tr>
  <tr>
    <td valign="top">keyfile</td>
    <td valign="top">Location of the file holding the private key.</td>
    <td valign="top" align="center">Yes, if you are using key based
      authentication.</td>
  </tr>
  <tr>
    <td valign="top">passphrase</td>
    <td valign="top">Passphrase for your private key.</td>
    <td valign="top" align="center">No, defaults to an empty string.</td>
  </tr>
  <tr>
    <td valign="top">timeout</td>
    <td valign="top">Give up if the connection cannot be established
      within the specified time (given in milliseconds). Defaults to 0
      which means &quot;wait forever&quot;.</td>
    <td align="center" valign="top">No</td>
  </tr>
 </table>

 <h3>Parameters specified as nested elements</h3>

 <a name="LocalTunnel"><h4>localtunnel</h4></a>
 <p>Optionally, any number of localtunnel elements can be used to
 define local port forwarding over the SSH connection.  If the
 localtunnels parameter was also specified, both sets of tunnels will
 be established.</p>

 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">lport</td>
    <td valign="top">The number of the local port to be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">rhost</td>
    <td valign="top">The hostname or IP address of the remote host to
      which the local port should be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">rport</td>
    <td valign="top">The number of the port on the remote host to
      which the local port should be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
 </table>

 <a name="RemoteTunnel"><h4>remotetunnel</h4></a>
 <p>Optionally, any number of remotetunnel elements can be used to
 define remote port forwarding over the SSH connection.  If the
 remotetunnels parameter was also specified, both sets of tunnels will
 be established.</p>

 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">rport</td>
    <td valign="top">The number of the remote port to be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">lhost</td>
    <td valign="top">The hostname or IP address of the local host to
      which the remote port should be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">lport</td>
    <td valign="top">The number of the port on the local host to which
      the remote port should be forwarded.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
 </table>

 <a name="Sequential"><h4>sequential</h4></a>
 <p>The sequential 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>

 <h3>Examples</h3>
 <p><b>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.</b></p>
 <pre>
  &lt;sshsession host=&quot;somehost&quot;
    username=&quot;dude&quot;
    password=&quot;yo&quot;
    localtunnels=&quot;2401:localhost:2401&quot;
  &gt;
    &lt;sequential&gt;
      &lt;cvs  command=&quot;update ${cvs.parms} ${module}&quot;
        cvsRoot=&quot;${cvs.root}&quot;
        dest=&quot;${local.root}&quot;
        failonerror=&quot;true&quot;
      /&gt;
    &lt;/sequential&gt;
  &lt;/sshsession&gt;
 </pre>

 <p><b>Do the same thing using nested localtunnel element.</b></p>
 <pre>
  &lt;sshsession host=&quot;somehost&quot;
    username=&quot;dude&quot;
    password=&quot;yo&quot;
  &gt;
    &lt;localtunnel lport=&quot;2401&quot; rhost=&quot;localhost&quot; rport=&quot;2401&quot;/&gt;
    &lt;sequential&gt;
      &lt;cvs  command=&quot;update ${cvs.parms} ${module}&quot;
        cvsRoot=&quot;${cvs.root}&quot;
        dest=&quot;${local.root}&quot;
        failonerror=&quot;true&quot;
    /&gt;
    &lt;/sequential&gt;
  &lt;/sshsession&gt;
 </pre>

 <p><b>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 get task using that tunnel.</b></p>
 <pre>
  &lt;sshsession host=&quot;somehost&quot;
  username=&quot;dude&quot;
  keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  passphrase=&quot;yo its a secret&quot;/&gt;
    &lt;LocalTunnel lport=&quot;1080&quot; rhost=&quot;intranet.mycomp.com&quot; rport=&quot;80&quot;/&gt;
    &lt;sequential&gt;
      &lt;get src=&quot;http://localhost:1080/somefile&quot; dest=&quot;temp/somefile&quot;/&gt;
    &lt;/sequential&gt;
  &lt;/sshsession&gt;
 </pre>


 <p><strong>Security Note:</strong> Hard coding passwords or
 passphrases and/or usernames in sshsession task can be a serious
 security hole. Consider using variable substitution and include the
 password on the command line. For example:<br>
 <pre>
  &lt;sshsession host=&quot;somehost&quot;
  username=&quot;${username}&quot;
  password=&quot;${password}&quot;
  localtunnels=&quot;2401:localhost:2401&quot;&gt;
    &lt;sequential&gt;
      &lt;sometask/&gt;
    &lt;/sequential&gt;
  &lt;/sshsession&gt;
 </pre>

 Invoking ant with the following command line:
 <pre>
    ant -Dusername=me -Dpassword=mypassword target1 target2
 </pre>

 Is slightly better, but the username/password is exposed to all users
 on an Unix system (via the ps command). The best approach is to use
 the
 <code>&lt;input&gt;</code> task and/or retrieve the password from a (secured)
 .properties file.
 </p>
 </body>
 </html>
--- a/docs/manual/optionaltasklist.html
+++ b/docs/manual/optionaltasklist.html
@@ -78,6 +78,7 @@
 <a href="OptionalTasks/sos.html">SourceOffSite</a><br/>
 <a href="OptionalTasks/splash.html">Splash</a><br/>
 <a href="OptionalTasks/sshexec.html">Sshexec</a><br/>
 <a href="OptionalTasks/sshsession.html">Sshsession</a><br/>
 <a href="OptionalTasks/starteam.html">Starteam Tasks</a><br/>
 <a href="OptionalTasks/stylebook.html"><i>Stylebook</i></a><br/>
 <a href="OptionalTasks/symlink.html">Symlink</a><br/>
--- a/src/main/org/apache/tools/ant/taskdefs/defaults.properties
+++ b/src/main/org/apache/tools/ant/taskdefs/defaults.properties
@@ -193,6 +193,7 @@ soslabel=org.apache.tools.ant.taskdefs.optional.sos.SOSLabel
 sound=org.apache.tools.ant.taskdefs.optional.sound.SoundTask
 splash=org.apache.tools.ant.taskdefs.optional.splash.SplashTask
 sshexec=org.apache.tools.ant.taskdefs.optional.ssh.SSHExec
 sshsession=org.apache.tools.ant.taskdefs.optional.ssh.SSHSession
 stcheckin=org.apache.tools.ant.taskdefs.optional.starteam.StarTeamCheckin
 stcheckout=org.apache.tools.ant.taskdefs.optional.starteam.StarTeamCheckout
 stlabel=org.apache.tools.ant.taskdefs.optional.starteam.StarTeamLabel
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.java
@@ -0,0 +1,323 @@
 /*
 *  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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  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.
 *
 */

 package org.apache.tools.ant.taskdefs.optional.ssh;

 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 import java.util.Vector;

 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.Task;
 import org.apache.tools.ant.TaskContainer;

 import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.Session;

 /**
 * Establishes an ssh session with a remote machine, optionally
 * establishing port forwarding, then executes any nested task(s)
 * before closing the session.
 * @since Ant 1.8.0
 */
 public class SSHSession extends SSHBase {

    /** units are milliseconds, default is 0=infinite */
    private long maxwait = 0;

    private Vector localTunnels = new Vector();
    private Set localPortsUsed = new TreeSet();
    private Vector remoteTunnels = new Vector();
    private Set remotePortsUsed = new TreeSet();
    private NestedSequential nestedSequential = null;

    private static final String TIMEOUT_MESSAGE =
        "Timeout period exceeded, connection dropped.";


    /** Optional Vector holding the nested tasks */
    private Vector nestedTasks = new Vector();

    /**
     * Add a nested task to Sequential.
     * <p>
     * @param nestedTask        Nested task to execute Sequential
     * <p>
     */
    public void addTask(Task nestedTask) {
        nestedTasks.addElement(nestedTask);
    }

    /**
     * The connection can be dropped after a specified number of
     * milliseconds. This is sometimes useful when a connection may be
     * flaky. Default is 0, which means &quot;wait forever&quot;.
     *
     * @param timeout  The new timeout value in seconds
     */
    public void setTimeout(long timeout) {
        maxwait = timeout;
    }

    /**
     * Changes the comma-delimited list of local tunnels to establish
     * on the connection.
     *
     * @param tunnels a comma-delimited list of lport:rhost:rport
     * tunnel specifications
     */
    public void setLocaltunnels(String tunnels) {
        String[] specs = tunnels.split(", ");
        for (int i = 0; i < specs.length; i++) {
            if (specs[i].length() > 0) {
                String[] spec = specs[i].split(":", 3);
                int lport = Integer.parseInt(spec[0]);
                String rhost = spec[1];
                int rport = Integer.parseInt(spec[2]);
                LocalTunnel tunnel = createLocalTunnel();
                tunnel.setLPort(lport);
                tunnel.setRHost(rhost);
                tunnel.setRPort(rport);
            }
        }
    }

    /**
     * Changes the comma-delimited list of remote tunnels to establish
     * on the connection.
     *
     * @param tunnels a comma-delimited list of rport:lhost:lport
     * tunnel specifications
     */
    public void setRemotetunnels(String tunnels) {
        String[] specs = tunnels.split(", ");
        for (int i = 0; i < specs.length; i++) {
            if (specs[i].length() > 0) {
                String[] spec = specs[i].split(":", 3);
                int rport = Integer.parseInt(spec[0]);
                String lhost = spec[1];
                int lport = Integer.parseInt(spec[2]);
                RemoteTunnel tunnel = createRemoteTunnel();
                tunnel.setRPort(rport);
                tunnel.setLHost(lhost);
                tunnel.setLPort(lport);
            }
        }
    }


    /**
     * Establish the ssh session and execute all nestedTasks
     *
     * @exception BuildException if one of the nested tasks fails, or
     * network error or bad parameter.
     */
    public void execute() throws BuildException {
        if (getHost() == null) {
            throw new BuildException("Host is required.");
        }
        if (getUserInfo().getName() == null) {
            throw new BuildException("Username is required.");
        }
        if (getUserInfo().getKeyfile() == null
            && getUserInfo().getPassword() == null) {
            throw new BuildException("Password or Keyfile is required.");
        }
        if (nestedSequential == null) {
            throw new BuildException("Missing sequential element.");
        }


        Session session = null;
        try {
            // establish the session
            session = openSession();
            session.setTimeout((int) maxwait);

            for (Iterator i = localTunnels.iterator(); i.hasNext();) {
                LocalTunnel tunnel = (LocalTunnel) i.next();
                session.setPortForwardingL(tunnel.getLPort(),
                                           tunnel.getRHost(),
                                           tunnel.getRPort());
            }

            for (Iterator i = remoteTunnels.iterator(); i.hasNext();) {
                RemoteTunnel tunnel = (RemoteTunnel) i.next();
                session.setPortForwardingR(tunnel.getRPort(),
                                           tunnel.getLHost(),
                                           tunnel.getLPort());
            }

            for (Iterator i = nestedSequential.getNested().iterator();
                 i.hasNext();) {
                Task nestedTask = (Task) i.next();
                nestedTask.perform();
            }
            // completed successfully

        } catch (JSchException e) {
            if (e.getMessage().indexOf("session is down") >= 0) {
                if (getFailonerror()) {
                    throw new BuildException(TIMEOUT_MESSAGE, e);
                } else {
                    log(TIMEOUT_MESSAGE, Project.MSG_ERR);
                }
            } else {
                if (getFailonerror()) {
                    throw new BuildException(e);
                } else {
                    log("Caught exception: " + e.getMessage(),
                        Project.MSG_ERR);
                }
            }
        } catch (BuildException e) {
            // avoid wrapping it into yet another BuildException further down
            throw e;
        } catch (Exception e) {
            if (getFailonerror()) {
                throw new BuildException(e);
            } else {
                log("Caught exception: " + e.getMessage(), Project.MSG_ERR);
            }
        } finally {
            if (session != null && session.isConnected()) {
                session.disconnect();
            }
        }
    }

    public LocalTunnel createLocalTunnel() {
        LocalTunnel tunnel = new LocalTunnel();
        localTunnels.add(tunnel);
        return tunnel;
    }

    public RemoteTunnel createRemoteTunnel() {
        RemoteTunnel tunnel = new RemoteTunnel();
        remoteTunnels.add(tunnel);
        return tunnel;
    }

    public class LocalTunnel {
        public LocalTunnel() {}

        int lport = 0;
        String rhost = null;
        int rport = 0;
        public void setLPort(int lport) {
            Integer portKey = new Integer(lport);
            if (localPortsUsed.contains(portKey))
                throw new BuildException("Multiple local tunnels defined to"
                                         + " use same local port " + lport);
            localPortsUsed.add(portKey);
            this.lport = lport;
        }
        public void setRHost(String rhost) { this.rhost = rhost; }
        public void setRPort(int rport) { this.rport = rport; }
        public int getLPort() {
            if (lport == 0) throw new BuildException("lport is required for"
                                                     + " LocalTunnel.");
            return lport;
        }
        public String getRHost() {
            if (rhost == null) throw new BuildException("rhost is required"
                                                        + " for LocalTunnel.");
            return rhost;
        }
        public int getRPort() {
            if (rport == 0) throw new BuildException("rport is required for"
                                                     + " LocalTunnel.");
            return rport;
        }
    }

    public class RemoteTunnel {
        public RemoteTunnel() {}

        int lport = 0;
        String lhost = null;
        int rport = 0;
        public void setLPort(int lport) { this.lport = lport; }
        public void setLHost(String lhost) { this.lhost = lhost; }
        public void setRPort(int rport) {
            Integer portKey = new Integer(rport);
            if (remotePortsUsed.contains(portKey))
                throw new BuildException("Multiple remote tunnels defined to"
                                         + " use same remote port " + rport);
            remotePortsUsed.add(portKey);
            this.rport = rport;
        }
        public int getLPort() {
            if (lport == 0) throw new BuildException("lport is required for"
                                                     + " RemoteTunnel.");
            return lport;
        }
        public String getLHost() {
            if (lhost == null) throw new BuildException("lhost is required for"
                                                        + " RemoteTunnel.");
            return lhost;
        }
        public int getRPort() {
            if (rport == 0) throw new BuildException("rport is required for"
                                                     + " RemoteTunnel.");
            return rport;
        }
    }

    /**
     * This is the sequential nested element of the macrodef.
     *
     * @return a sequential element to be configured.
     */
    public NestedSequential createSequential() {
        if (this.nestedSequential != null) {
            throw new BuildException("Only one sequential allowed");
        }
        this.nestedSequential = new NestedSequential();
        return this.nestedSequential;
    }

    /**
     * The class corresponding to the sequential nested element.
     * This is a simple task container.
     */
    public static class NestedSequential implements TaskContainer {
        private List nested = new ArrayList();

        /**
         * Add a task or type to the container.
         *
         * @param task an unknown element.
         */
        public void addTask(Task task) {
            nested.add(task);
        }

        /**
         * @return the list of unknown elements
         */
        public List getNested() {
            return nested;
        }
    }

 }