Feature/siprec server (#42)

* changes to handle siprec invites

* retain xml for sending

* send multipart body for siprec

* fixup sdp

* possibly trim xml string

* fix prev commit

* fix prev commit

* still tweaking sdp

* tweaks

* tweaking

* bit of refactoring

* refactor siprec client stuff into a library

* add direction in siprec metadata

* fix

app.js

@@ -111,6 +111,7 @@ const activeCallIds = srf.locals.activeCallIds;
 
 const {
   initLocals,
+  handleSipRec,
   identifyAccount,
   checkLimits,
   challengeDeviceCalls
@@ -161,7 +162,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,8 +1,9 @@
 const Emitter = require('events');
-const SrsClient = require('./srs-client');
+const SrsClient = require('@jambonz/siprec-client-utils');
 const {makeRtpEngineOpts, SdpWantsSrtp, makeCallCountKey} = require('./utils');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
 const {parseUri, stringifyUri, SipError} = require('drachtio-srf');
+const { v4: uuidv4 } = require('uuid');
 const debug = require('debug')('jambonz:sbc-inbound');
 const MS_TEAMS_USER_AGENT = 'Microsoft.PSTNHub.SIPProxy';
 const MS_TEAMS_SIP_ENDPOINT = 'sip.pstnhub.microsoft.com';
@@ -18,6 +19,20 @@ const createBLegFromHeader = (req) => {
   return '<sip:anonymous@localhost>';
 };
 
+const createSiprecBody = (headers, sdp, type, content) => {
+  const sep = uuidv4();
+  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();
@@ -25,6 +40,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;
@@ -45,6 +62,7 @@ class CallSession extends Emitter {
   }
 
   async connect() {
+    const {sdp} = this.req.locals;
     this.logger.info('inbound call accepted for routing');
     const engine = this.getRtpEngine();
     if (!engine) {
@@ -90,7 +108,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;
@@ -115,7 +133,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');
@@ -124,7 +142,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'),
@@ -134,6 +151,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, {
@@ -165,6 +186,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,
@@ -179,7 +201,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 = {
@@ -434,6 +456,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;
@@ -446,7 +472,7 @@ Duration=${payload.duration} `
         'from-tag': fromTag,
         'to-tag': toTag,
         direction,
-        sdp: req.body,
+        sdp: offeredSdp,
       };
 
       let response = await this.offer(opts);
@@ -532,6 +558,7 @@ Duration=${payload.duration} `
             }
             this.srsClient = new SrsClient(this.logger, {
               srf: dlg.srf,
+              direction: 'inbound',
               originalInvite: this.req,
               callingNumber: this.req.callingNumber,
               calledNumber: this.req.calledNumber,

lib/middleware.js

@@ -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,8 +109,31 @@ 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 {siprec, callId} = req.locals;
       const {wasOriginatedFromCarrier, getApplicationForDidAndCarrier} = req.srf.locals;
       const {
         fromCarrier,
@@ -132,8 +155,18 @@ 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,
@@ -296,6 +329,7 @@ module.exports = function(srf, logger) {
 
   return {
     initLocals,
+    handleSipRec,
     challengeDeviceCalls,
     identifyAccount,
     checkLimits

lib/srs-client.js

@@ -1,249 +0,0 @@
-const Emitter = require('events');
-const assert = require('assert');
-const transform = require('sdp-transform');
-const { v4: uuidv4 } = require('uuid');
-
-const createMultipartSdp = (sdp, {
-  originalInvite,
-  srsRecordingId,
-  callSid,
-  accountSid,
-  applicationSid,
-  sipCallId,
-  aorFrom,
-  aorTo,
-  callingNumber,
-  calledNumber
-}) => {
-  const sessionId = uuidv4();
-  const uuidStream1 = uuidv4();
-  const uuidStream2 = uuidv4();
-  const participant1 = uuidv4();
-  const participant2 = uuidv4();
-  const sipSessionId = originalInvite.get('Call-ID');
-  const {originator = 'unknown', carrier = 'unknown'} = originalInvite.locals;
-
-  const x = `--uniqueBoundary
-Content-Disposition: session;handling=required
-Content-Type: application/sdp
-
---sdp-placeholder--
---uniqueBoundary
-Content-Disposition: recording-session
-Content-Type: application/rs-metadata+xml
-
-<?xml version="1.0" encoding="UTF-8"?>
-<recording xmlns="urn:ietf:params:xml:ns:recording:1">
-  <datamode>complete</datamode>
-  <session session_id="${sessionId}">
-    <sipSessionID>${sipSessionId}</sipSessionID>
-  </session>
-  <extensiondata xmlns:jb="http://jambonz.org/siprec">
-    <jb:callsid>${callSid}</jb:callsid>
-    <jb:accountsid>${accountSid}</jb:accountsid>
-    <jb:applicationsid>${applicationSid}</jb:applicationsid>
-    <jb:recordingid>${srsRecordingId}</jb:recordingid>
-    <jb:originationsource>${originator}</jb:originationsource>
-    <jb:carrier>${carrier}</jb:carrier>
-  </extensiondata>
-  <participant participant_id="${participant1}">
-    <nameID aor="${aorFrom}">
-      <name>${callingNumber}</name>
-    </nameID>
-  </participant>
-  <participantsessionassoc participant_id="${participant1}" session_id="${sessionId}">
-  </participantsessionassoc>
-  <stream stream_id="${uuidStream1}" session_id="${sessionId}">
-    <label>1</label>
-  </stream>
-  <participant participant_id="${participant2}">
-    <nameID aor="${aorTo}">
-      <name>${calledNumber}</name>
-    </nameID>
-  </participant>
-  <participantsessionassoc participant_id="${participant2}" session_id="${sessionId}">
-  </participantsessionassoc>
-  <stream stream_id="${uuidStream2}" session_id="${sessionId}">
-    <label>2</label>
-  </stream>
-  <participantstreamassoc participant_id="${participant1}">
-    <send>${uuidStream1}</send>
-    <recv>${uuidStream2}</recv>
-  </participantstreamassoc>
-  <participantstreamassoc participant_id="${participant2}">
-    <send>${uuidStream2}</send>
-    <recv>${uuidStream1}</recv>
-  </participantstreamassoc>
-</recording>`
-    .replace(/\n/g, '\r\n')
-    .replace('--sdp-placeholder--', sdp);
-
-  return `${x}\r\n`;
-};
-
-class SrsClient extends Emitter {
-  constructor(logger, opts) {
-    super();
-    const {
-      srf,
-      originalInvite,
-      calledNumber,
-      callingNumber,
-      srsUrl,
-      srsRecordingId,
-      callSid,
-      accountSid,
-      applicationSid,
-      srsDestUserName,
-      rtpEngineOpts,
-      //fromTag,
-      toTag,
-      aorFrom,
-      aorTo,
-      subscribeRequest,
-      subscribeAnswer,
-      del,
-      blockMedia,
-      unblockMedia,
-      unsubscribe
-    } = opts;
-    this.logger = logger;
-    this.srf = srf;
-    this.originalInvite = originalInvite;
-    this.callingNumber = callingNumber;
-    this.calledNumber = calledNumber;
-    this.subscribeRequest = subscribeRequest;
-    this.subscribeAnswer = subscribeAnswer;
-    this.del = del;
-    this.blockMedia = blockMedia;
-    this.unblockMedia = unblockMedia;
-    this.unsubscribe = unsubscribe;
-    this.srsUrl = srsUrl;
-    this.srsRecordingId = srsRecordingId;
-    this.callSid = callSid;
-    this.accountSid = accountSid;
-    this.applicationSid = applicationSid;
-    this.srsDestUserName = srsDestUserName;
-    this.rtpEngineOpts = rtpEngineOpts;
-    this.sipRecFromTag = toTag;
-    this.aorFrom = aorFrom;
-    this.aorTo = aorTo;
-
-    /* state */
-    this.activated = false;
-    this.paused = false;
-  }
-
-  async start() {
-    assert(!this.activated);
-
-    const opts = {
-      'call-id': this.rtpEngineOpts.common['call-id'],
-      'from-tag': this.sipRecFromTag
-    };
-
-    let response = await this.subscribeRequest({...opts, label: '1', flags: ['all'], interface: 'public'});
-    if (response.result !== 'ok') {
-      this.logger.error({response}, 'SrsClient:start error calling subscribe request');
-      throw new Error('error calling subscribe request');
-    }
-    this.siprecToTag = response['to-tag'];
-
-    const parsed = transform.parse(response.sdp);
-    parsed.name = 'jambonz SRS';
-    parsed.media[0].label = '1';
-    parsed.media[1].label = '2';
-    this.sdpOffer = transform.write(parsed);
-    const sdp = createMultipartSdp(this.sdpOffer, {
-      originalInvite: this.originalInvite,
-      srsRecordingId: this.srsRecordingId,
-      callSid: this.callSid,
-      accountSid: this.accountSid,
-      applicationSid: this.applicationSid,
-      calledNumber: this.calledNumber,
-      callingNumber: this.callingNumber,
-      aorFrom: this.aorFrom,
-      aorTo: this.aorTo
-    });
-
-    this.logger.info({response}, `SrsClient: sending SDP ${sdp}`);
-
-    /* */
-    try {
-      this.uac = await this.srf.createUAC(this.srsUrl, {
-        headers: {
-          'Content-Type': 'multipart/mixed;boundary=uniqueBoundary',
-        },
-        localSdp: sdp
-      });
-    } catch (err) {
-      this.logger.info({err}, `Error sending SIPREC INVITE to ${this.srsUrl}`);
-      throw err;
-    }
-
-    this.logger.info({sdp: this.uac.remote.sdp}, `SrsClient:start - successfully connected to SRS ${this.srsUrl}`);
-    response = await this.subscribeAnswer({
-      ...opts,
-      sdp: this.uac.remote.sdp,
-      'to-tag': response['to-tag'],
-      label: '2'
-    });
-    if (response.result !== 'ok') {
-      this.logger.error({response}, 'SrsClient:start error calling subscribe answer');
-      throw new Error('error calling subscribe answer');
-    }
-
-    this.activated = true;
-    this.logger.info('successfully established siprec connection');
-    return true;
-  }
-
-  async stop() {
-    assert(this.activated);
-    const opts = {
-      'call-id': this.rtpEngineOpts.common['call-id'],
-      'from-tag': this.sipRecFromTag
-    };
-
-    this.del(opts)
-      //.then((response) => this.logger.debug({response}, 'Successfully stopped siprec media'))
-      .catch((err) => this.logger.info({err}, 'Error deleting siprec media session'));
-    this.uac.destroy().catch(() => {});
-    this.activated = false;
-    return true;
-  }
-
-  async pause() {
-    assert(!this.paused);
-    const opts = {
-      'call-id': this.rtpEngineOpts.common['call-id'],
-      'from-tag': this.sipRecFromTag
-    };
-    try {
-      await this.blockMedia(opts);
-      await this.uac.modify(this.sdpOffer.replace(/sendonly/g, 'inactive'));
-      this.paused = true;
-      return true;
-    } catch (err) {
-      this.logger.info({err}, 'Error pausing siprec media session');
-    }
-    return false;
-  }
-
-  async resume() {
-    assert(this.paused);
-    const opts = {
-      'call-id': this.rtpEngineOpts.common['call-id'],
-      'from-tag': this.sipRecFromTag
-    };
-    try {
-      await this.blockMedia(opts);
-      await this.uac.modify(this.sdpOffer);
-    } catch (err) {
-      this.logger.info({err}, 'Error resuming siprec media session');
-    }
-    return true;
-  }
-}
-
-module.exports = SrsClient;

package-lock.json

@@ -14,6 +14,7 @@
         "@jambonz/http-health-check": "^0.0.1",
         "@jambonz/realtimedb-helpers": "^0.4.29",
         "@jambonz/rtpengine-utils": "^0.3.1",
+        "@jambonz/siprec-client-utils": "^0.1.2",
         "@jambonz/stats-collector": "^0.1.6",
         "@jambonz/time-series": "^0.1.9",
         "aws-sdk": "^2.1152.0",
@@ -26,8 +27,7 @@
         "pino": "^7.11.0",
         "sdp-transform": "^2.14.1",
         "uuid": "^8.3.2",
-        "verify-aws-sns-signature": "^0.0.7",
-        "xml2js": "^0.4.23"
+        "verify-aws-sns-signature": "^0.0.7"
       },
       "devDependencies": {
         "eslint": "^7.32.0",
@@ -690,6 +690,15 @@
         }
       }
     },
+    "node_modules/@jambonz/siprec-client-utils": {
+      "version": "0.1.2",
+      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.1.2.tgz",
+      "integrity": "sha512-tGLED15NtiN9CwVgGgwI3pvDWeIgtmUjT9EWZ75MR9w4RBv43u1ygZDo0t5J0CsfTvPGbkaXx85Eqe+zfQH95g==",
+      "dependencies": {
+        "sdp-transform": "^2.14.1",
+        "uuid": "^8.3.2"
+      }
+    },
     "node_modules/@jambonz/stats-collector": {
       "version": "0.1.6",
       "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.6.tgz",
@@ -5227,26 +5236,6 @@
         }
       }
     },
-    "node_modules/xml2js": {
-      "version": "0.4.23",
-      "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.23.tgz",
-      "integrity": "sha512-ySPiMjM0+pLDftHgXY4By0uswI3SPKLDw/i3UXbnO8M/p28zqexCUoPmQFrYD+/1BzhGJSs2i1ERWKJAtiLrug==",
-      "dependencies": {
-        "sax": ">=0.6.0",
-        "xmlbuilder": "~11.0.0"
-      },
-      "engines": {
-        "node": ">=4.0.0"
-      }
-    },
-    "node_modules/xmlbuilder": {
-      "version": "11.0.1",
-      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-11.0.1.tgz",
-      "integrity": "sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA==",
-      "engines": {
-        "node": ">=4.0"
-      }
-    },
     "node_modules/y18n": {
       "version": "4.0.1",
       "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.1.tgz",
@@ -5852,6 +5841,15 @@
         }
       }
     },
+    "@jambonz/siprec-client-utils": {
+      "version": "0.1.2",
+      "resolved": "https://registry.npmjs.org/@jambonz/siprec-client-utils/-/siprec-client-utils-0.1.2.tgz",
+      "integrity": "sha512-tGLED15NtiN9CwVgGgwI3pvDWeIgtmUjT9EWZ75MR9w4RBv43u1ygZDo0t5J0CsfTvPGbkaXx85Eqe+zfQH95g==",
+      "requires": {
+        "sdp-transform": "^2.14.1",
+        "uuid": "^8.3.2"
+      }
+    },
     "@jambonz/stats-collector": {
       "version": "0.1.6",
       "resolved": "https://registry.npmjs.org/@jambonz/stats-collector/-/stats-collector-0.1.6.tgz",
@@ -9350,20 +9348,6 @@
       "integrity": "sha512-ri1Id1WinAX5Jqn9HejiGb8crfRio0Qgu8+MtL36rlTA6RLsMdWt1Az/19A2Qij6uSHUMphEFaTKa4WG+UNHNw==",
       "requires": {}
     },
-    "xml2js": {
-      "version": "0.4.23",
-      "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.23.tgz",
-      "integrity": "sha512-ySPiMjM0+pLDftHgXY4By0uswI3SPKLDw/i3UXbnO8M/p28zqexCUoPmQFrYD+/1BzhGJSs2i1ERWKJAtiLrug==",
-      "requires": {
-        "sax": ">=0.6.0",
-        "xmlbuilder": "~11.0.0"
-      }
-    },
-    "xmlbuilder": {
-      "version": "11.0.1",
-      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-11.0.1.tgz",
-      "integrity": "sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA=="
-    },
     "y18n": {
       "version": "4.0.1",
       "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.1.tgz",

package.json

@@ -30,6 +30,7 @@
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/realtimedb-helpers": "^0.4.29",
     "@jambonz/rtpengine-utils": "^0.3.1",
+    "@jambonz/siprec-client-utils": "^0.1.2",
     "@jambonz/stats-collector": "^0.1.6",
     "@jambonz/time-series": "^0.1.9",
     "aws-sdk": "^2.1152.0",
@@ -42,8 +43,7 @@
     "pino": "^7.11.0",
     "sdp-transform": "^2.14.1",
     "uuid": "^8.3.2",
-    "verify-aws-sns-signature": "^0.0.7",
-    "xml2js": "^0.4.23"
+    "verify-aws-sns-signature": "^0.0.7"
   },
   "devDependencies": {
     "eslint": "^7.32.0",