transport/transport-ssh/src/main/java/org/opendaylight/netconf/transport/ssh/SSHClient.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.group.DefaultChannelGroup;
  14 import io.netty.util.concurrent.GlobalEventExecutor;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.netconf.shaded.sshd.client.ClientFactoryManager;
  17 import org.opendaylight.netconf.shaded.sshd.client.session.ClientSessionImpl;
  18 import org.opendaylight.netconf.shaded.sshd.client.session.SessionFactory;
  19 import org.opendaylight.netconf.shaded.sshd.common.io.IoHandler;
  20 import org.opendaylight.netconf.transport.api.TransportChannelListener;
  21 import org.opendaylight.netconf.transport.api.TransportStack;
  22 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  23 import org.opendaylight.netconf.transport.tcp.TCPClient;
  24 import org.opendaylight.netconf.transport.tcp.TCPServer;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev230417.SshClientGrouping;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.client.rev230417.TcpClientGrouping;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.tcp.server.rev230417.TcpServerGrouping;
  28
  29 /**
  30  * A {@link TransportStack} acting as an SSH client.
  31  */
  32 public final class SSHClient extends SSHTransportStack {
  33     private final ClientFactoryManager clientFactoryManager;
  34     private final SessionFactory sessionFactory;
  35
  36     private SSHClient(final TransportChannelListener listener, final ClientFactoryManager clientFactoryManager,
  37             final String username) {
  38         super(listener);
  39         this.clientFactoryManager = clientFactoryManager;
  40         this.clientFactoryManager.addSessionListener(new UserAuthSessionListener(sessionAuthHandlers, sessions));
  41         sessionFactory = new SessionFactory(clientFactoryManager) {
  42             @Override
  43             protected ClientSessionImpl setupSession(final ClientSessionImpl session) {
  44                 session.setUsername(username);
  45                 return session;
  46             }
  47         };
  48         ioService = new SshIoService(this.clientFactoryManager,
  49                 new DefaultChannelGroup("sshd-client-channels", GlobalEventExecutor.INSTANCE),
  50                 sessionFactory);
  51     }
  52
  53     @Override
  54     IoHandler getSessionFactory() {
  55         return sessionFactory;
  56     }
  57
  58     public static @NonNull ListenableFuture<SSHClient> connect(final TransportChannelListener listener,
  59             final Bootstrap bootstrap, final TcpClientGrouping connectParams,
  60             final SshClientGrouping clientParams) throws UnsupportedConfigurationException {
  61         final var sshClient = newClient(listener, clientParams);
  62         return transformUnderlay(sshClient, TCPClient.connect(sshClient.asListener(), bootstrap, connectParams));
  63     }
  64
  65     public static @NonNull ListenableFuture<SSHClient> listen(final TransportChannelListener listener,
  66             final ServerBootstrap bootstrap, final TcpServerGrouping listenParams, final SshClientGrouping clientParams)
  67             throws UnsupportedConfigurationException {
  68         final var sshClient = newClient(listener, clientParams);
  69         return transformUnderlay(sshClient, TCPServer.listen(sshClient.asListener(), bootstrap, listenParams));
  70     }
  71
  72     private static SSHClient newClient(final TransportChannelListener listener, final SshClientGrouping clientParams)
  73             throws UnsupportedConfigurationException {
  74         final var clientIdentity = clientParams.getClientIdentity();
  75         final var username = clientIdentity == null ? "" : clientIdentity.getUsername();
  76
  77         return new SSHClient(listener, new TransportSshClient.Builder()
  78             .transportParams(clientParams.getTransportParams())
  79             .keepAlives(clientParams.getKeepalives())
  80             .clientIdentity(clientParams.getClientIdentity())
  81             .serverAuthentication(clientParams.getServerAuthentication())
  82             .buildChecked(), username);
  83     }
  84 }