merge features from hosted branch (#32)

major merge of features from the hosted branch that was created temporarily during the initial launch of jambonz.org

lib/utils/db-utils.js

@@ -0,0 +1,74 @@
+const {decrypt} = require('./encrypt-decrypt');
+
+const sqlAccountDetails = `SELECT * 
+FROM accounts account 
+WHERE account.account_sid = ?`;
+const sqlSpeechCredentials = `SELECT * 
+FROM speech_credentials 
+WHERE account_sid = ? `;
+const sqlSpeechCredentialsForSP = `SELECT * 
+FROM speech_credentials 
+WHERE service_provider_sid =  
+(SELECT service_provider_sid from accounts where account_sid = ?)`;
+
+const speechMapper = (cred) => {
+  const {credential, ...obj} = cred;
+  if ('google' === obj.vendor) {
+    obj.service_key = decrypt(credential);
+  }
+  else if ('aws' === obj.vendor) {
+    const o = JSON.parse(decrypt(credential));
+    obj.access_key_id = o.access_key_id;
+    obj.secret_access_key = o.secret_access_key;
+  }
+  return obj;
+};
+
+module.exports = (logger, srf) => {
+  const {pool}  = srf.locals.dbHelpers;
+  const pp = pool.promise();
+
+  const lookupAccountDetails = async(account_sid) => {
+    const [r] = await pp.query({sql: sqlAccountDetails, nestTables: true}, account_sid);
+    if (0 === r.length) throw new Error(`invalid accountSid: ${account_sid}`);
+    const [r2] = await pp.query(sqlSpeechCredentials, account_sid);
+    const speech = r2.map(speechMapper);
+
+    /* search at the service provider level if we don't find it at the account level */
+    const haveGoogle = speech.find((s) => s.vendor === 'google');
+    const haveAws = speech.find((s) => s.vendor === 'aws');
+    if (!haveGoogle || !haveAws) {
+      const [r3] = await pp.query(sqlSpeechCredentialsForSP, account_sid);
+      if (r3.length) {
+        if (!haveGoogle) {
+          const google = r3.find((s) => s.vendor === 'google');
+          if (google) speech.push(speechMapper(google));
+        }
+        if (!haveAws) {
+          const aws = r3.find((s) => s.vendor === 'aws');
+          if (aws) speech.push(speechMapper(aws));
+        }
+      }
+    }
+
+    return {
+      ...r[0],
+      speech
+    };
+  };
+
+  const updateSpeechCredentialLastUsed = async(speech_credential_sid) => {
+    const pp = pool.promise();
+    const sql = 'UPDATE speech_credentials SET last_used = NOW() WHERE speech_credential_sid = ?';
+    try {
+      await pp.execute(sql, [speech_credential_sid]);
+    } catch (err) {
+      logger.error({err}, `Error updating last_used for speech_credential_sid ${speech_credential_sid}`);
+    }
+  };
+
+  return {
+    lookupAccountDetails,
+    updateSpeechCredentialLastUsed
+  };
+};

lib/utils/encrypt-decrypt.js

@@ -0,0 +1,35 @@
+const crypto = require('crypto');
+const algorithm = 'aes-256-ctr';
+const iv = crypto.randomBytes(16);
+const secretKey = crypto.createHash('sha256')
+  .update(String(process.env.JWT_SECRET))
+  .digest('base64')
+  .substr(0, 32);
+
+const encrypt = (text) => {
+  const cipher = crypto.createCipheriv(algorithm, secretKey, iv);
+  const encrypted = Buffer.concat([cipher.update(text), cipher.final()]);
+  const data = {
+    iv: iv.toString('hex'),
+    content: encrypted.toString('hex')
+  };
+  return JSON.stringify(data);
+};
+
+const decrypt = (data) => {
+  let hash;
+  try {
+    hash = JSON.parse(data);
+  } catch (err) {
+    console.log(`failed to parse json string ${data}`);
+    throw err;
+  }
+  const decipher = crypto.createDecipheriv(algorithm, secretKey, Buffer.from(hash.iv, 'hex'));
+  const decrpyted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
+  return decrpyted.toString();
+};
+
+module.exports = {
+  encrypt,
+  decrypt
+};

lib/utils/install-srf-locals.js

@@ -38,9 +38,12 @@ function installSrfLocals(srf, logger) {
     const fsInventory = process.env.JAMBONES_FREESWITCH
       .split(',')
       .map((fs) => {
-        const arr = /^(.*):(.*):(.*)/.exec(fs);
+        const arr = /^([^:]*):([^:]*):([^:]*)(?::([^:]*))?/.exec(fs);
         assert.ok(arr, `Invalid syntax JAMBONES_FREESWITCH: ${process.env.JAMBONES_FREESWITCH}`);
-        return {address: arr[1], port: arr[2], secret: arr[3]};
+        const opts = {address: arr[1], port: arr[2], secret: arr[3]};
+        if (arr.length > 4) opts.advertisedAddress = arr[4];
+        if (process.env.NODE_ENV === 'test') opts.listenAddress = '0.0.0.0';
+        return opts;
       });
     logger.info({fsInventory}, 'freeswitch inventory');
 
@@ -72,6 +75,7 @@ function installSrfLocals(srf, logger) {
 
     // if we have a single freeswitch (as is typical) report stats periodically
     if (mediaservers.length === 1) {
+      srf.locals.mediaservers = [mediaservers[0].ms];
       setInterval(() => {
         try {
           if (mediaservers[0].ms && mediaservers[0].active) {
@@ -99,20 +103,25 @@ function installSrfLocals(srf, logger) {
   }
 
   const {
+    pool,
     lookupAppByPhoneNumber,
     lookupAppBySid,
     lookupAppByRealm,
     lookupAppByTeamsTenant,
     lookupTeamsByAccount,
-    lookupAccountBySid
+    lookupAccountBySid,
+    lookupAccountCapacitiesBySid,
+    lookupSmppGateways
   } = require('@jambonz/db-helpers')({
     host: process.env.JAMBONES_MYSQL_HOST,
     user: process.env.JAMBONES_MYSQL_USER,
+    port: process.env.JAMBONES_MYSQL_PORT || 3306,
     password: process.env.JAMBONES_MYSQL_PASSWORD,
     database: process.env.JAMBONES_MYSQL_DATABASE,
     connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
   }, logger);
   const {
+    client,
     updateCallStatus,
     retrieveCall,
     listCalls,
@@ -135,15 +144,27 @@ function installSrfLocals(srf, logger) {
     host: process.env.JAMBONES_REDIS_HOST,
     port: process.env.JAMBONES_REDIS_PORT || 6379
   }, logger);
+  const {
+    writeAlerts,
+    AlertType
+  } = require('@jambonz/time-series')(logger, {
+    host: process.env.JAMBONES_TIME_SERIES_HOST,
+    commitSize: 50,
+    commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+  });
 
-  Object.assign(srf.locals, {
+  srf.locals = {...srf.locals,
     dbHelpers: {
+      client,
+      pool,
       lookupAppByPhoneNumber,
       lookupAppBySid,
       lookupAppByRealm,
       lookupAppByTeamsTenant,
       lookupTeamsByAccount,
       lookupAccountBySid,
+      lookupAccountCapacitiesBySid,
+      lookupSmppGateways,
       updateCallStatus,
       retrieveCall,
       listCalls,
@@ -167,10 +188,15 @@ function installSrfLocals(srf, logger) {
     ipv4: localIp,
     serviceUrl: `http://${localIp}:${PORT}`,
     getSBC,
+    getSmpp: () => {
+      return process.env.SMPP_URL;
+    },
     lifecycleEmitter,
     getFreeswitch,
-    stats: stats
-  });
+    stats: stats,
+    writeAlerts,
+    AlertType
+  };
 }
 
 module.exports = installSrfLocals;

lib/utils/place-outdial.js

@@ -61,6 +61,7 @@ class SingleDialer extends Emitter {
   async exec(srf, ms, opts) {
     opts = opts || {};
     opts.headers = opts.headers || {};
+    opts.headers = {...opts.headers, 'X-Call-Sid': this.callSid};
     let uri, to;
     try {
       switch (this.target.type) {
@@ -71,10 +72,10 @@ class SingleDialer extends Emitter {
           to = this.target.number;
           if ('teams' === this.target.type) {
             assert(this.target.teamsInfo);
-            Object.assign(opts.headers, {
+            opts.headers = {...opts.headers,
               'X-MS-Teams-FQDN': this.target.teamsInfo.ms_teams_fqdn,
               'X-MS-Teams-Tenant-FQDN': this.target.teamsInfo.tenant_fqdn
-            });
+            };
             if (this.target.vmail === true) uri = `${uri};opaque=app:voicemail`;
           }
           break;
@@ -84,12 +85,6 @@ class SingleDialer extends Emitter {
           uri = `sip:${this.target.name}`;
           to = this.target.name;
 
-          if (this.target.overrideTo) {
-            Object.assign(opts.headers, {
-              'X-Override-To': this.target.overrideTo
-            });
-          }
-
           // need to send to the SBC registered on
           const reg = await registrar.query(aor);
           if (reg) {
@@ -267,7 +262,7 @@ class SingleDialer extends Emitter {
       // now execute it in a new ConfirmCallSession
       this.logger.debug(`SingleDialer:_executeApp: executing ${tasks.length} tasks`);
       const cs = new ConfirmCallSession({
-        logger: this.baseLogger,
+        logger: this.logger,
         application: this.application,
         dlg: this.dlg,
         ep: this.ep,

lib/utils/requestor.js

@@ -2,8 +2,30 @@ const bent = require('bent');
 const parseUrl = require('parse-url');
 const assert = require('assert');
 const snakeCaseKeys = require('./snakecase-keys');
+const crypto = require('crypto');
+const timeSeries = require('@jambonz/time-series');
+let alerter ;
+
 const toBase64 = (str) => Buffer.from(str || '', 'utf8').toString('base64');
 
+function computeSignature(payload, timestamp, secret) {
+  assert(secret);
+  const data = `${timestamp}.${JSON.stringify(payload)}`;
+  return crypto
+    .createHmac('sha256', secret)
+    .update(data, 'utf8')
+    .digest('hex');
+}
+
+function generateSigHeader(payload, secret) {
+  const timestamp = Math.floor(Date.now() / 1000);
+  const signature = computeSignature(payload, timestamp, secret);
+  const scheme = 'v1';
+  return {
+    'Jambonz-Signature': `t=${timestamp},${scheme}=${signature}`
+  };
+}
+
 function basicAuth(username, password) {
   if (!username || !password) return {};
   const creds = `${username}:${password || ''}`;
@@ -21,7 +43,7 @@ function isAbsoluteUrl(u) {
 }
 
 class Requestor {
-  constructor(logger, hook) {
+  constructor(logger, account_sid, hook, secret) {
     assert(typeof hook === 'object');
 
     this.logger = logger;
@@ -38,12 +60,22 @@ class Requestor {
 
     this.username = hook.username;
     this.password = hook.password;
+    this.secret = secret;
+    this.account_sid = account_sid;
 
     assert(isAbsoluteUrl(this.url));
     assert(['GET', 'POST'].includes(this.method));
 
     const {stats} = require('../../').srf.locals;
     this.stats = stats;
+
+    if (!alerter) {
+      alerter = timeSeries(logger, {
+        host: process.env.JAMBONES_TIME_SERIES_HOST,
+        commitSize: 50,
+        commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
+      });
+    }
   }
 
   get baseUrl() {
@@ -65,7 +97,6 @@ class Requestor {
     const payload = params ? snakeCaseKeys(params, ['customerData', 'sip']) : null;
     const url = hook.url || hook;
     const method = hook.method || 'POST';
-    const {username, password} = typeof hook === 'object' ? hook : {};
 
     assert.ok(url, 'Requestor:request url was not provided');
     assert.ok, (['GET', 'POST'].includes(method), `Requestor:request method must be 'GET' or 'POST' not ${method}`);
@@ -75,12 +106,27 @@ class Requestor {
 
     let buf;
     try {
+      const sigHeader = generateSigHeader(payload, this.secret);
+      const headers = {...sigHeader, ...this.authHeader};
+      this.logger.info({url, headers}, 'send webhook');
       buf = isRelativeUrl(url) ?
-        await this.post(url, payload, this.authHeader) :
-        await bent(method, 'buffer', 200, 201, 202)(url, payload, basicAuth(username, password));
+        await this.post(url, payload, headers) :
+        await bent(method, 'buffer', 200, 201, 202)(url, payload, headers);
     } catch (err) {
-      this.logger.info({baseUrl: this.baseUrl, url, statusCode: err.statusCode},
+      this.logger.error({err, secret: this.secret, baseUrl: this.baseUrl, url, statusCode: err.statusCode},
         `web callback returned unexpected error code ${err.statusCode}`);
+      let opts = {account_sid: this.account_sid};
+      if (err.code === 'ECONNREFUSED') {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url};
+      }
+      else if (err.name === 'StatusError') {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_STATUS_FAILURE, url, status: err.statusCode};
+      }
+      else {
+        opts = {...opts, alert_type: alerter.AlertType.WEBHOOK_CONNECTION_FAILURE, url, detail: err.message};
+      }
+      alerter.writeAlerts(opts).catch((err) => this.logger.info({err, opts}, 'Error writing alert'));
+
       throw err;
     }
     const diff = process.hrtime(startAt);

lib/utils/sbc-pinger.js

@@ -68,6 +68,8 @@ module.exports = (logger) => {
 
   // send OPTIONS pings to SBCs
   async function pingProxies(srf) {
+    if (process.env.NODE_ENV === 'test') return;
+
     for (const sbc of sbcs) {
       try {
         const ms = srf.locals.getFreeswitch();