import java.net.SocketAddress;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
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;
private final Future<?> negotiationFuture;
private final NetconfSshClient sshClient;
- private AsyncSshHandlerWriter sshWriteAsyncHandler;
+ // Initialized by connect()
+ @GuardedBy("this")
+ private ChannelPromise connectPromise;
+ private AsyncSshHandlerWriter sshWriteAsyncHandler;
private NettyAwareChannelSubsystem channel;
private ClientSession session;
- private ChannelPromise connectPromise;
private FutureListener<Object> negotiationFutureListener;
public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final NetconfSshClient sshClient,
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)
- .verify(ctx.channel().config().getConnectTimeoutMillis(), TimeUnit.MILLISECONDS);
- 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();
- verify(session instanceof NettyAwareClientSession, "Unexpected session %s", session);
-
- final AuthFuture authenticateFuture = authenticationHandler.authenticate(session);
- final NettyAwareClientSession localSession = (NettyAwareClientSession) session;
- authenticateFuture.addListener(future1 -> {
- if (future1.isSuccess()) {
- handleSshAuthenticated(localSession, ctx);
- } else {
- handleSshSetupFailure(ctx, new AuthenticationFailedException("Authentication failed",
- future1.getException()));
+ @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();
}
- });
+ };
+ //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 synchronized void onConnectComplete(final ConnectFuture connectFuture, final ChannelHandlerContext ctx) {
+ final var cause = connectFuture.getException();
+ if (cause != null) {
+ onOpenFailure(ctx, cause);
+ return;
+ }
+
+ final var clientSession = connectFuture.getSession();
+ LOG.trace("SSH session {} created on channel: {}", clientSession, ctx.channel());
+ verify(clientSession instanceof NettyAwareClientSession, "Unexpected session %s", clientSession);
+
+ final var localSession = (NettyAwareClientSession) clientSession;
+ session = localSession;
+
+ final AuthFuture authFuture;
+ try {
+ authFuture = authenticationHandler.authenticate(localSession);
} catch (final IOException e) {
- handleSshSetupFailure(ctx, e);
+ onOpenFailure(ctx, e);
+ return;
}
+
+ authFuture.addListener(future -> onAuthComplete(future, localSession, ctx));
}
- private synchronized void handleSshAuthenticated(final NettyAwareClientSession newSession,
+ private synchronized void onAuthComplete(final AuthFuture authFuture, final NettyAwareClientSession clientSession,
final ChannelHandlerContext ctx) {
+ final var cause = authFuture.getException();
+ if (cause != null) {
+ onOpenFailure(ctx, new AuthenticationFailedException("Authentication failed", cause));
+ return;
+ }
+
LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(),
- newSession.getServerVersion());
+ clientSession.getServerVersion());
+ final OpenFuture openFuture;
try {
- channel = newSession.createSubsystemChannel(SUBSYSTEM, ctx);
+ channel = clientSession.createSubsystemChannel(SUBSYSTEM, ctx);
channel.setStreaming(ClientChannel.Streaming.Async);
- channel.open().addListener(future -> {
- if (future.isOpened()) {
- handleSshChanelOpened(ctx);
- } else {
- handleSshSetupFailure(ctx, future.getException());
- }
- });
+ 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) {
- LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel());
+ private synchronized void onOpenComplete(final OpenFuture openFuture, final ChannelHandlerContext ctx) {
+ final var cause = openFuture.getException();
+ if (cause != null) {
+ onOpenFailure(ctx, cause);
+ return;
+ }
+ LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel());
if (negotiationFuture == null) {
connectPromise.setSuccess();
}
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);
+ @Holding("this")
+ private 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);
- }
-
- @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(), promise);
- connectPromise = requireNonNull(promise);
-
- if (negotiationFuture != null) {
- negotiationFutureListener = future -> {
- if (future.isSuccess()) {
- promise.setSuccess();
- }
- };
- //complete connection promise with netconf negotiation future
- negotiationFuture.addListener(negotiationFutureListener);
- }
- startSsh(ctx, remoteAddress);
- }
-
@Override
public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) {
disconnect(ctx, promise);
@Override
public void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
if (isDisconnected.compareAndSet(false, true)) {
- safelyDisconnect(ctx, promise);
+ ctx.executor().execute(() -> safelyDisconnect(ctx, promise));
}
}
+ // This method has the potential to interact with the channel pipeline, for example via fireChannelInactive(). These
+ // callbacks need to complete during execution of this method and therefore this method needs to be executing on
+ // the channel's executor.
@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);
+ LOG.trace("Closing SSH session on channel: {} with connect promise in state: {}", ctx.channel(),
+ connectPromise);
// If we have already succeeded and the session was dropped after,
// we need to fire inactive to notify reconnect logic
Code Review / netconf.git / blobdiff