2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.topology.singleton.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.VisibleForTesting;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.MoreExecutors;
17 import java.math.BigDecimal;
18 import java.net.InetSocketAddress;
20 import java.util.ArrayList;
21 import java.util.List;
23 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
24 import org.opendaylight.netconf.client.NetconfClientSessionListener;
25 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
26 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
27 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfigurationBuilder;
28 import org.opendaylight.netconf.nettyutil.ReconnectStrategyFactory;
29 import org.opendaylight.netconf.nettyutil.TimedReconnectStrategyFactory;
30 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
31 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.LoginPasswordHandler;
32 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
33 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
34 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
35 import org.opendaylight.netconf.sal.connect.netconf.LibraryModulesSchemas;
36 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
37 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceBuilder;
38 import org.opendaylight.netconf.sal.connect.netconf.SchemalessNetconfDevice;
39 import org.opendaylight.netconf.sal.connect.netconf.auth.DatastoreBackedPublicKeyAuth;
40 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
41 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
42 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfKeystoreAdapter;
43 import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider;
44 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
45 import org.opendaylight.netconf.sal.connect.util.SslHandlerFactoryImpl;
46 import org.opendaylight.netconf.topology.singleton.api.RemoteDeviceConnector;
47 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
48 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
49 import org.opendaylight.netconf.topology.spi.NetconfConnectorDTO;
50 import org.opendaylight.netconf.topology.spi.NetconfNodeUtils;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.OdlHelloMessageCapabilities;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.parameters.Protocol;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.KeyAuth;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPw;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPwUnencrypted;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.key.auth.KeyBased;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.LoginPassword;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencrypted;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
63 import org.opendaylight.yangtools.yang.common.Decimal64;
64 import org.opendaylight.yangtools.yang.common.Empty;
65 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
66 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
67 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
68 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
72 public class RemoteDeviceConnectorImpl implements RemoteDeviceConnector {
73 private static final Logger LOG = LoggerFactory.getLogger(RemoteDeviceConnectorImpl.class);
75 // Initializes default constant instances for the case when the default schema repository
76 // directory cache/schema is used.
78 private final NetconfTopologySetup netconfTopologyDeviceSetup;
79 private final RemoteDeviceId remoteDeviceId;
80 private final String privateKeyPath;
81 private final String privateKeyPassphrase;
82 private final AAAEncryptionService encryptionService;
83 private final NetconfKeystoreAdapter keystoreAdapter;
84 private final DeviceActionFactory deviceActionFactory;
86 // FIXME: this seems to be a builder-like transition between {start,stop}RemoteDeviceConnection. More documentation
87 // is needed, as to what the lifecycle is here.
88 private NetconfConnectorDTO deviceCommunicatorDTO;
90 public RemoteDeviceConnectorImpl(final NetconfTopologySetup netconfTopologyDeviceSetup,
91 final RemoteDeviceId remoteDeviceId, final DeviceActionFactory deviceActionFactory) {
92 this.netconfTopologyDeviceSetup = requireNonNull(netconfTopologyDeviceSetup);
93 this.remoteDeviceId = remoteDeviceId;
94 this.deviceActionFactory = requireNonNull(deviceActionFactory);
95 privateKeyPath = netconfTopologyDeviceSetup.getPrivateKeyPath();
96 privateKeyPassphrase = netconfTopologyDeviceSetup.getPrivateKeyPassphrase();
97 encryptionService = netconfTopologyDeviceSetup.getEncryptionService();
98 keystoreAdapter = new NetconfKeystoreAdapter(netconfTopologyDeviceSetup.getDataBroker());
102 public void startRemoteDeviceConnection(final RemoteDeviceHandler deviceHandler) {
104 final NetconfNode netconfNode = netconfTopologyDeviceSetup.getNode().augmentation(NetconfNode.class);
105 final NodeId nodeId = netconfTopologyDeviceSetup.getNode().getNodeId();
106 requireNonNull(netconfNode.getHost());
107 requireNonNull(netconfNode.getPort());
109 deviceCommunicatorDTO = createDeviceCommunicator(nodeId, netconfNode, deviceHandler);
110 final NetconfDeviceCommunicator deviceCommunicator = deviceCommunicatorDTO.getCommunicator();
111 final NetconfClientSessionListener netconfClientSessionListener = deviceCommunicatorDTO.getSessionListener();
112 final NetconfReconnectingClientConfiguration clientConfig =
113 getClientConfig(netconfClientSessionListener, netconfNode);
114 final ListenableFuture<Empty> future = deviceCommunicator
115 .initializeRemoteConnection(netconfTopologyDeviceSetup.getNetconfClientDispatcher(), clientConfig);
117 Futures.addCallback(future, new FutureCallback<>() {
119 public void onSuccess(final Empty result) {
120 LOG.debug("{}: Connector started successfully", remoteDeviceId);
124 public void onFailure(final Throwable throwable) {
125 LOG.error("{}: Connector failed", remoteDeviceId, throwable);
127 }, MoreExecutors.directExecutor());
130 @SuppressWarnings("checkstyle:IllegalCatch")
132 public void stopRemoteDeviceConnection() {
133 if (deviceCommunicatorDTO != null) {
135 deviceCommunicatorDTO.close();
136 } catch (final Exception e) {
137 LOG.error("{}: Error at closing device communicator.", remoteDeviceId, e);
143 NetconfConnectorDTO createDeviceCommunicator(final NodeId nodeId, final NetconfNode node,
144 final RemoteDeviceHandler deviceHandler) {
145 //setup default values since default value is not supported in mdsal
146 final long defaultRequestTimeoutMillis = node.getDefaultRequestTimeoutMillis() == null
147 ? NetconfTopologyUtils.DEFAULT_REQUEST_TIMEOUT_MILLIS : node.getDefaultRequestTimeoutMillis().toJava();
148 final long keepaliveDelay = node.getKeepaliveDelay() == null
149 ? NetconfTopologyUtils.DEFAULT_KEEPALIVE_DELAY : node.getKeepaliveDelay().toJava();
150 final boolean reconnectOnChangedSchema = node.getReconnectOnChangedSchema() == null
151 ? NetconfTopologyUtils.DEFAULT_RECONNECT_ON_CHANGED_SCHEMA : node.getReconnectOnChangedSchema();
153 RemoteDeviceHandler salFacade = requireNonNull(deviceHandler);
154 if (keepaliveDelay > 0) {
155 LOG.info("{}: Adding keepalive facade.", remoteDeviceId);
156 salFacade = new KeepaliveSalFacade(remoteDeviceId, salFacade,
157 netconfTopologyDeviceSetup.getKeepaliveExecutor(), keepaliveDelay,
158 defaultRequestTimeoutMillis);
161 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = netconfTopologyDeviceSetup.getSchemaResourcesDTO();
163 // pre register yang library sources as fallback schemas to schema registry
164 final List<SchemaSourceRegistration<?>> registeredYangLibSources = new ArrayList<>();
165 if (node.getYangLibrary() != null) {
166 final String yangLibURL = node.getYangLibrary().getYangLibraryUrl().getValue();
167 final String yangLibUsername = node.getYangLibrary().getUsername();
168 final String yangLigPassword = node.getYangLibrary().getPassword();
170 final LibraryModulesSchemas libraryModulesSchemas;
171 if (yangLibURL != null) {
172 if (yangLibUsername != null && yangLigPassword != null) {
173 libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL, yangLibUsername, yangLigPassword);
175 libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL);
178 for (final Map.Entry<SourceIdentifier, URL> sourceIdentifierURLEntry :
179 libraryModulesSchemas.getAvailableModels().entrySet()) {
180 registeredYangLibSources
181 .add(schemaResourcesDTO.getSchemaRegistry().registerSchemaSource(
182 new YangLibrarySchemaYangSourceProvider(remoteDeviceId,
183 libraryModulesSchemas.getAvailableModels()),
184 PotentialSchemaSource
185 .create(sourceIdentifierURLEntry.getKey(), YangTextSchemaSource.class,
186 PotentialSchemaSource.Costs.REMOTE_IO.getValue())));
191 final RemoteDevice<NetconfDeviceCommunicator> device;
192 if (node.getSchemaless()) {
193 device = new SchemalessNetconfDevice(netconfTopologyDeviceSetup.getBaseSchemas(), remoteDeviceId,
196 device = new NetconfDeviceBuilder()
197 .setReconnectOnSchemasChange(reconnectOnChangedSchema)
198 .setSchemaResourcesDTO(schemaResourcesDTO)
199 .setGlobalProcessingExecutor(netconfTopologyDeviceSetup.getProcessingExecutor())
200 .setBaseSchemas(netconfTopologyDeviceSetup.getBaseSchemas())
201 .setId(remoteDeviceId)
202 .setDeviceActionFactory(deviceActionFactory)
203 .setSalFacade(salFacade)
207 final int rpcMessageLimit = node.getConcurrentRpcLimit() == null
208 ? NetconfTopologyUtils.DEFAULT_CONCURRENT_RPC_LIMIT : node.getConcurrentRpcLimit().toJava();
210 if (rpcMessageLimit < 1) {
211 LOG.info("{}: Concurrent rpc limit is smaller than 1, no limit will be enforced.", remoteDeviceId);
214 final var netconfDeviceCommunicator = new NetconfDeviceCommunicator(remoteDeviceId, device, rpcMessageLimit,
215 NetconfNodeUtils.extractUserCapabilities(node));
217 if (salFacade instanceof KeepaliveSalFacade) {
218 ((KeepaliveSalFacade)salFacade).setListener(netconfDeviceCommunicator);
220 return new NetconfConnectorDTO(netconfDeviceCommunicator, salFacade, registeredYangLibSources);
224 NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener,
225 final NetconfNode node) {
227 //setup default values since default value is not supported in mdsal
228 final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null
229 ? NetconfTopologyUtils.DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis().toJava();
230 final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null
231 ? NetconfTopologyUtils.DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts().toJava();
232 final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null
233 ? NetconfTopologyUtils.DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS
234 : node.getBetweenAttemptsTimeoutMillis().toJava();
235 final boolean isTcpOnly = node.getTcpOnly() == null
236 ? NetconfTopologyUtils.DEFAULT_IS_TCP_ONLY : node.getTcpOnly();
237 final Decimal64 sleepFactor = node.getSleepFactor() == null
238 ? NetconfTopologyUtils.DEFAULT_SLEEP_FACTOR : node.getSleepFactor();
240 final InetSocketAddress socketAddress = NetconfNodeUtils.toInetSocketAddress(node);
242 final ReconnectStrategyFactory sf =
243 new TimedReconnectStrategyFactory(netconfTopologyDeviceSetup.getEventExecutor(), maxConnectionAttempts,
244 betweenAttemptsTimeoutMillis, BigDecimal.valueOf(sleepFactor.unscaledValue(), sleepFactor.scale()));
247 final NetconfReconnectingClientConfigurationBuilder reconnectingClientConfigurationBuilder;
248 final Protocol protocol = node.getProtocol();
250 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
251 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TCP)
252 .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
253 } else if (protocol == null || protocol.getName() == Protocol.Name.SSH) {
254 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
255 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH)
256 .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
257 } else if (protocol.getName() == Protocol.Name.TLS) {
258 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
259 .withSslHandlerFactory(new SslHandlerFactoryImpl(keystoreAdapter, protocol.getSpecification()))
260 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TLS);
262 throw new IllegalStateException("Unsupported protocol type: " + protocol.getName());
265 final List<Uri> odlHelloCapabilities = getOdlHelloCapabilities(node);
266 if (odlHelloCapabilities != null) {
267 reconnectingClientConfigurationBuilder.withOdlHelloCapabilities(odlHelloCapabilities);
270 return reconnectingClientConfigurationBuilder
271 .withAddress(socketAddress)
272 .withConnectionTimeoutMillis(clientConnectionTimeoutMillis)
273 .withReconnectStrategy(sf.createReconnectStrategy())
274 .withConnectStrategyFactory(sf)
275 .withSessionListener(listener)
279 private static List<Uri> getOdlHelloCapabilities(final NetconfNode node) {
280 final OdlHelloMessageCapabilities helloCapabilities = node.getOdlHelloMessageCapabilities();
281 return helloCapabilities != null ? List.copyOf(helloCapabilities.getCapability()) : null;
284 private AuthenticationHandler getHandlerFromCredentials(final Credentials credentials) {
286 instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node
287 .credentials.credentials.LoginPassword loginPassword) {
288 return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
290 if (credentials instanceof LoginPwUnencrypted) {
291 final LoginPasswordUnencrypted loginPassword =
292 ((LoginPwUnencrypted) credentials).getLoginPasswordUnencrypted();
293 return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
295 if (credentials instanceof LoginPw) {
296 final LoginPassword loginPassword = ((LoginPw) credentials).getLoginPassword();
297 return new LoginPasswordHandler(loginPassword.getUsername(),
298 encryptionService.decrypt(loginPassword.getPassword()));
300 if (credentials instanceof KeyAuth) {
301 final KeyBased keyPair = ((KeyAuth) credentials).getKeyBased();
302 return new DatastoreBackedPublicKeyAuth(keyPair.getUsername(), keyPair.getKeyId(),
303 keystoreAdapter, encryptionService);
305 throw new IllegalStateException("Unsupported credential type: " + credentials.getClass());