update deps (#130)

* check if sip gateway is in blacklist before sending outbound call

* wip

* wip

* wip

* add testcase for blacklist

* wip

app.js

@@ -97,6 +97,7 @@ srf.locals = {...srf.locals,
     lookupCarrierByAccountLcr
   },
   realtimeDbHelpers: {
+    client: redisClient,
     createHash,
     retrieveHash,
     incrKey,

lib/call-session.js

@@ -1,12 +1,13 @@
 const Emitter = require('events');
 const sdpTransform = require('sdp-transform');
 const SrsClient = require('@jambonz/siprec-client-utils');
-const {makeRtpEngineOpts, nudgeCallCounts, isPrivateVoipNetwork} = require('./utils');
+const {makeRtpEngineOpts, nudgeCallCounts, isPrivateVoipNetwork, isBlackListedSipGateway} = require('./utils');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {SipError, stringifyUri, parseUri} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-outbound');
 
 const makeInviteInProgressKey = (callid) => `sbc-out-iip${callid}`;
+const IMMUTABLE_HEADERS = ['via', 'from', 'to', 'call-id', 'cseq', 'max-forwards', 'content-length'];
 /**
  * this is to make sure the outgoing From has the number in the incoming From
  * and not the incoming PAI
@@ -102,6 +103,7 @@ class CallSession extends Emitter {
     this.lookupCarrierByAccountLcr = lookupCarrierByAccountLcr;
 
     this._mediaReleased = false;
+    this.recordingNoAnswerTimeout = (process.env.JAMBONES_RECORDING_NO_ANSWER_TIMEOUT || 2) * 1000;
   }
 
   get service_provider_sid() {
@@ -166,7 +168,7 @@ class CallSession extends Emitter {
       subscribeAnswer,
       unsubscribe
     } = engine;
-    const {createHash, retrieveHash} = this.srf.locals.realtimeDbHelpers;
+    const {client, createHash, retrieveHash} = this.srf.locals.realtimeDbHelpers;
     this.offer = offer;
     this.answer = answer;
     this.del = del;
@@ -184,7 +186,7 @@ class CallSession extends Emitter {
 
     this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, this.useWss || teams, false, teams);
     this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
-    let proxy, uris;
+    let proxy, uris = [];
     const mapGateways = new Map();
 
     try {
@@ -278,7 +280,13 @@ class CallSession extends Emitter {
           }
           const vc = await this.lookupCarrierBySid(voip_carrier_sid);
           const gateways = await this.lookupSipGatewaysByCarrier(voip_carrier_sid);
-          const gws = (gateways || [])
+          const goodGateways = [];
+          for (const g of gateways) {
+            if (!await isBlackListedSipGateway(client, this.logger, g.sip_gateway_sid)) {
+              goodGateways.push(g);
+            }
+          }
+          const gws = (goodGateways || [])
             .filter((gw) => gw.outbound);
           if (gws.length) {
             uris = [];
@@ -291,7 +299,7 @@ class CallSession extends Emitter {
               const hostport = !o.port || 5060 === o.port ? o.ipv4 : `${o.ipv4}:${o.port}`;
               const prependPlus = vc.e164_leading_plus && !this.req.calledNumber.startsWith('0') ? '+' : '';
               const transport = `transport=${protocol}`;
-              const scheme = protocol === 'tls' ? 'sips' : 'sip';
+              const scheme = (protocol === 'tls' && !process.env.JAMBONES_USE_BEST_EFFORT_TLS) ? 'sips' : 'sip';
               const u = `${scheme}:${prefix}${prependPlus}${calledNumber}@${hostport};${transport}`;
               const obj = {
                 name: vc.name,
@@ -330,6 +338,7 @@ class CallSession extends Emitter {
           }
           else {
             this.logger.info({voip_carrier_sid}, 'no outbound gateways found for requested carrier');
+            this.res.send(603);
           }
         } catch (err) {
           debug(err);
@@ -574,13 +583,18 @@ class CallSession extends Emitter {
     this.uas = uas;
     this.uac = uac;
     [uas, uac].forEach((dlg) => {
-      dlg.on('destroy', async() => {
+      dlg.on('destroy', async(bye) => {
         const other = dlg.other;
         this.rtpEngineResource.destroy();
         this.activeCallIds.delete(this.req.get('Call-ID'));
         this.unsubscribeForDTMF();
         //this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uac.tag);
         try {
+          const headers = {};
+          Object.keys(bye.headers).forEach((h) => {
+            if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
+          });
+          await other.destroy({headers});
           await other.destroy();
         } catch (err) {}
 
@@ -646,6 +660,22 @@ class CallSession extends Emitter {
     forwardInDialogRequests(uac,  ['notify', 'options', 'message']);
   }
 
+  _startRecordingNoAnswerTimer(res) {
+    this._clearRecordingNoAnswerTimer();
+    this.recordingNoAnswerTimer = setTimeout(() => {
+      this.logger.info('No response from SipRec server, return error to feature server');
+      this.isRecordingNoAnswerResponded = true;
+      res.send(400);
+    }, this.recordingNoAnswerTimeout);
+  }
+
+  _clearRecordingNoAnswerTimer() {
+    if (this.recordingNoAnswerTimer) {
+      clearTimeout(this.recordingNoAnswerTimer);
+      this.recordingNoAnswerTimer = null;
+    }
+  }
+
   _stopRecording() {
     if (this.srsClients.length) {
       this.srsClients.forEach((c) => c.stop());
@@ -752,6 +782,8 @@ Duration=${payload.duration} `
         sdp
       };
       response = await this.answer(opts);
+      /* now remove asymeetric as B party (looking at you Genesys ring group) may need port re-learning on invites  */
+      answerMedia.flags = answerMedia.flags.filter((f) => f !== 'asymmetric');
       if ('ok' !== response.result) {
         res.send(488);
         throw new Error(`_onReinvite: rtpengine failed: ${JSON.stringify(response)}`);
@@ -759,6 +791,7 @@ Duration=${payload.duration} `
       this.logger.debug({opts, sdp: response.sdp}, 'CallSession:_onReinvite: (answer) sending back upstream');
       res.send(200, {body: response.sdp});
     } catch (err) {
+      res.send(err.status || 500);
       this.logger.error(err, 'Error handling reinvite');
     }
   }
@@ -786,12 +819,12 @@ Duration=${payload.duration} `
         }
         else if (reason.includes('CallRecording')) {
           let succeeded = false;
+          const headers = contentType === 'application/json' && req.body ? JSON.parse(req.body) : {};
           if (reason === 'startCallRecording') {
             const from = this.req.getParsedHeader('From');
             const to = this.req.getParsedHeader('To');
             const aorFrom = from.uri;
             const aorTo = to.uri;
-            const headers = contentType === 'application/json' && req.body ? JSON.parse(req.body) : {};
             this.logger.info({to, from}, 'startCallRecording request for an outbound call');
 
             const srsUrl = req.get('X-Srs-Url');
@@ -834,49 +867,76 @@ Duration=${payload.duration} `
               headers
             }));
             try {
-              succeeded = (await Promise.all(
-                this.srsClients.map((c) => c.start())
-              )).every((r) => r);
+              this._startRecordingNoAnswerTimer(res);
+              await Promise.any(this.srsClients.map((c) => c.start()));
+              succeeded = true;
             } catch (err) {
               this.logger.error({err}, 'Error starting SipRec call recording');
+              succeeded = false;
             }
           }
           else if (reason === 'stopCallRecording') {
-            if (!this.srsClients.length) {
+            if (!this.srsClients.length || !this.srsClients.some((c) => c.activated)) {
               res.send(400);
               this.logger.info('discarding stopCallRecording request because we are not recording');
               return;
             }
             try {
-              succeeded = (await Promise.all(
-                this.srsClients.map((c) => c.stop())
-              )).every((r) => r);
+              this._startRecordingNoAnswerTimer(res);
+              await Promise.any(this.srsClients.map((c) => {
+                if (c.activated) {
+                  c.stop();
+                }
+              }));
+              succeeded = true;
             } catch (err) {
               this.logger.error({err}, 'Error stopping SipRec call recording');
+              succeeded = false;
             }
             this.srsClients = [];
           }
           else if (reason === 'pauseCallRecording') {
-            if (!this.srsClients.length || this.srsClients.every((c) => c.paused)) {
+            if (!this.srsClients.length || !this.srsClients.some((c) => c.activated && !c.paused)) {
               this.logger.info('discarding invalid pauseCallRecording request');
               res.send(400);
               return;
             }
-            succeeded = (await Promise.all(
-              this.srsClients.map((c) => c.pause())
-            )).every((r) => r);
+            try {
+              this._startRecordingNoAnswerTimer(res);
+              await Promise.any(this.srsClients.map((c) => {
+                if (c.activated && !c.paused) {
+                  c.pause({headers});
+                }
+              }));
+              succeeded = true;
+            } catch (err) {
+              this.logger.error({err}, 'Error pausing SipRec call recording');
+              succeeded = false;
+            }
           }
           else if (reason === 'resumeCallRecording') {
-            if (!this.srsClients.length || !this.srsClients.every((c) => c.paused)) {
+            if (!this.srsClients.length || !this.srsClients.some((c) => c.activated && c.paused)) {
               res.send(400);
               this.logger.info('discarding invalid resumeCallRecording request');
               return;
             }
-            succeeded = (await Promise.all(
-              this.srsClients.map((c) => c.resume())
-            )).every((r) => r);
+            try {
+              this._startRecordingNoAnswerTimer(res);
+              await Promise.any(this.srsClients.map((c) => {
+                if (c.activated && c.paused) {
+                  c.resume({headers});
+                }
+              }));
+              succeeded = true;
+            } catch (err) {
+              this.logger.error({err}, 'Error resuming SipRec call recording');
+              succeeded = false;
+            }
+          }
+          if (!this.isRecordingNoAnswerResponded) {
+            this._clearRecordingNoAnswerTimer();
+            res.send(succeeded ? 200 : 503);
           }
-          res.send(succeeded ? 200 : 503);
         } else if (reason.includes('Dtmf')) {
           const arr = /Signal=\s*([0-9#*])/.exec(req.body);
           if (!arr) {
@@ -934,10 +994,9 @@ Duration=${payload.duration} `
         }
       }
       else {
-        const immutableHdrs = ['via', 'from', 'to', 'call-id', 'cseq', 'max-forwards', 'content-length'];
         const headers = {};
         Object.keys(req.headers).forEach((h) => {
-          if (!immutableHdrs.includes(h)) headers[h] = req.headers[h];
+          if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = req.headers[h];
         });
         const response = await dlg.other.request({method: 'INFO', headers, body: req.body});
         const responseHeaders = {};
@@ -953,6 +1012,16 @@ Duration=${payload.duration} `
 
   async _onFeatureServerTransfer(dlg, req, res) {
     try {
+      // the following properties are ignored in the REFER headers
+      // eslint-disable-next-line no-unused-vars
+      const { via, from, to, 'call-id': callid, cseq, 'max-forwards': maxforwards,
+      // eslint-disable-next-line no-unused-vars
+        'content-length': _contentlength, 'refer-to': _referto, 'referred-by': _referredby,
+        // eslint-disable-next-line no-unused-vars
+        'X-Refer-To-Leave-Untouched': _leave,
+        ...customHeaders
+      } = req.headers;
+
       const referTo = req.getParsedHeader('Refer-To');
       const uri = parseUri(referTo.uri);
       this.logger.info({uri, referTo}, 'received REFER from feature server');
@@ -970,7 +1039,8 @@ Duration=${payload.duration} `
           method: 'REFER',
           headers: {
             'Refer-To': stringifyUri(uri),
-            'Referred-By': stringifyUri(u)
+            'Referred-By': stringifyUri(u),
+            ...customHeaders
           }
         });
         return res.send(response.status);

lib/utils.js

@@ -213,6 +213,18 @@ const isPrivateVoipNetwork = async(uri) => {
   return false;
 };
 
+function makeBlacklistGatewayKey(key) {
+  return `blacklist-sip-gateway:${key}`;
+}
+
+async function isBlackListedSipGateway(client, logger, sip_gateway_sid) {
+  try {
+    return await client.exists(makeBlacklistGatewayKey(sip_gateway_sid)) === 1;
+  } catch (err) {
+    logger.error({err}, `isBlackListedSipGateway: error while checking blacklist for ${sip_gateway_sid}`);
+  }
+}
+
 module.exports = {
   makeRtpEngineOpts,
   selectHostPort,
@@ -223,5 +235,6 @@ module.exports = {
   systemHealth,
   createHealthCheckApp,
   nudgeCallCounts,
-  isPrivateVoipNetwork
+  isPrivateVoipNetwork,
+  isBlackListedSipGateway
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-outbound",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "main": "app.js",
   "engines": {
     "node": ">= 12.0.0"
@@ -24,30 +24,30 @@
     "start": "node app",
     "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONES_HOSTING=1 JAMBONES_NETWORK_CIDR=127.0.0.1/32 JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
-    "jslint": "eslint app.js lib"
+    "jslint": "eslint app.js lib --fix"    
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.9.0",
-    "@jambonz/realtimedb-helpers": "^0.8.7",
+    "@jambonz/db-helpers": "^0.9.3",
+    "@jambonz/realtimedb-helpers": "^0.8.8",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/mw-registrar": "0.2.4",
-    "@jambonz/rtpengine-utils": "^0.4.3",
-    "@jambonz/siprec-client-utils": "^0.2.6",
+    "@jambonz/mw-registrar": "0.2.7",
+    "@jambonz/rtpengine-utils": "^0.4.4",
+    "@jambonz/siprec-client-utils": "^0.2.7",
     "@jambonz/stats-collector": "^0.1.9",
-    "@jambonz/time-series": "^0.2.5",
+    "@jambonz/time-series": "^0.2.8",
     "cidr-matcher": "^2.1.1",
     "debug": "^4.3.4",
-    "drachtio-fn-b2b-sugar": "^0.0.12",
+    "drachtio-fn-b2b-sugar": "^0.1.0",
     "drachtio-srf": "^4.5.31",
-    "express": "^4.18.1",
-    "pino": "^7.11.0",
-    "sdp-transform": "^2.14.1"
+    "express": "^4.19.2",
+    "pino": "^8.20.0",
+    "sdp-transform": "^2.14.2"
   },
   "devDependencies": {
     "bent": "^7.3.12",
     "eslint": "^7.32.0",
-    "eslint-plugin-promise": "^5.2.0",
+    "eslint-plugin-promise": "^6.1.1",
     "nyc": "^15.1.0",
-    "tape": "^5.5.3"
+    "tape": "^5.7.5"
   }
 }

test/scenarios/uac-pcap-carrier-fail-blacklist.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:16173333456@127.0.0.1 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16173333456@127.0.0.1>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      X-Account-Sid: ed649e33-e771-403a-8c99-1780eabbc803
+      X-Call-Sid: ff49e33-e771-403a-8c99-1780eabbc803
+      X-Jambonz-Routing: phone
+      Subject: uac-pcap-carrier-fail-limits
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="603" rtd="true" crlf="true">
+  </recv>
+
+  <send>
+    <![CDATA[
+
+      ACK sip:sip:+16173333456@127.0.0.1 SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:sip:+16173333456@127.0.0.1>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Subject: uac-pcap-carrier-fail-blacklist
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+
+</scenario>

test/sip-tests.js

@@ -26,6 +26,7 @@ function connect(connectable) {
 test('sbc-outbound tests', async(t) => {
   const {srf} = require('../app');
   const { queryCdrs } = srf.locals;
+  const redisClient = srf.locals.realtimeDbHelpers.client;
 
   try {
     await connect(srf);
@@ -95,7 +96,17 @@ test('sbc-outbound tests', async(t) => {
     /* fails when session limit exceeded */
     await sippUac('uac-pcap-carrier-fail-limits.xml');
     t.pass('fails when max calls in progress');
-      
+
+    // re-rack test data
+    execSync(`mysql -h 127.0.0.1 -u root  --protocol=tcp -D jambones_test < ${__dirname}/db/jambones-sql.sql`);
+    execSync(`mysql -h 127.0.0.1 -u root  --protocol=tcp -D jambones_test < ${__dirname}/db/populate-test-data.sql`);
+
+    // Black list good carrier for some seconds
+    await redisClient.setex('blacklist-sip-gateway:124a5339-c62c-4075-9e19-f4de70a96597', 3, '');
+    await sippUac('uac-pcap-carrier-fail-blacklist.xml');
+    t.pass('fails when carrier is blacklisted');
+    await redisClient.del('blacklist-sip-gateway:124a5339-c62c-4075-9e19-f4de70a96597');
+
     await waitFor(25);
 
     const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});