2 * Copyright (c) 2013 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.controller.netconf.osgi;
10 import com.google.common.base.Optional;
11 import java.io.FileInputStream;
12 import java.net.InetSocketAddress;
13 import org.opendaylight.controller.netconf.ssh.NetconfSSHServer;
14 import org.opendaylight.controller.netconf.ssh.authentication.AuthProvider;
15 import org.opendaylight.controller.netconf.util.osgi.NetconfConfigUtil;
16 import org.opendaylight.controller.usermanager.IUserManager;
17 import org.osgi.framework.BundleActivator;
18 import org.osgi.framework.BundleContext;
19 import org.osgi.framework.ServiceReference;
20 import org.osgi.util.tracker.ServiceTracker;
21 import org.osgi.util.tracker.ServiceTrackerCustomizer;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
26 * Activator for netconf SSH bundle which creates SSH bridge between netconf client and netconf server. Activator
27 * starts SSH Server in its own thread. This thread is closed when activator calls stop() method. Server opens socket
28 * and listen for client connections. Each client connection creation is handled in separate
29 * {@link org.opendaylight.controller.netconf.ssh.threads.SocketThread} thread.
30 * This thread creates two additional threads {@link org.opendaylight.controller.netconf.ssh.threads.IOThread}
31 * forwarding data from/to client.IOThread closes servers session and server connection when it gets -1 on input stream.
32 * {@link org.opendaylight.controller.netconf.ssh.threads.IOThread}'s run method waits for -1 on input stream to finish.
33 * All threads are daemons.
35 public class NetconfSSHActivator implements BundleActivator{
37 private NetconfSSHServer server;
38 private static final Logger logger = LoggerFactory.getLogger(NetconfSSHActivator.class);
39 private static final String EXCEPTION_MESSAGE = "Netconf ssh bridge is not available.";
40 private IUserManager iUserManager;
41 private BundleContext context = null;
43 ServiceTrackerCustomizer<IUserManager, IUserManager> customizer = new ServiceTrackerCustomizer<IUserManager, IUserManager>(){
45 public IUserManager addingService(ServiceReference<IUserManager> reference) {
46 logger.info("Service {} added, let there be SSH bridge.", reference);
47 iUserManager = context.getService(reference);
49 onUserManagerFound(iUserManager);
50 } catch (Exception e) {
51 logger.trace("Can't start SSH server due to {}",e);
56 public void modifiedService(ServiceReference<IUserManager> reference, IUserManager service) {
57 logger.info("Replacing modified service {} in netconf SSH.", reference);
58 server.addUserManagerService(service);
61 public void removedService(ServiceReference<IUserManager> reference, IUserManager service) {
62 logger.info("Removing service {} from netconf SSH. " +
63 "SSH won't authenticate users until IUserManeger service will be started.", reference);
64 removeUserManagerService();
70 public void start(BundleContext context) throws Exception {
71 this.context = context;
72 listenForManagerService();
76 public void stop(BundleContext context) throws Exception {
79 logger.trace("Netconf SSH bridge is down ...");
82 private void startSSHServer() throws Exception {
83 logger.trace("Starting netconf SSH bridge.");
84 Optional<InetSocketAddress> sshSocketAddressOptional = NetconfConfigUtil.extractSSHNetconfAddress(context, EXCEPTION_MESSAGE);
85 InetSocketAddress tcpSocketAddress = NetconfConfigUtil.extractTCPNetconfAddress(context,
86 EXCEPTION_MESSAGE, true);
88 if (sshSocketAddressOptional.isPresent()){
89 String path = NetconfConfigUtil.getPrivateKeyPath(context);
90 path = path.replace("\\", "/");
92 throw new Exception("Missing netconf.ssh.pk.path key in configuration file.");
95 try (FileInputStream fis = new FileInputStream(path)){
96 AuthProvider authProvider = new AuthProvider(iUserManager,fis);
97 this.server = NetconfSSHServer.start(sshSocketAddressOptional.get().getPort(),tcpSocketAddress,authProvider);
100 Thread serverThread = new Thread(server,"netconf SSH server thread");
101 serverThread.setDaemon(true);
102 serverThread.start();
103 logger.trace("Netconf SSH bridge up and running.");
105 logger.trace("No valid connection configuration for SSH bridge found.");
106 throw new Exception("No valid connection configuration for SSH bridge found.");
109 private void onUserManagerFound(IUserManager userManager) throws Exception{
110 if (server!=null && server.isUp()){
111 server.addUserManagerService(userManager);
116 private void removeUserManagerService(){
117 this.server.removeUserManagerService();
119 private void listenForManagerService(){
120 ServiceTracker<IUserManager, IUserManager> listenerTracker = new ServiceTracker<>(context, IUserManager.class,customizer);
121 listenerTracker.open();