2 * Copyright (c) 2022 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.netconf.transport.ssh;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import io.netty.bootstrap.Bootstrap;
14 import io.netty.bootstrap.ServerBootstrap;
15 import io.netty.channel.EventLoopGroup;
16 import io.netty.channel.group.DefaultChannelGroup;
17 import io.netty.util.concurrent.GlobalEventExecutor;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.netconf.shaded.sshd.common.io.IoHandler;
20 import org.opendaylight.netconf.shaded.sshd.netty.NettyIoServiceFactoryFactory;
21 import org.opendaylight.netconf.shaded.sshd.server.ServerFactoryManager;
22 import org.opendaylight.netconf.shaded.sshd.server.session.SessionFactory;
23 import org.opendaylight.netconf.shaded.sshd.server.subsystem.SubsystemFactory;
24 import org.opendaylight.netconf.transport.api.TransportChannelListener;
25 import org.opendaylight.netconf.transport.api.TransportStack;
26 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
27 import org.opendaylight.netconf.transport.tcp.TCPClient;
28 import org.opendaylight.netconf.transport.tcp.TCPServer;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.server.rev230417.SshServerGrouping;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.client.rev230417.TcpClientGrouping;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.server.rev230417.TcpServerGrouping;
34 * A {@link TransportStack} acting as an SSH server.
36 public final class SSHServer extends SSHTransportStack {
37 private final ServerFactoryManager serverFactoryManager;
38 private final SessionFactory serverSessionFactory;
40 private SSHServer(final TransportChannelListener listener, final ServerFactoryManager serverFactoryManager) {
42 this.serverFactoryManager = requireNonNull(serverFactoryManager);
43 this.serverFactoryManager.addSessionListener(new UserAuthSessionListener(sessionAuthHandlers, sessions));
44 serverSessionFactory = new SessionFactory(serverFactoryManager);
45 ioService = new SshIoService(this.serverFactoryManager,
46 new DefaultChannelGroup("sshd-server-channels", GlobalEventExecutor.INSTANCE),
47 serverSessionFactory);
50 static SSHServer of(final NettyIoServiceFactoryFactory ioServiceFactory, final EventLoopGroup group,
51 final TransportChannelListener listener, final SubsystemFactory subsystemFactory,
52 final SshServerGrouping serverParams, final ServerFactoryManagerConfigurator configurator)
53 throws UnsupportedConfigurationException {
54 return new SSHServer(listener, new TransportSshServer.Builder(ioServiceFactory, group, subsystemFactory)
55 .serverParams(serverParams)
56 .configurator(configurator)
61 IoHandler getSessionFactory() {
62 return serverSessionFactory;
65 @NonNull ListenableFuture<SSHServer> connect(final Bootstrap bootstrap, final TcpClientGrouping connectParams)
66 throws UnsupportedConfigurationException {
67 return transformUnderlay(this, TCPClient.connect(asListener(), bootstrap, connectParams));
70 @NonNull ListenableFuture<SSHServer> listen(final ServerBootstrap bootstrap, final TcpServerGrouping connectParams)
71 throws UnsupportedConfigurationException {
72 return transformUnderlay(this, TCPServer.listen(asListener(), bootstrap, connectParams));