changes for outbound LCR calls to handle challenges

2025-12-19 04:27:45 +00:00 · 2020-12-13 16:06:47 -05:00
parent 180b33f803
commit 03d6591f8a
7 changed files with 80 additions and 34 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -8,7 +8,7 @@
      "jsx": false,
      "modules": false
    },
-    "ecmaVersion": 2017 
+    "ecmaVersion": 2018
  },
  "plugins": ["promise"],
  "rules": {
--- a/lib/call-session.js
+++ b/lib/call-session.js
@@ -57,6 +57,7 @@ class CallSession extends Emitter {
    this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, this.useWss || teams, teams);
    this.rtpEngineResource = {destroy: this.del.bind(null, this.rtpEngineOpts.common)};
    let proxy, uris;
+    const mapGateways = new Map();

    try {
      // determine where to send the call
@@ -102,8 +103,12 @@ class CallSession extends Emitter {
          const routableNumber = this.req.calledNumber.startsWith('+') ?
            this.req.calledNumber.slice(1) :
            this.req.calledNumber;
-          uris = await this.performLcr(routableNumber);
-          if (!uris || uris.length === 0) throw new Error('no routes found');
+          //uris = await this.performLcr(routableNumber);
+          const gateways = await this.performLcr(routableNumber);
+          if (!gateways || gateways.length === 0) throw new Error('no routes found');
+          debug(`got gateways: ${JSON.stringify(gateways)}`);
+          gateways.forEach((gw) => mapGateways.set(gw.uri, gw.auth));
+          uris = gateways.map((gw) => gw.uri);
        } catch (err) {
          debug(err);
          this.logger.error(err, 'Error performing lcr');
@@ -127,14 +132,16 @@ class CallSession extends Emitter {
      // crank through the list of gateways until connected, exhausted or caller hangs up
      let earlyMedia = false;
      while (uris.length) {
+        const hdrs = { ...headers};
        const uri = uris.shift();
+        const auth = mapGateways.get(uri);
        const passFailure = 0 === uris.length;  // only a single target
        if (0 === uris.length) {
          try {
            const key = makeInviteInProgressKey(this.req.get('Call-ID'));
            const obj = await retrieveHash(key);
            if (obj.callId && obj.cseq) {
-              Object.assign(headers, {
+              Object.assign(hdrs, {
                'Call-ID': obj.callId,
                'CSeq': `${obj.cseq} INVITE`
              });
@@ -152,7 +159,8 @@ class CallSession extends Emitter {
            proxyRequestHeaders: ['all', '-X-MS-Teams-FQDN', '-X-MS-Teams-Tenant-FQDN', 'X-CID', '-Allow',
              '-Session-Expires', 'Min-SE'],
            proxyResponseHeaders: ['all', '-Allow'],
-            headers,
+            headers: hdrs,
+            auth,
            localSdpB: response.sdp,
            localSdpA: async(sdp, res) => {
              this.toTag = res.getParsedHeader('To').params.tag;
--- a/package-lock.json
+++ b/package-lock.json
@@ -364,9 +364,9 @@
      "dev": true
    },
    "@jambonz/db-helpers": {
-      "version": "0.5.3",
-      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.5.3.tgz",
-      "integrity": "sha512-3v366e5yzDbp5QZ3g/vgao78pXsCPXqWHUbf8timL3eSHv6BnfF/NlXt2qVwMP1ayZmFcGhygLSGYN2a+GOJQA==",
+      "version": "0.5.5",
+      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.5.5.tgz",
+      "integrity": "sha512-p+qtBjWUGaZ/+5NNfTbIDz7pcyEB4Kh4X1Egh+caGwQLGSm4lFIl0979wKpoW0/KLDFnG61QkQh1j50Ewq1Xmg==",
      "requires": {
        "debug": "^4.3.1",
        "mysql2": "^2.2.5",
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
    "jslint": "eslint app.js lib"
  },
  "dependencies": {
-    "@jambonz/db-helpers": "^0.5.1",
+    "@jambonz/db-helpers": "^0.5.5",
    "@jambonz/realtimedb-helpers": "^0.2.20",
    "@jambonz/rtpengine-utils": "^0.1.7",
    "@jambonz/stats-collector": "^0.1.4",
--- a/test/db/jambones-sql.sql
+++ b/test/db/jambones-sql.sql
@@ -55,8 +55,8 @@ api_key_sid CHAR(36) NOT NULL UNIQUE ,
 token CHAR(36) NOT NULL UNIQUE ,
 account_sid CHAR(36),
 service_provider_sid CHAR(36),
-expires_at TIMESTAMP NULL,
-last_used TIMESTAMP NULL,
+expires_at TIMESTAMP NULL  DEFAULT NULL,
+last_used TIMESTAMP NULL  DEFAULT NULL,
 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
 PRIMARY KEY (api_key_sid)
 ) ENGINE=InnoDB COMMENT='An authorization token that is used to access the REST api';
@@ -98,6 +98,10 @@ description VARCHAR(255),
 account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a customer PBX that is associated with a specific account',
 application_sid CHAR(36) COMMENT 'If provided, all incoming calls from this source will be routed to the associated application',
 e164_leading_plus BOOLEAN NOT NULL DEFAULT false,
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
 PRIMARY KEY (voip_carrier_sid)
 ) ENGINE=InnoDB COMMENT='A Carrier or customer PBX that can send or receive calls';

@@ -148,8 +152,9 @@ CREATE TABLE applications
 application_sid CHAR(36) NOT NULL UNIQUE ,
 name VARCHAR(64) NOT NULL,
 account_sid CHAR(36) NOT NULL COMMENT 'account that this application belongs to',
-call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls to phone numbers owned by this account',
+call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls ',
 call_status_hook_sid CHAR(36) COMMENT 'webhook to call for call status events',
+messaging_hook_sid CHAR(36) COMMENT 'webhook to call for inbound SMS/MMS ',
 speech_synthesis_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_synthesis_language VARCHAR(12) NOT NULL DEFAULT 'en-US',
 speech_synthesis_voice VARCHAR(64),
@@ -242,6 +247,8 @@ ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REF

 ALTER TABLE applications ADD FOREIGN KEY call_status_hook_sid_idxfk (call_status_hook_sid) REFERENCES webhooks (webhook_sid);

+ALTER TABLE applications ADD FOREIGN KEY messaging_hook_sid_idxfk (messaging_hook_sid) REFERENCES webhooks (webhook_sid);
+
 CREATE INDEX service_provider_sid_idx ON service_providers (service_provider_sid);
 CREATE INDEX name_idx ON service_providers (name);
 CREATE INDEX root_domain_idx ON service_providers (root_domain);
--- a/test/db/populate-test-data4.sql
+++ b/test/db/populate-test-data4.sql
@@ -6,6 +6,7 @@ insert into accounts(account_sid, service_provider_sid, name, sip_realm, registr
 values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'sip.example.com', '90dda62e-0ea2-47d1-8164-5bd49003476c');

 -- one carrier, uas script expecting a reinvite
-insert into voip_carriers (voip_carrier_sid, name) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco');
+insert into voip_carriers (voip_carrier_sid, name, e164_leading_plus, requires_register, register_username, register_sip_realm, register_password) 
+values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', 0, 1, 'foo', 'jambonz.org', 'bar');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('124a5339-c62c-4075-9e19-f4de70a96597', '287c1452-620d-4195-9f19-c9814ef90d78', '172.39.0.23', true, true);
--- a/test/scenarios/uas-reinvite.xml
+++ b/test/scenarios/uas-reinvite.xml
@@ -2,14 +2,60 @@
 <!DOCTYPE scenario SYSTEM "sipp.dtd">

 <scenario name="Basic UAS responder">
-  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
-  <!-- are saved and used for following messages sent. Useful to test   -->
-  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv request="INVITE" crlf="true">
+  </recv>
+
+  <send retrans="500">
+    <![CDATA[
+
+      SIP/2.0 401 Unauthorized
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      WWW-Authenticate: Digest realm="jambonz.org", nonce="4cdbb733645816512687270b83d2ae5d11e4d9d8"
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="ACK"
+        rtd="true"
+        crlf="true">
+  </recv>
+  
+  
  <recv request="INVITE" crlf="true">
    <action>
      <ereg regexp=".*" search_in="hdr" header="Subject:" assign_to="1" />
+      <verifyauth assign_to="authvalid" username="foo" password="bar" />
    </action>
  </recv>
+  <nop hide="true" test="authvalid" next="goodauth" />
+
+  <send retrans="500">
+    <![CDATA[
+
+      SIP/2.0 403 Forbidden
+      [last_Via:]
+      [last_From:]
+      [last_To:];tag=[pid]SIPpTag01[call_number]
+      [last_Call-ID:]
+      [last_CSeq:]
+      Contact: <sip:[local_ip]:[local_port];transport=[transport]>;expires=60
+      Content-Type: application/sdp
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv request="ACK" next="endit"
+        rtd="true"
+        crlf="true">
+  </recv>
+
+  <label id="goodauth"/>

  <send>
    <![CDATA[
@@ -93,7 +139,7 @@
  <recv request="BYE">
  </recv>

-  <send next="2">
+  <send>
    <![CDATA[

      SIP/2.0 200 OK
@@ -108,23 +154,7 @@
    ]]>
  </send>

-  <label id="1"/>
-  <send>
-  <![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"/>
+<label id="endit"/>

 </scenario>