Merge pull request jenkinsci#48 from jglick/exec-only

Delete non-exec-based agent factories

Author: alecharp

README.md

@@ -3,13 +3,14 @@
 This plugin allows you to provide SSH credentials to builds via a
 ssh-agent in Jenkins.
 
+This is convenient in some cases.
+Alternately, you can use the generic `withCredentials` step to bind an SSH private key to a temporary file
+and then pass that to commands that require it,
+for example using the `-i` option to `ssh` or `scp`.
+
 # Requirements
 
-Currently all **Windows** nodes (including the master) on which this
-plugin will be used must have the [Apache Tomcat Native
-libraries](http://tomcat.apache.org/native-doc/)
-installed. As of 1.0 should be unnecessary for Unix nodes. As of 1.14
-unnecessary if `ssh-agent` is installed.
+You need to have the `ssh-agent` executable installed on the agent.
 
 # Configuring
 
@@ -31,67 +32,6 @@ And then your build will have those credentials available, e.g.
 
 From a Pipeline job, use the `sshagent` step.
 
-# Installation Example: MacOSX (10.7.5)
-
-**Irrelevant in 1.14+ when `ssh-agent` is available in the path.**
-
-Prerequisites:
-
--   JDK7. The tomcat native libraries target the java 7 version.
--   APR - this seems to be preinstalled in /usr/lib/apr.
-
-Note that tomcat itself is not needed. This works fine with winstone
-(just running jenkins jar from command line).
-
-Download and extract the tomcat native
-library: <http://tomcat.apache.org/download-native.cgi>
-
-    tar -zxvf tomcat-native-1.1.XX-src.tar.gz
-
-Build the native library:
-
-    cd tomcat-native-1.1.XX/jni/native
-
-    ./configure --with-apr=/usr/bin/apr-1-config
-
-    make && sudo make install
-
-Build the java interface:
-
-    cd ..
-    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_17.jdk/Contents/Home
-
-    ant build
-
-    ant jar
-
-Copy the output jar somewhere suitable for inclusion in your jenkins
-CLASSPATH.
-
-Set environment variables prior to starting jenkins:
-
-    export DYLD_LIBRARY_PATH=/usr/local/apr/lib
-    export CLASSPATH=/path/to/tomcat-native-1.1.XX.jar
-    java -jar jenkins.war
-
-Additionally, you might have to add bouncycastle to your JCE providers.
-If you attempt to use the plugin and get an exception like the
-following:
-
-    java.lang.IllegalStateException: BouncyCastle must be registered as a JCE provider
-
-Then you may need to configure the jce provider. One way is to do this
-right in the JRE, so if Jenkins is using the same jdk as above, edit
-
-/Library/Java/JavaVirtualMachines/jdk1.7.0\_17.jdk/Contents/Home/jre/lib/security/java.security,
-and add the following line:
-
-    security.provider.11=org.bouncycastle.jce.provider.BouncyCastleProvider
-
-Then, restart jenkins.
-
-From there, configure using the instructions above.
-
 # Version History
 
 For new versions, see [GitHub releases](https://github.com/jenkinsci/ssh-agent-plugin/releases).

pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>4.12</version>
+    <version>4.16</version>
     <relativePath />
   </parent>
 
@@ -78,21 +78,6 @@
 
   <dependencies>
     <!-- regular dependencies -->
-    <dependency>
-      <groupId>org.apache.sshd</groupId>
-      <artifactId>sshd-core</artifactId>
-      <version>1.7.0</version>
-    </dependency>
-    <dependency>
-      <groupId>tomcat</groupId>
-      <artifactId>tomcat-apr</artifactId>
-      <version>5.5.23</version>
-    </dependency>
-    <dependency>
-      <groupId>com.cloudbees.util</groupId>
-      <artifactId>jnr-unixsocket-nodep</artifactId>
-      <version>0.3.1</version>
-    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins.workflow</groupId>
       <artifactId>workflow-step-api</artifactId>
@@ -107,11 +92,6 @@
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>ssh-credentials</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.jenkins-ci.plugins</groupId>
-      <artifactId>bouncycastle-api</artifactId>
-      <version>2.16.3</version>
-    </dependency>
     <!-- jenkins dependencies -->
     <!-- test dependencies -->
     <dependency>
@@ -142,7 +122,7 @@
       <dependency>
         <groupId>io.jenkins.tools.bom</groupId>
         <artifactId>bom-2.222.x</artifactId>
-        <version>20</version>
+        <version>26</version>
         <scope>import</scope>
         <type>pom</type>
       </dependency>
@@ -152,13 +132,10 @@
   <build>
     <plugins>
       <plugin>
-        <!-- critical because sshd needs to be loaded first, otherwise will just bail out -->
-        <!-- https://www.jenkins.io/doc/developer/plugin-development/dependencies-and-class-loading/ -->
         <groupId>org.jenkins-ci.tools</groupId>
         <artifactId>maven-hpi-plugin</artifactId>
         <extensions>true</extensions>
         <configuration>
-          <pluginFirstClassLoader>true</pluginFirstClassLoader>
           <compatibleSinceVersion>1.5</compatibleSinceVersion>
         </configuration>
       </plugin>

src/main/java/com/cloudbees/jenkins/plugins/sshagent/RemoteHelper.java

@@ -147,6 +147,7 @@ private void initRemoteAgent() throws IOException, InterruptedException {
             listener.getLogger().println(Messages.SSHAgentBuildWrapper_UsingCredentials(SSHAgentBuildWrapper.description(userPrivateKey)));
         }
 
+        // TODO UI could be streamlined now that there is only one impl
         listener.getLogger().println("[ssh-agent] Looking for ssh-agent implementation...");
         Map<String, Throwable> faults = new LinkedHashMap<String, Throwable>();
         for (RemoteAgentFactory factory : Jenkins.getActiveInstance().getExtensionList(RemoteAgentFactory.class)) {