/*
* 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.tooling.client;
import org.apache.karaf.tooling.utils.MojoSupport;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
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.SshClient;
import org.apache.sshd.client.auth.keyboard.UserInteraction;
import org.apache.sshd.client.channel.ClientChannel;
import org.apache.sshd.client.channel.ClientChannelEvent;
import org.apache.sshd.client.future.ConnectFuture;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.common.RuntimeSshException;
import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
import org.fusesource.jansi.Ansi;
import org.fusesource.jansi.Ansi.Color;
import org.fusesource.jansi.AnsiConsole;
import javax.management.MBeanServerConnection;
import javax.management.ObjectName;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.Console;
import java.io.File;
import java.io.IOError;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.URL;
import java.security.KeyPair;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.TimeUnit;
/**
* Deploy MOJO to deploy an artifact remotely on a running Karaf instance, using ssh or JMX
*/
@Mojo(name = "deploy", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true)
public class DeployMojo extends MojoSupport {
@Parameter(defaultValue = "8101")
private int port;
@Parameter(defaultValue = "localhost")
private String host;
@Parameter(defaultValue = "karaf")
private String user;
@Parameter(defaultValue = "karaf")
private String password;
@Parameter(defaultValue = "karaf-root")
private String instance = "karaf-root";
@Parameter(defaultValue = "0")
private int attempts;
@Parameter(defaultValue = "2")
private int delay;
@Parameter(defaultValue = "true")
private boolean useSsh = true;
@Parameter(defaultValue = "true")
private boolean useProjectArtifact = true;
@Parameter
List<String> artifactLocations;
@Parameter
private File keyFile;
private static final String NEW_LINE = System.getProperty("line.separator");
public void execute() throws MojoExecutionException {
List<String> artifacts = new ArrayList<>();
if (useProjectArtifact) {
Artifact projectArtifact = project.getArtifact();
artifacts.add("mvn:" + projectArtifact.getGroupId() + "/" + projectArtifact.getArtifactId() + "/" + projectArtifact.getVersion());
}
artifacts.addAll(artifactLocations);
if (useSsh)
deployWithSsh(artifactLocations);
else deployWithJmx(artifactLocations);
}
protected void deployWithJmx(List<String> locations) throws MojoExecutionException {
try {
JMXServiceURL jmxServiceURL = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://" + host + ":" + port + "/" + instance);
ArrayList<String> list = new ArrayList<>();
if (user != null)
list.add(user);
if (password != null)
list.add(password);
HashMap env = new HashMap();
String[] credentials = list.toArray(new String[list.size()]);
env.put(JMXConnector.CREDENTIALS, credentials);
JMXConnector jmxConnector = null;
if (credentials.length > 0)
jmxConnector = JMXConnectorFactory.connect(jmxServiceURL, env);
else jmxConnector = JMXConnectorFactory.connect(jmxServiceURL);
MBeanServerConnection mBeanServerConnection = jmxConnector.getMBeanServerConnection();
for (String location : locations) {
mBeanServerConnection.invoke(new ObjectName("org.apache.karaf:type=bundle,name=*"), "install", new Object[]{ location, true }, new String[]{ "java.lang.String", "boolean" });
}
} catch (Exception e) {
throw new MojoExecutionException("Can't deploy using JMX", e);
}
}
protected void deployWithSsh(List<String> locations) throws MojoExecutionException {
SshClient client = null;
try {
final Console console = System.console();
client = SshClient.setUpDefaultClient();
setupAgent(user, keyFile, client);
client.setUserInteraction( new UserInteraction() {
@Override
public void welcome(ClientSession s, String banner, String lang) {
console.printf(banner);
}
@Override
public String[] interactive(ClientSession s, String name, String instruction, String lang, String[] prompt, boolean[] echo)
{
String[] answers = new String[prompt.length];
try {
for (int i = 0; i < prompt.length; i++) {
if (console != null) {
if (echo[i]) {
answers[i] = console.readLine(prompt[i] + " ");
}
else {
answers[i] = new String( console.readPassword(prompt[i] + " "));
}
}
}
}
catch (IOError e) {
}
return answers;
}
@Override
public boolean isInteractionAllowed(ClientSession session) {
return true;
}
@Override
public void serverVersionInfo(ClientSession session, List<String> lines) {
}
@Override
public String getUpdatedPassword(ClientSession session, String prompt, String lang) {
return null;
}
});
client.start();
if (console != null) {
console.printf("Logging in as %s\n", user);
}
ClientSession session = connect(client);
if (password != null) {
session.addPasswordIdentity(password);
}
session.auth().verify();
StringWriter writer = new StringWriter();
PrintWriter print = new PrintWriter(writer, true);
for (String location : locations) {
print.println("bundle:install -s " + location);
}
final ClientChannel channel = session.createChannel("exec", print.toString().concat(NEW_LINE));
channel.setIn(new ByteArrayInputStream(new byte[0]));
final ByteArrayOutputStream sout = new ByteArrayOutputStream();
final ByteArrayOutputStream serr = new ByteArrayOutputStream();
channel.setOut( AnsiConsole.wrapOutputStream(sout));
channel.setErr( AnsiConsole.wrapOutputStream(serr));
channel.open();
channel.waitFor(EnumSet.of(ClientChannelEvent.CLOSED), 0);
sout.writeTo(System.out);
serr.writeTo(System.err);
// Expects issue KARAF-2623 is fixed
final boolean isError = (channel.getExitStatus() != null && channel.getExitStatus().intValue() != 0);
if (isError) {
final String errorMarker = Ansi.ansi().fg(Color.RED).toString();
final int fromIndex = sout.toString().indexOf(errorMarker) + errorMarker.length();
final int toIndex = sout.toString().lastIndexOf(Ansi.ansi().fg(Color.DEFAULT ).toString());
throw new MojoExecutionException(NEW_LINE + sout.toString().substring(fromIndex, toIndex));
}
}
catch (MojoExecutionException e) {
throw e;
}
catch (Throwable t) {
throw new MojoExecutionException(t, t.getMessage(), t.toString());
}
finally {
try {
client.stop();
}
catch (Throwable t) {
throw new MojoExecutionException(t, t.getMessage(), t.toString());
}
}
}
private void setupAgent(String user, File keyFile, SshClient client) {
URL builtInPrivateKey = ClientMojo.class.getClassLoader().getResource("karaf.key");
SshAgent agent = startAgent(user, builtInPrivateKey, keyFile);
client.setAgentFactory( new LocalAgentFactory(agent));
client.getProperties().put(SshAgent.SSH_AUTHSOCKET_ENV_NAME, "local");
}
private SshAgent startAgent(String user, URL privateKeyUrl, File keyFile) {
try (InputStream is = privateKeyUrl.openStream())
{
SshAgent agent = new AgentImpl();
ObjectInputStream r = new ObjectInputStream(is);
KeyPair keyPair = (KeyPair) r.readObject();
is.close();
agent.addIdentity(keyPair, user);
if (keyFile != null) {
FileKeyPairProvider fileKeyPairProvider = new FileKeyPairProvider(keyFile.getAbsoluteFile().toPath());
for (KeyPair key : fileKeyPairProvider.loadKeys()) {
agent.addIdentity(key, user);
}
}
return agent;
}
catch (Throwable e) {
getLog().error("Error starting ssh agent for: " + e.getMessage(), e);
return null;
}
}
private ClientSession connect(SshClient client) throws IOException, InterruptedException {
int retries = 0;
ClientSession session = null;
do {
final ConnectFuture future = client.connect(user, host, port);
future.await();
try {
session = future.getSession();
}
catch (RuntimeSshException ex) {
if (retries++ < attempts) {
Thread.sleep(TimeUnit.SECONDS.toMillis(delay));
getLog().info("retrying (attempt " + retries + ") ...");
}
else {
throw ex;
}
}
} while (session == null);
return session;
}
}