X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fnetconf-netty-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fnettyutil%2Fhandler%2Fssh%2Fclient%2FAsyncSshHandler.java;h=c8312e9419af95fe90a91c8130f35c74319a0ff1;hb=1b4958b336a80f2ab62164196de8f90a6f083f03;hp=c3ff3496625e0f84f154692f49d71b924d67ca15;hpb=2295d50e7212d80a9bc752f655fa66790ad45022;p=netconf.git diff --git a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java index c3ff349662..c8312e9419 100644 --- a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java +++ b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java @@ -5,23 +5,28 @@ * 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.netconf.nettyutil.handler.ssh.client; -import com.google.common.base.Preconditions; +import static com.google.common.base.Verify.verify; +import static java.util.Objects.requireNonNull; + import io.netty.channel.ChannelHandlerContext; import io.netty.channel.ChannelOutboundHandlerAdapter; import io.netty.channel.ChannelPromise; import io.netty.util.concurrent.Future; -import io.netty.util.concurrent.GenericFutureListener; +import io.netty.util.concurrent.FutureListener; import java.io.IOException; import java.net.SocketAddress; -import org.apache.sshd.client.SshClient; -import org.apache.sshd.client.channel.ClientChannel; -import org.apache.sshd.client.future.AuthFuture; -import org.apache.sshd.client.future.ConnectFuture; -import org.apache.sshd.client.session.ClientSession; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import org.eclipse.jdt.annotation.Nullable; import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler; +import org.opendaylight.netconf.shaded.sshd.client.channel.ClientChannel; +import org.opendaylight.netconf.shaded.sshd.client.future.AuthFuture; +import org.opendaylight.netconf.shaded.sshd.client.future.ConnectFuture; +import org.opendaylight.netconf.shaded.sshd.client.future.OpenFuture; +import org.opendaylight.netconf.shaded.sshd.client.session.ClientSession; +import org.opendaylight.netconf.shaded.sshd.core.CoreModuleProperties; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -34,15 +39,16 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { public static final String SUBSYSTEM = "netconf"; public static final int SSH_DEFAULT_NIO_WORKERS = 8; - // Disable default timeouts from mina sshd - private static final long DEFAULT_TIMEOUT = -1L; - public static final SshClient DEFAULT_CLIENT; + public static final NetconfSshClient DEFAULT_CLIENT; static { - final SshClient c = SshClient.setUpDefaultClient(); - c.getProperties().put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); - c.getProperties().put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); + final NetconfSshClient c = new NetconfClientBuilder().build(); + // Disable default timeouts from mina sshd + c.getProperties().put(CoreModuleProperties.AUTH_TIMEOUT.getName(), "0"); + c.getProperties().put(CoreModuleProperties.IDLE_TIMEOUT.getName(), "0"); + c.getProperties().put(CoreModuleProperties.NIO2_READ_TIMEOUT.getName(), "0"); + c.getProperties().put(CoreModuleProperties.TCP_NODELAY.getName(), true); // TODO make configurable, or somehow reuse netty threadpool c.setNioWorkers(SSH_DEFAULT_NIO_WORKERS); @@ -50,21 +56,22 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { DEFAULT_CLIENT = c; } + private final AtomicBoolean isDisconnected = new AtomicBoolean(); private final AuthenticationHandler authenticationHandler; - private final SshClient sshClient; - private Future negotiationFuture; + private final Future negotiationFuture; + private final NetconfSshClient sshClient; - private AsyncSshHandlerReader sshReadAsyncListener; private AsyncSshHandlerWriter sshWriteAsyncHandler; - private ClientChannel channel; + private NettyAwareChannelSubsystem channel; private ClientSession session; private ChannelPromise connectPromise; - private GenericFutureListener negotiationFutureListener; + private FutureListener negotiationFutureListener; - public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final SshClient sshClient, - final Future negotiationFuture) throws IOException { - this(authenticationHandler, sshClient); + public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final NetconfSshClient sshClient, + final Future negotiationFuture) { + this.authenticationHandler = requireNonNull(authenticationHandler); + this.sshClient = requireNonNull(sshClient); this.negotiationFuture = negotiationFuture; } @@ -73,16 +80,12 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { * * @param authenticationHandler authentication handler * @param sshClient started SshClient - * @throws IOException if the I/O operation fails */ - public AsyncSshHandler(final AuthenticationHandler authenticationHandler, - final SshClient sshClient) throws IOException { - this.authenticationHandler = Preconditions.checkNotNull(authenticationHandler); - this.sshClient = Preconditions.checkNotNull(sshClient); + public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final NetconfSshClient sshClient) { + this(authenticationHandler, sshClient, null); } - public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) - throws IOException { + public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) { return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT); } @@ -93,133 +96,148 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { * @param authenticationHandler authentication handler * @param negotiationFuture negotiation future * @return {@code AsyncSshHandler} - * @throws IOException if the I/O operation fails */ public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler, - final Future negotiationFuture) throws IOException { - return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT, negotiationFuture); + final Future negotiationFuture, final @Nullable NetconfSshClient sshClient) { + return new AsyncSshHandler(authenticationHandler, sshClient != null ? sshClient : DEFAULT_CLIENT, + negotiationFuture); } - private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) throws IOException { - LOG.debug("Starting SSH to {} on channel: {}", address, ctx.channel()); - - final ConnectFuture sshConnectionFuture = sshClient.connect(authenticationHandler.getUsername(), address); - sshConnectionFuture.addListener(future -> { - if (future.isConnected()) { - handleSshSessionCreated(future, ctx); - } else { - handleSshSetupFailure(ctx, future.getException()); - } - }); + @Override + public synchronized void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) { + sshWriteAsyncHandler.write(ctx, msg, promise); } - private synchronized void handleSshSessionCreated(final ConnectFuture future, final ChannelHandlerContext ctx) { - try { - LOG.trace("SSH session created on channel: {}", ctx.channel()); - - session = future.getSession(); - final AuthFuture authenticateFuture = authenticationHandler.authenticate(session); - authenticateFuture.addListener(future1 -> { - if (future1.isSuccess()) { - handleSshAuthenticated(session, ctx); - } else { - // Exception does not have to be set in the future, add simple exception in such case - final Throwable exception = future1.getException() == null - ? new IllegalStateException("Authentication failed") : future1.getException(); - handleSshSetupFailure(ctx, exception); + @Override + public synchronized void connect(final ChannelHandlerContext ctx, final SocketAddress remoteAddress, + final SocketAddress localAddress, final ChannelPromise promise) throws IOException { + LOG.debug("SSH session connecting on channel {}. promise: {}", ctx.channel(), promise); + connectPromise = requireNonNull(promise); + + if (negotiationFuture != null) { + negotiationFutureListener = future -> { + if (future.isSuccess()) { + promise.setSuccess(); } - }); - } catch (final IOException e) { - handleSshSetupFailure(ctx, e); + }; + //complete connection promise with netconf negotiation future + negotiationFuture.addListener(negotiationFutureListener); } + + LOG.debug("Starting SSH to {} on channel: {}", remoteAddress, ctx.channel()); + sshClient.connect(authenticationHandler.getUsername(), remoteAddress) + // FIXME: this is a blocking call, we should handle this with a concurrently-scheduled timeout. We do not + // have a Timer ready, so perhaps we should be using the event loop? + .verify(ctx.channel().config().getConnectTimeoutMillis(), TimeUnit.MILLISECONDS) + .addListener(future -> onConnectComplete(future, ctx)); + } + + private void onConnectComplete(final ConnectFuture future, final ChannelHandlerContext ctx) { + final var cause = future.getException(); + if (cause != null) { + onOpenFailure(ctx, cause); + return; + } + + final var clientSession = future.getSession(); + LOG.trace("SSH session {} created on channel: {}", clientSession, ctx.channel()); + verify(clientSession instanceof NettyAwareClientSession, "Unexpected session %s", clientSession); + onConnectComplete((NettyAwareClientSession) clientSession, ctx); } - private synchronized void handleSshAuthenticated(final ClientSession newSession, final ChannelHandlerContext ctx) { + private synchronized void onConnectComplete(final NettyAwareClientSession clientSession, + final ChannelHandlerContext ctx) { + session = clientSession; + + final AuthFuture authFuture; try { - LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), - newSession.getServerVersion()); + authFuture = authenticationHandler.authenticate(clientSession); + } catch (final IOException e) { + onOpenFailure(ctx, e); + return; + } - channel = newSession.createSubsystemChannel(SUBSYSTEM); - channel.setStreaming(ClientChannel.Streaming.Async); - channel.open().addListener(future -> { - if (future.isOpened()) { - handleSshChanelOpened(ctx); - } else { - handleSshSetupFailure(ctx, future.getException()); - } - }); + authFuture.addListener(future -> onAuthComplete(future, clientSession, ctx)); + } + + private void onAuthComplete(final AuthFuture future, final NettyAwareClientSession clientSession, + final ChannelHandlerContext ctx) { + final var cause = future.getException(); + if (cause != null) { + onOpenFailure(ctx, new AuthenticationFailedException("Authentication failed", cause)); + return; + } + + onAuthComplete(clientSession, ctx); + } + private synchronized void onAuthComplete(final NettyAwareClientSession clientSession, + final ChannelHandlerContext ctx) { + LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), + clientSession.getServerVersion()); + final OpenFuture openFuture; + try { + channel = clientSession.createSubsystemChannel(SUBSYSTEM, ctx); + channel.setStreaming(ClientChannel.Streaming.Async); + openFuture = channel.open(); } catch (final IOException e) { - handleSshSetupFailure(ctx, e); + onOpenFailure(ctx, e); + return; } + + openFuture.addListener(future -> onOpenComplete(future, ctx)); } - private synchronized void handleSshChanelOpened(final ChannelHandlerContext ctx) { + private void onOpenComplete(final OpenFuture future, final ChannelHandlerContext ctx) { + final var cause = future.getException(); + if (cause != null) { + onOpenFailure(ctx, cause); + return; + } + + onOpenComplete(ctx); + } + + private synchronized void onOpenComplete(final ChannelHandlerContext ctx) { LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel()); if (negotiationFuture == null) { connectPromise.setSuccess(); } - // TODO we should also read from error stream and at least log from that - - sshReadAsyncListener = new AsyncSshHandlerReader(() -> AsyncSshHandler.this.disconnect(ctx, ctx.newPromise()), - msg -> ctx.fireChannelRead(msg), channel.toString(), channel.getAsyncOut()); - - // if readAsyncListener receives immediate close, - // it will close this handler and closing this handler sets channel variable to null - if (channel != null) { - sshWriteAsyncHandler = new AsyncSshHandlerWriter(channel.getAsyncIn()); - ctx.fireChannelActive(); - } + sshWriteAsyncHandler = new AsyncSshHandlerWriter(channel.getAsyncIn()); + ctx.fireChannelActive(); + channel.onClose(() -> disconnect(ctx, ctx.newPromise())); } - private synchronized void handleSshSetupFailure(final ChannelHandlerContext ctx, final Throwable error) { - LOG.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), error); + private synchronized void onOpenFailure(final ChannelHandlerContext ctx, final Throwable cause) { + LOG.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), cause); // If the promise is not yet done, we have failed with initial connect and set connectPromise to failure if (!connectPromise.isDone()) { - connectPromise.setFailure(error); + connectPromise.setFailure(cause); } disconnect(ctx, ctx.newPromise()); } @Override - public synchronized void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) { - sshWriteAsyncHandler.write(ctx, msg, promise); + public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) { + disconnect(ctx, promise); } @Override - public synchronized void connect(final ChannelHandlerContext ctx, final SocketAddress remoteAddress, - final SocketAddress localAddress, final ChannelPromise promise) throws Exception { - LOG.debug("SSH session connecting on channel {}. promise: {} ", ctx.channel(), connectPromise); - this.connectPromise = promise; - - if (negotiationFuture != null) { - - negotiationFutureListener = future -> { - if (future.isSuccess()) { - connectPromise.setSuccess(); - } - }; - //complete connection promise with netconf negotiation future - negotiationFuture.addListener(negotiationFutureListener); + public void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) { + if (isDisconnected.compareAndSet(false, true)) { + safelyDisconnect(ctx, promise); } - startSsh(ctx, remoteAddress); - } - - @Override - public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception { - disconnect(ctx, promise); } @SuppressWarnings("checkstyle:IllegalCatch") - @Override - public synchronized void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) { + private synchronized void safelyDisconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) { LOG.trace("Closing SSH session on channel: {} with connect promise in state: {}", - ctx.channel(),connectPromise); + ctx.channel(), connectPromise); // If we have already succeeded and the session was dropped after, // we need to fire inactive to notify reconnect logic @@ -231,10 +249,6 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { sshWriteAsyncHandler.close(); } - if (sshReadAsyncListener != null) { - sshReadAsyncListener.close(); - } - //If connection promise is not already set, it means negotiation failed //we must set connection promise to failure if (!connectPromise.isDone()) { @@ -249,10 +263,12 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { if (session != null && !session.isClosed() && !session.isClosing()) { session.close(false).addListener(future -> { - if (!future.isClosed()) { - session.close(true); + synchronized (this) { + if (!future.isClosed()) { + session.close(true); + } + session = null; } - session = null; }); } @@ -268,9 +284,13 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { LOG.warn("Unable to cleanup all resources for channel: {}. Ignoring.", ctx.channel(), e); } - channel = null; + if (channel != null) { + //TODO: see if calling just close() is sufficient + //channel.close(false); + channel.close(); + channel = null; + } promise.setSuccess(); LOG.debug("SSH session closed on channel: {}", ctx.channel()); } - }