shell/ssh/src/main/java/org/apache/karaf/shell/ssh/SshAction.java - karaf - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *  http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 package org.apache.karaf.shell.ssh;

 import java.io.*;
 import java.net.URL;
 import java.security.KeyPair;
 import java.util.List;

 import jline.Terminal;

 import org.apache.karaf.shell.commands.Argument;
 import org.apache.karaf.shell.commands.Command;
 import org.apache.karaf.shell.commands.Option;
 import jline.console.ConsoleReader;
 import org.apache.karaf.shell.console.OsgiCommandSupport;
 import org.apache.karaf.shell.console.SessionProperties;
 import org.apache.sshd.ClientChannel;
 import org.apache.sshd.ClientSession;
 import org.apache.sshd.SshClient;
 import org.apache.sshd.agent.SshAgent;
 import org.apache.sshd.agent.local.AgentImpl;
 import org.apache.sshd.agent.local.LocalAgentFactory;
 import org.apache.sshd.client.ServerKeyVerifier;
 import org.apache.sshd.client.UserInteraction;
 import org.apache.sshd.client.channel.ChannelShell;
 import org.apache.sshd.client.future.ConnectFuture;
 import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
 import org.apache.sshd.common.util.NoCloseInputStream;
 import org.apache.sshd.common.util.NoCloseOutputStream;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 @Command(scope = "ssh", name = "ssh", description = "Connects to a remote SSH server")
 public class SshAction extends OsgiCommandSupport {
     private final Logger log = LoggerFactory.getLogger(getClass());

     @Option(name = "-l", aliases = {"--username"}, description = "The user name for remote login", required = false, multiValued = false)
     private String username;

     @Option(name = "-P", aliases = {"--password"}, description = "The password for remote login", required = false, multiValued = false)
     private String password;

     @Option(name = "-p", aliases = {"--port"}, description = "The port to use for SSH connection", required = false, multiValued = false)
     private int port = 22;

     @Option(name = "-k", aliases = {"--keyfile"}, description = "The private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag", required = false, multiValued = false)
     private String keyFile;

     @Option(name = "-q", description = "Quiet Mode. Do not ask for confirmations", required = false, multiValued = false)
     private boolean quiet;

     @Option(name = "-r", aliases = { "--retries" }, description = "Retry connection establishment (up to attempts times)", required = false, multiValued = false)
     private int retries = 0;

     @Argument(index = 0, name = "hostname", description = "The host name to connect to via SSH", required = true, multiValued = false)
     private String hostname;

     @Argument(index = 1, name = "command", description = "Optional command to execute", required = false, multiValued = true)
     private List<String> command;

     private ClientSession sshSession;


     @Override
     protected Object doExecute() throws Exception {

         if (hostname.indexOf('@') >= 0) {
             if (username == null) {
                 username = hostname.substring(0, hostname.indexOf('@'));
             }
             hostname = hostname.substring(hostname.indexOf('@') + 1, hostname.length());
         }

         System.out.println("Connecting to host " + hostname + " on port " + port);

         // If not specified, assume the current user name
         if (username == null) {
             username = (String) this.session.get("USER");
         }
         // If the username was not configured via cli, then prompt the user for the values
         if (username == null) {
             log.debug("Prompting user for login");
             if (username == null) {
                 username = readLine("Login: ");
             }
         }

         SshClient client = SshClient.setUpDefaultClient();
         setupAgent(username, keyFile, client);
         KnownHostsManager knownHostsManager = new KnownHostsManager(new File(System.getProperty("user.home"), ".sshkaraf/known_hosts"));
         ServerKeyVerifier serverKeyVerifier = new ServerKeyVerifierImpl(knownHostsManager, quiet);
         client.setServerKeyVerifier(serverKeyVerifier);
         log.debug("Created client: {}", client);

         client.setUserInteraction(new UserInteraction() {
             public void welcome(String banner) {
                 System.out.println(banner);
             }

             public String[] interactive(String destination, String name, String instruction, String[] prompt, boolean[] echo) {
                 String[] answers = new String[prompt.length];
                 try {
                     for (int i = 0; i < prompt.length; i++) {
                         answers[i] = readLine(prompt[i] + " ", echo[i] ? null : '*');
                     }
                 } catch (IOException e) {
                 }
                 return answers;
             }
         });
         client.start();

         try {
             ClientSession sshSession = client.connect(username, hostname, port).await().getSession();
             Object oldIgnoreInterrupts = this.session.get(SessionProperties.IGNORE_INTERRUPTS);

             try {
                 if (password != null) {
                     sshSession.addPasswordIdentity(password);
                 }

                 sshSession.auth().verify();

                 System.out.println("Connected");
                 this.session.put(SessionProperties.IGNORE_INTERRUPTS, Boolean.TRUE);

                 StringBuilder sb = new StringBuilder();
                 if (command != null) {
                     for (String cmd : command) {
                         if (sb.length() > 0) {
                             sb.append(' ');
                         }
                         sb.append(cmd);
                     }
                 }

                 ClientChannel channel;
                 if (sb.length() > 0) {
                     channel = sshSession.createChannel("exec", sb.append("\n").toString());
                     channel.setIn(new ByteArrayInputStream(new byte[0]));
                 } else {
                     channel = sshSession.createChannel("shell");
                     channel.setIn(new NoCloseInputStream(System.in));
                     ((ChannelShell) channel).setPtyColumns(getTermWidth());
                     ((ChannelShell) channel).setupSensibleDefaultPty();
                     ((ChannelShell) channel).setAgentForwarding(true);
                     Object ctype = session.get("LC_CTYPE");
                     if (ctype != null) {
                         ((ChannelShell) channel).setEnv("LC_CTYPE", ctype.toString());
                     }
                 }
                 channel.setOut(new NoCloseOutputStream(System.out));
                 channel.setErr(new NoCloseOutputStream(System.err));
                 channel.open().verify();
                 channel.waitFor(ClientChannel.CLOSED, 0);
             } finally {
                 session.put(SessionProperties.IGNORE_INTERRUPTS, oldIgnoreInterrupts);
                 sshSession.close(false);
             }
         } finally {
             client.stop();
         }

         return null;
     }

     private int getTermWidth() {
         Terminal term = (Terminal) session.get(".jline.terminal");
         return term != null ? term.getWidth() : 80;
     }

     public String readLine(String msg) throws IOException {
         return readLine(msg, null);
     }

     public String readLine(String msg, Character mask) throws IOException {
         ConsoleReader reader = (ConsoleReader) session.get(".jline.reader");
         return reader.readLine(msg, mask);
     }

     private void setupAgent(String user, String keyFile, SshClient client) {
         SshAgent agent;
         URL url = getClass().getClassLoader().getResource("karaf.key");
         agent = startAgent(user, url, keyFile);
         client.setAgentFactory(new LocalAgentFactory(agent));
         client.getProperties().put(SshAgent.SSH_AUTHSOCKET_ENV_NAME, "local");
     }

     private SshAgent startAgent(String user, URL privateKeyUrl, String keyFile) {
         InputStream is = null;
         try {
             SshAgent agent = new AgentImpl();
             is = privateKeyUrl.openStream();
             ObjectInputStream r = new ObjectInputStream(is);
             KeyPair keyPair = (KeyPair) r.readObject();
             is.close();
             agent.addIdentity(keyPair, user);
             if (keyFile != null) {
                 String[] keyFiles = new String[]{keyFile};
                 FileKeyPairProvider fileKeyPairProvider = new FileKeyPairProvider(keyFiles);
                 for (KeyPair key : fileKeyPairProvider.loadKeys()) {
                     agent.addIdentity(key, user);
                 }
             }
             return agent;
         } catch (Throwable e) {
             close(is);
             System.err.println("Error starting ssh agent for: " + e.getMessage());
             return null;
         }
     }

     private static ClientSession connectWithRetries(SshClient client, String username, String host, int port, int maxAttempts) throws Exception, InterruptedException {
         ClientSession session = null;
         int retries = 0;
         do {
             ConnectFuture future = client.connect(username, host, port);
             future.await();
             try {
                 session = future.getSession();
             } catch (Exception ex) {
                 if (retries++ < maxAttempts) {
                     Thread.sleep(2 * 1000);
                     System.out.println("retrying (attempt " + retries + ") ...");
                 } else {
                     throw ex;
                 }
             }
         } while (session == null);
         return session;
     }

     private void close(Closeable is) {
         if (is != null) {
             try {
                 is.close();
             } catch (IOException e1) {
                 // Ignore
             }
         }
     }

 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*/
	package org.apache.karaf.shell.ssh;

	import java.io.*;
	import java.net.URL;
	import java.security.KeyPair;
	import java.util.List;

	import jline.Terminal;

	import org.apache.karaf.shell.commands.Argument;
	import org.apache.karaf.shell.commands.Command;
	import org.apache.karaf.shell.commands.Option;
	import jline.console.ConsoleReader;
	import org.apache.karaf.shell.console.OsgiCommandSupport;
	import org.apache.karaf.shell.console.SessionProperties;
	import org.apache.sshd.ClientChannel;
	import org.apache.sshd.ClientSession;
	import org.apache.sshd.SshClient;
	import org.apache.sshd.agent.SshAgent;
	import org.apache.sshd.agent.local.AgentImpl;
	import org.apache.sshd.agent.local.LocalAgentFactory;
	import org.apache.sshd.client.ServerKeyVerifier;
	import org.apache.sshd.client.UserInteraction;
	import org.apache.sshd.client.channel.ChannelShell;
	import org.apache.sshd.client.future.ConnectFuture;
	import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
	import org.apache.sshd.common.util.NoCloseInputStream;
	import org.apache.sshd.common.util.NoCloseOutputStream;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;

	@Command(scope = "ssh", name = "ssh", description = "Connects to a remote SSH server")
	public class SshAction extends OsgiCommandSupport {
	private final Logger log = LoggerFactory.getLogger(getClass());

	@Option(name = "-l", aliases = {"--username"}, description = "The user name for remote login", required = false, multiValued = false)
	private String username;

	@Option(name = "-P", aliases = {"--password"}, description = "The password for remote login", required = false, multiValued = false)
	private String password;

	@Option(name = "-p", aliases = {"--port"}, description = "The port to use for SSH connection", required = false, multiValued = false)
	private int port = 22;

	@Option(name = "-k", aliases = {"--keyfile"}, description = "The private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag", required = false, multiValued = false)
	private String keyFile;

	@Option(name = "-q", description = "Quiet Mode. Do not ask for confirmations", required = false, multiValued = false)
	private boolean quiet;

	@Option(name = "-r", aliases = { "--retries" }, description = "Retry connection establishment (up to attempts times)", required = false, multiValued = false)
	private int retries = 0;

	@Argument(index = 0, name = "hostname", description = "The host name to connect to via SSH", required = true, multiValued = false)
	private String hostname;

	@Argument(index = 1, name = "command", description = "Optional command to execute", required = false, multiValued = true)
	private List<String> command;

	private ClientSession sshSession;



	@Override
	protected Object doExecute() throws Exception {

	if (hostname.indexOf('@') >= 0) {
	if (username == null) {
	username = hostname.substring(0, hostname.indexOf('@'));
	}
	hostname = hostname.substring(hostname.indexOf('@') + 1, hostname.length());
	}

	System.out.println("Connecting to host " + hostname + " on port " + port);

	// If not specified, assume the current user name
	if (username == null) {
	username = (String) this.session.get("USER");
	}
	// If the username was not configured via cli, then prompt the user for the values
	if (username == null) {
	log.debug("Prompting user for login");
	if (username == null) {
	username = readLine("Login: ");
	}
	}

	SshClient client = SshClient.setUpDefaultClient();
	setupAgent(username, keyFile, client);
	KnownHostsManager knownHostsManager = new KnownHostsManager(new File(System.getProperty("user.home"), ".sshkaraf/known_hosts"));
	ServerKeyVerifier serverKeyVerifier = new ServerKeyVerifierImpl(knownHostsManager, quiet);
	client.setServerKeyVerifier(serverKeyVerifier);
	log.debug("Created client: {}", client);

	client.setUserInteraction(new UserInteraction() {
	public void welcome(String banner) {
	System.out.println(banner);
	}

	public String[] interactive(String destination, String name, String instruction, String[] prompt, boolean[] echo) {
	String[] answers = new String[prompt.length];
	try {
	for (int i = 0; i < prompt.length; i++) {
	answers[i] = readLine(prompt[i] + " ", echo[i] ? null : '*');
	}
	} catch (IOException e) {
	}
	return answers;
	}
	});
	client.start();

	try {
	ClientSession sshSession = client.connect(username, hostname, port).await().getSession();
	Object oldIgnoreInterrupts = this.session.get(SessionProperties.IGNORE_INTERRUPTS);

	try {
	if (password != null) {
	sshSession.addPasswordIdentity(password);
	}

	sshSession.auth().verify();

	System.out.println("Connected");
	this.session.put(SessionProperties.IGNORE_INTERRUPTS, Boolean.TRUE);

	StringBuilder sb = new StringBuilder();
	if (command != null) {
	for (String cmd : command) {
	if (sb.length() > 0) {
	sb.append(' ');
	}
	sb.append(cmd);
	}
	}

	ClientChannel channel;
	if (sb.length() > 0) {
	channel = sshSession.createChannel("exec", sb.append("\n").toString());
	channel.setIn(new ByteArrayInputStream(new byte[0]));
	} else {
	channel = sshSession.createChannel("shell");
	channel.setIn(new NoCloseInputStream(System.in));
	((ChannelShell) channel).setPtyColumns(getTermWidth());
	((ChannelShell) channel).setupSensibleDefaultPty();
	((ChannelShell) channel).setAgentForwarding(true);
	Object ctype = session.get("LC_CTYPE");
	if (ctype != null) {
	((ChannelShell) channel).setEnv("LC_CTYPE", ctype.toString());
	}
	}
	channel.setOut(new NoCloseOutputStream(System.out));
	channel.setErr(new NoCloseOutputStream(System.err));
	channel.open().verify();
	channel.waitFor(ClientChannel.CLOSED, 0);
	} finally {
	session.put(SessionProperties.IGNORE_INTERRUPTS, oldIgnoreInterrupts);
	sshSession.close(false);
	}
	} finally {
	client.stop();
	}

	return null;
	}

	private int getTermWidth() {
	Terminal term = (Terminal) session.get(".jline.terminal");
	return term != null ? term.getWidth() : 80;
	}

	public String readLine(String msg) throws IOException {
	return readLine(msg, null);
	}

	public String readLine(String msg, Character mask) throws IOException {
	ConsoleReader reader = (ConsoleReader) session.get(".jline.reader");
	return reader.readLine(msg, mask);
	}

	private void setupAgent(String user, String keyFile, SshClient client) {
	SshAgent agent;
	URL url = getClass().getClassLoader().getResource("karaf.key");
	agent = startAgent(user, url, keyFile);
	client.setAgentFactory(new LocalAgentFactory(agent));
	client.getProperties().put(SshAgent.SSH_AUTHSOCKET_ENV_NAME, "local");
	}

	private SshAgent startAgent(String user, URL privateKeyUrl, String keyFile) {
	InputStream is = null;
	try {
	SshAgent agent = new AgentImpl();
	is = privateKeyUrl.openStream();
	ObjectInputStream r = new ObjectInputStream(is);
	KeyPair keyPair = (KeyPair) r.readObject();
	is.close();
	agent.addIdentity(keyPair, user);
	if (keyFile != null) {
	String[] keyFiles = new String[]{keyFile};
	FileKeyPairProvider fileKeyPairProvider = new FileKeyPairProvider(keyFiles);
	for (KeyPair key : fileKeyPairProvider.loadKeys()) {
	agent.addIdentity(key, user);
	}
	}
	return agent;
	} catch (Throwable e) {
	close(is);
	System.err.println("Error starting ssh agent for: " + e.getMessage());
	return null;
	}
	}

	private static ClientSession connectWithRetries(SshClient client, String username, String host, int port, int maxAttempts) throws Exception, InterruptedException {
	ClientSession session = null;
	int retries = 0;
	do {
	ConnectFuture future = client.connect(username, host, port);
	future.await();
	try {
	session = future.getSession();
	} catch (Exception ex) {
	if (retries++ < maxAttempts) {
	Thread.sleep(2 * 1000);
	System.out.println("retrying (attempt " + retries + ") ...");
	} else {
	throw ex;
	}
	}
	} while (session == null);
	return session;
	}

	private void close(Closeable is) {
	if (is != null) {
	try {
	is.close();
	} catch (IOException e1) {
	// Ignore
	}
	}
	}

	}