Fix/200 (#202)

* Update call-session.js

* Update call-session.js

.eslintignore

@@ -1 +0,0 @@
-test/*

.eslintrc.json

@@ -1,126 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es6": true  
-  },
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": false,
-      "modules": false
-    },
-    "ecmaVersion": 2020
-  },
-  "plugins": ["promise"],
-  "rules": {
-    "promise/always-return": "error",
-    "promise/no-return-wrap": "error",
-    "promise/param-names": "error",
-    "promise/catch-or-return": "error",
-    "promise/no-native": "off",
-    "promise/no-nesting": "warn",
-    "promise/no-promise-in-callback": "warn",
-    "promise/no-callback-in-promise": "warn",
-    "promise/no-return-in-finally": "warn",
-
-    // Possible Errors
-    // http://eslint.org/docs/rules/#possible-errors
-    "comma-dangle": [2, "only-multiline"],
-    "no-control-regex": 2,
-    "no-debugger": 2,
-    "no-dupe-args": 2,
-    "no-dupe-keys": 2,
-    "no-duplicate-case": 2,
-    "no-empty-character-class": 2,
-    "no-ex-assign": 2,
-    "no-extra-boolean-cast" : 2,
-    "no-extra-parens": [2, "functions"],
-    "no-extra-semi": 2,
-    "no-func-assign": 2,
-    "no-invalid-regexp": 2,
-    "no-irregular-whitespace": 2,
-    "no-negated-in-lhs": 2,
-    "no-obj-calls": 2,
-    "no-proto": 2,
-    "no-unexpected-multiline": 2,
-    "no-unreachable": 2,
-    "use-isnan": 2,
-    "valid-typeof": 2,
-
-    // Best Practices
-    // http://eslint.org/docs/rules/#best-practices
-    "no-fallthrough": 2,
-    "no-octal": 2,
-    "no-redeclare": 2,
-    "no-self-assign": 2,
-    "no-unused-labels": 2,
-
-    // Strict Mode
-    // http://eslint.org/docs/rules/#strict-mode
-    "strict": [2, "never"],
-
-    // Variables
-    // http://eslint.org/docs/rules/#variables
-    "no-delete-var": 2,
-    "no-undef": 2,
-    "no-unused-vars": [2, {"args": "none"}],
-
-    // Node.js and CommonJS
-    // http://eslint.org/docs/rules/#nodejs-and-commonjs
-    "no-mixed-requires": 2,
-    "no-new-require": 2,
-    "no-path-concat": 2,
-    "no-restricted-modules": [2, "sys", "_linklist"],
-
-    // Stylistic Issues
-    // http://eslint.org/docs/rules/#stylistic-issues
-    "comma-spacing": 2,
-    "eol-last": 2,
-    "indent": [2, 2, {"SwitchCase": 1}],
-    "keyword-spacing": 2,
-    "max-len": [2, 120, 2],
-    "new-parens": 2,
-    "no-mixed-spaces-and-tabs": 2,
-    "no-multiple-empty-lines": [2, {"max": 2}],
-    "no-trailing-spaces": [2, {"skipBlankLines": false }],
-    "quotes": [2, "single", "avoid-escape"],
-    "semi": 2,
-    "space-before-blocks": [2, "always"],
-    "space-before-function-paren": [2, "never"],
-    "space-in-parens": [2, "never"],
-    "space-infix-ops": 2,
-    "space-unary-ops": 2,
-
-    // ECMAScript 6
-    // http://eslint.org/docs/rules/#ecmascript-6
-    "arrow-parens": [2, "always"],
-    "arrow-spacing": [2, {"before": true, "after": true}],
-    "constructor-super": 2,
-    "no-class-assign": 2,
-    "no-confusing-arrow": 2,
-    "no-const-assign": 2,
-    "no-dupe-class-members": 2,
-    "no-new-symbol": 2,
-    "no-this-before-super": 2,
-    "prefer-const": 2
-  },
-  "globals": {
-    "DTRACE_HTTP_CLIENT_REQUEST"           : false,
-    "LTTNG_HTTP_CLIENT_REQUEST"            : false,
-    "COUNTER_HTTP_CLIENT_REQUEST"          : false,
-    "DTRACE_HTTP_CLIENT_RESPONSE"          : false,
-    "LTTNG_HTTP_CLIENT_RESPONSE"           : false,
-    "COUNTER_HTTP_CLIENT_RESPONSE"         : false,
-    "DTRACE_HTTP_SERVER_REQUEST"           : false,
-    "LTTNG_HTTP_SERVER_REQUEST"            : false,
-    "COUNTER_HTTP_SERVER_REQUEST"          : false,
-    "DTRACE_HTTP_SERVER_RESPONSE"          : false,
-    "LTTNG_HTTP_SERVER_RESPONSE"           : false,
-    "COUNTER_HTTP_SERVER_RESPONSE"         : false,
-    "DTRACE_NET_STREAM_END"                : false,
-    "LTTNG_NET_STREAM_END"                 : false,
-    "COUNTER_NET_SERVER_CONNECTION_CLOSE"  : false,
-    "DTRACE_NET_SERVER_CONNECTION"         : false,
-    "LTTNG_NET_SERVER_CONNECTION"          : false,
-    "COUNTER_NET_SERVER_CONNECTION"        : false  
-  }
-}

app.js

@@ -68,6 +68,9 @@ const {
   decrKey,
   retrieveSet,
   isMemberOfSet,
+  addKey,
+  deleteKey,
+  retrieveKey
 } = require('@jambonz/realtimedb-helpers')({}, logger);
 
 const activeCallIds = new Map();
@@ -101,6 +104,9 @@ srf.locals = {...srf.locals,
   },
   realtimeDbHelpers: {
     client: redisClient,
+    addKey,
+    deleteKey,
+    retrieveKey,
     createHash,
     retrieveHash,
     incrKey,

data/rtp-transcoding.json

@@ -3,6 +3,6 @@
   "DTLS": "off",
   "SDES": "off",
   "ICE": "remove",
-  "flags": ["media handover", "port latching"],
+  "flags": ["port latching"],
   "rtcp-mux": ["demux"]
 }

data/srtp-transcoding.json

@@ -3,13 +3,13 @@
     "transport-protocol": "UDP/TLS/RTP/SAVPF",
     "ICE": "force",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover", "port latching"],
+    "flags": ["generate mid", "SDES-no", "port latching"],
     "rtcp-mux": ["require"]  
   },
   "teams": {
     "transport-protocol": "RTP/SAVP",
     "ICE": "force",
-    "flags": ["generate mid", "media handover",
+    "flags": ["generate mid",
       "SDES-no-AES_CM_128_HMAC_SHA1_32",
       "SDES-no-F8_128_HMAC_SHA1_80",
       "SDES-no-F8_128_HMAC_SHA1_32",

eslint.config.js

@@ -0,0 +1,137 @@
+const promisePlugin = require('eslint-plugin-promise');
+
+module.exports = [
+  {
+    ignores: ['test/*']
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'commonjs',
+      globals: {
+        // Node.js globals
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        module: 'readonly',
+        require: 'readonly',
+        exports: 'readonly',
+        setTimeout: 'readonly',
+        clearTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearInterval: 'readonly',
+        setImmediate: 'readonly',
+        clearImmediate: 'readonly',
+        // DTrace/LTTNG globals
+        DTRACE_HTTP_CLIENT_REQUEST: false,
+        LTTNG_HTTP_CLIENT_REQUEST: false,
+        COUNTER_HTTP_CLIENT_REQUEST: false,
+        DTRACE_HTTP_CLIENT_RESPONSE: false,
+        LTTNG_HTTP_CLIENT_RESPONSE: false,
+        COUNTER_HTTP_CLIENT_RESPONSE: false,
+        DTRACE_HTTP_SERVER_REQUEST: false,
+        LTTNG_HTTP_SERVER_REQUEST: false,
+        COUNTER_HTTP_SERVER_REQUEST: false,
+        DTRACE_HTTP_SERVER_RESPONSE: false,
+        LTTNG_HTTP_SERVER_RESPONSE: false,
+        COUNTER_HTTP_SERVER_RESPONSE: false,
+        DTRACE_NET_STREAM_END: false,
+        LTTNG_NET_STREAM_END: false,
+        COUNTER_NET_SERVER_CONNECTION_CLOSE: false,
+        DTRACE_NET_SERVER_CONNECTION: false,
+        LTTNG_NET_SERVER_CONNECTION: false,
+        COUNTER_NET_SERVER_CONNECTION: false
+      }
+    },
+    plugins: {
+      promise: promisePlugin
+    },
+    rules: {
+      // Promise plugin rules
+      'promise/always-return': 'error',
+      'promise/no-return-wrap': 'error',
+      'promise/param-names': 'error',
+      'promise/catch-or-return': 'error',
+      'promise/no-native': 'off',
+      'promise/no-nesting': 'warn',
+      'promise/no-promise-in-callback': 'warn',
+      'promise/no-callback-in-promise': 'warn',
+      'promise/no-return-in-finally': 'warn',
+
+      // Possible Errors
+      'comma-dangle': [2, 'only-multiline'],
+      'no-control-regex': 2,
+      'no-debugger': 2,
+      'no-dupe-args': 2,
+      'no-dupe-keys': 2,
+      'no-duplicate-case': 2,
+      'no-empty-character-class': 2,
+      'no-ex-assign': 2,
+      'no-extra-boolean-cast': 2,
+      'no-extra-parens': [2, 'functions'],
+      'no-extra-semi': 2,
+      'no-func-assign': 2,
+      'no-invalid-regexp': 2,
+      'no-irregular-whitespace': 2,
+      'no-obj-calls': 2,
+      'no-proto': 2,
+      'no-unexpected-multiline': 2,
+      'no-unreachable': 2,
+      'use-isnan': 2,
+      'valid-typeof': 2,
+
+      // Best Practices
+      'no-fallthrough': 2,
+      'no-octal': 2,
+      'no-redeclare': 2,
+      'no-self-assign': 2,
+      'no-unused-labels': 2,
+
+      // Strict Mode
+      'strict': [2, 'never'],
+
+      // Variables
+      'no-delete-var': 2,
+      'no-undef': 2,
+      'no-unused-vars': [2, {args: 'none'}],
+
+      // Node.js and CommonJS
+      'no-mixed-requires': 2,
+      'no-new-require': 2,
+      'no-path-concat': 2,
+
+      // Stylistic Issues
+      'comma-spacing': 2,
+      'eol-last': 2,
+      'indent': [2, 2, {SwitchCase: 1}],
+      'keyword-spacing': 2,
+      'max-len': [2, 120, 2],
+      'new-parens': 2,
+      'no-mixed-spaces-and-tabs': 2,
+      'no-multiple-empty-lines': [2, {max: 2}],
+      'no-trailing-spaces': [2, {skipBlankLines: false}],
+      'quotes': [2, 'single', 'avoid-escape'],
+      'semi': 2,
+      'space-before-blocks': [2, 'always'],
+      'space-before-function-paren': [2, 'never'],
+      'space-in-parens': [2, 'never'],
+      'space-infix-ops': 2,
+      'space-unary-ops': 2,
+
+      // ECMAScript 6
+      'arrow-parens': [2, 'always'],
+      'arrow-spacing': [2, {before: true, after: true}],
+      'constructor-super': 2,
+      'no-class-assign': 2,
+      'no-confusing-arrow': 2,
+      'no-const-assign': 2,
+      'no-dupe-class-members': 2,
+      'no-new-symbol': 2,
+      'no-this-before-super': 2,
+      'prefer-const': 2
+    }
+  }
+];

lib/call-session.js

@@ -1,7 +1,17 @@
 const Emitter = require('events');
 const sdpTransform = require('sdp-transform');
 const SrsClient = require('@jambonz/siprec-client-utils');
-const {makeRtpEngineOpts, nudgeCallCounts, isPrivateVoipNetwork, isBlackListedSipGateway} = require('./utils');
+const {
+  makeRtpEngineOpts,
+  nudgeCallCounts,
+  isPrivateVoipNetwork,
+  isBlackListedSipGateway,
+  makeFullMediaReleaseKey,
+  makePartnerFullMediaReleaseKey,
+  isValidDomainOrIP,
+  removeVideoSdp
+} = require('./utils');
+const { MediaPath } = require('./constants.json');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {SipError, stringifyUri, parseUri} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-outbound');
@@ -71,6 +81,7 @@ const initCdr = (req, invite) => {
     account_sid: req.get('X-Account-Sid'),
     call_sid: req.get('X-Call-Sid'),
     sip_callid: invite.get('Call-ID'),
+    ...(req.has('X-CID') && {sip_parent_callid: req.get('X-CID')}),
     ...(applicationSid && {application_sid: applicationSid}),
     from,
     to,
@@ -88,8 +99,11 @@ const updateRtpEngineFlags = (sdp, opts) => {
   try {
     const parsed = sdpTransform.parse(sdp);
     const codec = parsed.media[0].rtp[0].codec;
-    if (['PCMU', 'PCMA'].includes(codec)) opts.flags.push(`codec-accept-${codec}`);
-  } catch (err) {}
+    if (['PCMU', 'PCMA'].includes(codec)) {
+      opts.flags.push(`codec-accept-${codec}`);
+      opts.flags.push('codec-accept-telephone-event');
+    }
+  } catch {}
   return opts;
 };
 
@@ -107,6 +121,8 @@ class CallSession extends Emitter {
     this.writeCdrs = this.srf.locals.writeCdrs;
 
     this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
+    this.addKey = req.srf.locals.realtimeDbHelpers.addKey;
+    this.retrieveKey = req.srf.locals.realtimeDbHelpers.retrieveKey;
 
     const {
       lookupOutboundCarrierForAccount,
@@ -119,7 +135,8 @@ class CallSession extends Emitter {
     this.lookupSipGatewaysByCarrier = lookupSipGatewaysByCarrier;
     this.lookupCarrierByAccountLcr = lookupCarrierByAccountLcr;
 
-    this._mediaReleased = false;
+    this._mediaPath = MediaPath.FullMedia;
+
     this.recordingNoAnswerTimeout = (process.env.JAMBONES_RECORDING_NO_ANSWER_TIMEOUT || 2) * 1000;
   }
 
@@ -140,12 +157,7 @@ class CallSession extends Emitter {
   }
 
   get isMediaReleased() {
-    return this._mediaReleased;
-  }
-
-  get calleeIsUsingSrtp() {
-    const tp = this.rtpEngineOpts?.uac?.mediaOpts['transport-protocol'];
-    return tp && -1 !== tp.indexOf('SAVP');
+    return this._mediaPath !== MediaPath.FullMedia;
   }
 
   subscribeForDTMF(dlg) {
@@ -310,7 +322,7 @@ class CallSession extends Emitter {
               const prefix = vc.tech_prefix || '';
               const transport =  o.protocol?.startsWith('tls') ? 'tls' : (o.protocol || 'udp');
               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 prependPlus = vc.e164_leading_plus && /^[1-9]/.test(calledNumber) ? '+' : '';
               const scheme = transport === 'tls' && !process.env.JAMBONES_USE_BEST_EFFORT_TLS && o.use_sips_scheme ?
                 'sips' : 'sip';
               let u = `${scheme}:${prefix}${prependPlus}${calledNumber}@${hostport};transport=${transport}`;
@@ -332,6 +344,14 @@ class CallSession extends Emitter {
                 proxy = u;
                 u = `${scheme}:${prefix}${prependPlus}${calledNumber}@${vc.register_sip_realm};transport=${transport}`;
                 this.logger.debug({uri: u}, `using outbound proxy for this registered trunk: ${proxy}`);
+              } else if (vc.outbound_sip_proxy && vc.outbound_sip_proxy.length > 0) {
+                if (vc.outbound_sip_proxy.includes('sip:') || vc.outbound_sip_proxy.includes('sips:')) {
+                  proxy = vc.outbound_sip_proxy;
+                } else if (isValidDomainOrIP(vc.outbound_sip_proxy)) {
+                  proxy =
+                    `${scheme}:${prefix}${prependPlus}${calledNumber}@${vc.outbound_sip_proxy};transport=${transport}`;
+                  this.logger.debug({uri: u}, `using outbound proxy for this trunk: ${proxy}`);
+                }
               }
               mapGateways.set(u, obj);
               uris.push(u);
@@ -477,16 +497,19 @@ class CallSession extends Emitter {
           };
         }
         else {
+          const uri = parseUri(this.req.uri);
           hdrs = {
             ...hdrs,
             'From': createBLegFromHeader({
               logger: this.logger,
               req: this.req,
+              transport: uri.params.transport,
               ...(private_network && {host: this.privateSipAddress})
             }),
             'Contact': createBLegFromHeader({
               logger: this.logger,
               req: this.req,
+              transport: uri.params.transport,
               ...(private_network && {host: this.privateSipAddress})
             })
           };
@@ -521,6 +544,11 @@ class CallSession extends Emitter {
               '-Allow',
               '-Session-Expires'
             ],
+            // Add X-CID header to feature server response.
+            // to allow calling/status hooks contains sbc_callid.
+            responseHeaders: (uacRes, headers) => {
+              headers['X-CID'] = uacRes.get('Call-ID');
+            },
             headers: hdrs,
             auth: gw ? gw.auth : undefined,
             localSdpB: response.sdp,
@@ -603,8 +631,18 @@ class CallSession extends Emitter {
             const abandoned = err.message && err.message.includes('rtpengine failed: Unknown call-id');
             const status = err.status || (abandoned ? 487 : 500);
             if (err instanceof SipError) this.logger.info(`final call failure  ${status}`);
-            else if (!abandoned) this.logger.error(err, 'unexpected call failure');
-            debug(`got final outdial error: ${err}`);
+            else if (!abandoned) {
+              const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
+              this.logger.error({err}, 'unexpected call failure');
+              nudgeCallCounts(this.req, 'failure', {
+                service_provider_sid: this.service_provider_sid,
+                account_sid: this.account_sid,
+                application_sid: this.application_sid,
+                callId: this.req.locals.callId
+              }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
+                .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
+            }
+            this.logger.debug(`got final outdial error: ${err}`);
             if (!passFailure) this.res.send(status);
             this.emit('failed');
             this.rtpEngineResource.destroy()
@@ -628,7 +666,7 @@ class CallSession extends Emitter {
         }
       }
     } catch (err) {
-      if ('abandonded' !== err.message) this.logger.error(err, `Error setting up outbound call to: ${uris}`);
+      if ('abandonded' !== err.message) this.logger.error({err}, `Error setting up outbound call to: ${uris}`);
       this.emit('failed');
       this.srf.endSession(this.req);
       this.rtpEngineResource.destroy();
@@ -647,6 +685,15 @@ class CallSession extends Emitter {
         answered_at: callStart
       };
     }
+
+    /* save far end SDP for later use if we do a full media release */
+    if (process.env.JAMBONES_ENABLE_FULL_MEDIA_RELEASE) {
+      const key = makeFullMediaReleaseKey(this.req.get('X-CID'));
+      const sdp = uac.remote.sdp;
+      this.logger.info({key, sdp}, 'saving far end sdp for full media release feature');
+      this.addKey(key, sdp, 3600).catch((err) => this.logger.error(err, 'Error saving far end sdp'));
+    }
+
     this.uas = uas;
     this.uac = uac;
     [uas, uac].forEach((dlg) => {
@@ -662,8 +709,7 @@ class CallSession extends Emitter {
             if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
           });
           await other.destroy({headers});
-          await other.destroy();
-        } catch (err) {}
+        } catch {}
 
         const trackingOn = process.env.JAMBONES_TRACK_ACCOUNT_CALLS ||
           process.env.JAMBONES_TRACK_SP_CALLS ||
@@ -671,10 +717,12 @@ class CallSession extends Emitter {
 
         if (process.env.JAMBONES_HOSTING || trackingOn) {
           const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
-          await nudgeCallCounts(this.logger, {
+          this.logger.debug('decrementing call count at end of call');
+          await nudgeCallCounts(this.req, 'complete', {
             service_provider_sid: this.service_provider_sid,
             account_sid: this.account_sid,
-            application_sid: this.application_sid
+            application_sid: this.application_sid,
+            callId: this.req.locals.callId
           }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
             .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
         }
@@ -753,12 +801,19 @@ class CallSession extends Emitter {
   async _onRefer(dlg, req, res) {
     /* REFER coming in from a sip device, forward to feature server */
     try {
+      const customHeaders = Object.keys(req.headers)
+        .filter((h) => h.toLowerCase().startsWith('x-'))
+        .reduce((acc, h) => {
+          acc[h] = req.get(h);
+          return acc;
+        }, {});
       const response = await dlg.other.request({
         method: 'REFER',
         headers: {
           'Refer-To': req.get('Refer-To'),
           'Referred-By': req.get('Referred-By'),
-          'User-Agent': req.get('User-Agent')
+          'User-Agent': req.get('User-Agent'),
+          ...customHeaders
         }
       });
       res.send(response.status, response.reason);
@@ -799,16 +854,44 @@ Duration=${payload.duration} `
     try {
       const reason = req.get('X-Reason');
       const isReleasingMedia = reason && dlg.type === 'uas' && ['release-media', 'anchor-media'].includes(reason);
+      const isFullMediaRelease = reason === 'release-media-entirely' && process.env.JAMBONES_ENABLE_FULL_MEDIA_RELEASE;
       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;
+      let offerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uac.mediaOpts : this.rtpEngineOpts.uas.mediaOpts;
+      let answerMedia = dlg.type === 'uas' ? this.rtpEngineOpts.uas.mediaOpts : this.rtpEngineOpts.uac.mediaOpts;
       const direction =  dlg.type === 'uas' ? ['private', 'public'] : ['public', 'private'];
+
+      if (isFullMediaRelease) {
+        const a_sdp = await this.retrieveKey(makePartnerFullMediaReleaseKey(this.req.get('X-CID')));
+        this.logger.info({a_sdp}, 'reinvite ourselves out of the media path with this reinvite offer');
+        const answerSdp = await dlg.other.modify(a_sdp);
+        this.logger.info({answerSdp}, 'far end response to full media release');
+        res.send(200, {
+          body: dlg.local.sdp,
+          headers: {
+            'Contact': this.contactHeader
+          }
+        });
+        /* no media going through us now we can destroy the rtpengine resource */
+        this.rtpEngineResource.destroy().catch((err) => {
+          this.logger.info({err}, 'Error destroying rtpengine resource after full media release');
+        });
+        this._mediaPath = MediaPath.NoMedia;
+        return;
+      }
+
       if (isReleasingMedia) {
         if (!offerMedia.flags.includes('port latching')) offerMedia.flags.push('port latching');
         if (!offerMedia.flags.includes('asymmetric')) offerMedia.flags.push('asymmetric');
         offerMedia.flags = offerMedia.flags.filter((f) => f !== 'media handover');
       }
+      const acceptCodecs = process.env.JAMBONES_ACCEPT_AND_TRANSCODE ?
+        process.env.JAMBONES_ACCEPT_AND_TRANSCODE :
+        process.env.JAMBONES_ACCEPT_G729 ? 'g729' : '';
+      offerMedia = { ...offerMedia, ...(acceptCodecs && dlg.type === 'uac' &&
+        { codec: { mask: acceptCodecs, transcode: 'pcmu,pcma' } })};
+      answerMedia = { ...answerMedia, ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER && dlg.type === 'uac' &&
+        { codec: {offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' }})};
       let opts = {
         ...this.rtpEngineOpts.common,
         ...offerMedia,
@@ -829,17 +912,20 @@ Duration=${payload.duration} `
 
       /* if this is a re-invite from the FS to change media anchoring, avoid sending the reinvite out */
       let sdp;
-      if (isReleasingMedia && !this.calleeIsUsingSrtp) {
+      //HL 2024-11-13: previously forwarded re-invites to webrtc clients but further testing has shown to be unnecessary
+      //if (isReleasingMedia && !this.calleeIsUsingSrtp) {
+
+      //DH 2024-11- 18: if we are going from no-media to either partial or full media, we need reinvite the far end
+      if (isReleasingMedia && this._mediaPath !== MediaPath.NoMedia) {
         this.logger.info(`got a reinvite from FS to ${reason}`);
         sdp = dlg.other.remote.sdp;
         if (!answerMedia.flags.includes('port latching')) answerMedia.flags.push('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;
+        this._mediaPath = 'release-media' === reason ? MediaPath.PartialMedia : MediaPath.FullMedia;
       }
       else {
         sdp = await dlg.other.modify(response.sdp);
-        this.logger.info({sdp}, 'CallSession:_onReinvite: got sdp from 200 OK to invite we sent');
       }
       opts = {
         ...this.rtpEngineOpts.common,
@@ -856,8 +942,12 @@ Duration=${payload.duration} `
         throw new Error(`_onReinvite: rtpengine failed: ${JSON.stringify(response)}`);
       }
       this.logger.debug({opts, sdp: response.sdp}, 'CallSession:_onReinvite: (answer) sending back upstream');
+      let responseSdp = response.sdp;
+      if (process.env.JAMBONES_VIDEO_CALLS_ENABLED_IN_FS) {
+        responseSdp = removeVideoSdp(responseSdp);
+      }
       res.send(200, {
-        body: response.sdp,
+        body: responseSdp,
         headers: {
           'Contact': this.contactHeader
         }
@@ -936,7 +1026,8 @@ Duration=${payload.duration} `
               blockMedia: this.blockMedia,
               unblockMedia: this.unblockMedia,
               unsubscribe: this.unsubscribe,
-              headers
+              headers,
+              isSipRecCall: Array.isArray(this.req.payload) && this.req.payload.length > 1
             }));
             try {
               this._startRecordingNoAnswerTimer(res);
@@ -1018,11 +1109,13 @@ Duration=${payload.duration} `
           const code = arr[1];
           const arr2 = /Duration=\s*(\d+)/.exec(req.body);
           const duration = arr2 ? arr2[1] : 250;
+          const volume = 13;
           const dtmfOpts = {
             ...this.rtpEngineOpts.common,
             'from-tag': this.rtpEngineOpts.uas.tag,
             code,
-            duration
+            duration,
+            volume
           };
           const response = await this.playDTMF(dtmfOpts);
           if ('ok' !== response.result) {
@@ -1088,9 +1181,9 @@ Duration=${payload.duration} `
       // 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,
+        'content-length': _contentlength, 'refer-to': _referto, 'referred-by': referredby,
         // eslint-disable-next-line no-unused-vars
-        'X-Refer-To-Leave-Untouched': _leave,
+        'X-Refer-To-Leave-Untouched': _leave, contact: _contact,
         ...customHeaders
       } = req.headers;
 
@@ -1100,9 +1193,7 @@ Duration=${payload.duration} `
       const arr = /context-(.*)/.exec(uri.user);
       if (!arr) {
         /* call transfer requested */
-        const referredBy = req.getParsedHeader('Referred-By');
-        if (!referredBy) return res.send(400);
-        const u = parseUri(referredBy.uri);
+        if (!req.has('Referred-By')) return res.send(400);
 
         /* delete contact if it was there from feature server */
         delete customHeaders['contact'];
@@ -1111,7 +1202,8 @@ Duration=${payload.duration} `
           method: 'REFER',
           headers: {
             'Refer-To': `<${stringifyUri(uri)}>`,
-            'Referred-By': `<${stringifyUri(u)}>`,
+            'Referred-By': referredby,
+            'Contact': this.contactHeader,
             ...customHeaders
           }
         });
@@ -1139,6 +1231,22 @@ Duration=${payload.duration} `
         this.activeCallIds.delete(this.req.get('Call-ID'));
         if (this.activeCallIds.size === 0) this.idleEmitter.emit('idle');
         uac.other.destroy();
+        if (this.req.locals.cdr) {
+          const now = Date.now();
+          const day = new Date();
+          const recordAllCalls = this.req.locals.record_all_calls;
+          let recording_url = `/Accounts/${this.account_sid}/RecentCalls/${this.req.locals.cdr.call_sid}/record`;
+          recording_url += `/${day.getFullYear()}/${(day.getMonth() + 1).toString().padStart(2, '0')}`;
+          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${recordAllCalls}`;
+          this.writeCdrs({...this.req.locals.cdr,
+            terminated_at: now,
+            termination_reason: 'caller hungup',
+            sip_status: 200,
+            answered: true,
+            duration: Math.floor((now - this.req.locals.cdr.answered_at) / 1000),
+            ...(recordAllCalls && {recording_url})
+          }).catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
+        }
         this.srf.endSession(this.req);
       });
 

lib/constants.json

@@ -0,0 +1,7 @@
+{
+  "MediaPath": {
+  "NoMedia": "no-media",
+  "PartialMedia": "partial-media",
+  "FullMedia": "full-media"
+  }
+}

lib/middleware.js

@@ -1,7 +1,7 @@
 const debug = require('debug')('jambonz:sbc-outbound');
 const parseUri = require('drachtio-srf').parseUri;
 const Registrar = require('@jambonz/mw-registrar');
-const {selectHostPort, nudgeCallCounts} = require('./utils');
+const { nudgeCallCounts} = require('./utils');
 const FS_UUID_SET_NAME =  'fsUUIDs';
 
 module.exports = (srf, logger, redisClient) => {
@@ -17,6 +17,8 @@ module.exports = (srf, logger, redisClient) => {
   const initLocals = async(req, res, next) => {
     req.locals = req.locals || {};
     const callId = req.get('Call-ID');
+    req.locals.nudge = 0;
+    req.locals.callId = callId;
     req.locals.account_sid = req.get('X-Account-Sid');
     req.locals.application_sid = req.get('X-Application-Sid');
     req.locals.record_all_calls = req.get('X-Record-All-Calls');
@@ -60,7 +62,7 @@ module.exports = (srf, logger, redisClient) => {
           });
           return req.srf.endSession(req);
         }
-      } catch (err) {
+      } catch {
         res.send(500);
         return req.srf.endSession(req);
       }
@@ -107,10 +109,11 @@ module.exports = (srf, logger, redisClient) => {
       /* decrement count if INVITE is later rejected */
       res.once('end', async({status}) => {
         if (status > 200) {
-          nudgeCallCounts(logger, {
+          nudgeCallCounts(req, 'failure', {
             service_provider_sid,
             account_sid,
-            application_sid
+            application_sid,
+            callId: req.locals.callId
           }, decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
             .catch((err) => logger.error(err, 'Error decrementing call counts'));
           const tags = ['accepted:no', `sipStatus:${status}`];
@@ -123,10 +126,11 @@ module.exports = (srf, logger, redisClient) => {
       });
 
       /* increment the call count */
-      const  {callsSP, calls} = await nudgeCallCounts(logger, {
+      const  {callsSP, calls} = await nudgeCallCounts(req, 'init', {
         service_provider_sid,
         account_sid,
-        application_sid
+        application_sid,
+        callId: req.locals.callId
       }, incrKey, {writeCallCountSP, writeCallCount, writeCallCountApp});
 
       /* compare to account's limit, though avoid db hit when call count is low */
@@ -170,6 +174,11 @@ module.exports = (srf, logger, redisClient) => {
           });
           return req.srf.endSession(req);
         }
+        if (!account_limit && !sp_limit && process.env.JAMBONES_HOSTING) {
+          logger.info(`checkLimits: no active subscription found for account ${account_sid}, rejecting call`);
+          res.send(503, 'No Active Subscription');
+          return req.srf.endSession(req);
+        }
         if (process.env.JAMBONES_TRACK_SP_CALLS && sp_limit > 0 && callsSP > sp_limit) {
           logger.info({callsSP, sp_limit}, 'checkLimits: service provider limits exceeded');
           writeAlerts({
@@ -225,10 +234,10 @@ module.exports = (srf, logger, redisClient) => {
         logger.info({details: reg}, `sending call to registered user ${aor}`);
         if (req.server.hostport !== reg.sbcAddress) {
           /* redirect to the correct SBC where this user is connected */
-          const proxyAddress = selectHostPort(reg.sbcAddress, 'tcp');
-          const redirectUri =  `<sip:${proxyAddress[1]}>`;
+          const proxyAddress = reg.privateSbcAddress.split(':');
+          const redirectUri =  `<sip:${proxyAddress[0]}>`;
           logger.info({
-            myHostPort: reg.server.hostport,
+            myHostPort: req.server.hostport,
             registeredHostPort: reg.sbcAddress,
           }, `redirecting call to SBC at ${redirectUri}`);
           return res.send(302, {headers: {Contact: redirectUri}});
@@ -251,9 +260,22 @@ module.exports = (srf, logger, redisClient) => {
     else if ('sip' === desiredRouting) {
       // call that needs to be forwarded to a sip endpoint
       logger.info(`forwarding call to sip endpoint ${req.uri}`);
+
+      // check if the domain is one of ours
+      if (process.env.JAMBONES_LOCAL_SIP_DOMAINS) {
+        const allowedDomains = process.env.JAMBONES_LOCAL_SIP_DOMAINS.split(',');
+        const domain = uri.host;
+        const isLoop = allowedDomains.some((allowed) =>
+          domain === allowed.trim() || domain.endsWith(`.${allowed.trim()}`)
+        );
+        if (isLoop) {
+          logger.info({ host: domain }, `returning 482 Loop Detected for attempt to send to: ${req.uri}`);
+          res.send(482, 'Loop Detected');
+          return req.srf.endSession(req);
+        }
+      }
       req.locals.target = 'forward';
-    }
-    else if ('phone' === desiredRouting) {
+    }    else if ('phone' === desiredRouting) {
       debug('sending call to LCR');
       req.locals.target = 'lcr';
     }

lib/utils.js

@@ -3,6 +3,7 @@ const srtpCharacteristics = require('../data/srtp-transcoding');
 const debug = require('debug')('jambonz:sbc-outbound');
 const CIDRMatcher = require('cidr-matcher');
 const dns = require('dns');
+const sdpTransform = require('sdp-transform');
 
 function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams) {
   const from = req.getParsedHeader('from');
@@ -27,6 +28,14 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
       srcOpts.flags.push('inject DTMF');
     }
   }
+
+  /** By default, and for backwards compatibility, use media handover
+   * set env var to true to use strict source instead (needed for rtpbleed vulnerability)
+   */
+  const enableStrictSource = !!process.env.RTPENGINE_ENABLE_STRICT_SOURCE;
+  dstOpts.flags.push(enableStrictSource ? 'strict source' : 'media handover');
+  srcOpts.flags.push(enableStrictSource ?  'strict source' : 'media handover');
+
   const common = {
     'call-id': req.get('Call-ID'),
     'replace': ['origin', 'session-connection'],
@@ -40,7 +49,11 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
     },
     uac: {
       tag: null,
-      mediaOpts: dstOpts
+      mediaOpts: {
+        ...dstOpts,
+        ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER &&
+          { codec: { offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' } }),
+      }
     }
   };
 }
@@ -127,13 +140,96 @@ const createHealthCheckApp = (port, logger) => {
   });
 };
 
-const nudgeCallCounts = async(logger, sids, nudgeOperator, writers) => {
-  const {service_provider_sid, account_sid, application_sid} = sids;
+/**
+ * nudgeCallCounts - increment or decrement call counts in redis
+ *
+ *              current nudge value
+ * -----------------------------------------
+ *  why    |     -1     |    0    |    1    |
+ * -----------------------------------------
+ *  init   |    no-op   |    +1   |    N/A  |
+ * failure |    N/A     |    -1   |    -1   |
+ * complete|    N/A     |    N/A  |    -1   |
+ *
+ *
+ */
+
+const shouldNudge = (why, req) => {
+  const {nudge, logger} = req.locals;
+  let modifyCount = false;
+  const originalNudge = nudge;
+
+  switch (why) {
+    case 'init':
+      if (nudge === 0) {
+        // normal case: new call, increment call count
+        req.locals.nudge = 1;
+        modifyCount = true;
+      }
+      else if (nudge === -1) {
+        // extremely quick cancel, don't increment call count
+        req.locals.nudge = 0;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    case 'failure':
+      if (nudge === 1) {
+        // normal case of call failed for any reason, decrement call count
+        req.locals.nudge = 0;
+        modifyCount = true;
+      }
+      else if (nudge === 0) {
+        // very quick failure dont decrement call count
+        req.locals.nudge = -1;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    case 'complete':
+      if (nudge === 1) {
+        // normal case of call completed, decrement call count
+        req.locals.nudge = 0;
+        modifyCount = true;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    default:
+      logger.info(`shouldNudge: unexpected why value ${why}`);
+      break;
+  }
+
+  logger.info(`shouldNudge: '${why}': updating count: ${modifyCount}, nudge: ${originalNudge} -> ${req.locals.nudge}`);
+  return modifyCount;
+};
+
+const nudgeCallCounts = async(req, why, sids, nudgeOperator, writers) => {
+  const {logger} = req.locals;
+  const {service_provider_sid, account_sid, application_sid, callId} = sids;
   const {writeCallCount, writeCallCountSP, writeCallCountApp} = writers;
   const nudges = [];
   const writes = [];
 
-  logger.debug(sids, 'nudgeCallCounts');
+  if (!shouldNudge(why, req)) {
+    return {callsSP: null, calls: null, callsApp: null};
+  }
+
+  if (process.env.JAMBONES_DEBUG_CALL_COUNTS) {
+    const {srf} = require('..');
+    const {addKey, deleteKey} = srf.locals.realtimeDbHelpers;
+
+    if (why === 'init') {
+      // save for 3 days
+      await addKey(`debug:outcalls:${account_sid}:${callId}`, new Date().toISOString(), 259200);
+    }
+    else {
+      await deleteKey(`debug:outcalls:${account_sid}:${callId}`);
+    }
+  }
 
   if (process.env.JAMBONES_TRACK_SP_CALLS) {
     const key = makeSPCallCountKey(service_provider_sid);
@@ -194,7 +290,7 @@ const isPrivateVoipNetwork = async(uri) => {
   if (privateNetworkCidr) {
     try {
       const matcher = new CIDRMatcher(privateNetworkCidr.split(','));
-      const arr = /sips?:.*@(.*?)(:\d+)?(;.*)$/.exec(uri);
+      const arr = /sips?:.*@(.*?)(:\d+)?(;.*)?$/.exec(uri);
       if (arr) {
         const input = arr[1];
         let addresses;
@@ -229,6 +325,30 @@ async function isBlackListedSipGateway(client, logger, sip_gateway_sid) {
   }
 }
 
+const makeFullMediaReleaseKey = (callId) => {
+  return `b_sdp:${callId}`;
+};
+const makePartnerFullMediaReleaseKey = (callId) => {
+  return `a_sdp:${callId}`;
+};
+
+function isValidDomainOrIP(input) {
+  const domainRegex = /^(?!:\/\/)([a-zA-Z0-9.-]+)(:\d+)?$/;
+  // eslint-disable-next-line max-len
+  const ipRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(:\d+)?$/;
+
+  if (domainRegex.test(input) || ipRegex.test(input)) {
+    return true;
+  }
+
+  return false; // Invalid input
+}
+const removeVideoSdp = (sdp) => {
+  const parsedSdp = sdpTransform.parse(sdp);
+  // Filter out video media sections, keeping only non-video media
+  parsedSdp.media = parsedSdp.media.filter((media) => media.type !== 'video');
+  return sdpTransform.write(parsedSdp);
+};
 module.exports = {
   makeRtpEngineOpts,
   selectHostPort,
@@ -240,5 +360,9 @@ module.exports = {
   createHealthCheckApp,
   nudgeCallCounts,
   isPrivateVoipNetwork,
-  isBlackListedSipGateway
+  isBlackListedSipGateway,
+  makeFullMediaReleaseKey,
+  makePartnerFullMediaReleaseKey,
+  isValidDomainOrIP,
+  removeVideoSdp
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-outbound",
-  "version": "0.9.2",
+  "version": "0.9.5",
   "main": "app.js",
   "engines": {
     "node": ">= 18.0.0"
@@ -24,29 +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 --fix"    
+    "jslint": "eslint app.js lib --fix"
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.9.7",
-    "@jambonz/realtimedb-helpers": "^0.8.9",
+    "@babel/helpers": "^7.26.10",
+    "@jambonz/db-helpers": "^0.9.18",
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "0.2.7",
+    "@jambonz/realtimedb-helpers": "^0.8.13",
     "@jambonz/rtpengine-utils": "^0.4.4",
-    "@jambonz/siprec-client-utils": "^0.2.7",
+    "@jambonz/siprec-client-utils": "^0.2.10",
     "@jambonz/stats-collector": "^0.1.10",
-    "@jambonz/time-series": "^0.2.8",
+    "@jambonz/time-series": "^0.2.10",
     "cidr-matcher": "^2.1.1",
     "debug": "^4.3.4",
-    "drachtio-fn-b2b-sugar": "^0.1.0",
-    "drachtio-srf": "^4.5.39",
+    "drachtio-fn-b2b-sugar": "^0.2.1",
+    "drachtio-srf": "^5.0.12",
     "express": "^4.19.2",
-    "pino": "^8.20.0",
-    "sdp-transform": "^2.14.2"
+    "pino": "^10.1.0",
+    "sdp-transform": "^2.15.0"
   },
   "devDependencies": {
     "bent": "^7.3.12",
-    "eslint": "^7.32.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint": "^9.17.0",
+    "eslint-plugin-promise": "^7.2.1",
     "nyc": "^15.1.0",
     "tape": "^5.7.5"
   }

test/docker-compose-testbed.yaml

@@ -24,7 +24,7 @@ services:
         ipv4_address: 172.39.0.2
 
   sbc:
-    image: drachtio/drachtio-server:latest
+    image: drachtio/drachtio-server:0.8.26
     command: drachtio --contact "sip:*;transport=udp" --loglevel debug --sofia-loglevel 9
     ports:
       - "9060:9022/tcp"