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=0d2f6e1aa5aa42868fb6bcec746a87ee168139a9;hb=22755ee880d798830f42cc0d60e84c8602fe3794;hp=8f6e2baa6304583b456901717bf48e4ec3988e7e;hpb=56754e685563cf98a77e2e0772753f95165293b8;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 8f6e2baa63..0d2f6e1aa5 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,29 +5,27 @@ * 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 io.netty.buffer.ByteBuf; +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 java.util.HashMap; -import java.util.Map; -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 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.session.ClientSession; +import org.opendaylight.netconf.shaded.sshd.core.CoreModuleProperties; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -40,40 +38,39 @@ 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 Map props = new HashMap<>(); - props.put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); - props.put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); - - final SshClient c = SshClient.setUpDefaultClient(); + 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); - c.setProperties(props); // TODO make configurable, or somehow reuse netty threadpool c.setNioWorkers(SSH_DEFAULT_NIO_WORKERS); c.start(); 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; } @@ -82,16 +79,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); } @@ -102,25 +95,23 @@ 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) { + 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(new SshFutureListener() { - @Override - public void operationComplete(final ConnectFuture future) { - if (future.isConnected()) { - handleSshSessionCreated(future, ctx); - } else { - handleSshSetupFailure(ctx, future.getException()); - } + final ConnectFuture sshConnectionFuture = sshClient.connect(authenticationHandler.getUsername(), address) + .verify(ctx.channel().config().getConnectTimeoutMillis(), TimeUnit.MILLISECONDS); + sshConnectionFuture.addListener(future -> { + if (future.isConnected()) { + handleSshSessionCreated(future, ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); } }); } @@ -130,18 +121,16 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { LOG.trace("SSH session created on channel: {}", ctx.channel()); session = future.getSession(); + verify(session instanceof NettyAwareClientSession, "Unexpected session %s", session); + final AuthFuture authenticateFuture = authenticationHandler.authenticate(session); - authenticateFuture.addListener(new SshFutureListener() { - @Override - public void operationComplete(final AuthFuture future) { - if (future.isSuccess()) { - handleSshAuthenticated(session, ctx); - } else { - // Exception does not have to be set in the future, add simple exception in such case - final Throwable exception = future.getException() == null - ? new IllegalStateException("Authentication failed") : future.getException(); - handleSshSetupFailure(ctx, exception); - } + final NettyAwareClientSession localSession = (NettyAwareClientSession) session; + authenticateFuture.addListener(future1 -> { + if (future1.isSuccess()) { + handleSshAuthenticated(localSession, ctx); + } else { + handleSshSetupFailure(ctx, new AuthenticationFailedException("Authentication failed", + future1.getException())); } }); } catch (final IOException e) { @@ -149,25 +138,21 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } } - private synchronized void handleSshAuthenticated(final ClientSession session, final ChannelHandlerContext ctx) { - try { - LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), - session.getServerVersion()); + private synchronized void handleSshAuthenticated(final NettyAwareClientSession newSession, + final ChannelHandlerContext ctx) { + LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), + newSession.getServerVersion()); - channel = session.createSubsystemChannel(SUBSYSTEM); + try { + channel = newSession.createSubsystemChannel(SUBSYSTEM, ctx); 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()); - } + channel.open().addListener(future -> { + if (future.isOpened()) { + handleSshChanelOpened(ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); } }); - - } catch (final IOException e) { handleSshSetupFailure(ctx, e); } @@ -180,26 +165,9 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { connectPromise.setSuccess(); } - // TODO we should also read from error stream and at least log from that - - sshReadAsyncListener = new AsyncSshHandlerReader(new AutoCloseable() { - @Override - public void close() throws Exception { - AsyncSshHandler.this.disconnect(ctx, ctx.newPromise()); - } - }, new AsyncSshHandlerReader.ReadMsgHandler() { - @Override - public void onMessageRead(final ByteBuf 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) { @@ -221,17 +189,13 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { @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; + LOG.debug("SSH session connecting on channel {}. promise: {}", ctx.channel(), promise); + connectPromise = requireNonNull(promise); if (negotiationFuture != null) { - - negotiationFutureListener = new GenericFutureListener>() { - @Override - public void operationComplete(final Future future) { - if (future.isSuccess()) { - connectPromise.setSuccess(); - } + negotiationFutureListener = future -> { + if (future.isSuccess()) { + promise.setSuccess(); } }; //complete connection promise with netconf negotiation future @@ -241,15 +205,21 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } @Override - public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception { + public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) { disconnect(ctx, promise); } - @SuppressWarnings("checkstyle:IllegalCatch") @Override - public synchronized void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) { + public void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) { + if (isDisconnected.compareAndSet(false, true)) { + safelyDisconnect(ctx, promise); + } + } + + @SuppressWarnings("checkstyle:IllegalCatch") + 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 @@ -261,10 +231,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()) { @@ -278,10 +244,9 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } if (session != null && !session.isClosed() && !session.isClosing()) { - session.close(false).addListener(new SshFutureListener() { - @Override - public void operationComplete(final CloseFuture future) { - if (future.isClosed() == false) { + session.close(false).addListener(future -> { + synchronized (this) { + if (!future.isClosed()) { session.close(true); } session = null; @@ -301,9 +266,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()); } - }