Feature/recent calls enhancement with sp (#47)

* write cdrs and alerts with service_provider_sid

* update to latest @jambonz/http-authenticator which sends sip headers

* add call_sid to cdr when call is connected

* write call counts by SP as well as account, bugfix to allow digit '0' in dtmf-relay

Dockerfile

@@ -1,10 +1,23 @@
-FROM node:slim
+FROM --platform=linux/amd64 node:18.8.0-alpine as base
+
+RUN apk --update --no-cache add --virtual .builds-deps build-base python3
+
 WORKDIR /opt/app/
+
+FROM base as build
+
 COPY package.json package-lock.json ./
+
 RUN npm ci
-RUN npm prune
-COPY . /opt/app
+
+COPY . .
+
+FROM base
+
+COPY --from=build /opt/app /opt/app/
+
 ARG NODE_ENV
+
 ENV NODE_ENV $NODE_ENV
 
-CMD [ "npm", "start" ]
+CMD [ "node", "app.js" ]

app.js

@@ -15,6 +15,7 @@ const opts = Object.assign({
 const logger = require('pino')(opts);
 const {
   writeCallCount,
+  writeCallCountSP,
   queryCdrs,
   writeCdrs,
   writeAlerts,
@@ -71,6 +72,7 @@ const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], lo
 srf.locals = {...srf.locals,
   stats,
   writeCallCount,
+  writeCallCountSP,
   queryCdrs,
   writeCdrs,
   writeAlerts,
@@ -96,12 +98,14 @@ srf.locals = {...srf.locals,
   }
 };
 const {
+  getSPForAccount,
   wasOriginatedFromCarrier,
   getApplicationForDidAndCarrier,
   getOutboundGatewayForRefer
 } = require('./lib/db-utils')(srf, logger);
 srf.locals = {
   ...srf.locals,
+  getSPForAccount,
   wasOriginatedFromCarrier,
   getApplicationForDidAndCarrier,
   getOutboundGatewayForRefer,
@@ -111,6 +115,7 @@ const activeCallIds = srf.locals.activeCallIds;
 
 const {
   initLocals,
+  handleSipRec,
   identifyAccount,
   checkLimits,
   challengeDeviceCalls
@@ -161,7 +166,13 @@ if (process.env.NODE_ENV === 'test') {
 }
 
 /* install middleware */
-srf.use('invite', [initLocals, identifyAccount, checkLimits, challengeDeviceCalls]);
+srf.use('invite', [
+  initLocals,
+  handleSipRec,
+  identifyAccount,
+  checkLimits,
+  challengeDeviceCalls
+]);
 
 srf.invite((req, res) => {
   if (req.has('Replaces')) {

lib/call-session.js

@@ -1,5 +1,6 @@
 const Emitter = require('events');
-const {makeRtpEngineOpts, SdpWantsSrtp, makeCallCountKey} = require('./utils');
+const SrsClient = require('@jambonz/siprec-client-utils');
+const {makeRtpEngineOpts, SdpWantsSrtp, makeAccountCallCountKey, makeSPCallCountKey} = require('./utils');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {parseUri, stringifyUri, SipError} = require('drachtio-srf');
 const debug = require('debug')('jambonz:sbc-inbound');
@@ -17,6 +18,20 @@ const createBLegFromHeader = (req) => {
   return '<sip:anonymous@localhost>';
 };
 
+const createSiprecBody = (headers, sdp, type, content) => {
+  const sep = 'uniqueBoundary';
+  headers['Content-Type'] = `multipart/mixed;boundary="${sep}"`;
+  return `--${sep}\r
+Content-Type: application/sdp\r
+\r
+${sdp}\r
+--${sep}\r
+Content-Type: ${type}\r
+Content-Disposition: recording-session\r
+\r
+${content}`;
+};
+
 class CallSession extends Emitter {
   constructor(logger, req, res) {
     super();
@@ -24,6 +39,8 @@ class CallSession extends Emitter {
     this.res = res;
     this.srf = req.srf;
     this.logger = logger.child({callId: req.get('Call-ID')});
+    this.siprec = req.locals.siprec;
+    this.xml = req.locals.xml;
 
     this.getRtpEngine = req.srf.locals.getRtpEngine;
     this.getFeatureServer = req.srf.locals.getFeatureServer;
@@ -32,7 +49,9 @@ class CallSession extends Emitter {
     this.activeCallIds = this.srf.locals.activeCallIds;
 
     this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
-    this.callCountKey = makeCallCountKey(req.locals.account_sid);
+    this.callCountKey = makeAccountCallCountKey(req.locals.account_sid);
+    this.callCountKeySP = makeSPCallCountKey(req.locals.service_provider_sid);
+    this._mediaReleased = false;
   }
 
   get isFromMSTeams() {
@@ -43,7 +62,17 @@ class CallSession extends Emitter {
     return this.srf.locals.privateSipAddress;
   }
 
+  get isMediaReleased() {
+    return this._mediaReleased;
+  }
+
+  get callerIsUsingSrtp() {
+    const tp = this.rtpEngineOpts?.uas?.mediaOpts['transport-protocol'];
+    return tp && -1 !== tp.indexOf('SAVP');
+  }
+
   async connect() {
+    const {sdp} = this.req.locals;
     this.logger.info('inbound call accepted for routing');
     const engine = this.getRtpEngine();
     if (!engine) {
@@ -61,8 +90,12 @@ class CallSession extends Emitter {
       unblockMedia,
       blockDTMF,
       unblockDTMF,
+      playDTMF,
       subscribeDTMF,
-      unsubscribeDTMF
+      unsubscribeDTMF,
+      subscribeRequest,
+      subscribeAnswer,
+      unsubscribe
     } = engine;
     this.offer = offer;
     this.answer = answer;
@@ -71,8 +104,12 @@ class CallSession extends Emitter {
     this.unblockMedia = unblockMedia;
     this.blockDTMF = blockDTMF;
     this.unblockDTMF = unblockDTMF;
+    this.playDTMF = playDTMF;
     this.subscribeDTMF = subscribeDTMF;
     this.unsubscribeDTMF = unsubscribeDTMF;
+    this.subscribeRequest = subscribeRequest;
+    this.subscribeAnswer = subscribeAnswer;
+    this.unsubscribe = unsubscribe;
 
     const featureServer = await this.getFeatureServer();
     if (!featureServer) {
@@ -83,7 +120,7 @@ class CallSession extends Emitter {
     }
     this.logger.debug(`using feature server ${featureServer}`);
 
-    this.rtpEngineOpts = makeRtpEngineOpts(this.req, SdpWantsSrtp(this.req.body), false, this.isFromMSTeams);
+    this.rtpEngineOpts = makeRtpEngineOpts(this.req, SdpWantsSrtp(sdp), false, this.isFromMSTeams);
     this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
     const obj = parseUri(this.req.uri);
     let proxy, host, uri;
@@ -108,7 +145,7 @@ class CallSession extends Emitter {
         ...this.rtpEngineOpts.uac.mediaOpts,
         'from-tag': this.rtpEngineOpts.uas.tag,
         direction:  ['public', 'private'],
-        sdp: this.req.body
+        sdp
       };
       const response = await this.offer(opts);
       this.logger.debug({opts, response}, 'response from rtpengine to offer');
@@ -117,7 +154,6 @@ class CallSession extends Emitter {
         throw new Error('rtpengine failed: answer');
       }
 
-      // now send the INVITE in towards the feature servers
       let headers = {
         'From': createBLegFromHeader(this.req),
         'To': this.req.get('To'),
@@ -127,6 +163,10 @@ class CallSession extends Emitter {
       };
       if (this.privateSipAddress) headers = {...headers, Contact: `<sip:${this.privateSipAddress}>`};
 
+      const spdOfferB = this.siprec && this.xml ?
+        createSiprecBody(headers, response.sdp, this.xml.type, this.xml.content) :
+        response.sdp;
+
       const responseHeaders = {};
       if (this.req.locals.carrier) {
         Object.assign(headers, {
@@ -158,6 +198,7 @@ class CallSession extends Emitter {
 
       if (this.req.canceled) throw new Error('call canceled');
 
+      // now send the INVITE in towards the feature servers
       debug(`sending INVITE to ${proxy} with ${uri}`);
       const {uas, uac} = await this.srf.createB2BUA(this.req, this.res, uri, {
         proxy,
@@ -172,7 +213,7 @@ class CallSession extends Emitter {
           '-X-Subspace-Forwarded-For'
         ],
         proxyResponseHeaders: ['all', '-X-Trace-ID'],
-        localSdpB: response.sdp,
+        localSdpB: spdOfferB,
         localSdpA: async(sdp, res) => {
           this.rtpEngineOpts.uac.tag = res.getParsedHeader('To').params.tag;
           const opts = {
@@ -224,6 +265,12 @@ class CallSession extends Emitter {
       this.rtpEngineResource.destroy().catch((err) => {});
       this.activeCallIds.delete(callId);
       if (dlg.other && dlg.other.connected) dlg.other.destroy().catch((e) => {});
+
+      if (this.srsClient) {
+        this.srsClient.stop();
+        this.srsClient = null;
+      }
+
       this.srf.endSession(this.req);
     });
 
@@ -237,11 +284,13 @@ class CallSession extends Emitter {
     const tags = ['accepted:yes', 'sipStatus:200', `originator:${this.req.locals.originator}`];
     this.stats.increment('sbc.terminations', tags);
     this.activeCallIds.set(this.req.get('Call-ID'), this);
+    const call_sid = uac.res?.get('X-Call-Sid');
     if (this.req.locals.cdr) {
       this.req.locals.cdr = {
         ...this.req.locals.cdr,
         answered: true,
         answered_at: callStart,
+        ...(call_sid && {call_sid}),
         trace_id: uac.res?.get('X-Trace-ID') || '00000000000000000000000000000000'
       };
     }
@@ -257,15 +306,25 @@ class CallSession extends Emitter {
         } catch (err) {}
         this.unsubscribeDTMF(this.logger, this.req.get('Call-ID'), this.rtpEngineOpts.uas.tag);
         if (process.env.JAMBONES_HOSTING || process.env.JAMBONES_TRACK_ACCOUNT_CALLS) {
-          const {account_sid} = this.req.locals;
-          this.decrKey(this.callCountKey)
-            .then((count) => {
-              this.logger.info(
-                {key: this.callCountKey},
-                `after hangup there are ${count} active calls for this account`);
-              return this.req.srf.locals.writeCallCount({account_sid, calls_in_progress: count});
+          const {account_sid, service_provider_sid} = this.req.locals;
+          const {writeCallCount, writeCallCountSP} = this.req.srf.locals;
+
+          this.logger.info('going to decrement call count');
+
+          Promise.all([
+            this.decrKey(this.callCountKey),
+            this.decrKey(this.callCountKeySP)
+          ])
+            .then(([calls, callsSP]) => {
+              this.logger.info({calls, callsSP}, 'decremented call counts after call completion');
+              return Promise.all([
+                writeCallCount(account_sid, calls),
+                writeCallCountSP(service_provider_sid, callsSP)
+              ]);
             })
-            .catch((err) => this.logger.error({err}, 'Error decrementing call count'));
+            .catch((err) => {
+              this.logger.error({err}, 'error decrementing call counts after call completion');
+            });
         }
 
         /* write cdr for connected call */
@@ -274,13 +333,23 @@ class CallSession extends Emitter {
           const trunk = ['trunk', 'teams'].includes(this.req.locals.originator) ?
             this.req.locals.carrier :
             this.req.locals.originator;
+          const cdr = {...this.req.locals.cdr,
+            terminated_at: now,
+            termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
+            sip_status: 200,
+            duration: Math.floor((now - callStart) / 1000),
+            trunk
+          };
+          this.logger.info({cdr}, 'going to write a cdr now..');
           this.writeCdrs({...this.req.locals.cdr,
             terminated_at: now,
             termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
             sip_status: 200,
             duration: Math.floor((now - callStart) / 1000),
             trunk
-          }).catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
+          })
+            .then(() => this.logger.debug('successfully wrote cdr'))
+            .catch((err) => this.logger.error({err}, 'Error writing cdr for completed call'));
         }
         /* de-link the 2 Dialogs for GC */
         dlg.removeAllListeners();
@@ -288,6 +357,11 @@ class CallSession extends Emitter {
         dlg.other = null;
         other.other = null;
 
+        if (this.srsClient) {
+          this.srsClient.stop();
+          this.srsClient = null;
+        }
+
         this.logger.info(`call ended with normal termination, there are ${this.activeCallIds.size} active`);
         this.srf.endSession(this.req);
       });
@@ -344,7 +418,19 @@ Duration=${payload.duration} `
    */
   async replaces(req, res) {
     try {
-      let opts = Object.assign({}, this.rtpEngineOpts.uas.mediaOpts, {sdp: req.body});
+      const fromTag = this.rtpEngineOpts.uas.tag;
+      const toTag =  this.rtpEngineOpts.uac.tag;
+      const offerMedia = this.rtpEngineOpts.uac.mediaOpts;
+      const answerMedia = this.rtpEngineOpts.uas.mediaOpts;
+      const direction = ['public', 'private'];
+      let opts = {
+        ...this.rtpEngineOpts.common,
+        ...offerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        direction,
+        sdp: req.body,
+      };
       let response = await this.offer(opts);
       if ('ok' !== response.result) {
         res.send(488);
@@ -352,8 +438,13 @@ Duration=${payload.duration} `
       }
       this.logger.info({opts, response}, 'sent offer for reinvite to rtpengine');
       const sdp = await this.uac.modify(response.sdp);
-      opts = Object.assign({}, this.rtpEngineOpts.uac.mediaOpts, {sdp, 'to-tag': this.toTag});
-      Object.assign(this.rtpEngineOpts.uas.mediaOpts, {'to-tag': this.toTag});
+      opts = {
+        ...this.rtpEngineOpts.common,
+        ...answerMedia,
+        'from-tag': fromTag,
+        'to-tag': toTag,
+        sdp
+      };
       response = await this.answer(opts);
       if ('ok' !== response.result) {
         res.send(488);
@@ -399,6 +490,10 @@ Duration=${payload.duration} `
         res.send(200, {body: dlg.local.sdp});
         return;
       }
+      const offeredSdp = Array.isArray(req.payload) && req.payload.length > 1 ?
+        req.payload.find((p) => p.type === 'application/sdp').content :
+        req.body;
+
       const reason = req.get('X-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;
@@ -411,9 +506,9 @@ Duration=${payload.duration} `
         'from-tag': fromTag,
         'to-tag': toTag,
         direction,
-        sdp: req.body,
+        sdp: offeredSdp,
       };
-      //if (reason && opts.flags && !opts.flags.includes('reset')) opts.flags.push('reset');
+      if (reason && opts.flags && !opts.flags.includes('reset')) opts.flags.push('reset');
 
       let response = await this.offer(opts);
       if ('ok' !== response.result) {
@@ -423,9 +518,12 @@ 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)) {
+      if (reason && dlg.type === 'uac' && ['release-media', 'anchor-media'].includes(reason) &&
+        !this.callerIsUsingSrtp) {
         this.logger.info({response}, `got a reinvite from FS to ${reason}`);
         sdp = dlg.other.remote.sdp;
+        answerMedia.flags = ['asymmetric', 'port latching'];
+        this._mediaReleased = 'release-media' === reason;
       }
       else {
         sdp = await dlg.other.modify(response.sdp);
@@ -450,6 +548,8 @@ Duration=${payload.duration} `
 
   async _onInfo(dlg, req, res) {
     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 contentType = req.get('Content-Type');
     try {
       if (dlg.type === 'uac' && req.has('X-Reason')) {
         const reason = req.get('X-Reason');
@@ -459,16 +559,135 @@ Duration=${payload.duration} `
           'from-tag': fromTag
         };
         this.logger.info(`_onInfo: got request ${reason}`);
-        res.send(200);
 
         if (reason.startsWith('mute')) {
           const response = Promise.all([this.blockMedia(opts), this.blockDTMF(opts)]);
+          res.send(200);
           this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
         }
         else if (reason.startsWith('unmute')) {
           const response = Promise.all([this.unblockMedia(opts), this.unblockDTMF(opts)]);
+          res.send(200);
           this.logger.info({response}, `_onInfo: response to rtpengine command for ${reason}`);
         }
+        else if (reason.includes('CallRecording')) {
+          let succeeded = false;
+          if (reason === 'startCallRecording') {
+            const from = this.req.getParsedHeader('From');
+            const to = this.req.getParsedHeader('To');
+            const aorFrom = from.uri;
+            const aorTo = to.uri;
+            this.logger.info({to, from}, 'startCallRecording request for a call');
+
+            const srsUrl = req.get('X-Srs-Url');
+            const srsRecordingId = req.get('X-Srs-Recording-ID');
+            const callSid = req.get('X-Call-Sid');
+            const accountSid = req.get('X-Account-Sid');
+            const applicationSid = req.get('X-Application-Sid');
+            if (this.srsClient) {
+              res.send(400);
+              this.logger.info('discarding duplicate startCallRecording request for a call');
+              return;
+            }
+            if (!srsUrl) {
+              this.logger.info('startCallRecording request is missing X-Srs-Url header');
+              res.send(400);
+              return;
+            }
+            this.srsClient = new SrsClient(this.logger, {
+              srf: dlg.srf,
+              direction: 'inbound',
+              originalInvite: this.req,
+              callingNumber: this.req.callingNumber,
+              calledNumber: this.req.calledNumber,
+              srsUrl,
+              srsRecordingId,
+              callSid,
+              accountSid,
+              applicationSid,
+              rtpEngineOpts: this.rtpEngineOpts,
+              fromTag,
+              toTag,
+              aorFrom,
+              aorTo,
+              subscribeRequest: this.subscribeRequest,
+              subscribeAnswer: this.subscribeAnswer,
+              del: this.del,
+              blockMedia: this.blockMedia,
+              unblockMedia: this.unblockMedia,
+              unsubscribe: this.unsubscribe
+            });
+            try {
+              succeeded = await this.srsClient.start();
+            } catch (err) {
+              this.logger.error({err}, 'Error starting SipRec call recording');
+            }
+          }
+          else if (reason === 'stopCallRecording') {
+            if (!this.srsClient) {
+              res.send(400);
+              this.logger.info('discarding stopCallRecording request because we are not recording');
+              return;
+            }
+            try {
+              succeeded = await this.srsClient.stop();
+            } catch (err) {
+              this.logger.error({err}, 'Error stopping SipRec call recording');
+            }
+            this.srsClient = null;
+          }
+          else if (reason === 'pauseCallRecording') {
+            if (!this.srsClient || this.srsClient.paused) {
+              this.logger.info('discarding invalid pauseCallRecording request');
+              res.send(400);
+              return;
+            }
+            succeeded = await this.srsClient.pause();
+          }
+          else if (reason === 'resumeCallRecording') {
+            if (!this.srsClient || !this.srsClient.paused) {
+              res.send(400);
+              this.logger.info('discarding invalid resumeCallRecording request');
+              return;
+            }
+            succeeded = await this.srsClient.resume();
+          }
+          res.send(succeeded ? 200 : 503);
+        }
+      }
+      else if (dlg.type === 'uas' && ['application/dtmf-relay', 'application/dtmf'].includes(contentType)) {
+        const arr = /Signal=\s*([0-9#*])/.exec(req.body);
+        if (!arr) {
+          this.logger.info({body: req.body}, '_onInfo: invalid INFO dtmf request');
+          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;
+
+        if (this.isMediaReleased) {
+          /* just relay on to the feature server */
+          this.logger.info({code, duration}, 'got SIP INFO DTMF from caller, relaying to feature server');
+          this._onDTMF(dlg.other, {event: code, duration})
+            .catch((err) => this.logger.info({err}, 'Error relaying DTMF to feature server'));
+          res.send(200);
+        }
+        else {
+          /* else convert SIP INFO to RFC 2833 telephony events */
+          this.logger.info({code, duration}, 'got SIP INFO DTMF from caller, converting to RFC 2833');
+          const opts = {
+            ...this.rtpEngineOpts.common,
+            'from-tag': this.rtpEngineOpts.uas.tag,
+            code,
+            duration
+          };
+          const response = await this.playDTMF(opts);
+          if ('ok' !== response.result) {
+            this.logger.info({response}, `rtpengine playDTMF failed with ${JSON.stringify(response)}`);
+            throw new Error('rtpengine failed: answer');
+          }
+          res.send(200);
+        }
       }
       else {
         const immutableHdrs = ['via', 'from', 'to', 'call-id', 'cseq', 'max-forwards', 'content-length'];
@@ -484,6 +703,10 @@ Duration=${payload.duration} `
         res.send(response.status, {headers: responseHeaders, body: response.body});
       }
     } catch (err) {
+      if (this.srsClient) {
+        this.srsClient = null;
+      }
+      res.send(500);
       this.logger.info({err}, `Error handing INFO request on ${dlg.type} leg`);
     }
   }
@@ -520,11 +743,19 @@ Duration=${payload.duration} `
         if (e164 && !uri.user.startsWith('+')) {
           uri.user = `+${uri.user}`;
         }
+        // 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,
+          ...customHeaders
+        } = req.headers;
+
         const response = await this.uas.request({
           method: 'REFER',
           headers: {
             'Refer-To': stringifyUri(uri),
-            'Referred-By': stringifyUri(u)
+            'Referred-By': stringifyUri(u),
+            ...customHeaders
           }
         });
         return res.send(response.status);

lib/db-utils.js

@@ -3,6 +3,8 @@ const CIDRMatcher = require('cidr-matcher');
 const {parseUri} = require('drachtio-srf');
 const {normalizeDID} = require('./utils');
 
+const sqlSelectSPForAccount = 'SELECT service_provider_sid FROM accounts WHERE account_sid = ?';
+
 const sqlSelectAllCarriersForAccountByRealm =
 `SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
 vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask  
@@ -68,6 +70,12 @@ module.exports = (srf, logger) => {
   const {pool}  = srf.locals.dbHelpers;
   const pp = pool.promise();
 
+  const getSPForAccount = async(account_sid) => {
+    const [r] = await pp.query(sqlSelectSPForAccount, [account_sid]);
+    if (0 === r.length) return null;
+    return r[0].service_provider_sid;
+  };
+
   const getOutboundGatewayForRefer = async(voip_carrier_sid) => {
     try {
       const [r] = await pp.query(sqlSelectOutboundGatewayForCarrier, [voip_carrier_sid]);
@@ -115,10 +123,12 @@ module.exports = (srf, logger) => {
         const [r] = await pp.query(sqlCarriersForAccountBySid,
           [process.env.SBC_ACCOUNT_SID, req.source_address, req.source_port]);
         if (0 === r.length) return failure;
+        const service_provider_sid = await getSPForAccount(process.env.SBC_ACCOUNT_SID);
         return {
           fromCarrier: true,
           gateway: r[0],
-          account_sid: process.env.SBC_ACCOUNT_SID
+          account_sid: process.env.SBC_ACCOUNT_SID,
+          service_provider_sid
         };
       }
       else {
@@ -147,6 +157,7 @@ module.exports = (srf, logger) => {
               return {
                 fromCarrier: true,
                 gateway: matches[0],
+                service_provider_sid: accounts[0].service_provider_sid,
                 account_sid: accounts[0].account_sid,
                 account: accounts[0]
               };
@@ -158,6 +169,7 @@ module.exports = (srf, logger) => {
           return {
             fromCarrier: true,
             gateway,
+            service_provider_sid: accounts[0].service_provider_sid,
             account_sid: r[0].account_sid,
             application_sid: r[0].application_sid,
             account: accounts[0]
@@ -178,6 +190,7 @@ module.exports = (srf, logger) => {
       return {
         fromCarrier: true,
         gateway: selected,
+        service_provider_sid: a[0].service_provider_sid,
         account_sid: a[0].account_sid,
         application_sid: selected.application_sid,
         account: a[0]
@@ -189,6 +202,7 @@ module.exports = (srf, logger) => {
   return {
     wasOriginatedFromCarrier,
     getApplicationForDidAndCarrier,
-    getOutboundGatewayForRefer
+    getOutboundGatewayForRefer,
+    getSPForAccount
   };
 };

lib/middleware.js

@@ -2,7 +2,7 @@ const debug = require('debug')('jambonz:sbc-inbound');
 const assert = require('assert');
 const Emitter = require('events');
 const parseUri = require('drachtio-srf').parseUri;
-const {makeCallCountKey} = require('./utils');
+const {makeAccountCallCountKey, makeSPCallCountKey} = require('./utils');
 const msProxyIps = process.env.MS_TEAMS_SIP_PROXY_IPS ?
   process.env.MS_TEAMS_SIP_PROXY_IPS.split(',').map((i) => i.trim()) :
   [];
@@ -30,10 +30,10 @@ module.exports = function(srf, logger) {
           stats.histogram('app.hook.response_time', rtt, ['hook_type:auth', `status:${status}`]);
         })
         .on('error', async(err, req) => {
-          const {account_sid} = req.locals;
+          const {account_sid, account} = req.locals;
           const {writeAlerts, AlertType} = req.srf.locals;
           if (account_sid) {
-            let opts = {account_sid};
+            let opts = {account_sid, service_provider_sid: account.service_provider_sid};
             if (err.code === 'ECONNREFUSED') {
               opts = {...opts, alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE, url: err.hook};
             }
@@ -70,7 +70,8 @@ module.exports = function(srf, logger) {
   });
 
   const initLocals = (req, res, next) => {
-    req.locals = req.locals || {};
+    const callId = req.get('Call-ID');
+    req.locals = req.locals || {callId};
 
     /* check if forwarded by a proxy that applied an X-Forwarded-For Header */
     if (req.has('X-Forwarded-For') || req.has('X-Subspace-Forwarded-For')) {
@@ -83,7 +84,6 @@ module.exports = function(srf, logger) {
       req.source_address = original_source_address;
     }
     req.locals.cdr = initCdr(req);
-    const callId = req.get('Call-ID');
     req.on('cancel', () => {
       logger.info({callId}, 'caller hungup before connecting to feature server');
       req.canceled = true;
@@ -109,14 +109,38 @@ module.exports = function(srf, logger) {
     next();
   };
 
+  const handleSipRec = async(req, res, next) => {
+    const {callId} = req.locals;
+    if (Array.isArray(req.payload) && req.payload.length > 1) {
+      const sdp = req.payload
+        .find((p) => p.type === 'application/sdp')
+        .content;
+      if (!sdp) {
+        logger.error({callId}, 'No SDP in multipart sdp');
+        return res.send(503);
+      }
+      const xml = req.payload.find((p) => p.type !== 'application/sdp');
+      const endPos = xml.content.indexOf('</recording>');
+      xml.content = endPos !== -1 ?
+        `${xml.content.substring(0, endPos + 12)}` :
+        xml.content;
+      logger.debug({callId, xml}, 'incoming call with SIPREC body');
+      req.locals = {...req.locals, sdp, siprec: true, xml};
+    }
+    else req.locals = {...req.locals, sdp: req.body};
+    next();
+  };
+
   const identifyAccount = async(req, res, next) => {
     try {
-      const {wasOriginatedFromCarrier, getApplicationForDidAndCarrier} = req.srf.locals;
+      const {siprec, callId} = req.locals;
+      const {getSPForAccount, wasOriginatedFromCarrier, getApplicationForDidAndCarrier} = req.srf.locals;
       const {
         fromCarrier,
         gateway,
         account_sid,
         application_sid,
+        service_provider_sid,
         account
       } = await wasOriginatedFromCarrier(req);
       /**
@@ -132,14 +156,25 @@ module.exports = function(srf, logger) {
         }
         logger.debug({gateway}, 'identifyAccount: incoming call from gateway');
 
-        /* check for phone number level routing */
-        const sid = application_sid || await getApplicationForDidAndCarrier(req, gateway.voip_carrier_sid);
+        let sid;
+        if (siprec) {
+          if (!account.siprec_hook_sid) {
+            logger.info({callId}, 'identifyAccount: rejecting call because SIPREC hook has not been provisioned');
+            return res.send(404);
+          }
+          sid = account.siprec_hook_sid;
+        }
+        else {
+          /* check for phone number level routing */
+          sid = application_sid || await getApplicationForDidAndCarrier(req, gateway.voip_carrier_sid);
+        }
         req.locals = {
           originator: 'trunk',
           carrier: gateway.name,
           gateway,
           voip_carrier_sid: gateway.voip_carrier_sid,
           application_sid: sid || gateway.application_sid,
+          service_provider_sid,
           account_sid,
           account,
           ...req.locals
@@ -155,12 +190,13 @@ module.exports = function(srf, logger) {
           res.send(404, {headers: {'X-Reason': 'no configured application'}});
           return req.srf.endSession(req);
         }
-
+        const service_provider_sid = await getSPForAccount(app.account_sid);
         req.locals = {
           originator: 'teams',
           carrier: 'Microsoft Teams',
           msTeamsTenantFqdn: uri.host,
           account_sid: app.account_sid,
+          service_provider_sid,
           ...req.locals
         };
       }
@@ -186,18 +222,21 @@ module.exports = function(srf, logger) {
           return req.srf.endSession(req);
         }
         req.locals = {
+          service_provider_sid: account.service_provider_sid,
           account_sid: account.account_sid,
           account,
           webhook_secret: account.webhook_secret,
           ...req.locals
         };
       }
+      assert(req.locals.service_provider_sid);
       assert(req.locals.account_sid);
       req.locals.cdr.account_sid = req.locals.account_sid;
 
       if (!req.locals.account) {
         req.locals.account = await lookupAccountBySid(req.locals.account_sid);
       }
+      req.locals.cdr.service_provider_sid = req.locals.account?.service_provider_sid;
 
       if (!req.locals.account.is_active) {
         stats.increment('sbc.terminations', ['sipStatus:503']);
@@ -209,7 +248,11 @@ module.exports = function(srf, logger) {
         delete req.locals.cdr;
       }
 
-      req.locals.logger = logger.child({callId: req.get('Call-ID'), account_sid: req.locals.account_sid});
+      req.locals.logger = logger.child({
+        callId: req.get('Call-ID'),
+        service_provider_sid: req.locals.service_provider_sid,
+        account_sid: req.locals.account_sid
+      });
 
       next();
     } catch (err) {
@@ -223,32 +266,35 @@ module.exports = function(srf, logger) {
     if (!process.env.JAMBONES_HOSTING && !process.env.JAMBONES_TRACK_ACCOUNT_CALLS) return next(); // skip
 
     const {incrKey, decrKey} = req.srf.locals.realtimeDbHelpers;
-    const {logger, account_sid} = req.locals;
-    const {writeCallCount, writeAlerts, AlertType} = req.srf.locals;
+    const {logger, account_sid, account, service_provider_sid} = req.locals;
+    const {writeCallCount, writeCallCountSP, writeAlerts, AlertType} = req.srf.locals;
     assert(account_sid);
-    const key = makeCallCountKey(account_sid);
+    assert(service_provider_sid);
+    const keyAccount = makeAccountCallCountKey(account_sid);
+    const keySP = makeSPCallCountKey(service_provider_sid);
 
     /* decrement count if INVITE is later rejected */
-    res.once('end', ({status}) => {
+    res.once('end', async({status}) => {
       if (status > 200) {
-        decrKey(key)
-          .then((count) => {
-            logger.info({key}, `after rejection there are ${count} active calls for this account`);
-            debug({key}, `after rejection there are ${count} active calls for this account`);
-            return count;
-          })
-          .then((count) => writeCallCount({account_sid, calls_in_progress: count}))
-          .catch((err) => logger.error({err}, 'checkLimits: decrKey err'));
+        try {
+          const [calls, callsSP] = await Promise.all([decrKey(keyAccount), decrKey(keySP)]);
+          logger.info({calls, callsSP}, `decremented call counts after ${status} response`);
+        } catch (err) {
+          logger.info({err}, 'Error decrementing call count');
+        }
       }
     });
 
     try {
       /* increment the call count */
-      const calls = await incrKey(key);
-      writeCallCount({account_sid, calls_in_progress: calls})
-        .then(() => logger.info(`checkLimits: after incrementing there are ${calls} active calls for this account`))
-        .catch((err) => logger.error({err}, 'checkLimits: error writing call count'));
-      if (!process.env.JAMBONES_HOSTING) return next();
+      const [calls, callsSP] = await Promise.all([incrKey(keyAccount), incrKey(keySP)]);
+      logger.info({calls, callsSP}, 'incremented call counts');
+
+      /* write the call counts to the database for both account and service provider */
+      Promise.all([
+        writeCallCount(account_sid, calls),
+        writeCallCountSP(service_provider_sid, callsSP)
+      ]).catch((err) => logger.error({err}, 'Error writing call counts'));
 
       /* compare to account's limit, though avoid db hit when call count is low */
       const minLimit = process.env.MIN_CALL_LIMIT ?
@@ -257,21 +303,26 @@ module.exports = function(srf, logger) {
       logger.debug(`checkLimits: call count is now ${calls}, limit is ${minLimit}`);
       if (calls <= minLimit) return next();
 
-      const capacities = await lookupAccountCapacitiesBySid(account_sid);
-      const limit = capacities.find((c) => c.category == 'voice_call_session');
-      if (!limit) throw new Error('no account_capacities found');
-      const limit_sessions = limit.quantity;
-      if (calls > limit_sessions) {
-        debug(`checkLimits: limits exceeded: call count ${calls}, limit ${limit_sessions}`);
-        logger.info({calls, limit_sessions}, 'checkLimits: limits exceeded');
-        writeAlerts({
-          alert_type: AlertType.CALL_LIMIT,
-          account_sid,
-          count: limit_sessions
-        }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
-        res.send(503, 'Maximum Calls In Progress');
-        return req.srf.endSession(req);
+      const accountCapacities = await lookupAccountCapacitiesBySid(account_sid);
+      const accountLimit = accountCapacities.find((c) => c.category == 'voice_call_session');
+      if (accountLimit) {
+        /* check account limit */
+        const limit_sessions = accountLimit.quantity;
+        if (calls > limit_sessions) {
+          debug(`checkLimits: limits exceeded: call count ${calls}, limit ${limit_sessions}`);
+          logger.info({calls, limit_sessions}, 'checkLimits: limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.ACCOUNT_CALL_LIMIT,
+            service_provider_sid: account.service_provider_sid,
+            account_sid,
+            count: limit_sessions
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Maximum Calls In Progress');
+          return req.srf.endSession(req);
+        }
       }
+
+      //TODO: implement service provider limits
       next();
     } catch (err) {
       stats.increment('sbc.terminations', ['sipStatus:500']);
@@ -296,6 +347,7 @@ module.exports = function(srf, logger) {
 
   return {
     initLocals,
+    handleSipRec,
     challengeDeviceCalls,
     identifyAccount,
     checkLimits

lib/utils.js

@@ -15,7 +15,13 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
   const from = req.getParsedHeader('from');
   const srtpOpts = teams ? srtpCharacteristics['teams'] : srtpCharacteristics['default'];
   const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCharacteristics;
-  const srctOpts = srcIsUsingSrtp ? srtpOpts : rtpCharacteristics;
+  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCharacteristics;
+
+  /* webrtc clients (e.g. sipjs) send DMTF via SIP INFO */
+  if ((srcIsUsingSrtp || dstIsUsingSrtp) && !teams) {
+    dstOpts.flags.push('inject DTMF');
+    srcOpts.flags.push('inject DTMF');
+  }
   const common = {
     'call-id': req.get('Call-ID'),
     'replace': ['origin', 'session-connection']
@@ -24,7 +30,7 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
     common,
     uas: {
       tag: from.params.tag,
-      mediaOpts: srctOpts
+      mediaOpts: srcOpts
     },
     uac: {
       tag: null,
@@ -37,7 +43,8 @@ const SdpWantsSrtp = (sdp) => {
   return /m=audio.*SAVP/.test(sdp);
 };
 
-const makeCallCountKey = (sid) => `${sid}:incalls`;
+const makeAccountCallCountKey = (sid) => `${sid}:incalls:account`;
+const makeSPCallCountKey = (sid) => `${sid}:incalls:sp`;
 
 const normalizeDID = (tel) => {
   const regex = /^\+(\d+)$/;
@@ -81,7 +88,8 @@ module.exports = {
   SdpWantsSrtp,
   getAppserver,
   makeRtpEngineOpts,
-  makeCallCountKey,
+  makeAccountCallCountKey,
+  makeSPCallCountKey,
   normalizeDID,
   equalsIgnoreOrder,
   systemHealth,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-inbound",
-  "version": "v0.7.5",
+  "version": "v0.7.6",
   "main": "app.js",
   "engines": {
     "node": ">= 12.0.0"
@@ -20,36 +20,36 @@
   },
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONES_NETWORK_CIDR='127.0.0.1/32' JAMBONES_HOSTING=1 SBC_ACCOUNT_SID=ed649e33-e771-403a-8c99-1780eabbc803 JAMBONES_TIME_SERIES_HOST=127.0.0.1 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_LOGLEVEL=info DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ ",
+    "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONES_NETWORK_CIDR='127.0.0.1/32' JAMBONES_HOSTING=1 SBC_ACCOUNT_SID=ed649e33-e771-403a-8c99-1780eabbc803 JAMBONES_TIME_SERIES_HOST=127.0.0.1 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_LOGLEVEL=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
     "jslint": "eslint app.js lib"
   },
   "dependencies": {
     "@jambonz/db-helpers": "^0.6.18",
-    "@jambonz/http-authenticator": "^0.2.0",
+    "@jambonz/http-authenticator": "^0.2.2",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.4.24",
+    "@jambonz/realtimedb-helpers": "^0.4.29",
     "@jambonz/rtpengine-utils": "^0.3.1",
+    "@jambonz/siprec-client-utils": "^0.1.4",
     "@jambonz/stats-collector": "^0.1.6",
-    "@jambonz/time-series": "^0.1.9",
-    "aws-sdk": "^2.1036.0",
+    "@jambonz/time-series": "^0.2.1",
+    "aws-sdk": "^2.1152.0",
     "bent": "^7.3.12",
     "cidr-matcher": "^2.1.1",
-    "debug": "^4.3.3",
+    "debug": "^4.3.4",
     "drachtio-fn-b2b-sugar": "0.0.12",
-    "drachtio-srf": "^4.4.59",
-    "express": "^4.17.3",
-    "husky": "^7.0.4",
-    "pino": "^7.4.1",
-    "rtpengine-client": "^0.2.0",
-    "verify-aws-sns-signature": "^0.0.6",
+    "drachtio-srf": "^4.5.1",
+    "express": "^4.18.1",
+    "pino": "^7.11.0",
+    "sdp-transform": "^2.14.1",
+    "uuid": "^8.3.2",
+    "verify-aws-sns-signature": "^0.1.0",
     "xml2js": "^0.4.23"
   },
   "devDependencies": {
-    "clear-module": "^4.1.1",
     "eslint": "^7.32.0",
     "eslint-plugin-promise": "^4.3.1",
     "nyc": "^15.1.0",
-    "tape": "^4.13.3"
+    "tape": "^4.15.1"
   }
 }

test/scenarios/uas.xml

@@ -124,7 +124,24 @@
   ]]>
 </send>
 
+<recv request="BYE">
+</recv>
+
+<send next="2">
+  <![CDATA[
+
+    SIP/2.0 200 OK
+    [last_Via:]
+    [last_From:]
+    [last_To:]
+    [last_Call-ID:]
+    [last_CSeq:]
+    Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+    Content-Length: 0
+
+  ]]>
+</send>
+
 <label id="2"/>
 
 </scenario>
-

test/sip-tests.js

@@ -58,7 +58,7 @@ test('incoming call tests', async(t) => {
     t.pass('handles in-dialog requests');
   
     await sippUac('uac-pcap-carrier-max-call-limit.xml', '172.38.0.20');
-    t.pass('rejects incoming call with 503 when max calls reached')
+    t.pass('rejects incoming call with 503 when max calls per account reached')
   
     await waitFor(10);
     const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});