Handle absolute paths to SSH identity files

The list of private keys in Eclipse may contain absolute paths. Only
resolve relative paths relative to the configured SSH2 home directory.

Bug: 548121
Change-Id: I7ace545e2736c451b625699d07cba438f0e3934b
Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>

2 files changed, 80 insertions, 3 deletions

diff --git a/org.eclipse.egit.core.test/src/org/eclipse/egit/core/internal/SshPreferencesMirrorTest.java b/org.eclipse.egit.core.test/src/org/eclipse/egit/core/internal/SshPreferencesMirrorTest.java
new file mode 100644
index 0000000000..7fed0e9289
--- /dev/null
+++ b/org.eclipse.egit.core.test/src/org/eclipse/egit/core/internal/SshPreferencesMirrorTest.java
@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright (C) 2019 Thomas Wolf <thomas.wolf@paranor.ch>
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package org.eclipse.egit.core.internal;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+
+import org.eclipse.core.runtime.preferences.IEclipsePreferences;
+import org.eclipse.core.runtime.preferences.InstanceScope;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+
+public class SshPreferencesMirrorTest {
+
+	@Rule
+	public TemporaryFolder tmp = new TemporaryFolder();
+
+	@Before
+	public void prepareMirror() throws Exception {
+		SshPreferencesMirror.INSTANCE.start();
+	}
+
+	@After
+	public void resetPreferences() throws Exception {
+		set("PRIVATEKEY", null);
+	}
+
+	private void set(String key, String value) throws Exception {
+		IEclipsePreferences preferences = InstanceScope.INSTANCE
+				.getNode("org.eclipse.jsch.core");
+		if (value == null) {
+			preferences.remove(key);
+		} else {
+			preferences.put(key, value);
+		}
+		preferences.flush();
+	}
+
+	@Test
+	public void testAbsoluteKeyPath() throws Exception {
+		File fakeSshHome = tmp.newFolder("faks_ssh_home");
+		File otherDirectory = tmp.newFolder("other");
+		File fakeDefaultKey = File.createTempFile("id_", "key", fakeSshHome);
+		File fakeOtherKey = File.createTempFile("other", "key", otherDirectory);
+		set("PRIVATEKEY", fakeDefaultKey.getName() + ','
+				+ fakeOtherKey.getAbsolutePath());
+		assertEquals(
+				'[' + fakeDefaultKey.getAbsolutePath() + ", "
+						+ fakeOtherKey.getAbsolutePath() + ']',
+				SshPreferencesMirror.INSTANCE.getDefaultIdentities(fakeSshHome)
+						.toString());
+	}
+}
diff --git a/org.eclipse.egit.core/src/org/eclipse/egit/core/internal/SshPreferencesMirror.java b/org.eclipse.egit.core/src/org/eclipse/egit/core/internal/SshPreferencesMirror.java
index dcfafbca3e..8c73aab60e 100644
--- a/org.eclipse.egit.core/src/org/eclipse/egit/core/internal/SshPreferencesMirror.java
+++ b/org.eclipse.egit.core/src/org/eclipse/egit/core/internal/SshPreferencesMirror.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
+ * Copyright (C) 2018, 2019 Thomas Wolf <thomas.wolf@paranor.ch>
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -58,12 +58,18 @@ public class SshPreferencesMirror {
 
 	private String defaultMechanisms;
 
+	private boolean started;
+
 	private SshPreferencesMirror() {
 		// This is a singleton.
 	}
 
 	/** Starts mirroring the ssh preferences. */
 	public void start() {
+		if (started) {
+			return;
+		}
+		started = true;
 		preferences = InstanceScope.INSTANCE.getNode(PREFERENCES_NODE);
 		if (preferences != null) {
 			preferences.addPreferenceChangeListener(listener);
@@ -73,6 +79,7 @@ public class SshPreferencesMirror {
 
 	/** Stops mirroring the ssh preferences. */
 	public void stop() {
+		started = false;
 		if (preferences != null) {
 			preferences.removePreferenceChangeListener(listener);
 		}
@@ -168,8 +175,13 @@ public class SshPreferencesMirror {
 				return null;
 			}
 			return defaultIdentities.stream()
-					.map(s -> new File(sshDir, s).toPath())
-					.filter(Files::exists).collect(Collectors.toList());
+					.map(s -> {
+						File f = new File(s);
+						if (!f.isAbsolute()) {
+							f = new File(sshDir, s);
+						}
+						return f.toPath();
+					}).filter(Files::exists).collect(Collectors.toList());
 		}
 	}