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 com.google.common.util.concurrent.ListenableFuture;
  11 import io.netty.bootstrap.Bootstrap;
  12 import io.netty.bootstrap.ServerBootstrap;
  13 import io.netty.channel.EventLoopGroup;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.netconf.shaded.sshd.common.session.Session;
  16 import org.opendaylight.netconf.shaded.sshd.netty.NettyIoServiceFactoryFactory;
  17 import org.opendaylight.netconf.shaded.sshd.server.subsystem.SubsystemFactory;
  18 import org.opendaylight.netconf.transport.api.TransportChannelListener;
  19 import org.opendaylight.netconf.transport.api.TransportStack;
  20 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  21 import org.opendaylight.netconf.transport.tcp.TCPClient;
  22 import org.opendaylight.netconf.transport.tcp.TCPServer;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.server.rev230417.SshServerGrouping;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.client.rev230417.TcpClientGrouping;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.server.rev230417.TcpServerGrouping;
  26
  27 /**
  28  * A {@link TransportStack} acting as an SSH server.
  29  */
  30 public final class SSHServer extends SSHTransportStack {
  31     private SSHServer(final TransportChannelListener listener, final TransportSshServer sshServer) {
  32         super(listener, sshServer, sshServer.getSessionFactory());
  33     }
  34
  35     static SSHServer of(final NettyIoServiceFactoryFactory ioServiceFactory, final EventLoopGroup group,
  36             final TransportChannelListener listener, final SubsystemFactory subsystemFactory,
  37             final SshServerGrouping serverParams, final ServerFactoryManagerConfigurator configurator)
  38                 throws UnsupportedConfigurationException {
  39         return new SSHServer(listener, new TransportSshServer.Builder(ioServiceFactory, group, subsystemFactory)
  40             .serverParams(serverParams)
  41             .configurator(configurator)
  42             .buildChecked());
  43     }
  44
  45     @NonNull ListenableFuture<SSHServer> connect(final Bootstrap bootstrap, final TcpClientGrouping connectParams)
  46             throws UnsupportedConfigurationException {
  47         return transformUnderlay(this, TCPClient.connect(asListener(), bootstrap, connectParams));
  48     }
  49
  50     @NonNull ListenableFuture<SSHServer> listen(final ServerBootstrap bootstrap, final TcpServerGrouping connectParams)
  51             throws UnsupportedConfigurationException {
  52         return transformUnderlay(this, TCPServer.listen(asListener(), bootstrap, connectParams));
  53     }
  54
  55     @Override
  56     void onKeyEstablished(final Session session) {
  57         // No-op
  58     }
  59 }