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.api.RemoteDeviceId;
36 import org.opendaylight.netconf.sal.connect.netconf.LibraryModulesSchemas;
37 import org.opendaylight.netconf.sal.connect.netconf.NetconfDevice;
38 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceBuilder;
39 import org.opendaylight.netconf.sal.connect.netconf.SchemalessNetconfDevice;
40 import org.opendaylight.netconf.sal.connect.netconf.auth.DatastoreBackedPublicKeyAuth;
41 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
42 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade;
43 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfKeystoreAdapter;
44 import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider;
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.device.rev221225.connection.parameters.OdlHelloMessageCapabilities;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.connection.parameters.Protocol.Name;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.Credentials;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.credentials.KeyAuth;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.credentials.LoginPw;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.credentials.LoginPwUnencrypted;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
60 import org.opendaylight.yangtools.yang.common.Decimal64;
61 import org.opendaylight.yangtools.yang.common.Empty;
62 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
63 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
64 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
65 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
66 import org.slf4j.Logger;
67 import org.slf4j.LoggerFactory;
69 public class RemoteDeviceConnectorImpl implements RemoteDeviceConnector {
70 private static final Logger LOG = LoggerFactory.getLogger(RemoteDeviceConnectorImpl.class);
72 // Initializes default constant instances for the case when the default schema repository
73 // directory cache/schema is used.
75 private final NetconfTopologySetup netconfTopologyDeviceSetup;
76 private final RemoteDeviceId remoteDeviceId;
77 private final String privateKeyPath;
78 private final String privateKeyPassphrase;
79 private final AAAEncryptionService encryptionService;
80 private final NetconfKeystoreAdapter keystoreAdapter;
81 private final DeviceActionFactory deviceActionFactory;
83 // FIXME: this seems to be a builder-like transition between {start,stop}RemoteDeviceConnection. More documentation
84 // is needed, as to what the lifecycle is here.
85 private NetconfConnectorDTO deviceCommunicatorDTO;
87 public RemoteDeviceConnectorImpl(final NetconfTopologySetup netconfTopologyDeviceSetup,
88 final RemoteDeviceId remoteDeviceId, final DeviceActionFactory deviceActionFactory) {
89 this.netconfTopologyDeviceSetup = requireNonNull(netconfTopologyDeviceSetup);
90 this.remoteDeviceId = remoteDeviceId;
91 this.deviceActionFactory = requireNonNull(deviceActionFactory);
92 privateKeyPath = netconfTopologyDeviceSetup.getPrivateKeyPath();
93 privateKeyPassphrase = netconfTopologyDeviceSetup.getPrivateKeyPassphrase();
94 encryptionService = netconfTopologyDeviceSetup.getEncryptionService();
95 keystoreAdapter = new NetconfKeystoreAdapter(netconfTopologyDeviceSetup.getDataBroker());
99 public void startRemoteDeviceConnection(final RemoteDeviceHandler deviceHandler) {
101 final NetconfNode netconfNode = netconfTopologyDeviceSetup.getNode().augmentation(NetconfNode.class);
102 final NodeId nodeId = netconfTopologyDeviceSetup.getNode().getNodeId();
103 requireNonNull(netconfNode.getHost());
104 requireNonNull(netconfNode.getPort());
106 deviceCommunicatorDTO = createDeviceCommunicator(nodeId, netconfNode, deviceHandler);
107 final NetconfDeviceCommunicator deviceCommunicator = deviceCommunicatorDTO.getCommunicator();
108 final NetconfClientSessionListener netconfClientSessionListener = deviceCommunicatorDTO.getSessionListener();
109 final NetconfReconnectingClientConfiguration clientConfig =
110 getClientConfig(netconfClientSessionListener, netconfNode);
111 final ListenableFuture<Empty> future = deviceCommunicator
112 .initializeRemoteConnection(netconfTopologyDeviceSetup.getNetconfClientDispatcher(), clientConfig);
114 Futures.addCallback(future, new FutureCallback<>() {
116 public void onSuccess(final Empty result) {
117 LOG.debug("{}: Connector started successfully", remoteDeviceId);
121 public void onFailure(final Throwable throwable) {
122 LOG.error("{}: Connector failed", remoteDeviceId, throwable);
124 }, MoreExecutors.directExecutor());
127 @SuppressWarnings("checkstyle:IllegalCatch")
129 public void stopRemoteDeviceConnection() {
130 if (deviceCommunicatorDTO != null) {
132 deviceCommunicatorDTO.close();
133 } catch (final Exception e) {
134 LOG.error("{}: Error at closing device communicator.", remoteDeviceId, e);
140 NetconfConnectorDTO createDeviceCommunicator(final NodeId nodeId, final NetconfNode node,
141 final RemoteDeviceHandler deviceHandler) {
142 //setup default values since default value is not supported in mdsal
143 final long defaultRequestTimeoutMillis = node.getDefaultRequestTimeoutMillis() == null
144 ? NetconfTopologyUtils.DEFAULT_REQUEST_TIMEOUT_MILLIS : node.getDefaultRequestTimeoutMillis().toJava();
145 final long keepaliveDelay = node.getKeepaliveDelay() == null
146 ? NetconfTopologyUtils.DEFAULT_KEEPALIVE_DELAY : node.getKeepaliveDelay().toJava();
147 final boolean reconnectOnChangedSchema = node.getReconnectOnChangedSchema() == null
148 ? NetconfTopologyUtils.DEFAULT_RECONNECT_ON_CHANGED_SCHEMA : node.getReconnectOnChangedSchema();
150 RemoteDeviceHandler salFacade = requireNonNull(deviceHandler);
151 if (keepaliveDelay > 0) {
152 LOG.info("{}: Adding keepalive facade.", remoteDeviceId);
153 salFacade = new KeepaliveSalFacade(remoteDeviceId, salFacade,
154 netconfTopologyDeviceSetup.getKeepaliveExecutor(), keepaliveDelay,
155 defaultRequestTimeoutMillis);
158 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO = netconfTopologyDeviceSetup.getSchemaResourcesDTO();
160 // pre register yang library sources as fallback schemas to schema registry
161 final List<SchemaSourceRegistration<?>> registeredYangLibSources = new ArrayList<>();
162 if (node.getYangLibrary() != null) {
163 final String yangLibURL = node.getYangLibrary().getYangLibraryUrl().getValue();
164 final String yangLibUsername = node.getYangLibrary().getUsername();
165 final String yangLigPassword = node.getYangLibrary().getPassword();
167 final LibraryModulesSchemas libraryModulesSchemas;
168 if (yangLibURL != null) {
169 if (yangLibUsername != null && yangLigPassword != null) {
170 libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL, yangLibUsername, yangLigPassword);
172 libraryModulesSchemas = LibraryModulesSchemas.create(yangLibURL);
175 for (final Map.Entry<SourceIdentifier, URL> sourceIdentifierURLEntry :
176 libraryModulesSchemas.getAvailableModels().entrySet()) {
177 registeredYangLibSources
178 .add(schemaResourcesDTO.getSchemaRegistry().registerSchemaSource(
179 new YangLibrarySchemaYangSourceProvider(remoteDeviceId,
180 libraryModulesSchemas.getAvailableModels()),
181 PotentialSchemaSource
182 .create(sourceIdentifierURLEntry.getKey(), YangTextSchemaSource.class,
183 PotentialSchemaSource.Costs.REMOTE_IO.getValue())));
188 final RemoteDevice<NetconfDeviceCommunicator> device;
189 if (node.getSchemaless()) {
190 device = new SchemalessNetconfDevice(netconfTopologyDeviceSetup.getBaseSchemas(), remoteDeviceId,
193 device = new NetconfDeviceBuilder()
194 .setReconnectOnSchemasChange(reconnectOnChangedSchema)
195 .setSchemaResourcesDTO(schemaResourcesDTO)
196 .setGlobalProcessingExecutor(netconfTopologyDeviceSetup.getProcessingExecutor())
197 .setBaseSchemas(netconfTopologyDeviceSetup.getBaseSchemas())
198 .setId(remoteDeviceId)
199 .setDeviceActionFactory(deviceActionFactory)
200 .setSalFacade(salFacade)
204 final int rpcMessageLimit = node.getConcurrentRpcLimit() == null
205 ? NetconfTopologyUtils.DEFAULT_CONCURRENT_RPC_LIMIT : node.getConcurrentRpcLimit().toJava();
207 if (rpcMessageLimit < 1) {
208 LOG.info("{}: Concurrent rpc limit is smaller than 1, no limit will be enforced.", remoteDeviceId);
211 final var netconfDeviceCommunicator = new NetconfDeviceCommunicator(remoteDeviceId, device, rpcMessageLimit,
212 NetconfNodeUtils.extractUserCapabilities(node));
214 if (salFacade instanceof KeepaliveSalFacade) {
215 ((KeepaliveSalFacade)salFacade).setListener(netconfDeviceCommunicator);
217 return new NetconfConnectorDTO(netconfDeviceCommunicator, salFacade, registeredYangLibSources);
221 NetconfReconnectingClientConfiguration getClientConfig(final NetconfClientSessionListener listener,
222 final NetconfNode node) {
224 //setup default values since default value is not supported in mdsal
225 final long clientConnectionTimeoutMillis = node.getConnectionTimeoutMillis() == null
226 ? NetconfTopologyUtils.DEFAULT_CONNECTION_TIMEOUT_MILLIS : node.getConnectionTimeoutMillis().toJava();
227 final long maxConnectionAttempts = node.getMaxConnectionAttempts() == null
228 ? NetconfTopologyUtils.DEFAULT_MAX_CONNECTION_ATTEMPTS : node.getMaxConnectionAttempts().toJava();
229 final int betweenAttemptsTimeoutMillis = node.getBetweenAttemptsTimeoutMillis() == null
230 ? NetconfTopologyUtils.DEFAULT_BETWEEN_ATTEMPTS_TIMEOUT_MILLIS
231 : node.getBetweenAttemptsTimeoutMillis().toJava();
232 final boolean isTcpOnly = node.getTcpOnly() == null
233 ? NetconfTopologyUtils.DEFAULT_IS_TCP_ONLY : node.getTcpOnly();
234 final Decimal64 sleepFactor = node.getSleepFactor() == null
235 ? NetconfTopologyUtils.DEFAULT_SLEEP_FACTOR : node.getSleepFactor();
237 final InetSocketAddress socketAddress = NetconfNodeUtils.toInetSocketAddress(node);
239 final ReconnectStrategyFactory sf =
240 new TimedReconnectStrategyFactory(netconfTopologyDeviceSetup.getEventExecutor(), maxConnectionAttempts,
241 betweenAttemptsTimeoutMillis, BigDecimal.valueOf(sleepFactor.unscaledValue(), sleepFactor.scale()));
244 final NetconfReconnectingClientConfigurationBuilder reconnectingClientConfigurationBuilder;
245 final var protocol = node.getProtocol();
247 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
248 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TCP)
249 .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
250 } else if (protocol == null || protocol.getName() == Name.SSH) {
251 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
252 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH)
253 .withAuthHandler(getHandlerFromCredentials(node.getCredentials()));
254 } else if (protocol.getName() == Name.TLS) {
255 reconnectingClientConfigurationBuilder = NetconfReconnectingClientConfigurationBuilder.create()
256 .withSslHandlerFactory(new SslHandlerFactoryImpl(keystoreAdapter, protocol.getSpecification()))
257 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.TLS);
259 throw new IllegalStateException("Unsupported protocol type: " + protocol.getName());
262 final List<Uri> odlHelloCapabilities = getOdlHelloCapabilities(node);
263 if (odlHelloCapabilities != null) {
264 reconnectingClientConfigurationBuilder.withOdlHelloCapabilities(odlHelloCapabilities);
267 return reconnectingClientConfigurationBuilder
268 .withAddress(socketAddress)
269 .withConnectionTimeoutMillis(clientConnectionTimeoutMillis)
270 .withReconnectStrategy(sf.createReconnectStrategy())
271 .withConnectStrategyFactory(sf)
272 .withSessionListener(listener)
276 private static List<Uri> getOdlHelloCapabilities(final NetconfNode node) {
277 final OdlHelloMessageCapabilities helloCapabilities = node.getOdlHelloMessageCapabilities();
278 return helloCapabilities != null ? List.copyOf(helloCapabilities.getCapability()) : null;
281 private AuthenticationHandler getHandlerFromCredentials(final Credentials credentials) {
283 instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225
284 .credentials.credentials.LoginPassword loginPassword) {
285 return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
287 if (credentials instanceof LoginPwUnencrypted unencrypted) {
288 final var loginPassword = unencrypted.getLoginPasswordUnencrypted();
289 return new LoginPasswordHandler(loginPassword.getUsername(), loginPassword.getPassword());
291 if (credentials instanceof LoginPw loginPw) {
292 final var loginPassword = loginPw.getLoginPassword();
293 return new LoginPasswordHandler(loginPassword.getUsername(),
294 encryptionService.decrypt(loginPassword.getPassword()));
296 if (credentials instanceof KeyAuth keyAuth) {
297 final var keyPair = keyAuth.getKeyBased();
298 return new DatastoreBackedPublicKeyAuth(keyPair.getUsername(), keyPair.getKeyId(),
299 keystoreAdapter, encryptionService);
301 throw new IllegalStateException("Unsupported credential type: " + credentials.getClass());