From 953ef0690fc6803449c43e3e886fb30f2ac5d7b3 Mon Sep 17 00:00:00 2001 From: Maros Marsalek Date: Mon, 25 Aug 2014 10:01:47 +0200 Subject: [PATCH] BUG-1568 Ssh Handler for netconf client Mina implementation This implementation of Ssh Handler is asynchronous and based on Apache Mina SSHD. + Add Mina SSHD to distribution. Change-Id: I51f51e2eb56b5f97a87c3d068ea90f8a44adca09 Signed-off-by: Maros Marsalek Signed-off-by: Robert Varga --- features/netconf/pom.xml | 4 + .../netconf/src/main/resources/features.xml | 3 +- opendaylight/commons/opendaylight/pom.xml | 6 + .../distribution/opendaylight/pom.xml | 4 + .../test/sal/binding/it/TestHelper.java | 1 + .../client/SshClientChannelInitializer.java | 4 +- .../netconf/it/NetconfITSecureTest.java | 18 +- .../netconf/netconf-netty-util/pom.xml | 7 +- .../authentication/AuthenticationHandler.java | 7 +- .../ssh/authentication/LoginPassword.java | 20 +- .../handler/ssh/client/AsyncSshHandler.java | 267 ++++++++++++++++++ opendaylight/netconf/netconf-ssh/pom.xml | 4 + 12 files changed, 321 insertions(+), 24 deletions(-) create mode 100644 opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java diff --git a/features/netconf/pom.xml b/features/netconf/pom.xml index 106e54a338..51d6f6291b 100644 --- a/features/netconf/pom.xml +++ b/features/netconf/pom.xml @@ -74,6 +74,10 @@ org.opendaylight.controller.thirdparty ganymed + + org.apache.sshd + sshd-core + org.openexi nagasena diff --git a/features/netconf/src/main/resources/features.xml b/features/netconf/src/main/resources/features.xml index f1631a5340..1453a5fb96 100644 --- a/features/netconf/src/main/resources/features.xml +++ b/features/netconf/src/main/resources/features.xml @@ -52,6 +52,7 @@ odl-netconf-util mvn:org.opendaylight.controller/netconf-netty-util/${project.version} mvn:org.opendaylight.controller.thirdparty/ganymed/${ganymed.version} + mvn:org.apache.sshd/sshd-core/${sshd-core.version} mvn:org.openexi/nagasena/${exi.nagasena.version} mvn:io.netty/netty-codec/${netty.version} mvn:io.netty/netty-handler/${netty.version} @@ -69,4 +70,4 @@ mvn:org.opendaylight.controller/netconf-monitoring/${project.version} - \ No newline at end of file + diff --git a/opendaylight/commons/opendaylight/pom.xml b/opendaylight/commons/opendaylight/pom.xml index 2f1cd8b925..873ad7a9b7 100644 --- a/opendaylight/commons/opendaylight/pom.xml +++ b/opendaylight/commons/opendaylight/pom.xml @@ -216,6 +216,7 @@ 2013.09.07.4-SNAPSHOT 1.0.0-SNAPSHOT 0.6.2-SNAPSHOT + 0.12.0 @@ -236,6 +237,11 @@ netconf-netty-util ${netconf.version} + + org.apache.sshd + sshd-core + ${sshd-core.version} + ch.qos.logback logback-classic diff --git a/opendaylight/distribution/opendaylight/pom.xml b/opendaylight/distribution/opendaylight/pom.xml index d70bf46411..9a7677099d 100644 --- a/opendaylight/distribution/opendaylight/pom.xml +++ b/opendaylight/distribution/opendaylight/pom.xml @@ -1156,6 +1156,10 @@ org.opendaylight.controller.thirdparty ganymed + + org.apache.sshd + sshd-core + org.opendaylight.yangtools binding-generator-api diff --git a/opendaylight/md-sal/sal-binding-it/src/main/java/org/opendaylight/controller/test/sal/binding/it/TestHelper.java b/opendaylight/md-sal/sal-binding-it/src/main/java/org/opendaylight/controller/test/sal/binding/it/TestHelper.java index 344694381a..dba2908e9c 100644 --- a/opendaylight/md-sal/sal-binding-it/src/main/java/org/opendaylight/controller/test/sal/binding/it/TestHelper.java +++ b/opendaylight/md-sal/sal-binding-it/src/main/java/org/opendaylight/controller/test/sal/binding/it/TestHelper.java @@ -73,6 +73,7 @@ public class TestHelper { mavenBundle(CONTROLLER, "netconf-client").versionAsInProject(), // mavenBundle(CONTROLLER, "netconf-util").versionAsInProject(), // mavenBundle(CONTROLLER, "netconf-netty-util").versionAsInProject(), // + mavenBundle("org.apache.sshd", "sshd-core").versionAsInProject(), // mavenBundle("org.openexi", "nagasena").versionAsInProject(), // mavenBundle("org.openexi", "nagasena-rta").versionAsInProject(), // mavenBundle(CONTROLLER + ".thirdparty", "ganymed").versionAsInProject(), // diff --git a/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/SshClientChannelInitializer.java b/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/SshClientChannelInitializer.java index 87b3f837e8..2aa5d15224 100644 --- a/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/SshClientChannelInitializer.java +++ b/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/SshClientChannelInitializer.java @@ -12,7 +12,7 @@ import io.netty.util.concurrent.Promise; import java.io.IOException; import org.opendaylight.controller.netconf.nettyutil.AbstractChannelInitializer; import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler; -import org.opendaylight.controller.netconf.nettyutil.handler.ssh.client.SshHandler; +import org.opendaylight.controller.netconf.nettyutil.handler.ssh.client.AsyncSshHandler; import org.opendaylight.protocol.framework.SessionListenerFactory; final class SshClientChannelInitializer extends AbstractChannelInitializer { @@ -32,7 +32,7 @@ final class SshClientChannelInitializer extends AbstractChannelInitializer promise) { try { - ch.pipeline().addFirst(SshHandler.createForNetconfSubsystem(authenticationHandler)); + ch.pipeline().addFirst(AsyncSshHandler.createForNetconfSubsystem(authenticationHandler)); super.initialize(ch,promise); } catch (final IOException e) { throw new RuntimeException(e); diff --git a/opendaylight/netconf/netconf-it/src/test/java/org/opendaylight/controller/netconf/it/NetconfITSecureTest.java b/opendaylight/netconf/netconf-it/src/test/java/org/opendaylight/controller/netconf/it/NetconfITSecureTest.java index 6826b4a09c..56f674bc34 100644 --- a/opendaylight/netconf/netconf-it/src/test/java/org/opendaylight/controller/netconf/it/NetconfITSecureTest.java +++ b/opendaylight/netconf/netconf-it/src/test/java/org/opendaylight/controller/netconf/it/NetconfITSecureTest.java @@ -9,13 +9,10 @@ package org.opendaylight.controller.netconf.it; import static java.util.Arrays.asList; -import static org.mockito.Matchers.any; import static org.mockito.Matchers.anyString; -import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; -import ch.ethz.ssh2.Connection; import io.netty.channel.ChannelFuture; import io.netty.channel.EventLoopGroup; import io.netty.channel.nio.NioEventLoopGroup; @@ -30,8 +27,6 @@ import junit.framework.Assert; import org.junit.After; import org.junit.Before; import org.junit.Test; -import org.mockito.invocation.InvocationOnMock; -import org.mockito.stubbing.Answer; import org.opendaylight.controller.config.manager.impl.factoriesresolver.HardcodedModuleFactoriesResolver; import org.opendaylight.controller.config.spi.ModuleFactory; import org.opendaylight.controller.netconf.api.NetconfMessage; @@ -47,6 +42,7 @@ import org.opendaylight.controller.netconf.impl.DefaultCommitNotificationProduce import org.opendaylight.controller.netconf.impl.NetconfServerDispatcher; import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationServiceFactoryListenerImpl; import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler; +import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.LoginPassword; import org.opendaylight.controller.netconf.ssh.NetconfSSHServer; import org.opendaylight.controller.netconf.ssh.authentication.AuthProvider; import org.opendaylight.controller.netconf.ssh.authentication.AuthProviderImpl; @@ -144,16 +140,6 @@ public class NetconfITSecureTest extends AbstractNetconfConfigTest { } public AuthenticationHandler getAuthHandler() throws IOException { - final AuthenticationHandler authHandler = mock(AuthenticationHandler.class); - doAnswer(new Answer() { - @Override - public Object answer(final InvocationOnMock invocation) throws Throwable { - Connection conn = (Connection) invocation.getArguments()[0]; - conn.authenticateWithPassword("user", "pwd"); - return null; - } - }).when(authHandler).authenticate(any(Connection.class)); - doReturn("auth handler").when(authHandler).toString(); - return authHandler; + return new LoginPassword("user", "pwd"); } } diff --git a/opendaylight/netconf/netconf-netty-util/pom.xml b/opendaylight/netconf/netconf-netty-util/pom.xml index 13041598d1..80dc1ae0fd 100644 --- a/opendaylight/netconf/netconf-netty-util/pom.xml +++ b/opendaylight/netconf/netconf-netty-util/pom.xml @@ -52,6 +52,10 @@ org.opendaylight.controller.thirdparty ganymed + + org.apache.sshd + sshd-core + org.openexi nagasena @@ -73,6 +77,7 @@ xmlunit xmlunit + @@ -82,7 +87,7 @@ maven-bundle-plugin - ch.ethz.ssh2, com.google.common.base, com.google.common.collect, io.netty.buffer, + org.apache.sshd.*, ch.ethz.ssh2, com.google.common.base, com.google.common.collect, io.netty.buffer, io.netty.channel, io.netty.channel.socket, io.netty.handler.codec, io.netty.handler.ssl, io.netty.util, io.netty.util.concurrent, javax.xml.transform, javax.xml.transform.dom, javax.xml.transform.sax, javax.xml.transform.stream, org.opendaylight.controller.netconf.api, diff --git a/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/AuthenticationHandler.java b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/AuthenticationHandler.java index b22b792d52..eea2b8693a 100644 --- a/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/AuthenticationHandler.java +++ b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/AuthenticationHandler.java @@ -9,12 +9,17 @@ package org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication; import ch.ethz.ssh2.Connection; - import java.io.IOException; +import org.apache.sshd.ClientSession; /** * Class providing authentication facility to SSH handler. */ public abstract class AuthenticationHandler { public abstract void authenticate(Connection connection) throws IOException; + + + public abstract String getUsername(); + + public abstract org.apache.sshd.client.future.AuthFuture authenticate(final ClientSession session) throws IOException; } diff --git a/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/LoginPassword.java b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/LoginPassword.java index b67aa0f96d..553e5359ff 100644 --- a/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/LoginPassword.java +++ b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/authentication/LoginPassword.java @@ -8,10 +8,13 @@ package org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication; -import ch.ethz.ssh2.Connection; - import java.io.IOException; +import org.apache.sshd.ClientSession; +import org.apache.sshd.client.future.AuthFuture; + +import ch.ethz.ssh2.Connection; + /** * Class Providing username/password authentication option to * {@link org.opendaylight.controller.netconf.nettyutil.handler.ssh.client.SshHandler} @@ -27,10 +30,21 @@ public class LoginPassword extends AuthenticationHandler { @Override public void authenticate(Connection connection) throws IOException { - boolean isAuthenticated = connection.authenticateWithPassword(username, password); + final boolean isAuthenticated = connection.authenticateWithPassword(username, password); if (!isAuthenticated) { throw new IOException("Authentication failed."); } } + + @Override + public String getUsername() { + return username; + } + + @Override + public AuthFuture authenticate(final ClientSession session) throws IOException { + session.addPasswordIdentity(password); + return session.auth(); + } } diff --git a/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java new file mode 100644 index 0000000000..2761a45d03 --- /dev/null +++ b/opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java @@ -0,0 +1,267 @@ +/* + * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ + +package org.opendaylight.controller.netconf.nettyutil.handler.ssh.client; + +import com.google.common.base.Preconditions; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelOutboundHandlerAdapter; +import io.netty.channel.ChannelPromise; +import java.io.IOException; +import java.net.SocketAddress; +import org.apache.sshd.ClientChannel; +import org.apache.sshd.ClientSession; +import org.apache.sshd.SshClient; +import org.apache.sshd.client.future.AuthFuture; +import org.apache.sshd.client.future.ConnectFuture; +import org.apache.sshd.client.future.OpenFuture; +import org.apache.sshd.common.future.CloseFuture; +import org.apache.sshd.common.future.SshFutureListener; +import org.apache.sshd.common.io.IoInputStream; +import org.apache.sshd.common.io.IoReadFuture; +import org.apache.sshd.common.util.Buffer; +import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Netty SSH handler class. Acts as interface between Netty and SSH library. + */ +public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { + + private static final Logger logger = LoggerFactory.getLogger(AsyncSshHandler.class); + public static final String SUBSYSTEM = "netconf"; + + public static final SshClient DEFAULT_CLIENT = SshClient.setUpDefaultClient(); + + public static final int SSH_DEFAULT_NIO_WORKERS = 8; + + static { + // TODO make configurable, or somehow reuse netty threadpool + DEFAULT_CLIENT.setNioWorkers(SSH_DEFAULT_NIO_WORKERS); + DEFAULT_CLIENT.start(); + } + + private final AuthenticationHandler authenticationHandler; + private final SshClient sshClient; + + private SshReadAsyncListener sshReadAsyncListener; + private ClientChannel channel; + private ClientSession session; + private ChannelPromise connectPromise; + + public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) throws IOException { + return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT); + } + + /** + * + * @param authenticationHandler + * @param sshClient started SshClient + * @throws IOException + */ + public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final SshClient sshClient) throws IOException { + this.authenticationHandler = Preconditions.checkNotNull(authenticationHandler); + this.sshClient = Preconditions.checkNotNull(sshClient); + // Start just in case + sshClient.start(); + } + + private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) { + logger.debug("Starting SSH to {} on channel: {}", address, ctx.channel()); + + final ConnectFuture sshConnectionFuture = sshClient.connect(authenticationHandler.getUsername(), address); + sshConnectionFuture.addListener(new SshFutureListener() { + @Override + public void operationComplete(final ConnectFuture future) { + if (future.isConnected()) { + handleSshSessionCreated(future, ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); + } + } + }); + } + + private synchronized void handleSshSessionCreated(final ConnectFuture future, final ChannelHandlerContext ctx) { + try { + logger.trace("SSH session created on channel: {}", ctx.channel()); + + session = future.getSession(); + final AuthFuture authenticateFuture = authenticationHandler.authenticate(session); + authenticateFuture.addListener(new SshFutureListener() { + @Override + public void operationComplete(final AuthFuture future) { + if (future.isSuccess()) { + handleSshAuthenticated(session, ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); + } + } + }); + } catch (final IOException e) { + handleSshSetupFailure(ctx, e); + } + } + + private synchronized void handleSshAuthenticated(final ClientSession session, final ChannelHandlerContext ctx) { + try { + logger.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), session.getServerVersion()); + + channel = session.createSubsystemChannel(SUBSYSTEM); + channel.setStreaming(ClientChannel.Streaming.Async); + channel.open().addListener(new SshFutureListener() { + @Override + public void operationComplete(final OpenFuture future) { + if(future.isOpened()) { + handleSshChanelOpened(ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); + } + } + }); + + + } catch (final IOException e) { + handleSshSetupFailure(ctx, e); + } + } + + private synchronized void handleSshChanelOpened(final ChannelHandlerContext ctx) { + logger.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel()); + + connectPromise.setSuccess(); + connectPromise = null; + ctx.fireChannelActive(); + + final IoInputStream asyncOut = channel.getAsyncOut(); + sshReadAsyncListener = new SshReadAsyncListener(ctx, asyncOut); + } + + private synchronized void handleSshSetupFailure(final ChannelHandlerContext ctx, final Throwable e) { + logger.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), e); + connectPromise.setFailure(e); + connectPromise = null; + throw new IllegalStateException("Unable to setup SSH connection on channel: " + ctx.channel(), e); + } + + @Override + public synchronized void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) { + try { + if(channel.getAsyncIn().isClosed() || channel.getAsyncIn().isClosing()) { + handleSshSessionClosed(ctx); + } else { + channel.getAsyncIn().write(toBuffer(msg)); + ((ByteBuf) msg).release(); + } + } catch (final Exception e) { + logger.warn("Exception while writing to SSH remote on channel {}", ctx.channel(), e); + throw new IllegalStateException("Exception while writing to SSH remote on channel " + ctx.channel(),e); + } + } + + private static void handleSshSessionClosed(final ChannelHandlerContext ctx) { + logger.debug("SSH session closed on channel: {}", ctx.channel()); + ctx.fireChannelInactive(); + } + + private Buffer toBuffer(final Object msg) { + // TODO Buffer vs ByteBuf translate, Can we handle that better ? + Preconditions.checkState(msg instanceof ByteBuf); + final ByteBuf byteBuf = (ByteBuf) msg; + final byte[] temp = new byte[byteBuf.readableBytes()]; + byteBuf.readBytes(temp, 0, byteBuf.readableBytes()); + return new Buffer(temp); + } + + @Override + public synchronized void connect(final ChannelHandlerContext ctx, final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) throws Exception { + this.connectPromise = promise; + startSsh(ctx, remoteAddress); + } + + @Override + public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception { + disconnect(ctx, promise); + } + + @Override + public synchronized void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception { + if(sshReadAsyncListener != null) { + sshReadAsyncListener.close(); + } + + session.close(false).addListener(new SshFutureListener() { + @Override + public void operationComplete(final CloseFuture future) { + if(future.isClosed() == false) { + session.close(true); + } + session = null; + } + }); + + channel = null; + } + + /** + * Listener over async input stream from SSH session. + * This listeners schedules reads in a loop until the session is closed or read fails. + */ + private static class SshReadAsyncListener implements SshFutureListener, AutoCloseable { + private static final int BUFFER_SIZE = 8192; + + private final ChannelHandlerContext ctx; + + private IoInputStream asyncOut; + private Buffer buf; + private IoReadFuture currentReadFuture; + + public SshReadAsyncListener(final ChannelHandlerContext ctx, final IoInputStream asyncOut) { + this.ctx = ctx; + this.asyncOut = asyncOut; + buf = new Buffer(BUFFER_SIZE); + asyncOut.read(buf).addListener(this); + } + + @Override + public synchronized void operationComplete(final IoReadFuture future) { + if(future.getException() != null) { + + if(asyncOut.isClosed() || asyncOut.isClosing()) { + // We are closing + handleSshSessionClosed(ctx); + } else { + logger.warn("Exception while reading from SSH remote on channel {}", ctx.channel(), future.getException()); + throw new IllegalStateException("Exception while reading from SSH remote on channel " + ctx.channel(), future.getException()); + } + } + + if (future.getRead() > 0) { + ctx.fireChannelRead(Unpooled.wrappedBuffer(buf.array(), 0, future.getRead())); + + // Schedule next read + buf = new Buffer(BUFFER_SIZE); + currentReadFuture = asyncOut.read(buf); + currentReadFuture.addListener(this); + } + } + + @Override + public synchronized void close() throws Exception { + // Remove self as listener on close to prevent reading from closed input + if(currentReadFuture != null) { + currentReadFuture.removeListener(this); + } + + asyncOut = null; + } + } +} diff --git a/opendaylight/netconf/netconf-ssh/pom.xml b/opendaylight/netconf/netconf-ssh/pom.xml index febf3abf8e..8d48077f93 100644 --- a/opendaylight/netconf/netconf-ssh/pom.xml +++ b/opendaylight/netconf/netconf-ssh/pom.xml @@ -40,6 +40,10 @@ org.opendaylight.controller.thirdparty ganymed + + org.apache.sshd + sshd-core + org.slf4j slf4j-api -- 2.36.6