fix sbc to forward BYE header (#129 )

* fix sbc to forward BYE header * fix sbc to forward BYE header
support sending DTMF to caller (#125 )
2026-10-04 02:04:22 +00:00 · 2023-12-28 20:45:38 -05:00 · 2023-12-13 09:14:27 -05:00 · 2023-12-13 08:25:26 -05:00 · 2023-11-14 09:13:08 -05:00 · 2023-11-13 15:24:41 -05:00
8 changed files with 702 additions and 1089 deletions
@@ -14,31 +14,6 @@ assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
 assert.ok(process.env.JAMBONES_TIME_SERIES_HOST, 'missing JAMBONES_TIME_SERIES_HOST env var');
 assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_NETWORK_CIDR env var');

-
-const JAMBONES_REDIS_SENTINELS = process.env.JAMBONES_REDIS_SENTINELS ? {
-  sentinels: process.env.JAMBONES_REDIS_SENTINELS.split(',').map((sentinel) => {
-    let host, port = 26379;
-    if (sentinel.includes(':')) {
-      const arr = sentinel.split(':');
-      host = arr[0];
-      port = parseInt(arr[1], 10);
-    } else {
-      host = sentinel;
-    }
-    return {host, port};
-  }),
-  name: process.env.JAMBONES_REDIS_SENTINEL_MASTER_NAME,
-  ...(process.env.JAMBONES_REDIS_SENTINEL_PASSWORD && {
-    password: process.env.JAMBONES_REDIS_SENTINEL_PASSWORD
-  }),
-  ...(process.env.JAMBONES_REDIS_SENTINEL_USERNAME && {
-    username: process.env.JAMBONES_REDIS_SENTINEL_USERNAME
-  }),
-  ...(process.env.JAMBONES_REDIS_SENTINEL_SENTINAL_PASSWORD && {
-    sentinelPassword: process.env.JAMBONES_REDIS_SENTINEL_SENTINAL_PASSWORD
-  }),
-} : null;
-
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-inbound');
 const opts = Object.assign({
@@ -67,7 +42,6 @@ const {LifeCycleEvents} = require('./lib/constants');
 const setNameRtp = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-rtp`;
 const rtpServers = [];
 const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
-const Registrar = require('@jambonz/mw-registrar');

 const {
  pool,
@@ -81,8 +55,7 @@ const {
  lookupAccountBySid,
  lookupAccountCapacitiesBySid,
  queryCallLimits,
-  lookupClientByAccountAndUsername,
-  lookupAppBySid
+  lookupClientByAccountAndUsername
 } = require('@jambonz/db-helpers')({
  host: process.env.JAMBONES_MYSQL_HOST,
  port: process.env.JAMBONES_MYSQL_PORT || 3306,
@@ -98,11 +71,7 @@ const {
  addToSet,
  removeFromSet,
  incrKey,
-  decrKey} = require('@jambonz/realtimedb-helpers')(JAMBONES_REDIS_SENTINELS || {
-  host: process.env.JAMBONES_REDIS_HOST,
-  port: process.env.JAMBONES_REDIS_PORT || 6379
-}, logger);
-const registrar = new Registrar(logger, redisClient);
+  decrKey} = require('@jambonz/realtimedb-helpers')({}, logger);

 const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
 const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
@@ -123,7 +92,6 @@ srf.locals = {...srf.locals,
  activeCallIds: new Map(),
  getRtpEngine,
  dbHelpers: {
-    registrar,
    pool,
    ping,
    lookupAuthHook,
@@ -134,8 +102,7 @@ srf.locals = {...srf.locals,
    lookupAccountBySipRealm,
    lookupAccountCapacitiesBySid,
    queryCallLimits,
-    lookupClientByAccountAndUsername,
-    lookupAppBySid
+    lookupClientByAccountAndUsername
  },
  realtimeDbHelpers: {
    createSet,
@@ -6,7 +6,8 @@ const {
  SdpWantsSDES,
  nudgeCallCounts,
  roundTripTime,
-  parseConnectionIp
+  parseConnectionIp,
+  isPrivateVoipNetwork
 } = require('./utils');

 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
@@ -14,6 +15,7 @@ const {parseUri, stringifyUri, SipError} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-inbound');
 const MS_TEAMS_USER_AGENT = 'Microsoft.PSTNHub.SIPProxy';
 const MS_TEAMS_SIP_ENDPOINT = 'sip.pstnhub.microsoft.com';
+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
@@ -177,7 +179,7 @@ class CallSession extends Emitter {
        ...this.rtpEngineOpts.common,
        ...this.rtpEngineOpts.uac.mediaOpts,
        'from-tag': this.rtpEngineOpts.uas.tag,
-        direction:  ['public', 'private'],
+        direction:  [isPrivateVoipNetwork(this.req.source_address) ? 'private' : 'public', 'private'],
        sdp
      };
      const startAt = process.hrtime();
@@ -224,12 +226,6 @@ class CallSession extends Emitter {
      if (this.req.locals.application_sid) {
        Object.assign(headers, {'X-Application-Sid': this.req.locals.application_sid});
      }
-      if (this.req.locals.queue_name) {
-        Object.assign(headers, {'X-Queue-Name': this.req.locals.queue_name});
-      }
-      if (this.req.locals.called_user) {
-        Object.assign(headers, {'X-Called-User': this.req.locals.called_user});
-      }
      if (this.req.authorization) {
        if (this.req.authorization.grant && this.req.authorization.grant.application_sid) {
          Object.assign(headers, {'X-Application-Sid': this.req.authorization.grant.application_sid});
@@ -254,7 +250,8 @@ class CallSession extends Emitter {
          '-Max-Forwards',
          '-Record-Route',
          '-Session-Expires',
-          '-X-Subspace-Forwarded-For',
+          '-X-Application-Sid',
+          '-X-Authenticated-User'
        ],
        proxyResponseHeaders: ['all', '-X-Trace-ID'],
        localSdpB: spdOfferB,
@@ -361,12 +358,16 @@ 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().catch((err) => {});
        this.activeCallIds.delete(this.req.get('Call-ID'));
        try {
-          await other.destroy();
+          const headers = {};
+          Object.keys(bye.headers).forEach((h) => {
+            if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
+          });
+          await other.destroy({headers});
        } catch (err) {}
        this.unsubscribeForDTMF();

@@ -784,6 +785,27 @@ Duration=${payload.duration} `
            )).every((r) => r);
          }
          res.send(succeeded ? 200 : 503);
+        } else if (reason.includes('Dtmf')) {
+          const arr = /Signal=\s*([0-9#*])/.exec(req.body);
+          if (!arr) {
+            this.logger.info({body: req.body}, '_onInfo: invalid INFO Dtmf');
+            throw new Error(`_onInfo: no dtmf in body for ${contentType}`);
+          }
+          const code = arr[1];
+          const arr2 = /Duration=\s*(\d+)/.exec(req.body);
+          const duration = arr2 ? arr2[1] : 250;
+          const dtmfOpts = {
+            ...this.rtpEngineOpts.common,
+            'from-tag': this.rtpEngineOpts.uac.tag,
+            code,
+            duration
+          };
+          const response = await this.playDTMF(dtmfOpts);
+          if ('ok' !== response.result) {
+            this.logger.info({response}, `rtpengine play Dtmf failed with ${JSON.stringify(response)}`);
+            throw new Error('rtpengine failed: answer');
+          }
+          res.send(200);
        }
      }
      else if (dlg.type === 'uas' && ['application/dtmf-relay', 'application/dtmf'].includes(contentType)) {
@@ -821,10 +843,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 = {};
@@ -142,7 +142,7 @@ module.exports = (srf, logger) => {
    const failure = {fromCarrier: false};
    const uri = parseUri(req.uri);
    const isDotDecimal = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/.test(uri.host);
-
+    const did = normalizeDID(req.calledNumber) || 'anonymous';
    if (!isDotDecimal) {
      /**
       * The host part of the SIP URI is not a dot-decimal IP address,
@@ -175,12 +175,19 @@ module.exports = (srf, logger) => {
          .sort((a, b) => b.netmask - a.netmask);
        const selected = gw.find(gatewayMatchesSourceAddress.bind(null, logger, req.source_address));
        if (selected) {
+          const sql =
+            `SELECT application_sid FROM phone_numbers WHERE number = '${did}'
+            AND voip_carrier_sid = '${selected.voip_carrier_sid}'
+            AND account_sid = '${a[0].account_sid}'`;
+          logger.debug({selected, sql, did}, 'looking up DID');
+          const [r] = await pp.query(sql);
+
          return {
            fromCarrier: true,
            gateway: selected,
            service_provider_sid: a[0].service_provider_sid,
            account_sid: a[0].account_sid,
-            application_sid: selected.application_sid,
+            application_sid: r[0]?.application_sid || selected.application_sid,
            account: a[0]
          };
        }
@@ -207,12 +214,19 @@ module.exports = (srf, logger) => {
          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}`);
+          const sql =
+            `SELECT application_sid FROM phone_numbers WHERE number = '${did}'
+            AND voip_carrier_sid = '${matches[0].voip_carrier_sid}'
+            AND account_sid = '${matches[0].account_sid}'`;
+          logger.debug({matches: matches[0], sql, did}, 'looking up DID');
+
+          const [r] = await pp.query(sql);
          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,
+            application_sid: r[0]?.application_sid || matches[0].application_sid,
            account: a[0]
          };
        }
@@ -264,7 +278,6 @@ module.exports = (srf, logger) => {
      if (matches.length) {
        /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
        const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
-        const did = normalizeDID(req.calledNumber) || 'anonymous';
        const sql =  `SELECT * FROM phone_numbers WHERE number = '${did}' AND voip_carrier_sid IN (${vc_sids})`;
        logger.debug({matches, sql, did, vc_sids}, 'looking up DID');

@@ -28,9 +28,7 @@ module.exports = function(srf, logger) {
    lookupAccountBySipRealm,
    lookupAccountBySid,
    lookupAccountCapacitiesBySid,
-    queryCallLimits,
-    lookupAppBySid,
-    registrar
+    queryCallLimits
  }  = srf.locals.dbHelpers;
  const {stats, writeCdrs} = srf.locals;

@@ -198,32 +196,11 @@ module.exports = function(srf, logger) {
          res.send(404);
          return req.srf.endSession(req);
        }
-        let deviceAppSid = null;
-        let called_user = null;
-        const queue_name = uri.user.startsWith('queue-') ? uri.user.match(/queue-(.*)/)[1] : null;
-        if (uri.user.startsWith('app-')) {
-          // Call from registered device to test application.
-          const appSid = uri.user.match(/app-(.*)/)[1];
-          const app = await lookupAppBySid(appSid);
-          if (app && app.account_sid === account.account_sid) {
-            deviceAppSid = app.application_sid;
-          }
-        } else if (!queue_name) {
-          // check if call to registered user
-          const {realm} = this.req.authorization.challengeResponse;
-          const calledAor = `${req.calledNumber}@${realm}`;
-          const reg = await registrar.query(calledAor);
-          if (reg) {
-            called_user = calledAor;
-          }
-        }
        req.locals = {
          service_provider_sid: account.service_provider_sid,
          account_sid: account.account_sid,
          account,
-          application_sid: deviceAppSid || account.device_calling_application_sid,
-          ...(queue_name && ({queue_name})),
-          ...(called_user && ({called_user})),
+          application_sid: account.device_calling_application_sid,
          webhook_secret: account.webhook_secret,
          realm: uri.host,
          ...(account.registration_hook && {
@@ -22,8 +22,8 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
  const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCopy;
  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCopy;

-  /* webrtc clients (e.g. sipjs) send DMTF via SIP INFO */
-  if ((srcIsUsingSrtp || dstIsUsingSrtp) && !teams) {
+  /* Allow Feature server to inject DTMF to both leg except call from Teams*/
+  if (!teams) {
    dstOpts.flags.push('inject DTMF');
    srcOpts.flags.push('inject DTMF');
  }
@@ -195,6 +195,14 @@ const isMSTeamsCIDR = (ip) => {
  return matcher.contains(ip);
 };

+const isPrivateVoipNetwork = (ip) => {
+  if (process.env.PRIVATE_VOIP_NETWORK_CIDR) {
+    const matcher = new CIDRMatcher(process.env.PRIVATE_VOIP_NETWORK_CIDR.split(','));
+    return matcher.contains(ip);
+  }
+  return false;
+};
+
 module.exports = {
  isWSS,
  SdpWantsSrtp,
@@ -211,5 +219,6 @@ module.exports = {
  nudgeCallCounts,
  roundTripTime,
  parseConnectionIp,
-  isMSTeamsCIDR
+  isMSTeamsCIDR,
+  isPrivateVoipNetwork
 };
@@ -1,6 +1,6 @@
 {
  "name": "sbc-inbound",
-  "version": "0.8.4",
+  "version": "0.8.5",
  "main": "app.js",
  "engines": {
    "node": ">= 12.0.0"
@@ -27,20 +27,19 @@
  "dependencies": {
    "@jambonz/db-helpers": "^0.9.1",
    "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.8.6",
+    "@jambonz/realtimedb-helpers": "^0.8.7",
    "@jambonz/rtpengine-utils": "^0.4.3",
    "@jambonz/siprec-client-utils": "^0.2.6",
    "@jambonz/stats-collector": "^0.1.9",
    "@jambonz/time-series": "^0.2.5",
    "@jambonz/digest-utils": "^0.0.3",
-    "@jambonz/mw-registrar": "^0.2.4",
    "@aws-sdk/client-sns": "^3.360.0",
    "@aws-sdk/client-auto-scaling": "^3.360.0",
    "bent": "^7.3.12",
    "cidr-matcher": "^2.1.1",
    "debug": "^4.3.4",
    "drachtio-fn-b2b-sugar": "0.0.12",
-    "drachtio-srf": "^4.5.21",
+    "drachtio-srf": "^4.5.31",
    "express": "^4.18.1",
    "pino": "^7.11.0",
    "verify-aws-sns-signature": "^0.1.0",
@@ -36,6 +36,8 @@
      Subject: uac-pcap-carrier-success
      Content-Type: application/sdp
      Content-Length: [len]
+      X-Authenticated-User: xhoaluu@jambonz.org
+      X-Application-Sid: APP_ID_1

      v=0
      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
Author	SHA1	Message	Date
Hoan Luu Huu	96a83619c7	fix sbc to forward BYE header (#129 ) * fix sbc to forward BYE header * fix sbc to forward BYE header	2023-12-28 20:45:38 -05:00
Hoan Luu Huu	b8a67019a1	support sending DTMF to caller (#125 ) * support sending DTMF to caller * wip	2023-12-13 09:14:27 -05:00
Hoan Luu Huu	0e1627ba82	phone number's application should override voice carrier default application (#128 ) * phone number's application should override voice carrier default application * fix review comments * fix review comments	2023-12-13 08:25:26 -05:00
Hoan Luu Huu	bb857a72ff	let realtimedb-utils build configuration from env vars (#122 )	2023-11-14 09:13:08 -05:00
Hoan Luu Huu	aea3033ae0	support PRIVATE_VOIP_NETWORK_CIDR for SDP negotiation (#124 ) * support PRIVATE_VOIP_NETWORK_CIDR for SDP negotiation * support multi PRIVATE_VOIP_NETWORK_CIDR	2023-11-13 15:24:41 -05:00
Dave Horton	9b9eaa37fb	0.8.5	2023-11-09 12:39:24 -05:00
Dave Horton	56e0e3c0f2	update drachtio-srf	2023-11-09 10:02:46 -05:00
Hoan Luu Huu	6a6b4dd26f	upgrade drachtio srf (#121 ) * upgrade drachtio srf * fix review comments	2023-10-24 08:42:53 -04:00