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
   9 package org.opendaylight.netconf.topology.singleton.impl;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Lists;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import io.netty.util.concurrent.EventExecutor;
  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.Objects;
  26 import java.util.Optional;
  27 import javax.annotation.Nullable;
  28 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  29 import org.opendaylight.netconf.api.NetconfMessage;
  30 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  31 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  32 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  33 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
  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.RemoteDevice;
  37 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
  38 import org.opendaylight.netconf.sal.connect.netconf.LibraryModulesSchemas;
  39 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
  40 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceBuilder;
  41 import org.opendaylight.netconf.sal.connect.netconf.SchemalessNetconfDevice;
  42 import org.opendaylight.netconf.sal.connect.netconf.auth.DatastoreBackedPublicKeyAuth;
  43 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  44 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  45 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  46 import org.opendaylight.netconf.sal.connect.netconf.listener.UserPreferences;
  47 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
  48 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfKeystoreAdapter;
  49 import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider;
  50 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  51 import org.opendaylight.netconf.topology.singleton.api.RemoteDeviceConnector;
  52 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfConnectorDTO;
  53 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  54 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  55 import org.opendaylight.protocol.framework.ReconnectStrategy;
  56 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  57 import org.opendaylight.protocol.framework.TimedReconnectStrategy;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.OdlHelloMessageCapabilities;
  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
  94     public RemoteDeviceConnectorImpl(final NetconfTopologySetup netconfTopologyDeviceSetup,
  95                                      final RemoteDeviceId remoteDeviceId) {
  96
  97         this.netconfTopologyDeviceSetup = Preconditions.checkNotNull(netconfTopologyDeviceSetup);
  98         this.remoteDeviceId = remoteDeviceId;
  99         this.privateKeyPath = netconfTopologyDeviceSetup.getPrivateKeyPath();
 100         this.privateKeyPassphrase = netconfTopologyDeviceSetup.getPrivateKeyPassphrase();
 101         this.encryptionService = netconfTopologyDeviceSetup.getEncryptionService();
 102         keystoreAdapter = new NetconfKeystoreAdapter(netconfTopologyDeviceSetup.getDataBroker());
 103     }
 104
 105     @Override
 106     public void startRemoteDeviceConnection(final RemoteDeviceHandler<NetconfSessionPreferences> deviceHandler) {
 107
 108         final NetconfNode netconfNode = netconfTopologyDeviceSetup.getNode().getAugmentation(NetconfNode.class);
 109         final NodeId nodeId = netconfTopologyDeviceSetup.getNode().getNodeId();
 110         Preconditions.checkNotNull(netconfNode.getHost());
 111         Preconditions.checkNotNull(netconfNode.getPort());
 112         Preconditions.checkNotNull(netconfNode.isTcpOnly());
 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(@Nullable 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().getExecutor(), 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().getExecutor())
 204                     .setId(remoteDeviceId)
 205                     .setSalFacade(salFacade)
 206                     .build();
 207         }
 208
 209         final Optional<NetconfSessionPreferences> userCapabilities = getUserCapabilities(node);
 210         final int rpcMessageLimit =
 211                 node.getConcurrentRpcLimit() == null
 212                         ? NetconfTopologyUtils.DEFAULT_CONCURRENT_RPC_LIMIT : node.getConcurrentRpcLimit();
 213
 214         if (rpcMessageLimit < 1) {
 215             LOG.info("{}: Concurrent rpc limit is smaller than 1, no limit will be enforced.", remoteDeviceId);
 216         }
 217
 218         return new NetconfConnectorDTO(
 219                 userCapabilities.isPresent() ? new NetconfDeviceCommunicator(remoteDeviceId, device,
 220                         new UserPreferences(userCapabilities.get(),
 221                                 Objects.isNull(node.getYangModuleCapabilities())
 222                                         ? false : node.getYangModuleCapabilities().isOverride(),
 223                                 Objects.isNull(node.getNonModuleCapabilities())
 224                                         ? false : node.getNonModuleCapabilities().isOverride()), rpcMessageLimit)
 225                         : new NetconfDeviceCommunicator(remoteDeviceId, device, rpcMessageLimit), salFacade);
 226     }
 227
 228     private Optional<NetconfSessionPreferences> getUserCapabilities(final NetconfNode node) {
 229         if (node.getYangModuleCapabilities() == null && node.getNonModuleCapabilities() == null) {
 230             return Optional.empty();
 231         }
 232         final List<String> capabilities = new ArrayList<>();
 233
 234         if (node.getYangModuleCapabilities() != null) {
 235             capabilities.addAll(node.getYangModuleCapabilities().getCapability());
 236         }
 237
 238         //non-module capabilities should not exist in yang module capabilities
 239         final NetconfSessionPreferences netconfSessionPreferences = NetconfSessionPreferences.fromStrings(capabilities);
 240         Preconditions.checkState(netconfSessionPreferences.getNonModuleCaps().isEmpty(),
 241                 "List yang-module-capabilities/capability should contain only module based capabilities. "
 242                         + "Non-module capabilities used: " + netconfSessionPreferences.getNonModuleCaps());
 243
 244         if (node.getNonModuleCapabilities() != null) {
 245             capabilities.addAll(node.getNonModuleCapabilities().getCapability());
 246         }
 247
 248         return Optional.of(NetconfSessionPreferences.fromStrings(capabilities, CapabilityOrigin.UserDefined));
 249     }
 250
 251     //TODO: duplicate code
 252     private InetSocketAddress getSocketAddress(final Host host, final int port) {
 253         if (host.getDomainName() != null) {
 254             return new InetSocketAddress(host.getDomainName().getValue(), port);
 255         } else {
 256             final IpAddress ipAddress = host.getIpAddress();
 257             final String ip = ipAddress.getIpv4Address() != null ? ipAddress.getIpv4Address().getValue() :
 258                     ipAddress.getIpv6Address().getValue();
 259             return new InetSocketAddress(ip, port);
 260         }
 261     }
 262
 263     @VisibleForTesting
 264     NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener,
 265                                                            final NetconfNode node) {
 266
 267         //setup default values since default value is not supported in mdsal
 268         final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null
 269                 ? NetconfTopologyUtils.DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis();
 270         final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null
 271                 ? NetconfTopologyUtils.DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts();
 272         final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null
 273                 ? NetconfTopologyUtils.DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS : node.getBetweenAttemptsTimeoutMillis();
 274         final BigDecimal sleepFactor = node.getSleepFactor() == null
 275                 ? NetconfTopologyUtils.DEFAULT_SLEEP_FACTOR : node.getSleepFactor();
 276
 277         final InetSocketAddress socketAddress = getSocketAddress(node.getHost(), node.getPort().getValue());
 278
 279         final ReconnectStrategyFactory sf =
 280                 new TimedReconnectStrategyFactory(netconfTopologyDeviceSetup.getEventExecutor(), maxConnectionAttempts,
 281                         betweenAttemptsTimeoutMillis, sleepFactor);
 282         final ReconnectStrategy strategy = sf.createReconnectStrategy();
 283
 284         final AuthenticationHandler authHandler = getHandlerFromCredentials(node.getCredentials());
 285
 286         final NetconfReconnectingClientConfigurationBuilder builder =
 287                 NetconfReconnectingClientConfigurationBuilder.create()
 288                         .withAddress(socketAddress)
 289                         .withConnectionTimeoutMillis(clientConnectionTimeoutMillis)
 290                         .withReconnectStrategy(strategy)
 291                         .withAuthHandler(authHandler)
 292                         .withProtocol(node.isTcpOnly()
 293                                 ? NetconfClientConfiguration.NetconfClientProtocol.TCP
 294                                 : NetconfClientConfiguration.NetconfClientProtocol.SSH)
 295                         .withConnectStrategyFactory(sf)
 296                         .withSessionListener(listener);
 297
 298         final List<Uri> odlHelloCapabilities = getOdlHelloCapabilities(node);
 299         if (odlHelloCapabilities != null) {
 300             builder.withOdlHelloCapabilities(odlHelloCapabilities);
 301         }
 302         return builder.build();
 303     }
 304
 305     private List<Uri> getOdlHelloCapabilities(final NetconfNode node) {
 306         final OdlHelloMessageCapabilities helloCapabilities = node.getOdlHelloMessageCapabilities();
 307         if (helloCapabilities != null) {
 308             return helloCapabilities.getCapability();
 309         }
 310         return null;
 311     }
 312
 313     private AuthenticationHandler getHandlerFromCredentials(final Credentials credentials) {
 314         if (credentials instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 315                 .rev150114.netconf.node.credentials.credentials.LoginPassword) {
 316             final org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 317                     .rev150114.netconf.node.credentials.credentials.LoginPassword loginPassword
 318                     = (org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology
 319                     .rev150114.netconf.node.credentials.credentials.LoginPassword) credentials;
 320             return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
 321         }
 322         if (credentials instanceof LoginPwUnencrypted) {
 323             final LoginPasswordUnencrypted loginPassword =
 324                     ((LoginPwUnencrypted) credentials).getLoginPasswordUnencrypted();
 325             return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
 326         }
 327         if (credentials instanceof LoginPw) {
 328             final LoginPassword loginPassword = ((LoginPw) credentials).getLoginPassword();
 329             return new LoginPasswordHandler(loginPassword.getUsername(),
 330                     encryptionService.decrypt(loginPassword.getPassword()));
 331         }
 332         if (credentials instanceof KeyAuth) {
 333             final KeyBased keyPair = ((KeyAuth) credentials).getKeyBased();
 334             return new DatastoreBackedPublicKeyAuth(keyPair.getUsername(), keyPair.getKeyId(),
 335                     keystoreAdapter, encryptionService);
 336         }
 337         throw new IllegalStateException("Unsupported credential type: " + credentials.getClass());
 338     }
 339
 340     private static final class TimedReconnectStrategyFactory implements ReconnectStrategyFactory {
 341         private final Long connectionAttempts;
 342         private final EventExecutor executor;
 343         private final double sleepFactor;
 344         private final int minSleep;
 345
 346         TimedReconnectStrategyFactory(final EventExecutor executor, final Long maxConnectionAttempts,
 347                                       final int minSleep, final BigDecimal sleepFactor) {
 348             if (maxConnectionAttempts != null && maxConnectionAttempts > 0) {
 349                 connectionAttempts = maxConnectionAttempts;
 350             } else {
 351                 connectionAttempts = null;
 352             }
 353
 354             this.sleepFactor = sleepFactor.doubleValue();
 355             this.executor = executor;
 356             this.minSleep = minSleep;
 357         }
 358
 359         @Override
 360         public ReconnectStrategy createReconnectStrategy() {
 361             return new TimedReconnectStrategy(executor, minSleep,
 362                     minSleep, sleepFactor, null /*maxSleep*/, connectionAttempts, null /*deadline*/);
 363         }
 364     }
 365 }