Prompt for passwords from the console in jgit command line tools

If we are on a Java 6 JVM we should have the Console class available,
unless the user has redirected /dev/null to stdin.  When there is a
console present we would prefer to use that for command line prompts
as that is what the user expects from a command line tool.

Change-Id: Ibaf87bb5540371d94d96d1b7e94ca002f752e5bd
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

2 files changed, 239 insertions, 0 deletions

diff --git a/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleAuthenticator.java b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleAuthenticator.java
new file mode 100644
index 0000000000..84fd520f75
--- /dev/null
+++ b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleAuthenticator.java
@@ -0,0 +1,94 @@
+/*
+ * Copyright (C) 2009, Google Inc.
+ * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.eclipse.jgit.console;
+
+import java.io.Console;
+import java.net.Authenticator;
+import java.net.PasswordAuthentication;
+
+import org.eclipse.jgit.util.CachedAuthenticator;
+
+/** Basic network prompt for username/password when using the console. */
+public class ConsoleAuthenticator extends CachedAuthenticator {
+	/** Install this authenticator implementation into the JVM. */
+	public static void install() {
+		final ConsoleAuthenticator c = new ConsoleAuthenticator();
+		if (c.cons == null)
+			throw new NoClassDefFoundError("No System.console available");
+		Authenticator.setDefault(c);
+	}
+
+	private final Console cons = System.console();
+
+	@Override
+	protected PasswordAuthentication promptPasswordAuthentication() {
+		final String realm = formatRealm();
+		String username = cons.readLine("Username for %s: ", realm);
+		if (username == null || username.isEmpty()) {
+			return null;
+		}
+		char[] password = cons.readPassword("Password: ");
+		if (password == null) {
+			password = new char[0];
+		}
+		return new PasswordAuthentication(username, password);
+	}
+
+	private String formatRealm() {
+		final StringBuilder realm = new StringBuilder();
+		if (getRequestorType() == RequestorType.PROXY) {
+			realm.append(getRequestorType());
+			realm.append(" ");
+			realm.append(getRequestingHost());
+			if (getRequestingPort() > 0) {
+				realm.append(":");
+				realm.append(getRequestingPort());
+			}
+		} else {
+			realm.append(getRequestingURL());
+		}
+		return realm.toString();
+	}
+}
diff --git a/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleSshSessionFactory.java b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleSshSessionFactory.java
new file mode 100644
index 0000000000..7d36dded48
--- /dev/null
+++ b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleSshSessionFactory.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright (C) 2009, Google Inc.
+ * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
+ * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.eclipse.jgit.console;
+
+import java.io.Console;
+
+import org.eclipse.jgit.transport.OpenSshConfig;
+import org.eclipse.jgit.transport.SshConfigSessionFactory;
+import org.eclipse.jgit.transport.SshSessionFactory;
+
+import com.jcraft.jsch.Session;
+import com.jcraft.jsch.UIKeyboardInteractive;
+import com.jcraft.jsch.UserInfo;
+
+/**
+ * Loads known hosts and private keys from <code>$HOME/.ssh</code>.
+ * <p>
+ * This is the default implementation used by JGit and provides most of the
+ * compatibility necessary to match OpenSSH, a popular implementation of SSH
+ * used by C Git.
+ * <p>
+ * If user interactivity is required by SSH (e.g. to obtain a password) the
+ * system console is used to display a prompt to the end-user.
+ */
+public class ConsoleSshSessionFactory extends SshConfigSessionFactory {
+	/** Install this session factory implementation into the JVM. */
+	public static void install() {
+		final ConsoleSshSessionFactory c = new ConsoleSshSessionFactory();
+		if (c.cons == null)
+			throw new NoClassDefFoundError("No System.console available");
+		SshSessionFactory.setInstance(c);
+	}
+
+	private final Console cons = System.console();
+
+	@Override
+	protected void configure(final OpenSshConfig.Host hc, final Session session) {
+		if (!hc.isBatchMode())
+			session.setUserInfo(new ConsoleUserInfo());
+	}
+
+	private class ConsoleUserInfo implements UserInfo, UIKeyboardInteractive {
+		private String passwd;
+
+		private String passphrase;
+
+		public void showMessage(final String msg) {
+			cons.printf("%s\n", msg);
+			cons.flush();
+		}
+
+		public boolean promptYesNo(final String msg) {
+			String r = cons.readLine("%s [y/n]? ", msg);
+			return "y".equalsIgnoreCase(r);
+		}
+
+		public boolean promptPassword(final String msg) {
+			passwd = null;
+			char[] p = cons.readPassword("%s: ", msg);
+			if (p != null) {
+				passwd = new String(p);
+				return true;
+			}
+			return false;
+		}
+
+		public boolean promptPassphrase(final String msg) {
+			passphrase = null;
+			char[] p = cons.readPassword("%s: ", msg);
+			if (p != null) {
+				passphrase = new String(p);
+				return true;
+			}
+			return false;
+		}
+
+		public String getPassword() {
+			return passwd;
+		}
+
+		public String getPassphrase() {
+			return passphrase;
+		}
+
+		public String[] promptKeyboardInteractive(final String destination,
+				final String name, final String instruction,
+				final String[] prompt, final boolean[] echo) {
+			cons.printf("%s: %s\n", destination, name);
+			cons.printf("%s\n", instruction);
+			final String[] response = new String[prompt.length];
+			for (int i = 0; i < prompt.length; i++) {
+				if (echo[i]) {
+					response[i] = cons.readLine("%s: ", prompt[i]);
+				} else {
+					final char[] p = cons.readPassword("%s: ", prompt[i]);
+					response[i] = p != null ? new String(p) : "";
+				}
+			}
+			return response;
+		}
+	}
+}