bugfix: transferring conference legs to different FS

* add support for incoming calls from carriers we register with, who then put their domain in the host part of incoming INVITE

* fix query to lookup registration carriers

Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=linux/amd64 node:18.8.0-alpine as base
+FROM --platform=linux/amd64 node:18.9.0-alpine3.16 as base
 
 RUN apk --update --no-cache add --virtual .builds-deps build-base python3
 

app.js

@@ -69,7 +69,7 @@ const {
 const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
 const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
 const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {
-  emitter: stats,
+  //emitter: stats,
   dtmfListenPort: process.env.DTMF_LISTEN_PORT || 22224,
   protocol: ngProtocol
 });

lib/call-session.js

@@ -80,6 +80,10 @@ class CallSession extends Emitter {
     return tp && -1 !== tp.indexOf('SAVP');
   }
 
+  get isFive9VoiceStream() {
+    return this.req.has('X-Five9-StreamingPairId');
+  }
+
   async connect() {
     const {sdp} = this.req.locals;
     this.logger.info('inbound call accepted for routing');
@@ -246,6 +250,17 @@ class CallSession extends Emitter {
             this.logger.error(`rtpengine answer failed with ${JSON.stringify(response)}`);
             throw new Error('rtpengine failed: answer');
           }
+          /* special case: Five9 Voicestream calls do not advertise a:sendonly, though they should */
+          if (this.isFive9VoiceStream) {
+            const opts = {
+              ...this.rtpEngineOpts.common,
+              'from-tag':this.rtpEngineOpts.uac.tag
+            };
+            this.logger.info('Voicestream call from Five9, blocking audio in the reverse direction');
+            const response = await Promise.all([this.blockMedia(opts), this.blockDTMF(opts)]);
+            this.logger.debug({response}, 'response to blockMedia/blockDTMF');
+          }
+
           return response.sdp;
         }
       });
@@ -508,11 +523,16 @@ Duration=${payload.duration} `
         req.body;
 
       const reason = req.get('X-Reason');
+      const isReleasingMedia = reason && dlg.type === 'uas' && ['release-media', 'anchor-media'].includes(reason);
       const fromTag = dlg.type === 'uas' ? this.rtpEngineOpts.uas.tag : this.rtpEngineOpts.uac.tag;
       const toTag = dlg.type === 'uas' ? this.rtpEngineOpts.uac.tag : this.rtpEngineOpts.uas.tag;
       const offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
       const answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
       const direction =  dlg.type === 'uas' ? ['public', 'private'] : ['private', 'public'];
+      if (isReleasingMedia) {
+        if (!offerMedia.flags.includes('asymmetric')) offerMedia.flags.push('asymmetric');
+        offerMedia.flags = offerMedia.flags.filter((f) => f !== 'media handover');
+      }
       let opts = {
         ...this.rtpEngineOpts.common,
         ...offerMedia,
@@ -531,11 +551,11 @@ Duration=${payload.duration} `
 
       /* if this is a re-invite from the FS to change media anchoring, avoid sending the reinvite out */
       let sdp;
-      if (reason && dlg.type === 'uac' && ['release-media', 'anchor-media'].includes(reason) &&
-        !this.callerIsUsingSrtp) {
+      if (isReleasingMedia && !this.callerIsUsingSrtp) {
         this.logger.info({response}, `got a reinvite from FS to ${reason}`);
         sdp = dlg.other.remote.sdp;
-        answerMedia.flags = ['asymmetric', 'port latching'];
+        if (!answerMedia.flags.includes('asymmetric')) answerMedia.flags.push('asymmetric');
+        answerMedia.flags = answerMedia.flags.filter((f) => f !== 'media handover');
         this._mediaReleased = 'release-media' === reason;
       }
       else {
@@ -776,15 +796,15 @@ Duration=${payload.duration} `
       res.send(202);
 
       // invite to new fs
-      const headers = {};
-      if (req.has('X-Retain-Call-Sid')) {
-        Object.assign(headers, {'X-Retain-Call-Sid': req.get('X-Retain-Call-Sid')});
-      }
+      const headers = {
+        ...(req.has('X-Retain-Call-Sid') && {'X-Retain-Call-Sid': req.get('X-Retain-Call-Sid')}),
+        ...(req.has('X-Account-Sid') && {'X-Account-Sid': req.get('X-Account-Sid')})
+      };
       const uac = await this.srf.createUAC(referTo.uri, {localSdp: dlg.local.sdp, headers});
       this.uac = uac;
       uac.other = this.uas;
       this.uas.other = uac;
-      uac.on('modify', this._onFeatureServerReinvite.bind(this, uac));
+      uac.on('modify', this._onReinvite.bind(this, uac));
       uac.on('refer', this._onFeatureServerTransfer.bind(this, uac));
       uac.on('destroy', () => {
         this.logger.info('call ended with normal termination');
@@ -802,7 +822,7 @@ Duration=${payload.duration} `
       const response = await this.answer(opts);
       if ('ok' !== response.result) {
         res.send(488);
-        throw new Error(`_onFeatureServerReinvite: rtpengine failed: ${JSON.stringify(response)}`);
+        throw new Error(`_onFeatureServerTransfer: rtpengine failed: ${JSON.stringify(response)}`);
       }
       this.logger.info('successfully moved call to new feature server');
     } catch (err) {

lib/db-utils.js

@@ -57,6 +57,16 @@ WHERE sg.voip_carrier_sid = ?
 AND sg.voip_carrier_sid = vc.voip_carrier_sid 
 AND outbound = 1`;
 
+const sqlSelectCarrierRequiringRegistration = `
+SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid, vc.account_sid, 
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
+FROM sip_gateways sg, voip_carriers vc 
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid 
+AND vc.requires_register = 1 
+AND vc.is_active = 1 
+AND vc.register_sip_realm = ? 
+AND vc.register_username = ?`;
+
 const gatewayMatchesSourceAddress = (source_address, gw) => {
   if (32 === gw.netmask && gw.ipv4 === source_address) return true;
   if (gw.netmask < 32) {
@@ -179,6 +189,15 @@ module.exports = (srf, logger) => {
       }
     }
 
+    /**
+     * The host part of the SIP URI is not a dot-decimal IP address,
+     * so this can be one of two things:
+     * (1) a sip realm value associate with an account, or
+     * (2) a carrier name for a carrier that we send outbound registrations to
+     *
+     * Let's look for case #1 first...
+     */
+
     /* get all the carriers and gateways for the account owning this sip realm */
     const [gwAcc] = await pp.query(sqlSelectAllCarriersForAccountByRealm, uri.host);
     const [gwSP] = gwAcc.length ? [[]] : await pp.query(sqlSelectAllCarriersForSPByRealm, uri.host);
@@ -196,6 +215,41 @@ module.exports = (srf, logger) => {
         account: a[0]
       };
     }
+
+    /* no match, so let's look for case #2 */
+    try {
+      logger.info({
+        host: uri.host,
+        user: uri.user
+      }, 'sip realm is not associated with an account, checking carriers');
+      const [gw] = await pp.query(sqlSelectCarrierRequiringRegistration, [uri.host, uri.user]);
+      const matches = gw.filter(gatewayMatchesSourceAddress.bind(null, req.source_address));
+      if (1 === matches.length) {
+        // bingo
+        //TODO: this assumes the carrier is associate to an account, not an SP
+        //if the carrier is associated with an SP (which would mean we
+        //must see a dialed number in the To header, not the register username),
+        //then we need to look up the account based on the dialed number in the To header
+        const [a] = await pp.query(sqlAccountBySid, matches[0].account_sid);
+        if (0 === a.length) return failure;
+        logger.debug({matches}, `found registration carrier using ${uri.host} and ${uri.user}`);
+        return {
+          fromCarrier: true,
+          gateway: matches[0],
+          service_provider_sid: a[0].service_provider_sid,
+          account_sid: a[0].account_sid,
+          application_sid: matches[0].application_sid,
+          account: a[0]
+        };
+
+      }
+      else if (matches.length > 1) {
+        logger.warn({matches, source_address: req.source_address}, 'multiple gateways match source address');
+      }
+    } catch (err) {
+      logger.info({err, host: uri.host, user: uri.user}, 'Error looking up carrier by host and user');
+    }
+
     return failure;
   };
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-inbound",
-  "version": "v0.7.6",
+  "version": "v0.7.7",
   "main": "app.js",
   "engines": {
     "node": ">= 12.0.0"
@@ -26,10 +26,10 @@
   },
   "dependencies": {
     "@jambonz/db-helpers": "^0.6.19",
+    "@jambonz/realtimedb-helpers": "^0.4.35",
     "@jambonz/http-authenticator": "^0.2.2",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.4.29",
-    "@jambonz/rtpengine-utils": "^0.3.6",
+    "@jambonz/rtpengine-utils": "^0.3.10",
     "@jambonz/siprec-client-utils": "^0.1.4",
     "@jambonz/stats-collector": "^0.1.6",
     "@jambonz/time-series": "^0.2.5",