Implemented support for connecting via WebSockets and proxies

Author: vkrish-mcafee

.travis.yml

@@ -13,7 +13,7 @@ services:
 
 before_install:
   - docker pull opendxl/opendxl-broker
-  - docker run -d -p 127.0.0.1:8883:8883 -p 127.0.0.1:8443:8443 opendxl/opendxl-broker
+  - docker run -d -p 127.0.0.1:8883:8883 -p 127.0.0.1:8443:8443 -p 127.0.0.1:443:443 opendxl/opendxl-broker
   - docker ps -a
 
 env:
@@ -32,4 +32,10 @@ before_script:
   - cat test/integration/client_config.cfg
 
 script:
+  - echo Running tests with MQTT
   - npm run ci
+  - sed -i -e "s/#UseWebSockets=false/UseWebSockets=true/g" test/integration/client_config.cfg
+  - cat test/integration/client_config.cfg
+  - echo Running tests with WebSockets
+  - npm run test
+

doc/sdk/basic-cli-provisioning.md

@@ -13,13 +13,13 @@ Here is an example usage of `provisionconfig` operation for a Mac or Linux-based
 operating system:
 
 ```sh
-node_modules/.bin/dxlclient config myserver client1
+node_modules/.bin/dxlclient provisionconfig config myserver client1
 ```
 
 For Windows, the equivalent command would be:
 
 ```sh
-node_modules\.bin\dxlclient config myserver client1
+node_modules\.bin\dxlclient provisionconfig config myserver client1
 ```
 
 The parameters are as follows:
@@ -46,7 +46,7 @@ environment variable, you can also provide the path to the openssl executable
 as a separate parameter. For example:
 
 ```sh
-node_modules\.bin\dxlclient --opensslbin D:\custom\openssl.exe config myserver client1
+node_modules\.bin\dxlclient --opensslbin D:\custom\openssl.exe provisionconfig config myserver client1
 ```
 
 When prompted, provide credentials for the OpenDXL Broker Management Console

doc/sdk/samples.md

@@ -5,3 +5,6 @@ Prior to running any of the examples, you must complete the following:
 
 The `dxlclient.config` file located in the `sample` sub-directory of the
 JavaScript DXL SDK must be populated.
+
+NOTE: If {@tutorial basic-cli-provisioning} Command Line Interface (CLI) provisioning is being performed, specify the 
+`sample` directory as the output location for the provisioning operation.

index.js

@@ -13,6 +13,7 @@ exports.RequestError = require('./lib/request-error')
 exports.Response = require('./lib/response')
 exports.ResponseErrorCode = require('./lib/response-error-code')
 exports.ServiceRegistrationInfo = require('./lib/service-registration-info')
+exports.Proxy = require('./lib/proxy')
 
 // Leaving this for backward compatibility for now
 exports.MessageError = exports.RequestError

lib/_provisioning/management-service.js

@@ -5,6 +5,7 @@ var https = require('https')
 var querystring = require('querystring')
 var url = require('url')
 var provisionUtil = require('./provision-util')
+var HttpsProxyAgent = require('https-proxy-agent')
 
 var HTTP_MAX_REDIRECTS = 5
 
@@ -230,6 +231,21 @@ ManagementService.prototype.request = function (description, path, queryString,
     requestOptions.requestCert = false
   }
 
+  // use proxy specified in the env
+  var proxy
+  if (process.env.http_proxy != null) { proxy = process.env.http_proxy }
+  if (process.env.HTTP_PROXY != null) { proxy = process.env.HTTP_PROXY }
+
+  if (proxy) {
+    // if there is no protocol set in the env variable add the http://
+    proxy = (proxy.indexOf('://') === -1) ? 'http://' + proxy : proxy
+    var proxyOptions = url.parse(proxy)
+    proxyOptions.secureEndpoint = true
+    console.log('Connecting via Proxy:', proxy)
+    // set proxy agent in requestOptions
+    requestOptions.agent = new HttpsProxyAgent(proxyOptions)
+  }
+
   var requestUrl = toUrlString(requestOptions)
 
   httpGet(description, 0, requestOptions, verbosity,

lib/_provisioning/provision-config.js

@@ -68,10 +68,13 @@ function brokersForConfig (brokerLines) {
  *   include in the stored configuration file.
  * @param {Number} verbosity - Level of verbosity at which to log any error
  *   or trace messages.
+ * @param {Boolean} useWebSockets Whether or not the client will use WebSockets.
+ *   If false MQTT over tcp will be used.
+ *   If only WebSocket brokers are specified this will default to true.
  * @private
  */
 function storeProvisionConfig (config, configDir, filePrefix,
-                               privateKeyFileName, verbosity) {
+                               privateKeyFileName, verbosity, useWebSockets) {
   if (typeof config !== 'string') {
     throw new DxlError('Unexpected data type for response: ' +
       typeof config)
@@ -91,16 +94,41 @@ function storeProvisionConfig (config, configDir, filePrefix,
 
   var brokers = brokersForConfig(brokerLines)
 
+  var brokerWSLines = []
+  if (configElements[3]) {
+    brokerWSLines = configElements[3].split(
+      /[\r\n]+/).filter(function (brokerWSLine) {
+        return brokerWSLine.length > 0
+      }
+    )
+  }
+
+  var brokersWS = brokersForConfig(brokerWSLines)
+  var webSocketsEnabled = typeof useWebSockets !== 'undefined' ? useWebSockets : false
   var certFileName = filePrefix + '.crt'
   var configString = ini.encode({
+    General: {
+      UseWebSockets: webSocketsEnabled
+    },
     Certs: {
       BrokerCertChain: DEFAULT_BROKER_CERT_CHAIN_FILE_NAME,
       CertFile: path.basename(certFileName),
       PrivateKey: path.basename(privateKeyFileName)
     },
-    Brokers: brokers
+    Brokers: brokerLines.length ? brokers : { marker: 1 },
+    BrokersWebSockets: brokerWSLines.length ? brokersWS : { marker: 1 }
   }).replace(/\\;/g, ';')
 
+  // ini.js does not support empty sections , using marker and replacing it
+  if (configString.includes('marker=1')) {
+    configString = configString.replace(/marker=1(\r\n|\n)/g, '')
+  }
+
+  if (!webSocketsEnabled) {
+    // UseWebSockets property is commented out by default
+    configString = configString.replace('UseWebSockets', '#UseWebSockets')
+  }
+
   var configFileName = path.join(configDir,
     provisionUtil.DEFAULT_CONFIG_FILE_NAME)
   if (verbosity) {
@@ -203,10 +231,13 @@ function storeProvisionConfig (config, configDir, filePrefix,
  *   provisioned configuration has been stored. If an error occurs, the first
  *   parameter supplied to the `doneCallback` is an `Error` instance
  *   containing failure details.
+ *  @param {Boolean} [useWebSockets] Whether or not the client will use WebSockets.
+ *    If false MQTT over tcp will be used.
+ *    If only WebSocket brokers are specified this will default to true.
  * @private
  */
 module.exports = function provisionConfig (configDir, commonOrCsrFileName,
-                                           hostInfo, options) {
+                                           hostInfo, options, useWebSockets) {
   if (!configDir) {
     throw new TypeError('configDir is required for provisioning')
   }
@@ -239,10 +270,15 @@ module.exports = function provisionConfig (configDir, commonOrCsrFileName,
             try {
               storeProvisionConfig(config, configDir,
                 options.filePrefix || pki.DEFAULT_PKI_FILE_PREFIX,
-                privateKeyFileName, verbosity)
+                privateKeyFileName, verbosity, useWebSockets)
             } catch (err) {
               error = err
             }
+          } else {
+            if (error) {
+              console.log('Error from server' + error)
+            }
+            console.log('No data from Server.Check Server Configuration')
           }
           provisionUtil.invokeCallback(error, doneCallback, verbosity)
         }

lib/_provisioning/update-config.js

@@ -75,10 +75,41 @@ function requestBrokerList (managementService, verbosity, callback) {
  */
 function brokerConfigLines (brokerListResponse) {
   var brokers = JSON.parse(brokerListResponse).brokers
-  return brokers.map(function (broker) {
-    return broker.guid + '=' + [broker.guid, broker.port,
-      broker.hostName, broker.ipAddress].join(';')
-  })
+  return createMap(brokers)
+}
+
+/**
+ * Converts the list of WebSocket Brokers received from a call to the getBrokerList
+ * endpoint on the management server (JSON objects) into the broker format
+ * used in a configuration ini file (key=value pairs).
+ * @param {String} brokerListResponse - Response received from the management
+ *   service for a request to the getBrokerList endpoint.
+ * @returns {Array<String>} A list of WebSocket broker lines to include in the client
+ *   configuration file.
+ * @private
+ */
+function brokerWsConfigLines (brokerListResponse) {
+  var brokersWs = JSON.parse(brokerListResponse).webSocketBrokers
+  return createMap(brokersWs)
+}
+
+/**
+ * Helper function that converts the list of broker info received from a call to the getBrokerList
+ * endpoint on the management server (JSON objects) into the broker format
+ * used in a configuration ini file (key=value pairs).
+ * @param {String} brokers - ParsedResponse received from the management
+ *   service for a request to the getBrokerList endpoint.
+ * @returns {Array<String>} A list of broker lines to include in the client
+ *   configuration file.
+ * @private
+ */
+function createMap (brokers) {
+  if (brokers) {
+    return brokers.map(function (broker) {
+      return broker.guid + '=' + [broker.guid, broker.port,
+        broker.hostName, broker.ipAddress].join(';')
+    })
+  }
 }
 
 /**
@@ -89,13 +120,10 @@ function brokerConfigLines (brokerListResponse) {
  *  into the configuration file.
  * @param {Number} verbosity - Level of verbosity at which to log any error
  *   or trace messages.
+ * @param {String} section - Section like Brokers or websockets to process
  * @private
  */
-function updateBrokerListInConfigFile (configFileName, brokerLines, verbosity) {
-  if (verbosity) {
-    console.log('Updating DXL config file at ' + configFileName)
-  }
-
+function updateBrokerListInConfigFile (configFileName, brokerLines, verbosity, section) {
   var inBrokerSection = false
   var linesAfterBrokerSection = []
   var configFileData = util.getConfigFileData(configFileName)
@@ -105,7 +133,7 @@ function updateBrokerListInConfigFile (configFileName, brokerLines, verbosity) {
   // sections - for example, the 'Certs' section.
   var newConfigLines = configFileData.lines.reduce(
     function (acc, line) {
-      if (line === '[Brokers]') {
+      if (line === section) {
         inBrokerSection = true
         acc.push(line)
       } else {
@@ -273,7 +301,12 @@ module.exports = function updateConfig (configDir, hostInfo, options) {
               if (response) {
                 try {
                   updateBrokerListInConfigFile(configFileName,
-                    brokerConfigLines(response), verbosity)
+                    brokerConfigLines(response), verbosity, '[Brokers]')
+                  updateBrokerListInConfigFile(configFileName,
+                    brokerWsConfigLines(response), verbosity, '[BrokersWebSockets]')
+                  if (verbosity) {
+                    console.log('Updating DXL config file at ' + configFileName)
+                  }
                 } catch (err) {
                   error = err
                 }

lib/client.js

@@ -10,6 +10,10 @@ var DxlError = require('./dxl-error')
 var message = require('./message')
 var RequestManager = require('./request-manager')
 var ServiceManager = require('./service-manager')
+var HttpsProxyAgent = require('https-proxy-agent')
+var url = require('url')
+var nodeUtil = require('util')
+var debug = nodeUtil.debuglog('dxlclient')
 
 var REPLY_TO_PREFIX = '/mcafee/client/'
 
@@ -132,6 +136,7 @@ function Client (config) {
     return result
   }, [])
 
+  this._iswebSocketEnabled = this.config.useWebSockets
   events.EventEmitter.call(this)
 }
 
@@ -305,10 +310,20 @@ Client.prototype.connect = function (callback) {
 
   var that = this
   var firstConnection = true
-
+  // server list
+  var brokerList = this._servers
+  // default protocol is MQTT
+  var protocolToUse = 'mqtts'
+  var rejectUnauthorized = true
+  // if UseWebSockets property is enabled or mqtt broker list is empty, connect via WebSockets
+  if (this._iswebSocketEnabled) {
+    protocolToUse = 'wss'
+    rejectUnauthorized = false
+    console.log('Setting \'UseWebSockets\' is enabled. Client will connect via WebSockets')
+  }
   var connectOptions = {
-    servers: this._servers,
-    protocol: 'mqtts',
+    servers: brokerList,
+    protocol: protocolToUse,
     protocolId: 'MQIsdp',
     protocolVersion: 3,
     clientId: this._clientId,
@@ -320,10 +335,35 @@ Client.prototype.connect = function (callback) {
     },
     keepalive: this.config.keepAliveInterval,
     reconnectPeriod: this.config.reconnectDelay * 1000,
-    rejectUnauthorized: true,
+    rejectUnauthorized: rejectUnauthorized,
     requestCert: true
   }
+  // check proxy configuration (Optional)
+  var proxy = that.config.proxy
+  if (protocolToUse === 'wss' && proxy) {
+    var port = proxy.port
+    var hostname = proxy.address
+    var user = proxy.user
+    var pwd = proxy.password
+    // http proxy support Only
+    var proxyUrl = nodeUtil.format('http://%s:%d', hostname, port)
+    var proxyOptions = url.parse(proxyUrl)
+    // true for wss
+    proxyOptions.secureEndpoint = true
+    console.log('Connecting via Proxy:', proxyUrl)
+    if (user && pwd) {
+      proxyOptions.auth = nodeUtil.format('%s:%s', user, pwd)
+      console.log('Proxy connection user:', user)
+    }
+    // Set up a proxy agent
+    var wsagent = new HttpsProxyAgent(proxyOptions)
+    // Set Agent for wsOption in MQTT
+    connectOptions.wsOptions = {
+      agent: wsagent
+    }
+  }
 
+  debug('Connect options', connectOptions)
   var mqttClient = mqtt.connect(connectOptions)
 
   Object.keys(this._subscriptionsByMessageType).forEach(function (topic) {