Added support to openssh config file

Author: Federico Fissore

app/src/cc/arduino/packages/DiscoveryManager.java

@@ -73,9 +73,19 @@ public void run() {
 
   public List<BoardPort> discovery() {
     List<BoardPort> res = new ArrayList<BoardPort>();
-    for (Discovery d : discoverers)
+    for (Discovery d : discoverers) {
       res.addAll(d.discovery());
+    }
     return res;
   }
 
+  public BoardPort find(String address) {
+    for (BoardPort boardPort : discovery()) {
+      if (boardPort.getAddress().equals(address)) {
+        return boardPort;
+      }
+    }
+    return null;
+  }
+
 }

app/src/cc/arduino/packages/UploaderAndMonitorFactory.java

@@ -31,21 +31,24 @@
 
 import cc.arduino.packages.uploaders.SSHUploader;
 import cc.arduino.packages.uploaders.SerialUploader;
-import processing.app.*;
+import processing.app.AbstractMonitor;
+import processing.app.Base;
+import processing.app.NetworkMonitor;
+import processing.app.SerialMonitor;
 import processing.app.debug.TargetBoard;
 
 public class UploaderAndMonitorFactory {
 
-  public Uploader newUploader(TargetBoard board, String port) {
-    if ("true".equals(board.getPreferences().get("upload.via_ssh")) && Constants.IPV4_ADDRESS.matcher(port).find()) {
+  public Uploader newUploader(TargetBoard board, BoardPort port) {
+    if ("true".equals(board.getPreferences().get("upload.via_ssh")) && "network".equals(port.getProtocol())) {
       return new SSHUploader(port);
     }
 
     return new SerialUploader();
   }
 
-  public AbstractMonitor newMonitor(String port, Base base) {
-    if (Constants.IPV4_ADDRESS.matcher(port).find()) {
+  public AbstractMonitor newMonitor(BoardPort port, Base base) {
+    if ("network".equals(port.getProtocol())) {
       return new NetworkMonitor(port, base);
     }
 

app/src/cc/arduino/packages/discoverers/NetworkDiscovery.java

@@ -31,7 +31,7 @@
 
 import cc.arduino.packages.BoardPort;
 import cc.arduino.packages.Discovery;
-import cc.arduino.packages.discoverers.network.NetworkChecker;
+import cc.arduino.packages.discoverers.network.*;
 import processing.app.Base;
 import processing.app.helpers.NetUtils;
 import processing.app.helpers.PreferencesMap;

app/src/cc/arduino/packages/ssh/NoInteractionUserInfo.java

@@ -0,0 +1,36 @@
+package cc.arduino.packages.ssh;
+
+import com.jcraft.jsch.UserInfo;
+
+public class NoInteractionUserInfo implements UserInfo {
+
+  private final String password;
+
+  public NoInteractionUserInfo(String password) {
+    this.password = password;
+  }
+
+  public String getPassword() {
+    return password;
+  }
+
+  public boolean promptYesNo(String str) {
+    return true;
+  }
+
+  public String getPassphrase() {
+    return password;
+  }
+
+  public boolean promptPassphrase(String message) {
+    return true;
+  }
+
+  public boolean promptPassword(String message) {
+    return true;
+  }
+
+  public void showMessage(String message) {
+  }
+
+}

app/src/cc/arduino/packages/uploaders/ssh/SCP.java renamed to app/src/cc/arduino/packages/ssh/SCP.java

@@ -27,11 +27,10 @@
  * Copyright 2013 Arduino LLC (http://www.arduino.cc/)
  */
 
-package cc.arduino.packages.uploaders.ssh;
+package cc.arduino.packages.ssh;
 
 import com.jcraft.jsch.Channel;
 import com.jcraft.jsch.ChannelExec;
-import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.Session;
 
 import java.io.*;

app/src/cc/arduino/packages/uploaders/ssh/SSH.java renamed to app/src/cc/arduino/packages/ssh/SSH.java

@@ -27,7 +27,7 @@
  * Copyright 2013 Arduino LLC (http://www.arduino.cc/)
  */
 
-package cc.arduino.packages.uploaders.ssh;
+package cc.arduino.packages.ssh;
 
 import com.jcraft.jsch.Channel;
 import com.jcraft.jsch.ChannelExec;

app/src/cc/arduino/packages/ssh/SSHClientSetupChainRing.java

@@ -0,0 +1,17 @@
+package cc.arduino.packages.ssh;
+
+import cc.arduino.packages.BoardPort;
+import com.jcraft.jsch.JSch;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.Session;
+
+import java.io.IOException;
+
+public interface SSHClientSetupChainRing {
+
+  /*
+  Chain is actually useless as default JSCH behaviour is to follow SSH Server authentication methods list
+   */
+  Session setup(BoardPort port, JSch jSch) throws JSchException, IOException;
+
+}

app/src/cc/arduino/packages/ssh/SSHConfigFileSetup.java

@@ -0,0 +1,93 @@
+package cc.arduino.packages.ssh;
+
+import cc.arduino.packages.BoardPort;
+import com.jcraft.jsch.*;
+
+import java.io.File;
+import java.io.IOException;
+
+public class SSHConfigFileSetup implements SSHClientSetupChainRing {
+
+  private final SSHClientSetupChainRing nextChainRing;
+
+  public SSHConfigFileSetup(SSHClientSetupChainRing nextChainRing) {
+    this.nextChainRing = nextChainRing;
+  }
+
+  public Session setup(BoardPort port, JSch jSch) throws JSchException, IOException {
+    String ipAddress = port.getAddress();
+    String hostname = port.getBoardName().contains(".local") ? port.getBoardName() : port.getBoardName() + ".local";
+
+    File sshFolder = new File(System.getProperty("user.home"), ".ssh");
+    File sshConfig = new File(sshFolder, "config");
+
+    if (!sshFolder.exists() || !sshConfig.exists()) {
+      if (nextChainRing != null) {
+        return nextChainRing.setup(port, jSch);
+      }
+      throw new JSchException("Unable to find a way to connect");
+    }
+
+    OpenSSHConfig configRepository = OpenSSHConfig.parseFile(sshConfig.getAbsolutePath());
+
+    jSch.setConfigRepository(new OpenSSHConfigWrapper(configRepository, ipAddress));
+
+    return jSch.getSession(hostname);
+  }
+
+  public static class OpenSSHConfigWrapper implements ConfigRepository {
+
+    private final OpenSSHConfig config;
+    private final String ipAddress;
+
+    public OpenSSHConfigWrapper(OpenSSHConfig config, String ipAddress) {
+      this.config = config;
+      this.ipAddress = ipAddress;
+    }
+
+    @Override
+    public Config getConfig(String host) {
+      return new ConfigWrapper(config.getConfig(host), ipAddress);
+    }
+  }
+
+  public static class ConfigWrapper implements ConfigRepository.Config {
+
+    private final ConfigRepository.Config config;
+    private final String ipAddress;
+
+    public ConfigWrapper(OpenSSHConfig.Config config, String ipAddress) {
+      this.config = config;
+      this.ipAddress = ipAddress;
+    }
+
+    @Override
+    public String getHostname() {
+      return ipAddress;
+    }
+
+    @Override
+    public String getUser() {
+      String user = config.getUser();
+      if (user != null) {
+        return user;
+      }
+      return "root";
+    }
+
+    @Override
+    public int getPort() {
+      return config.getPort();
+    }
+
+    @Override
+    public String getValue(String key) {
+      return config.getValue(key);
+    }
+
+    @Override
+    public String[] getValues(String key) {
+      return config.getValues(key);
+    }
+  }
+}

app/src/cc/arduino/packages/ssh/SSHPwdSetup.java

@@ -0,0 +1,21 @@
+package cc.arduino.packages.ssh;
+
+import cc.arduino.packages.BoardPort;
+import com.jcraft.jsch.JSch;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.Session;
+import processing.app.Preferences;
+
+public class SSHPwdSetup implements SSHClientSetupChainRing {
+
+  @Override
+  public Session setup(BoardPort port, JSch jSch) throws JSchException {
+    String ipAddress = port.getAddress();
+
+    Session session = jSch.getSession("root", ipAddress, 22);
+    session.setPassword(Preferences.get("runtime.pwd." + ipAddress));
+
+    return session;
+  }
+
+}

app/src/cc/arduino/packages/uploaders/SSHUploader.java

@@ -29,15 +29,13 @@
 
 package cc.arduino.packages.uploaders;
 
+import cc.arduino.packages.BoardPort;
 import cc.arduino.packages.Uploader;
-import cc.arduino.packages.uploaders.ssh.SCP;
-import cc.arduino.packages.uploaders.ssh.SSH;
+import cc.arduino.packages.ssh.*;
 import com.jcraft.jsch.JSch;
 import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.Session;
 import processing.app.Base;
-import processing.app.Constants;
-import processing.app.NetworkMonitor;
 import processing.app.Preferences;
 import processing.app.debug.RunnerException;
 import processing.app.debug.TargetPlatform;
@@ -48,30 +46,26 @@
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
-import java.util.regex.Matcher;
 
 import static processing.app.I18n._;
 
 public class SSHUploader extends Uploader {
 
   private static final List<String> FILES_NOT_TO_COPY = Arrays.asList(".DS_Store", ".Trash", "Thumbs.db", "__MACOSX");
 
-  private final String ipAddress;
+  private final BoardPort port;
 
-  public SSHUploader(String port) {
-    Matcher matcher = Constants.IPV4_ADDRESS.matcher(port);
-    if (!matcher.find()) {
-      throw new IllegalArgumentException(port);
-    }
-    ipAddress = matcher.group();
+  public SSHUploader(BoardPort port) {
+    this.port = port;
   }
 
   public boolean requiresAuthorization() {
     return true;
   }
 
+  @Override
   public String getAuthorizationKey() {
-    return "runtime.pwd." + ipAddress;
+    return "runtime.pwd." + port.getAddress();
   }
 
   @Override
@@ -84,10 +78,10 @@ public boolean uploadUsingPreferences(File sourcePath, String buildPath, String
     SCP scp = null;
     try {
       JSch jSch = new JSch();
-      session = jSch.getSession("root", ipAddress, 22);
-      session.setPassword(Preferences.get(getAuthorizationKey()));
+      SSHClientSetupChainRing sshClientSetupChain = new SSHConfigFileSetup(new SSHPwdSetup());
+      session = sshClientSetupChain.setup(port, jSch);
 
-      session.setUserInfo(new NetworkMonitor.NoInteractionUserInfo());
+      session.setUserInfo(new NoInteractionUserInfo(Preferences.get("runtime.pwd." + port.getAddress())));
       session.connect(30000);
 
       scp = new SCP(session);
@@ -97,7 +91,8 @@ public boolean uploadUsingPreferences(File sourcePath, String buildPath, String
 
       return runAVRDude(ssh);
     } catch (JSchException e) {
-      if ("Auth cancel".equals(e.getMessage())) {
+      String message = e.getMessage();
+      if ("Auth cancel".equals(message) || "Auth fail".equals(message)) {
         return false;
       }
       throw new RunnerException(e);