+++ /dev/null
-/*
- * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-
-package org.opendaylight.netconf.ssh;
-
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.collect.ImmutableList;
-import com.google.common.util.concurrent.ThreadFactoryBuilder;
-import io.netty.channel.EventLoopGroup;
-import java.io.IOException;
-import java.nio.channels.AsynchronousChannelGroup;
-import java.time.Duration;
-import java.util.List;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicLong;
-import org.opendaylight.netconf.shaded.sshd.common.FactoryManager;
-import org.opendaylight.netconf.shaded.sshd.common.NamedFactory;
-import org.opendaylight.netconf.shaded.sshd.common.RuntimeSshException;
-import org.opendaylight.netconf.shaded.sshd.common.cipher.BuiltinCiphers;
-import org.opendaylight.netconf.shaded.sshd.common.cipher.Cipher;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoAcceptor;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoConnector;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoHandler;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoServiceEventListener;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoServiceFactory;
-import org.opendaylight.netconf.shaded.sshd.common.io.IoServiceFactoryFactory;
-import org.opendaylight.netconf.shaded.sshd.common.io.nio2.Nio2Acceptor;
-import org.opendaylight.netconf.shaded.sshd.common.io.nio2.Nio2Connector;
-import org.opendaylight.netconf.shaded.sshd.common.io.nio2.Nio2ServiceFactoryFactory;
-import org.opendaylight.netconf.shaded.sshd.common.session.SessionHeartbeatController.HeartbeatType;
-import org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable;
-import org.opendaylight.netconf.shaded.sshd.core.CoreModuleProperties;
-import org.opendaylight.netconf.shaded.sshd.server.SshServer;
-
-/**
- * Proxy SSH server that just delegates decrypted content to a delegate server within same VM.
- * Implemented using Apache Mina SSH lib.
- */
-public class SshProxyServer implements AutoCloseable {
- private final SshServer sshServer;
- private final ScheduledExecutorService minaTimerExecutor;
- private final EventLoopGroup clientGroup;
- private final IoServiceFactoryFactory nioServiceWithPoolFactoryFactory;
-
- private SshProxyServer(final ScheduledExecutorService minaTimerExecutor, final EventLoopGroup clientGroup,
- final IoServiceFactoryFactory serviceFactory) {
- this.minaTimerExecutor = minaTimerExecutor;
- this.clientGroup = clientGroup;
- nioServiceWithPoolFactoryFactory = serviceFactory;
- sshServer = SshServer.setUpDefaultServer();
- }
-
- public SshProxyServer(final ScheduledExecutorService minaTimerExecutor,
- final EventLoopGroup clientGroup, final ExecutorService nioExecutor) {
- this(minaTimerExecutor, clientGroup, new NioServiceWithPoolFactoryFactory(nioExecutor));
- }
-
- /**
- * Create a server with a shared {@link AsynchronousChannelGroup}. Unlike the other constructor, this does
- * not create a dedicated thread group, which is useful when you need to start a large number of servers and do
- * not want to have a thread group (and hence an anonyous thread) for each of them.
- */
- @VisibleForTesting
- public SshProxyServer(final ScheduledExecutorService minaTimerExecutor, final EventLoopGroup clientGroup,
- final AsynchronousChannelGroup group) {
- this(minaTimerExecutor, clientGroup, new SharedNioServiceFactoryFactory(group));
- }
-
- public void bind(final SshProxyServerConfiguration sshProxyServerConfiguration) throws IOException {
- sshServer.setHost(sshProxyServerConfiguration.getBindingAddress().getHostString());
- sshServer.setPort(sshProxyServerConfiguration.getBindingAddress().getPort());
-
- //remove rc4 ciphers
- final List<NamedFactory<Cipher>> cipherFactories = sshServer.getCipherFactories();
- cipherFactories.removeIf(factory -> factory.getName().contains(BuiltinCiphers.arcfour128.getName())
- || factory.getName().contains(BuiltinCiphers.arcfour256.getName()));
- sshServer.setPasswordAuthenticator(
- (username, password, session)
- -> sshProxyServerConfiguration.getAuthenticator().authenticated(username, password));
-
- sshProxyServerConfiguration.getPublickeyAuthenticator().ifPresent(sshServer::setPublickeyAuthenticator);
-
- sshServer.setKeyPairProvider(sshProxyServerConfiguration.getKeyPairProvider());
-
- sshServer.setIoServiceFactoryFactory(nioServiceWithPoolFactoryFactory);
- sshServer.setScheduledExecutorService(minaTimerExecutor);
-
- final int idleTimeoutMillis = sshProxyServerConfiguration.getIdleTimeout();
- final Duration idleTimeout = Duration.ofMillis(idleTimeoutMillis);
- CoreModuleProperties.IDLE_TIMEOUT.set(sshServer, idleTimeout);
-
- final Duration nioReadTimeout;
- if (idleTimeoutMillis > 0) {
- final long heartBeat = idleTimeoutMillis * 333333L;
- sshServer.setSessionHeartbeat(HeartbeatType.IGNORE, TimeUnit.NANOSECONDS, heartBeat);
- nioReadTimeout = Duration.ofMillis(idleTimeoutMillis + TimeUnit.SECONDS.toMillis(15L));
- } else {
- nioReadTimeout = Duration.ZERO;
- }
- CoreModuleProperties.NIO2_READ_TIMEOUT.set(sshServer, nioReadTimeout);
- CoreModuleProperties.AUTH_TIMEOUT.set(sshServer, idleTimeout);
- CoreModuleProperties.TCP_NODELAY.set(sshServer, Boolean.TRUE);
-
- final RemoteNetconfCommand.NetconfCommandFactory netconfCommandFactory =
- new RemoteNetconfCommand.NetconfCommandFactory(clientGroup,
- sshProxyServerConfiguration.getLocalAddress());
- sshServer.setSubsystemFactories(ImmutableList.of(netconfCommandFactory));
- sshServer.start();
- }
-
- @Override
- public void close() throws IOException {
- try {
- sshServer.stop(true);
- } finally {
- sshServer.close(true);
- }
- }
-
- private abstract static class AbstractNioServiceFactory extends AbstractCloseable implements IoServiceFactory {
- private final FactoryManager manager;
- private final AsynchronousChannelGroup group;
- private final ExecutorService resumeTasks;
- private IoServiceEventListener eventListener;
-
- AbstractNioServiceFactory(final FactoryManager manager, final AsynchronousChannelGroup group,
- final ExecutorService resumeTasks) {
- this.manager = requireNonNull(manager);
- this.group = requireNonNull(group);
- this.resumeTasks = requireNonNull(resumeTasks);
- }
-
- final AsynchronousChannelGroup group() {
- return group;
- }
-
- final ExecutorService resumeTasks() {
- return resumeTasks;
- }
-
- @Override
- public final IoConnector createConnector(final IoHandler handler) {
- return new Nio2Connector(manager, handler, group, resumeTasks);
- }
-
- @Override
- public final IoAcceptor createAcceptor(final IoHandler handler) {
- return new Nio2Acceptor(manager, handler, group, resumeTasks);
- }
-
- @Override
- public final IoServiceEventListener getIoServiceEventListener() {
- return eventListener;
- }
-
- @Override
- public final void setIoServiceEventListener(final IoServiceEventListener listener) {
- eventListener = listener;
- }
- }
-
- /**
- * Based on Nio2ServiceFactory with one addition: injectable executor.
- */
- private static final class NioServiceWithPoolFactory extends AbstractNioServiceFactory {
- NioServiceWithPoolFactory(final FactoryManager manager, final AsynchronousChannelGroup group,
- final ExecutorService resumeTasks) {
- super(manager, group, resumeTasks);
- }
-
- @Override
- protected void doCloseImmediately() {
- try {
- resumeTasks().shutdownNow();
- group().shutdownNow();
- resumeTasks().awaitTermination(5, TimeUnit.SECONDS);
- group().awaitTermination(5, TimeUnit.SECONDS);
- } catch (final IOException | InterruptedException e) {
- log.debug("Exception caught while closing channel group", e);
- } finally {
- super.doCloseImmediately();
- }
- }
- }
-
- private static final class NioServiceWithPoolFactoryFactory extends Nio2ServiceFactoryFactory {
- private static final AtomicLong COUNTER = new AtomicLong();
-
- private final ExecutorServiceFacade nioExecutor;
-
- NioServiceWithPoolFactoryFactory(final ExecutorService nioExecutor) {
- this.nioExecutor = new ExecutorServiceFacade(nioExecutor);
- }
-
- @Override
- public IoServiceFactory create(final FactoryManager manager) {
- try {
- return new NioServiceWithPoolFactory(manager, AsynchronousChannelGroup.withThreadPool(nioExecutor),
- Executors.newSingleThreadExecutor(new ThreadFactoryBuilder()
- .setNameFormat("sshd-resume-read-" + COUNTER.getAndIncrement() + "-%d")
- .build()));
- } catch (final IOException e) {
- throw new RuntimeSshException("Failed to create channel group", e);
- }
- }
- }
-
- private static final class SharedNioServiceFactory extends AbstractNioServiceFactory {
- SharedNioServiceFactory(final FactoryManager manager, final AsynchronousChannelGroup group,
- final ExecutorService resumeTasks) {
- super(manager, group, resumeTasks);
- }
- }
-
- private static final class SharedNioServiceFactoryFactory extends Nio2ServiceFactoryFactory {
- private final AsynchronousChannelGroup group;
-
- SharedNioServiceFactoryFactory(final AsynchronousChannelGroup group) {
- this.group = requireNonNull(group);
- }
-
- @Override
- public IoServiceFactory create(final FactoryManager manager) {
- return new SharedNioServiceFactory(manager, group, Executors.newSingleThreadExecutor());
- }
- }
-}
Code Review / netconf.git / blobdiff