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