feat: new launcher using Apache Mina sshd library

pom.xml

@@ -98,6 +98,18 @@
   </dependencyManagement>
 
   <dependencies>
+    <dependency>
+      <groupId>io.jenkins.plugins.mina-sshd-api</groupId>
+      <artifactId>mina-sshd-api-common</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.jenkins.plugins.mina-sshd-api</groupId>
+      <artifactId>mina-sshd-api-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.jenkins.plugins.mina-sshd-api</groupId>
+      <artifactId>mina-sshd-api-scp</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>credentials</artifactId>
@@ -106,6 +118,7 @@
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>ssh-credentials</artifactId>
     </dependency>
+    <!-- TODO remove in future versions -->
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>trilead-api</artifactId>

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/Connection.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
+import java.io.IOException;
+import java.io.OutputStream;
+import org.apache.sshd.client.session.ClientSession;
+
+/**
+ * Interface to manage an SSH connection.
+ *
+ */
+public interface Connection extends AutoCloseable {
+    /**
+     * Execute a command and return the exit code returned when it finish.
+     *
+     * @param command Command to execute.
+     * @return The exit code of the command (if the command ran).
+     * @throws IOException in case of an error launching the command.
+     */
+    int execCommand(String command) throws IOException;
+
+    /**
+     * Create a {@link ShellChannel} to execute non-interactive commands.
+     *
+     * @return Return a {@link ShellChannel}
+     * @throws IOException
+     */
+    ShellChannel shellChannel() throws IOException;
+
+    /**
+     * @return Return the host configured to connect by SSH.
+     */
+    String getHostname();
+
+    /**
+     * @return Return the port configured to connect by SSH.
+     */
+    int getPort();
+
+    /**
+     * Copy a file to the host by SCP. It does not create folders, so the folders of the path must
+     * exist prior to calling this.
+     * FIXME The remote file should be relative to the working directory.
+     * FIXME use SHA instead of MD5 to check the content of the file, it is no longer in the JDK.
+     * @param remoteFile Full path to the remote file.
+     * @param data Array of bytes with the data to write.
+     * @param overwrite @{code true} to overwrite the file if it already exists.  If @{false} and the file exists an @{code IOException} will be thrown.
+     * @param checkSameContent if true will calculate and compare the checksum of the remote file and data and if identical will skip writing the file.
+     * @throws IOException
+     */
+    void copyFile(String remoteFile, byte[] data, boolean overwrite, boolean checkSameContent) throws IOException;
+
+    /**
+     * Set the TCP_NODELAY flag on connections.
+     *
+     * @param tcpNoDelay True to set TCP_NODELAY.
+     */
+    void setTCPNoDelay(boolean tcpNoDelay);
+
+    /**
+     * Establishes an SSH connection with the configuration set in the class.
+     *
+     * @return Return a {@link ClientSession} to interact with the SSH connection.
+     * @throws IOException
+     */
+    ClientSession connect() throws IOException;
+
+    /**
+     * Set Server host verifier.
+     *
+     * @param verifier The Server host verifier to use.
+     */
+    void setServerHostKeyVerifier(ServerHostKeyVerifier verifier);
+
+    /**
+     * Set the connection timeout.
+     *
+     * @param timeout Timeout in milliseconds.
+     */
+    void setTimeout(long timeout);
+
+    /**
+     * Set the credential to use to authenticate in the SSH service.
+     *
+     * @param credentials Credentials used to authenticate.
+     */
+    void setCredentials(StandardUsernameCredentials credentials);
+
+    /**
+     * Set the time to wait between retries.
+     *
+     * @param time Time to wait in seconds.
+     */
+    void setRetryWaitTime(int time);
+
+    /**
+     * Set the number of times we will retry the SSH connection.
+     *
+     * @param retries Number of retries.
+     */
+    void setRetries(int retries);
+
+    /**
+     * Set the absolute path to the working directory.
+     *
+     * @param path absolute path to the working directory.
+     */
+    void setWorkingDirectory(String path);
+
+    /**
+     * Set the standard error output.
+     *
+     * @param stderr Value of the new standard error output.
+     */
+    void setStdErr(OutputStream stderr);
+
+    /**
+     * Set the standard output.
+     *
+     * @param stdout Value of the new standard output.
+     */
+    void setStdOut(OutputStream stdout);
+
+    /**
+     * Check if the connection is open.
+     *
+     * @return True if the connection is open, false otherwise.
+     */
+    boolean isOpen();
+}

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/KeyAlgorithm.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.io.IOException;
+
+/**
+ * Class to manage key algorithms for SSH connections.
+ *
+ */
+public class KeyAlgorithm {
+    public String getKeyFormat() {
+        return "";
+    }
+
+    public void decodePublicKey(byte[] keyValue) throws IOException {}
+}

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/KeyAlgorithmManager.java

@@ -0,0 +1,16 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.util.List;
+
+/**
+ * Interface to manage supported key algorithms for SSH connections.
+ *
+ */
+public interface KeyAlgorithmManager {
+
+    List<KeyAlgorithm> getSupportedAlgorithms();
+}

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/KnownHosts.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.io.File;
+
+/**
+ * Class to manage known hosts for SSH connections. It provides methods to verify host keys and
+ * manage known hosts files. TODO Implement a proper host key verification mechanism.
+ *
+ */
+public class KnownHosts {
+    public static final int HOSTKEY_IS_OK = 0;
+    public static final int HOSTKEY_IS_NEW = 1;
+
+    public KnownHosts(File knownHostsFile) {}
+
+    public static String createHexFingerprint(String algorithm, byte[] key) {
+        return "";
+    }
+
+    public int verifyHostkey(String host, String algorithm, byte[] key) {
+        return 1;
+    }
+
+    public String[] getPreferredServerHostkeyAlgorithmOrder(String host) {
+        return new String[0];
+    }
+}

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/ServerHostKeyVerifier.java

@@ -0,0 +1,12 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+/**
+ * Interface to verify the server host key during SSH connections. TODO Implement a proper host key
+ * verification mechanism.
+ *
+ */
+public interface ServerHostKeyVerifier {}

src/main/java/io/jenkins/plugins/sshbuildagents/ssh/ShellChannel.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: MIT
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+/**
+ * Interface to manage non-interactive sessions.
+ * TODO review names for interactive and non-interactive sessions. Mina uses ShellChannel for interactive and ExecChannel for non-interactive.
+ *
+ */
+public interface ShellChannel extends AutoCloseable {
+    /**
+     * Execute a command in a non-interactive session and return without waiting for the command to complete.
+     *
+     * @param cmd
+     * @throws IOException
+     */
+    void execCommand(String cmd) throws IOException;
+
+    /**
+     * @return The standard output of the process launched in a InputStream for reading.
+     */
+    InputStream getInvertedStdout();
+
+    /**
+     * @return The standard input of the process launched in a OutputStream for writting.
+     */
+    OutputStream getInvertedStdin();
+
+    /**
+     * @return the last error in the channel.
+     */
+    Throwable getLastError();
+
+    /**
+     * @return the last command received in the SSH channel.
+     */
+    String getLastAttemptedCommand();
+}