feat: new launcher using Apache Mina sshd library

.editorconfig

@@ -9,6 +9,14 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+[*.java]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
 [Jenkinsfile*]
 indent_style = space
 indent_size = 2

Jenkinsfile

@@ -6,5 +6,5 @@ buildPlugin(
   useContainerAgent: false, // TestContainers
   configurations: [
     [platform: 'linux', jdk: 21],
-    [platform: 'windows', jdk: 17],
+    [platform: 'windows', jdk: 21],
 ])

pom.xml

@@ -93,19 +93,48 @@
         <version>4924.v6b_eb_a_79a_d9d0</version>
         <type>pom</type>
         <scope>import</scope>
+        <exclusions>
+          <exclusion>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>trilead-api</artifactId>
+          </exclusion>
+        </exclusions>
       </dependency>
     </dependencies>
   </dependencyManagement>
 
   <dependencies>
+    <dependency>
+      <groupId>io.jenkins.plugins</groupId>
+      <artifactId>eddsa-api</artifactId>
+    </dependency>
+    <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>
     </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>ssh-credentials</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>org.jenkins-ci.plugins</groupId>
+          <artifactId>trilead-api</artifactId>
+        </exclusion>
+      </exclusions>
     </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,164 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, Michael Clarke
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+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.
+ *
+ * @author Ivan Fernandez Calvo
+ */
+public interface Connection extends AutoCloseable {
+    /**
+     * Execute a command and return the error code returned when it finish.
+     *
+     * @param command Command to execute.
+     * @return The error code returned by the command.
+     * @throws IOException in case of error.
+     */
+    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();
+
+    /** Close the connections and resources associated. */
+    void close();
+
+    /**
+     * Copy a file to the host by SCP. It does not create folders, so the folders of the path should
+     * exist.
+     *
+     * @param remoteFile Full path to the remote file.
+     * @param bytes Array of bytes with the data to write.
+     * @param overwrite True to overwrite exit files.
+     * @param checkSameContent True to check the md5 of the file before write it and do not update the
+     *     lie if it is the same.
+     * @throws IOException
+     */
+    void copyFile(String remoteFile, byte[] bytes, boolean overwrite, boolean checkSameContent) throws IOException;
+
+    /**
+     * Set server host key Algorithms.
+     *
+     * @param algorithms Array of Host Key Algorithms.
+     */
+    void setServerHostKeyAlgorithms(String[] algorithms);
+
+    /**
+     * 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,39 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, Michael Clarke
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.io.IOException;
+
+/**
+ * Class to manage key algorithms for SSH connections.
+ *
+ * @author Ivan Fernandez Calvo
+ */
+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,36 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, Michael Clarke
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+import java.util.List;
+
+/**
+ * Interface to manage supported key algorithms for SSH connections.
+ *
+ * @author Ivan Fernandez Calvo
+ */
+public interface KeyAlgorithmManager {
+
+    List<KeyAlgorithm> getSupportedAlgorithms();
+}

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

@@ -0,0 +1,51 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, Michael Clarke
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+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.
+ *
+ * @author Ivan Fernandez Calvo
+ */
+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,32 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, Michael Clarke
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package io.jenkins.plugins.sshbuildagents.ssh;
+
+/**
+ * Interface to verify the server host key during SSH connections. TODO Implement a proper host key
+ * verification mechanism.
+ *
+ * @author Ivan Fernandez Calvo
+ */
+public interface ServerHostKeyVerifier {}