library/impl/src/main/java/org/opendaylight/ovsdb/lib/impl/OvsdbConnectionService.java

   1 /*
   2  * Copyright (c) 2014, 2015 Red Hat, 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.ovsdb.lib.impl;
  10
  11 import com.fasterxml.jackson.annotation.JsonInclude.Include;
  12 import com.fasterxml.jackson.databind.DeserializationFeature;
  13 import com.fasterxml.jackson.databind.ObjectMapper;
  14 import com.google.common.collect.Maps;
  15 import com.google.common.collect.Sets;
  16 import com.google.common.util.concurrent.FutureCallback;
  17 import com.google.common.util.concurrent.Futures;
  18 import com.google.common.util.concurrent.ListenableFuture;
  19 import com.google.common.util.concurrent.ThreadFactoryBuilder;
  20 import io.netty.bootstrap.Bootstrap;
  21 import io.netty.bootstrap.ServerBootstrap;
  22 import io.netty.channel.AdaptiveRecvByteBufAllocator;
  23 import io.netty.channel.Channel;
  24 import io.netty.channel.ChannelFuture;
  25 import io.netty.channel.ChannelInitializer;
  26 import io.netty.channel.ChannelOption;
  27 import io.netty.channel.EventLoopGroup;
  28 import io.netty.channel.nio.NioEventLoopGroup;
  29 import io.netty.channel.socket.SocketChannel;
  30 import io.netty.channel.socket.nio.NioServerSocketChannel;
  31 import io.netty.channel.socket.nio.NioSocketChannel;
  32 import io.netty.handler.codec.string.StringEncoder;
  33 import io.netty.handler.logging.LogLevel;
  34 import io.netty.handler.logging.LoggingHandler;
  35 import io.netty.handler.ssl.SslHandler;
  36 import io.netty.handler.timeout.IdleStateHandler;
  37 import io.netty.handler.timeout.ReadTimeoutHandler;
  38 import io.netty.util.CharsetUtil;
  39 import java.net.InetAddress;
  40 import java.util.ArrayList;
  41 import java.util.Arrays;
  42 import java.util.Collection;
  43 import java.util.List;
  44 import java.util.Map;
  45 import java.util.Set;
  46 import java.util.concurrent.ExecutorService;
  47 import java.util.concurrent.Executors;
  48 import java.util.concurrent.ScheduledExecutorService;
  49 import java.util.concurrent.ThreadFactory;
  50 import java.util.concurrent.TimeUnit;
  51 import javax.annotation.Nullable;
  52 import javax.net.ssl.SSLContext;
  53 import javax.net.ssl.SSLEngine;
  54 import javax.net.ssl.SSLEngineResult.HandshakeStatus;
  55 import javax.net.ssl.SSLPeerUnverifiedException;
  56 import org.opendaylight.ovsdb.lib.OvsdbClient;
  57 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  58 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo.ConnectionType;
  59 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo.SocketConnectionType;
  60 import org.opendaylight.ovsdb.lib.OvsdbConnectionListener;
  61 import org.opendaylight.ovsdb.lib.jsonrpc.ExceptionHandler;
  62 import org.opendaylight.ovsdb.lib.jsonrpc.JsonRpcDecoder;
  63 import org.opendaylight.ovsdb.lib.jsonrpc.JsonRpcEndpoint;
  64 import org.opendaylight.ovsdb.lib.jsonrpc.JsonRpcServiceBinderHandler;
  65 import org.opendaylight.ovsdb.lib.message.OvsdbRPC;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68
  69 /**
  70  * OvsDBConnectionService provides OVSDB connection management functionality which includes
  71  * both Active and Passive connections.
  72  * From the Library perspective, Active OVSDB connections are those that are initiated from
  73  * the Controller towards the ovsdb-manager.
  74  * While Passive OVSDB connections are those that are initiated from the ovs towards
  75  * the controller.
  76  *
  77  * <p>Applications that use OvsDBConnectionService can use the OvsDBConnection class' connect APIs
  78  * to initiate Active connections and can listen to the asynchronous Passive connections via
  79  * registerConnectionListener listener API.
  80  *
  81  * <p>The library is designed as Java modular component that can work in both OSGi and non-OSGi
  82  * environment. Hence a single instance of the service will be active (via Service Registry in OSGi)
  83  * and a Singleton object in a non-OSGi environment.
  84  */
  85 public class OvsdbConnectionService implements AutoCloseable, OvsdbConnection {
  86     private static final Logger LOG = LoggerFactory.getLogger(OvsdbConnectionService.class);
  87
  88     private static ThreadFactory passiveConnectionThreadFactory = new ThreadFactoryBuilder()
  89             .setNameFormat("OVSDBPassiveConnServ-%d").build();
  90     private static ScheduledExecutorService executorService
  91             = Executors.newScheduledThreadPool(10, passiveConnectionThreadFactory);
  92
  93     private static ThreadFactory connectionNotifierThreadFactory = new ThreadFactoryBuilder()
  94             .setNameFormat("OVSDBConnNotifSer-%d").build();
  95     private static ExecutorService connectionNotifierService
  96             = Executors.newCachedThreadPool(connectionNotifierThreadFactory);
  97
  98     private static Set<OvsdbConnectionListener> connectionListeners = Sets.newHashSet();
  99     private static Map<OvsdbClient, Channel> connections = Maps.newHashMap();
 100     private static OvsdbConnection connectionService;
 101     private static volatile boolean singletonCreated = false;
 102     private static final int IDLE_READER_TIMEOUT = 30;
 103     private static final int READ_TIMEOUT = 180;
 104     private static final String OVSDB_RPC_TASK_TIMEOUT_PARAM = "ovsdb-rpc-task-timeout";
 105
 106     private static final StalePassiveConnectionService STALE_PASSIVE_CONNECTION_SERVICE =
 107             new StalePassiveConnectionService(executorService);
 108
 109     private static int retryPeriod = 100; // retry after 100 milliseconds
 110
 111
 112     public static OvsdbConnection getService() {
 113         if (connectionService == null) {
 114             connectionService = new OvsdbConnectionService();
 115         }
 116         return connectionService;
 117     }
 118
 119     @Override
 120     public OvsdbClient connect(final InetAddress address, final int port) {
 121         return connectWithSsl(address, port, null /* SslContext */);
 122     }
 123
 124     @Override
 125     public OvsdbClient connectWithSsl(final InetAddress address, final int port,
 126                                final SSLContext sslContext) {
 127         try {
 128             Bootstrap bootstrap = new Bootstrap();
 129             bootstrap.group(new NioEventLoopGroup());
 130             bootstrap.channel(NioSocketChannel.class);
 131             bootstrap.option(ChannelOption.TCP_NODELAY, true);
 132             bootstrap.option(ChannelOption.RCVBUF_ALLOCATOR, new AdaptiveRecvByteBufAllocator(65535, 65535, 65535));
 133
 134             bootstrap.handler(new ChannelInitializer<SocketChannel>() {
 135                 @Override
 136                 public void initChannel(SocketChannel channel) throws Exception {
 137                     if (sslContext != null) {
 138                         /* First add ssl handler if ssl context is given */
 139                         SSLEngine engine =
 140                             sslContext.createSSLEngine(address.toString(), port);
 141                         engine.setUseClientMode(true);
 142                         channel.pipeline().addLast("ssl", new SslHandler(engine));
 143                     }
 144                     channel.pipeline().addLast(
 145                             //new LoggingHandler(LogLevel.INFO),
 146                             new JsonRpcDecoder(100000),
 147                             new StringEncoder(CharsetUtil.UTF_8),
 148                             new IdleStateHandler(IDLE_READER_TIMEOUT, 0, 0),
 149                             new ReadTimeoutHandler(READ_TIMEOUT),
 150                             new ExceptionHandler());
 151                 }
 152             });
 153
 154             ChannelFuture future = bootstrap.connect(address, port).sync();
 155             Channel channel = future.channel();
 156             return getChannelClient(channel, ConnectionType.ACTIVE, SocketConnectionType.SSL);
 157         } catch (InterruptedException e) {
 158             LOG.warn("Failed to connect {}:{}", address, port, e);
 159         }
 160         return null;
 161     }
 162
 163     @Override
 164     public void disconnect(OvsdbClient client) {
 165         if (client == null) {
 166             return;
 167         }
 168         Channel channel = connections.get(client);
 169         if (channel != null) {
 170             channel.disconnect();
 171         }
 172         connections.remove(client);
 173     }
 174
 175     @Override
 176     public void registerConnectionListener(OvsdbConnectionListener listener) {
 177         LOG.info("registerConnectionListener: registering {}", listener.getClass().getSimpleName());
 178         connectionListeners.add(listener);
 179     }
 180
 181     @Override
 182     public void unregisterConnectionListener(OvsdbConnectionListener listener) {
 183         connectionListeners.remove(listener);
 184     }
 185
 186     private static OvsdbClient getChannelClient(Channel channel, ConnectionType type,
 187         SocketConnectionType socketConnType) {
 188         ObjectMapper objectMapper = new ObjectMapper();
 189         objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 190         objectMapper.setSerializationInclusion(Include.NON_NULL);
 191
 192         JsonRpcEndpoint factory = new JsonRpcEndpoint(objectMapper, channel);
 193         JsonRpcServiceBinderHandler binderHandler = new JsonRpcServiceBinderHandler(factory);
 194         binderHandler.setContext(channel);
 195         channel.pipeline().addLast(binderHandler);
 196
 197         OvsdbRPC rpc = factory.getClient(channel, OvsdbRPC.class);
 198         OvsdbClientImpl client = new OvsdbClientImpl(rpc, channel, type, socketConnType);
 199         client.setConnectionPublished(true);
 200         connections.put(client, channel);
 201         ChannelFuture closeFuture = channel.closeFuture();
 202         closeFuture.addListener(new ChannelConnectionHandler(client));
 203         return client;
 204     }
 205
 206     /**
 207      * Method that initiates the Passive OVSDB channel listening functionality.
 208      * By default the ovsdb passive connection will listen in port 6640 which can
 209      * be overridden using the ovsdb.listenPort system property.
 210      */
 211     @Override
 212     public synchronized boolean startOvsdbManager(final int ovsdbListenPort) {
 213         if (!singletonCreated) {
 214             LOG.info("startOvsdbManager: Starting");
 215             new Thread() {
 216                 @Override
 217                 public void run() {
 218                     ovsdbManager(ovsdbListenPort);
 219                 }
 220             }.start();
 221             singletonCreated = true;
 222             return true;
 223         } else {
 224             return false;
 225         }
 226     }
 227
 228     /**
 229      * Method that initiates the Passive OVSDB channel listening functionality
 230      * with ssl.By default the ovsdb passive connection will listen in port
 231      * 6640 which can be overridden using the ovsdb.listenPort system property.
 232      */
 233     @Override
 234     public synchronized boolean startOvsdbManagerWithSsl(final int ovsdbListenPort,
 235                                      final SSLContext sslContext) {
 236         if (!singletonCreated) {
 237             new Thread() {
 238                 @Override
 239                 public void run() {
 240                     ovsdbManagerWithSsl(ovsdbListenPort, sslContext);
 241                 }
 242             }.start();
 243             singletonCreated = true;
 244             return true;
 245         } else {
 246             return false;
 247         }
 248     }
 249
 250     /**
 251      * OVSDB Passive listening thread that uses Netty ServerBootstrap to open
 252      * passive connection handle channel callbacks.
 253      */
 254     private static void ovsdbManager(int port) {
 255         ovsdbManagerWithSsl(port, null /* SslContext */);
 256     }
 257
 258     /**
 259      * OVSDB Passive listening thread that uses Netty ServerBootstrap to open
 260      * passive connection with Ssl and handle channel callbacks.
 261      */
 262     private static void ovsdbManagerWithSsl(int port, final SSLContext sslContext) {
 263         EventLoopGroup bossGroup = new NioEventLoopGroup();
 264         EventLoopGroup workerGroup = new NioEventLoopGroup();
 265         try {
 266             ServerBootstrap serverBootstrap = new ServerBootstrap();
 267             serverBootstrap.group(bossGroup, workerGroup)
 268                     .channel(NioServerSocketChannel.class)
 269                     .option(ChannelOption.SO_BACKLOG, 100)
 270                     .handler(new LoggingHandler(LogLevel.INFO))
 271                     .childHandler(new ChannelInitializer<SocketChannel>() {
 272                         @Override
 273                         public void initChannel(SocketChannel channel) throws Exception {
 274                             LOG.debug("New Passive channel created : {}", channel);
 275                             if (sslContext != null) {
 276                                 /* Add SSL handler first if SSL context is provided */
 277                                 SSLEngine engine = sslContext.createSSLEngine();
 278                                 engine.setUseClientMode(false); // work in a server mode
 279                                 engine.setNeedClientAuth(true); // need client authentication
 280                                 //Disable SSLv3 and enable all other supported protocols
 281                                 String[] protocols = {"SSLv2Hello", "TLSv1", "TLSv1.1", "TLSv1.2"};
 282                                 LOG.debug("Set enable protocols {}", Arrays.toString(protocols));
 283                                 engine.setEnabledProtocols(protocols);
 284                                 LOG.debug("Supported ssl protocols {}",
 285                                         Arrays.toString(engine.getSupportedProtocols()));
 286                                 LOG.debug("Enabled ssl protocols {}",
 287                                         Arrays.toString(engine.getEnabledProtocols()));
 288                                 //Set cipher suites
 289                                 String[] cipherSuites = {"TLS_RSA_WITH_AES_128_CBC_SHA"};
 290                                 LOG.debug("Set enable cipher cuites {}", Arrays.toString(cipherSuites));
 291                                 engine.setEnabledCipherSuites(cipherSuites);
 292                                 LOG.debug("Enabled cipher suites {}",
 293                                         Arrays.toString(engine.getEnabledCipherSuites()));
 294                                 channel.pipeline().addLast("ssl", new SslHandler(engine));
 295                             }
 296
 297                             channel.pipeline().addLast(
 298                                  new JsonRpcDecoder(100000),
 299                                  new StringEncoder(CharsetUtil.UTF_8),
 300                                  new IdleStateHandler(IDLE_READER_TIMEOUT, 0, 0),
 301                                  new ReadTimeoutHandler(READ_TIMEOUT),
 302                                  new ExceptionHandler());
 303
 304                             handleNewPassiveConnection(channel);
 305                         }
 306                     });
 307             serverBootstrap.option(ChannelOption.TCP_NODELAY, true);
 308             serverBootstrap.option(ChannelOption.RCVBUF_ALLOCATOR,
 309                     new AdaptiveRecvByteBufAllocator(65535, 65535, 65535));
 310             // Start the server.
 311             ChannelFuture channelFuture = serverBootstrap.bind(port).sync();
 312             Channel serverListenChannel = channelFuture.channel();
 313             // Wait until the server socket is closed.
 314             serverListenChannel.closeFuture().sync();
 315         } catch (InterruptedException e) {
 316             LOG.error("Thread interrupted", e);
 317         } finally {
 318             // Shut down all event loops to terminate all threads.
 319             bossGroup.shutdownGracefully();
 320             workerGroup.shutdownGracefully();
 321         }
 322     }
 323
 324     private static void handleNewPassiveConnection(OvsdbClient client) {
 325         ListenableFuture<List<String>> echoFuture = client.echo();
 326         LOG.debug("Send echo message to probe the OVSDB switch {}",client.getConnectionInfo());
 327         Futures.addCallback(echoFuture, new FutureCallback<List<String>>() {
 328             @Override
 329             public void onSuccess(@Nullable List<String> result) {
 330                 LOG.debug("Probe was successful to OVSDB switch {}",client.getConnectionInfo());
 331                 List<OvsdbClient> clientsFromSameNode = getPassiveClientsFromSameNode(client);
 332                 if (clientsFromSameNode.size() == 0) {
 333                     notifyListenerForPassiveConnection(client);
 334                 } else {
 335                     STALE_PASSIVE_CONNECTION_SERVICE.handleNewPassiveConnection(client, clientsFromSameNode);
 336                 }
 337             }
 338
 339             @Override
 340             public void onFailure(Throwable failureException) {
 341                 LOG.error("Probe failed to OVSDB switch. Disconnecting the channel {}", client.getConnectionInfo());
 342                 client.disconnect();
 343             }
 344         }, connectionNotifierService);
 345     }
 346
 347     private static void handleNewPassiveConnection(final Channel channel) {
 348         if (!channel.isOpen()) {
 349             LOG.warn("Channel {} is not open, skipped further processing of the connection.",channel);
 350             return;
 351         }
 352         SslHandler sslHandler = (SslHandler) channel.pipeline().get("ssl");
 353         if (sslHandler != null) {
 354             class HandleNewPassiveSslRunner implements Runnable {
 355                 public SslHandler sslHandler;
 356                 public final Channel channel;
 357                 private int retryTimes;
 358
 359                 HandleNewPassiveSslRunner(Channel channel, SslHandler sslHandler) {
 360                     this.channel = channel;
 361                     this.sslHandler = sslHandler;
 362                     this.retryTimes = 3;
 363                 }
 364
 365                 @Override
 366                 public void run() {
 367                     HandshakeStatus status = sslHandler.engine().getHandshakeStatus();
 368                     LOG.debug("Handshake status {}", status);
 369                     switch (status) {
 370                         case FINISHED:
 371                         case NOT_HANDSHAKING:
 372                             if (sslHandler.engine().getSession().getCipherSuite()
 373                                     .equals("SSL_NULL_WITH_NULL_NULL")) {
 374                                 // Not begin handshake yet. Retry later.
 375                                 LOG.debug("handshake not begin yet {}", status);
 376                                 executorService.schedule(this, retryPeriod, TimeUnit.MILLISECONDS);
 377                             } else {
 378                               //Check if peer is trusted before notifying listeners
 379                                 try {
 380                                     sslHandler.engine().getSession().getPeerCertificates();
 381                                     //Handshake done. Notify listener.
 382                                     OvsdbClient client = getChannelClient(channel, ConnectionType.PASSIVE,
 383                                         SocketConnectionType.SSL);
 384                                     handleNewPassiveConnection(client);
 385                                 } catch (SSLPeerUnverifiedException e) {
 386                                     //Trust manager is still checking peer certificate. Retry later
 387                                     LOG.debug("Peer certifiacte is not verified yet {}", status);
 388                                     executorService.schedule(this, retryPeriod, TimeUnit.MILLISECONDS);
 389                                 }
 390                             }
 391                             break;
 392
 393                         case NEED_UNWRAP:
 394                         case NEED_TASK:
 395                             //Handshake still ongoing. Retry later.
 396                             LOG.debug("handshake not done yet {}", status);
 397                             executorService.schedule(this,  retryPeriod, TimeUnit.MILLISECONDS);
 398                             break;
 399
 400                         case NEED_WRAP:
 401                             if (sslHandler.engine().getSession().getCipherSuite()
 402                                     .equals("SSL_NULL_WITH_NULL_NULL")) {
 403                                 /* peer not authenticated. No need to notify listener in this case. */
 404                                 LOG.error("Ssl handshake fail. channel {}", channel);
 405                             } else {
 406                                 /*
 407                                  * peer is authenticated. Give some time to wait for completion.
 408                                  * If status is still NEED_WRAP, client might already disconnect.
 409                                  * This happens when the first time client connects to controller in two-way handshake.
 410                                  * After obtaining controller certificate, client will disconnect and start
 411                                  * new connection with controller certificate it obtained.
 412                                  * In this case no need to do anything for the first connection attempt. Just skip
 413                                  * since client will reconnect later.
 414                                  */
 415                                 LOG.debug("handshake not done yet {}", status);
 416                                 if (retryTimes > 0) {
 417                                     executorService.schedule(this,  retryPeriod, TimeUnit.MILLISECONDS);
 418                                 } else {
 419                                     LOG.debug("channel closed {}", channel);
 420                                 }
 421                                 retryTimes--;
 422                             }
 423                             break;
 424
 425                         default:
 426                             LOG.error("unknown hadshake status {}", status);
 427                     }
 428                 }
 429             }
 430
 431             executorService.schedule(new HandleNewPassiveSslRunner(channel, sslHandler),
 432                     retryPeriod, TimeUnit.MILLISECONDS);
 433         } else {
 434             executorService.execute(new Runnable() {
 435                 @Override
 436                 public void run() {
 437                     OvsdbClient client = getChannelClient(channel, ConnectionType.PASSIVE,
 438                         SocketConnectionType.NON_SSL);
 439                     handleNewPassiveConnection(client);
 440                 }
 441             });
 442         }
 443     }
 444
 445     public static void channelClosed(final OvsdbClient client) {
 446         LOG.info("Connection closed {}", client.getConnectionInfo().toString());
 447         connections.remove(client);
 448         if (client.isConnectionPublished()) {
 449             for (OvsdbConnectionListener listener : connectionListeners) {
 450                 listener.disconnected(client);
 451             }
 452         }
 453         STALE_PASSIVE_CONNECTION_SERVICE.clientDisconnected(client);
 454     }
 455
 456     @Override
 457     public Collection<OvsdbClient> getConnections() {
 458         return connections.keySet();
 459     }
 460
 461     @Override
 462     public void close() throws Exception {
 463         LOG.info("OvsdbConnectionService closed");
 464     }
 465
 466     @Override
 467     public OvsdbClient getClient(Channel channel) {
 468         for (OvsdbClient client : connections.keySet()) {
 469             Channel ctx = connections.get(client);
 470             if (ctx.equals(channel)) {
 471                 return client;
 472             }
 473         }
 474         return null;
 475     }
 476
 477     private static List<OvsdbClient> getPassiveClientsFromSameNode(OvsdbClient ovsdbClient) {
 478         List<OvsdbClient> passiveClients = new ArrayList<>();
 479         for (OvsdbClient client : connections.keySet()) {
 480             if (!client.equals(ovsdbClient)
 481                     && client.getConnectionInfo().getRemoteAddress()
 482                             .equals(ovsdbClient.getConnectionInfo().getRemoteAddress())
 483                     && client.getConnectionInfo().getType() == ConnectionType.PASSIVE) {
 484                 passiveClients.add(client);
 485             }
 486         }
 487         return passiveClients;
 488     }
 489
 490     public static void notifyListenerForPassiveConnection(final OvsdbClient client) {
 491         client.setConnectionPublished(true);
 492         for (final OvsdbConnectionListener listener : connectionListeners) {
 493             connectionNotifierService.submit(new Runnable() {
 494                 @Override
 495                 public void run() {
 496                     LOG.trace("Connection {} notified to listener {}", client.getConnectionInfo(), listener);
 497                     listener.connected(client);
 498                 }
 499             });
 500         }
 501     }
 502
 503     public void updateConfigParameter(Map<String, Object> configParameters) {
 504         LOG.debug("Config parameters received : {}", configParameters.entrySet());
 505         if (configParameters != null && !configParameters.isEmpty()) {
 506             for (Map.Entry<String, Object> paramEntry : configParameters.entrySet()) {
 507                 if (paramEntry.getKey().equalsIgnoreCase(OVSDB_RPC_TASK_TIMEOUT_PARAM)) {
 508                     JsonRpcEndpoint.setReaperInterval(Integer.parseInt((String)paramEntry.getValue()));
 509
 510                     //Please remove the break if you add more config nobs.
 511                     break;
 512                 }
 513             }
 514         }
 515     }
 516 }