From 17d9c686367888a7f001221ff6c31b802c267e4b Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Wed, 10 Nov 2010 14:41:10 -0800 Subject: Implement command line support for CredentialsProvider Instead of configuring the JSch session factory, configure a more generic CredentialsProvider, which will work for other transport types such as http, in addition to the existing ssh. Change-Id: I22b13303c17e654ba6720edf4be2ef15fe29537a Signed-off-by: Shawn O. Pearce --- .../jgit/console/ConsoleCredentialsProvider.java | 175 +++++++++++++++++++++ .../jgit/console/ConsoleSshSessionFactory.java | 145 ----------------- 2 files changed, 175 insertions(+), 145 deletions(-) create mode 100644 org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleCredentialsProvider.java delete mode 100644 org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleSshSessionFactory.java (limited to 'org.eclipse.jgit.console/src') diff --git a/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleCredentialsProvider.java b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleCredentialsProvider.java new file mode 100644 index 0000000000..f8f8ff9bcf --- /dev/null +++ b/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleCredentialsProvider.java @@ -0,0 +1,175 @@ +/* + * Copyright (C) 2010, Google Inc. + * Copyright (C) 2008, Robin Rosenberg + * Copyright (C) 2008, Shawn O. Pearce + * 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.errors.UnsupportedCredentialItem; +import org.eclipse.jgit.transport.CredentialItem; +import org.eclipse.jgit.transport.CredentialsProvider; +import org.eclipse.jgit.transport.URIish; + +/** Interacts with the user during authentication by using the text console. */ +public class ConsoleCredentialsProvider extends CredentialsProvider { + /** Install this implementation as the default. */ + public static void install() { + final ConsoleCredentialsProvider c = new ConsoleCredentialsProvider(); + if (c.cons == null) + throw new NoClassDefFoundError( + ConsoleText.get().noSystemConsoleAvailable); + CredentialsProvider.setDefault(c); + } + + private final Console cons = System.console(); + + @Override + public boolean isInteractive() { + return true; + } + + @Override + public boolean supports(CredentialItem... items) { + for (CredentialItem i : items) { + if (i instanceof CredentialItem.StringType) + continue; + + else if (i instanceof CredentialItem.CharArrayType) + continue; + + else if (i instanceof CredentialItem.YesNoType) + continue; + + else if (i instanceof CredentialItem.InformationalMessage) + continue; + + else + return false; + } + return true; + } + + @Override + public boolean get(URIish uri, CredentialItem... items) + throws UnsupportedCredentialItem { + boolean ok = true; + for (int i = 0; i < items.length && ok; i++) { + CredentialItem item = items[i]; + + if (item instanceof CredentialItem.StringType) + ok = get(uri, (CredentialItem.StringType) item); + + else if (item instanceof CredentialItem.CharArrayType) + ok = get(uri, (CredentialItem.CharArrayType) item); + + else if (item instanceof CredentialItem.YesNoType) + ok = get(uri, (CredentialItem.YesNoType) item); + + else if (item instanceof CredentialItem.InformationalMessage) + ok = get(uri, (CredentialItem.InformationalMessage) item); + + else + throw new UnsupportedCredentialItem(uri, item.getPromptText()); + } + return ok; + } + + private boolean get(URIish uri, CredentialItem.StringType item) { + if (item.isValueSecure()) { + char[] v = cons.readPassword("%s: ", item.getPromptText()); + if (v != null) { + item.setValue(new String(v)); + return true; + } else { + return false; + } + } else { + String v = cons.readLine("%s: ", item.getPromptText()); + if (v != null) { + item.setValue(v); + return true; + } else { + return false; + } + } + } + + private boolean get(URIish uri, CredentialItem.CharArrayType item) { + if (item.isValueSecure()) { + char[] v = cons.readPassword("%s: ", item.getPromptText()); + if (v != null) { + item.setValueNoCopy(v); + return true; + } else { + return false; + } + } else { + String v = cons.readLine("%s: ", item.getPromptText()); + if (v != null) { + item.setValueNoCopy(v.toCharArray()); + return true; + } else { + return false; + } + } + } + + private boolean get(URIish uri, CredentialItem.InformationalMessage item) { + cons.printf("%s\n", item.getPromptText()); + cons.flush(); + return true; + } + + private boolean get(URIish uri, CredentialItem.YesNoType item) { + String r = cons.readLine("%s [%s/%s]? ", item.getPromptText(), + ConsoleText.get().answerYes, ConsoleText.get().answerNo); + if (r != null) { + item.setValue(ConsoleText.get().answerYes.equalsIgnoreCase(r)); + return true; + } else { + return false; + } + } +} 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 deleted file mode 100644 index b11078dea8..0000000000 --- a/org.eclipse.jgit.console/src/org/eclipse/jgit/console/ConsoleSshSessionFactory.java +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Copyright (C) 2009, Google Inc. - * Copyright (C) 2008, Robin Rosenberg - * Copyright (C) 2008, Shawn O. Pearce - * 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 $HOME/.ssh. - *

- * 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. - *

- * 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(ConsoleText.get().noSystemConsoleAvailable); - 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 [%s/%s]? ", msg, ConsoleText.get().answerYes, ConsoleText.get().answerNo); - return ConsoleText.get().answerYes.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; - } - } -} -- cgit v1.2.3