transport/transport-ssh/src/main/java/org/opendaylight/netconf/transport/ssh/SSHServer.java

   1 /*
   2  * Copyright (c) 2022 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.transport.ssh;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import io.netty.bootstrap.Bootstrap;
  17 import io.netty.bootstrap.ServerBootstrap;
  18 import io.netty.channel.EventLoopGroup;
  19 import java.io.IOException;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.netconf.shaded.sshd.common.session.Session;
  22 import org.opendaylight.netconf.shaded.sshd.netty.NettyIoServiceFactoryFactory;
  23 import org.opendaylight.netconf.transport.api.TransportChannelListener;
  24 import org.opendaylight.netconf.transport.api.TransportStack;
  25 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  26 import org.opendaylight.netconf.transport.tcp.TCPClient;
  27 import org.opendaylight.netconf.transport.tcp.TCPServer;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.server.rev230417.SshServerGrouping;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.client.rev230417.TcpClientGrouping;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.server.rev230417.TcpServerGrouping;
  31 import org.opendaylight.yangtools.yang.common.Empty;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * A {@link TransportStack} acting as an SSH server.
  37  */
  38 public final class SSHServer extends SSHTransportStack {
  39     private static final Logger LOG = LoggerFactory.getLogger(SSHServer.class);
  40
  41     private final String subsystem;
  42
  43     private SSHServer(final String subsystem, final TransportChannelListener listener,
  44             final TransportSshServer sshServer) {
  45         super(listener, sshServer, sshServer.getSessionFactory());
  46         this.subsystem = requireNonNull(subsystem);
  47     }
  48
  49     static SSHServer of(final NettyIoServiceFactoryFactory ioServiceFactory, final EventLoopGroup group,
  50             final String subsystem, final TransportChannelListener listener, final SshServerGrouping serverParams,
  51             final ServerFactoryManagerConfigurator configurator) throws UnsupportedConfigurationException {
  52         return new SSHServer(subsystem, listener,
  53             new TransportSshServer.Builder(ioServiceFactory, group)
  54                 .serverParams(serverParams)
  55                 .configurator(configurator)
  56                 .buildChecked());
  57     }
  58
  59     @NonNull ListenableFuture<SSHServer> connect(final Bootstrap bootstrap, final TcpClientGrouping connectParams)
  60             throws UnsupportedConfigurationException {
  61         return transformUnderlay(this, TCPClient.connect(asListener(), bootstrap, connectParams));
  62     }
  63
  64     @NonNull ListenableFuture<SSHServer> listen(final ServerBootstrap bootstrap, final TcpServerGrouping connectParams)
  65             throws UnsupportedConfigurationException {
  66         return transformUnderlay(this, TCPServer.listen(asListener(), bootstrap, connectParams));
  67     }
  68
  69     @Override
  70     void onKeyEstablished(final Session session) {
  71         // No-op
  72     }
  73
  74     @Override
  75     void onAuthenticated(final Session session) throws IOException {
  76         final var sessionId = sessionId(session);
  77         LOG.debug("Awaiting \"{}\" subsystem on session {}", subsystem, sessionId);
  78
  79         Futures.addCallback(cast(session).attachUnderlay(subsystem, getUnderlayOf(sessionId)), new FutureCallback<>() {
  80             @Override
  81             public void onSuccess(final Empty result) {
  82                 // Note: we re-validating the underlay ... we may need to refactor state management to make this
  83                 //       non-awkward
  84                 transportEstablished(sessionId);
  85             }
  86
  87             @Override
  88             public void onFailure(final Throwable cause) {
  89                 LOG.debug("Transport on session {} failed", sessionId, cause);
  90                 deleteSession(sessionId);
  91             }
  92         }, MoreExecutors.directExecutor());
  93     }
  94
  95     private static TransportServerSession cast(final Session session) throws IOException {
  96         return TransportUtils.checkCast(TransportServerSession.class, session);
  97     }
  98 }