netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/impl/RemoteDeviceConnectorImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.topology.singleton.impl;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import com.google.common.collect.Lists;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import java.math.BigDecimal;
  20 import java.net.InetSocketAddress;
  21 import java.net.URL;
  22 import java.util.ArrayList;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  27 import org.opendaylight.netconf.api.NetconfMessage;
  28 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  29 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  30 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  31 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
  32 import org.opendaylight.netconf.nettyutil.ReconnectStrategyFactory;
  33 import org.opendaylight.netconf.nettyutil.TimedReconnectStrategyFactory;
  34 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
  35 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.LoginPasswordHandler;
  36 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  37 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
  38 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  39 import org.opendaylight.netconf.sal.connect.netconf.LibraryModulesSchemas;
  40 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
  41 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceBuilder;
  42 import org.opendaylight.netconf.sal.connect.netconf.SchemalessNetconfDevice;
  43 import org.opendaylight.netconf.sal.connect.netconf.auth.DatastoreBackedPublicKeyAuth;
  44 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  45 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  46 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  47 import org.opendaylight.netconf.sal.connect.netconf.listener.UserPreferences;
  48 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
  49 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfKeystoreAdapter;
  50 import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider;
  51 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  52 import org.opendaylight.netconf.sal.connect.util.SslHandlerFactoryImpl;
  53 import org.opendaylight.netconf.topology.singleton.api.RemoteDeviceConnector;
  54 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
  55 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  56 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.OdlHelloMessageCapabilities;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.Protocol;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.KeyAuth;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPw;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPwUnencrypted;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.key.auth.KeyBased;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.LoginPassword;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencrypted;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  72 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  73 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  74 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
  75 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
  76 import org.slf4j.Logger;
  77 import org.slf4j.LoggerFactory;
  78
  79 public class RemoteDeviceConnectorImpl implements RemoteDeviceConnector {
  80
  81     private static final Logger LOG = LoggerFactory.getLogger(RemoteDeviceConnectorImpl.class);
  82
  83     // Initializes default constant instances for the case when the default schema repository
  84     // directory cache/schema is used.
  85
  86     private final NetconfTopologySetup netconfTopologyDeviceSetup;
  87     private final RemoteDeviceId remoteDeviceId;
  88     private final String privateKeyPath;
  89     private final String privateKeyPassphrase;
  90     private final AAAEncryptionService encryptionService;
  91     private NetconfConnectorDTO deviceCommunicatorDTO;
  92     private final NetconfKeystoreAdapter keystoreAdapter;
  93     private final DeviceActionFactory deviceActionFactory;
  94
  95     public RemoteDeviceConnectorImpl(final NetconfTopologySetup netconfTopologyDeviceSetup,
  96             final RemoteDeviceId remoteDeviceId, final DeviceActionFactory deviceActionFactory) {
  97         this.netconfTopologyDeviceSetup = requireNonNull(netconfTopologyDeviceSetup);
  98         this.remoteDeviceId = remoteDeviceId;
  99         this.deviceActionFactory = requireNonNull(deviceActionFactory);
 100         this.privateKeyPath = netconfTopologyDeviceSetup.getPrivateKeyPath();
 101         this.privateKeyPassphrase = netconfTopologyDeviceSetup.getPrivateKeyPassphrase();
 102         this.encryptionService = netconfTopologyDeviceSetup.getEncryptionService();
 103         keystoreAdapter = new NetconfKeystoreAdapter(netconfTopologyDeviceSetup.getDataBroker());
 104     }
 105
 106     @Override
 107     public void startRemoteDeviceConnection(final RemoteDeviceHandler<NetconfSessionPreferences> deviceHandler) {
 108
 109         final NetconfNode netconfNode = netconfTopologyDeviceSetup.getNode().augmentation(NetconfNode.class);
 110         final NodeId nodeId = netconfTopologyDeviceSetup.getNode().getNodeId();
 111         requireNonNull(netconfNode.getHost());
 112         requireNonNull(netconfNode.getPort());
 113
 114         this.deviceCommunicatorDTO = createDeviceCommunicator(nodeId, netconfNode, deviceHandler);
 115         final NetconfDeviceCommunicator deviceCommunicator = deviceCommunicatorDTO.getCommunicator();
 116         final NetconfClientSessionListener netconfClientSessionListener = deviceCommunicatorDTO.getSessionListener();
 117         final NetconfReconnectingClientConfiguration clientConfig =
 118                 getClientConfig(netconfClientSessionListener, netconfNode);
 119         final ListenableFuture<NetconfDeviceCapabilities> future = deviceCommunicator
 120                 .initializeRemoteConnection(netconfTopologyDeviceSetup.getNetconfClientDispatcher(), clientConfig);
 121
 122         Futures.addCallback(future, new FutureCallback<NetconfDeviceCapabilities>() {
 123             @Override
 124             public void onSuccess(final NetconfDeviceCapabilities result) {
 125                 LOG.debug("{}: Connector started successfully", remoteDeviceId);
 126             }
 127
 128             @Override
 129             public void onFailure(final Throwable throwable) {
 130                 LOG.error("{}: Connector failed", remoteDeviceId, throwable);
 131             }
 132         }, MoreExecutors.directExecutor());
 133     }
 134
 135     @SuppressWarnings("checkstyle:IllegalCatch")
 136     @Override
 137     public void stopRemoteDeviceConnection() {
 138         if (deviceCommunicatorDTO != null) {
 139             try {
 140                 deviceCommunicatorDTO.close();
 141             } catch (final Exception e) {
 142                 LOG.error("{}: Error at closing device communicator.", remoteDeviceId, e);
 143             }
 144         }
 145     }
 146
 147     @VisibleForTesting
 148     NetconfConnectorDTO createDeviceCommunicator(final NodeId nodeId, final NetconfNode node,
 149                                                  final RemoteDeviceHandler<NetconfSessionPreferences> deviceHandler) {
 150         //setup default values since default value is not supported in mdsal
 151         final long defaultRequestTimeoutMillis = node.getDefaultRequestTimeoutMillis() == null
 152                 ? NetconfTopologyUtils.DEFAULT_REQUEST_TIMEOUT_MILLIS : node.getDefaultRequestTimeoutMillis();
 153         final long keepaliveDelay = node.getKeepaliveDelay() == null
 154                 ? NetconfTopologyUtils.DEFAULT_KEEPALIVE_DELAY : node.getKeepaliveDelay();
 155         final boolean reconnectOnChangedSchema = node.isReconnectOnChangedSchema() == null
 156                 ? NetconfTopologyUtils.DEFAULT_RECONNECT_ON_CHANGED_SCHEMA : node.isReconnectOnChangedSchema();
 157
 158         RemoteDeviceHandler<NetconfSessionPreferences> salFacade = deviceHandler;
 159         if (keepaliveDelay > 0) {
 160             LOG.info("{}: Adding keepalive facade.", remoteDeviceId);
 161             salFacade = new KeepaliveSalFacade(remoteDeviceId, salFacade,
 162                     netconfTopologyDeviceSetup.getKeepaliveExecutor(), keepaliveDelay,
 163                     defaultRequestTimeoutMillis);
 164         }
 165
 166         final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = netconfTopologyDeviceSetup.getSchemaResourcesDTO();
 167
 168         // pre register yang library sources as fallback schemas to schema registry
 169         final List<SchemaSourceRegistration<YangTextSchemaSource>> registeredYangLibSources = Lists.newArrayList();
 170         if (node.getYangLibrary() != null) {
 171             final String yangLibURL = node.getYangLibrary().getYangLibraryUrl().getValue();
 172             final String yangLibUsername = node.getYangLibrary().getUsername();
 173             final String yangLigPassword = node.getYangLibrary().getPassword();
 174
 175             final LibraryModulesSchemas libraryModulesSchemas;
 176             if (yangLibURL != null) {
 177                 if (yangLibUsername != null && yangLigPassword != null) {
 178                     libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL, yangLibUsername, yangLigPassword);
 179                 } else {
 180                     libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL);
 181                 }
 182
 183                 for (final Map.Entry<SourceIdentifier, URL> sourceIdentifierURLEntry :
 184                         libraryModulesSchemas.getAvailableModels().entrySet()) {
 185                     registeredYangLibSources
 186                             .add(schemaResourcesDTO.getSchemaRegistry().registerSchemaSource(
 187                                     new YangLibrarySchemaYangSourceProvider(remoteDeviceId,
 188                                             libraryModulesSchemas.getAvailableModels()),
 189                                     PotentialSchemaSource
 190                                             .create(sourceIdentifierURLEntry.getKey(), YangTextSchemaSource.class,
 191                                                     PotentialSchemaSource.Costs.REMOTE_IO.getValue())));
 192                 }
 193             }
 194         }
 195
 196         final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> device;
 197         if (node.isSchemaless()) {
 198             device = new SchemalessNetconfDevice(remoteDeviceId, salFacade);
 199         } else {
 200             device = new NetconfDeviceBuilder()
 201                     .setReconnectOnSchemasChange(reconnectOnChangedSchema)
 202                     .setSchemaResourcesDTO(schemaResourcesDTO)
 203                     .setGlobalProcessingExecutor(netconfTopologyDeviceSetup.getProcessingExecutor())
 204                     .setId(remoteDeviceId)
 205                     .setDeviceActionFactory(deviceActionFactory)
 206                     .setSalFacade(salFacade)
 207                     .build();
 208         }
 209
 210         final Optional<NetconfSessionPreferences> userCapabilities = getUserCapabilities(node);
 211         final int rpcMessageLimit =
 212                 node.getConcurrentRpcLimit() == null
 213                         ? NetconfTopologyUtils.DEFAULT_CONCURRENT_RPC_LIMIT : node.getConcurrentRpcLimit();
 214
 215         if (rpcMessageLimit < 1) {
 216             LOG.info("{}: Concurrent rpc limit is smaller than 1, no limit will be enforced.", remoteDeviceId);
 217         }
 218
 219         NetconfDeviceCommunicator netconfDeviceCommunicator =
 220              userCapabilities.isPresent() ? new NetconfDeviceCommunicator(remoteDeviceId, device,
 221              new UserPreferences(userCapabilities.get(),
 222                  node.getYangModuleCapabilities() == null ? false : node.getYangModuleCapabilities().isOverride(),
 223                  node.getNonModuleCapabilities() == null ? false : node.getNonModuleCapabilities().isOverride()),
 224              rpcMessageLimit)
 225             : new NetconfDeviceCommunicator(remoteDeviceId, device, rpcMessageLimit);
 226
 227         if (salFacade instanceof KeepaliveSalFacade) {
 228             ((KeepaliveSalFacade)salFacade).setListener(netconfDeviceCommunicator);
 229         }
 230         return new NetconfConnectorDTO(netconfDeviceCommunicator, salFacade);
 231     }
 232
 233     private static Optional<NetconfSessionPreferences> getUserCapabilities(final NetconfNode node) {
 234         if (node.getYangModuleCapabilities() == null && node.getNonModuleCapabilities() == null) {
 235             return Optional.empty();
 236         }
 237         final List<String> capabilities = new ArrayList<>();
 238
 239         if (node.getYangModuleCapabilities() != null) {
 240             capabilities.addAll(node.getYangModuleCapabilities().getCapability());
 241         }
 242
 243         //non-module capabilities should not exist in yang module capabilities
 244         final NetconfSessionPreferences netconfSessionPreferences = NetconfSessionPreferences.fromStrings(capabilities);
 245         checkState(netconfSessionPreferences.getNonModuleCaps().isEmpty(),
 246                 "List yang-module-capabilities/capability should contain only module based capabilities. "
 247                         + "Non-module capabilities used: " + netconfSessionPreferences.getNonModuleCaps());
 248
 249         if (node.getNonModuleCapabilities() != null) {
 250             capabilities.addAll(node.getNonModuleCapabilities().getCapability());
 251         }
 252
 253         return Optional.of(NetconfSessionPreferences.fromStrings(capabilities, CapabilityOrigin.UserDefined));
 254     }
 255
 256     //TODO: duplicate code
 257     private static InetSocketAddress getSocketAddress(final Host host, final int port) {
 258         if (host.getDomainName() != null) {
 259             return new InetSocketAddress(host.getDomainName().getValue(), port);
 260         } else {
 261             final IpAddress ipAddress = host.getIpAddress();
 262             final String ip = ipAddress.getIpv4Address() != null ? ipAddress.getIpv4Address().getValue() :
 263                     ipAddress.getIpv6Address().getValue();
 264             return new InetSocketAddress(ip, port);
 265         }
 266     }
 267
 268     @VisibleForTesting
 269     NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener,
 270                                                            final NetconfNode node) {
 271
 272         //setup default values since default value is not supported in mdsal
 273         final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null
 274                 ? NetconfTopologyUtils.DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis();
 275         final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null
 276                 ? NetconfTopologyUtils.DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts();
 277         final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null
 278                 ? NetconfTopologyUtils.DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS : node.getBetweenAttemptsTimeoutMillis();
 279         final boolean isTcpOnly = node.isTcpOnly() == null
 280                 ? NetconfTopologyUtils.DEFAULT_IS_TCP_ONLY : node.isTcpOnly();
 281         final BigDecimal sleepFactor = node.getSleepFactor() == null
 282                 ? NetconfTopologyUtils.DEFAULT_SLEEP_FACTOR : node.getSleepFactor();
 283
 284         final InetSocketAddress socketAddress = getSocketAddress(node.getHost(), node.getPort().getValue());
 285
 286         final ReconnectStrategyFactory sf =
 287                 new TimedReconnectStrategyFactory(netconfTopologyDeviceSetup.getEventExecutor(), maxConnectionAttempts,
 288                         betweenAttemptsTimeoutMillis, sleepFactor);
 289
 290
 291         final NetconfReconnectingClientConfigurationBuilder reconnectingClientConfigurationBuilder;
 292         final Protocol protocol = node.getProtocol();
 293         if (isTcpOnly) {
 294             reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
 295                     .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TCP)
 296                     .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
 297         } else if (protocol == null || protocol.getName() == Protocol.Name.SSH) {
 298             reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
 299                     .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH)
 300                     .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
 301         } else if (protocol.getName() == Protocol.Name.TLS) {
 302             reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
 303                     .withSslHandlerFactory(new SslHandlerFactoryImpl(keystoreAdapter, protocol.getSpecification()))
 304                     .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TLS);
 305         } else {
 306             throw new IllegalStateException("Unsupported protocol type: " + protocol.getName());
 307         }
 308
 309         final List<Uri> odlHelloCapabilities = getOdlHelloCapabilities(node);
 310         if (odlHelloCapabilities != null) {
 311             reconnectingClientConfigurationBuilder.withOdlHelloCapabilities(odlHelloCapabilities);
 312         }
 313
 314         return reconnectingClientConfigurationBuilder
 315                 .withAddress(socketAddress)
 316                 .withConnectionTimeoutMillis(clientConnectionTimeoutMillis)
 317                 .withReconnectStrategy(sf.createReconnectStrategy())
 318                 .withConnectStrategyFactory(sf)
 319                 .withSessionListener(listener)
 320                 .build();
 321     }
 322
 323     private static List<Uri> getOdlHelloCapabilities(final NetconfNode node) {
 324         final OdlHelloMessageCapabilities helloCapabilities = node.getOdlHelloMessageCapabilities();
 325         return helloCapabilities != null ? helloCapabilities.getCapability() : null;
 326     }
 327
 328     private AuthenticationHandler getHandlerFromCredentials(final Credentials credentials) {
 329         if (credentials instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 330                 .rev150114.netconf.node.credentials.credentials.LoginPassword) {
 331             final org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 332                     .rev150114.netconf.node.credentials.credentials.LoginPassword loginPassword
 333                     = (org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 334                     .rev150114.netconf.node.credentials.credentials.LoginPassword) credentials;
 335             return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
 336         }
 337         if (credentials instanceof LoginPwUnencrypted) {
 338             final LoginPasswordUnencrypted loginPassword =
 339                     ((LoginPwUnencrypted) credentials).getLoginPasswordUnencrypted();
 340             return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
 341         }
 342         if (credentials instanceof LoginPw) {
 343             final LoginPassword loginPassword = ((LoginPw) credentials).getLoginPassword();
 344             return new LoginPasswordHandler(loginPassword.getUsername(),
 345                     encryptionService.decrypt(loginPassword.getPassword()));
 346         }
 347         if (credentials instanceof KeyAuth) {
 348             final KeyBased keyPair = ((KeyAuth) credentials).getKeyBased();
 349             return new DatastoreBackedPublicKeyAuth(keyPair.getUsername(), keyPair.getKeyId(),
 350                     keystoreAdapter, encryptionService);
 351         }
 352         throw new IllegalStateException("Unsupported credential type: " + credentials.getClass());
 353     }
 354 }