support incoming calls from registration trunks with ephemeral gateways (#216)

* support incoming calls from registration trunks with ephemeral gateways

* fix bug with multiple ephemeral gateways

* update to pino 10.1.0

* update eslint

.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,13 +68,17 @@ const {
 const {
   client: redisClient,
   addKey,
+  deleteKey,
   retrieveKey,
   createSet,
   retrieveSet,
   addToSet,
   removeFromSet,
   incrKey,
-  decrKey} = require('@jambonz/realtimedb-helpers')({}, logger);
+  decrKey,
+  createEphemeralGateway,
+  queryEphemeralGateways
+} = require('@jambonz/realtimedb-helpers')({}, logger);
 
 const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
 const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
@@ -111,11 +115,14 @@ srf.locals = {...srf.locals,
   },
   realtimeDbHelpers: {
     addKey,
+    deleteKey,
     retrieveKey,
     createSet,
     incrKey,
     decrKey,
-    retrieveSet
+    retrieveSet,
+    createEphemeralGateway,
+    queryEphemeralGateways
   }
 };
 const {

data/rtp-transcoding.json

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

data/srtp-transcoding.json

@@ -3,14 +3,14 @@
     "transport-protocol": "UDP/TLS/RTP/SAVPF",
     "ICE": "default",
     "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": "default",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover", "port latching"],
+    "flags": ["generate mid", "SDES-no", "port latching"],
     "rtcp-mux": ["accept"]
   }
 }

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/autoscale-manager.js

@@ -8,7 +8,7 @@ module.exports = (logger) => {
   // listen for SNS lifecycle changes
   let lifecycleEmitter = new Emitter();
   lifecycleEmitter.dryUpCalls = false;
-  if (process.env.AWS_SNS_TOPIC_ARM) {
+  if (process.env.AWS_SNS_TOPIC_ARN) {
 
     (async function() {
       try {

lib/aws-sns-lifecycle.js

@@ -69,7 +69,17 @@ class SnsNotifier extends Emitter {
             subscriptionRequestId: this.subscriptionRequestId
           }, 'response from SNS SubscribeURL');
           const data = await this.describeInstance();
-          this.lifecycleState = data.AutoScalingGroups[0].Instances[0].LifecycleState;
+
+          const group = data.AutoScalingGroups.find((group) =>
+            group.Instances && group.Instances.some((instance) => instance.InstanceId === this.instanceId)
+          );
+          if (!group) {
+            this.logger.error('Current instance not found in any Auto Scaling group', data);
+          } else {
+            const instance = group.Instances.find((instance) => instance.InstanceId === this.instanceId);
+            this.lifecycleState = instance.LifecycleState;
+          }
+
           this.emit('SubscriptionConfirmation', {publicIp: this.publicIp});
           break;
 
@@ -137,13 +147,13 @@ class SnsNotifier extends Emitter {
     try {
       const params = {
         Protocol: 'http',
-        TopicArn: process.env.AWS_SNS_TOPIC_ARM,
+        TopicArn: process.env.AWS_SNS_TOPIC_ARN,
         Endpoint: this.snsEndpoint
       };
       const response = await snsClient.send(new SubscribeCommand(params));
-      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARN}`);
     } catch (err) {
-      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARN}`);
     }
   }
 
@@ -154,9 +164,9 @@ class SnsNotifier extends Emitter {
         SubscriptionArn: this.subscriptionArn
       };
       const response = await snsClient.send(new UnsubscribeCommand(params));
-      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARN}`);
     } catch (err) {
-      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARM}`);
+      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARN}`);
     }
   }
 

lib/call-session.js

@@ -180,8 +180,8 @@ class CallSession extends Emitter {
       host = obj.host;
       proxy = `sip:${featureServer}`;
     }
-    if (obj.user) uri = `${scheme}:${obj.user}@${host}`;
-    else uri = `${scheme}:${host}`;
+    if (obj.user) uri = `sip:${obj.user}@${host}`;
+    else uri = `sip:${host}`;
     this.logger.info(`uri will be: ${uri}, proxy ${proxy}`);
 
     const sendOfferToRtpEngine = async(remoteSdp) => {
@@ -347,7 +347,16 @@ class CallSession extends Emitter {
         this.emit('failed');
       }
       else if (err.message !== 'call canceled') {
+        const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
         this.logger.error(err, 'unexpected error routing inbound call');
+        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.srf.endSession(this.req);
     }
@@ -443,7 +452,7 @@ class CallSession extends Emitter {
             if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
           });
           await other.destroy({headers});
-        } catch (err) {}
+        } catch {}
         this.unsubscribeForDTMF();
 
 
@@ -456,10 +465,11 @@ class CallSession extends Emitter {
           if (!this.req.locals.callCountNudged) {
             this.req.locals.callCountNudged = true;
             this.logger.debug('decrementing call count at end of call');
-            await nudgeCallCounts(this.logger, {
+            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'));
           }
@@ -854,7 +864,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);
@@ -936,11 +947,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.uac.tag,
             code,
-            duration
+            duration,
+            volume
           };
           const response = await this.playDTMF(dtmfOpts);
           if ('ok' !== response.result) {
@@ -1046,7 +1059,7 @@ Duration=${payload.duration} `
           // eslint-disable-next-line no-unused-vars
           '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;
 
@@ -1055,6 +1068,7 @@ Duration=${payload.duration} `
           headers: {
             'Refer-To': `<${stringifyUri(uri)}>`,
             'Referred-By': referredby,
+            'Contact': this.contactHeader,
             ...customHeaders
           }
         });

lib/db-utils.js

@@ -56,15 +56,23 @@ AND sg.voip_carrier_sid = vc.voip_carrier_sid
 AND outbound = 1`;
 
 const sqlSelectCarrierRequiringRegistration = `
-SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid, vc.account_sid, 
+SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid, vc.account_sid,
 vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto
-FROM sip_gateways sg, voip_carriers vc 
-WHERE sg.voip_carrier_sid = vc.voip_carrier_sid 
-AND vc.requires_register = 1 
-AND vc.is_active = 1 
-AND vc.register_sip_realm = ? 
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.requires_register = 1
+AND vc.is_active = 1
+AND vc.register_sip_realm = ?
 AND vc.register_username = ?`;
 
+const sqlSelectGatewaysByVoipCarrierSids = `
+SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid,
+vc.account_sid, vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid IN (?)
+AND sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.is_active = 1`;
+
 const gatewayMatchesSourceAddress = (logger, source_address, gw) => {
   if (32 === gw.netmask && gw.ipv4 === source_address) return true;
   if (gw.netmask < 32) {
@@ -80,6 +88,7 @@ const gatewayMatchesSourceAddress = (logger, source_address, gw) => {
 
 module.exports = (srf, logger) => {
   const {pool}  = srf.locals.dbHelpers;
+  const {queryEphemeralGateways} = srf.locals.realtimeDbHelpers;
   const pp = pool.promise();
 
   const getApplicationBySid = async(application_sid) => {
@@ -107,6 +116,22 @@ module.exports = (srf, logger) => {
     }
   };
 
+  /**
+   * Retrieves the application for a given DID (phone number) and carrier combination.
+   * First attempts an exact DID match, then falls back to pattern/wildcard matching
+   * if no exact match is found. Pattern matching is done in order of pattern length
+   * (longest/most specific first) and handles both regex and wildcard (*) patterns.
+   *
+   * @param {Object} req - The request object containing the called number
+   * @param {string} voip_carrier_sid - The SID of the VoIP carrier
+   * @returns {Promise<(string|Object|null)>} Returns either:
+   *   - application_sid (string) if appObject is false
+   *   - full application object if appObject is true
+   *   - null if no matching application is found
+   * @throws {Error} Database errors or other unexpected errors
+   */
+  // Refactored to handle invalid regular expressions gracefully as part of
+  // https://github.com/jambonz/sbc-inbound/issues/201
   const getApplicationForDidAndCarrier = async(req, voip_carrier_sid) => {
     const did = normalizeDID(req.calledNumber) || 'anonymous';
 
@@ -117,17 +142,117 @@ module.exports = (srf, logger) => {
 
       /* wildcard / regex match */
       const [r2] = await pp.query(sqlQueryAllDidsForCarrier, [voip_carrier_sid]);
-      const match = r2
+      const patterns = r2
         .filter((o) => o.number.match(/\D/))                  // look at anything with non-digit characters
-        .sort((a, b) => b.number.length - a.number.length)    // prefer longest match
-        .find((o) => did.match(new RegExp(o.number.endsWith('*') ? `${o.number.slice(0, -1)}\\d*` : o.number)));
-      if (match) return match.application_sid;
+        .sort((a, b) => b.number.length - a.number.length);
+      for (const pattern of patterns) {
+        try {
+          const regexPattern = pattern.number.endsWith('*') ?
+            `${pattern.number.slice(0, -1)}\\d*` :
+            pattern.number;
+          if (did.match(new RegExp(regexPattern))) {
+            logger.debug({voip_carrier_sid, 'pattern':pattern.number, 'did':did}, 'Found a matching pattern');
+            return pattern.application_sid;
+          }
+        } catch (err) {
+          logger.warn({err, voip_carrier_sid, pattern: pattern.number}, 'Invalid regex pattern encountered - skipping');
+          continue;
+        }
+      }
+      logger.debug({voip_carrier_sid, did}, 'No matching pattern found');
       return null;
     } catch (err) {
       logger.error({err}, 'getApplicationForDidAndCarrier');
     }
   };
 
+  /**
+   * Searches for a matching application across multiple carriers using pattern/wildcard matching.
+   * This function is similar to getApplicationForDidAndCarrier but operates on multiple carriers
+   * simultaneously for better performance. It searches through all patterns from the specified
+   * carriers, ordered by pattern length (longest/most specific first).
+   *
+   * @param {Object} req - The request object containing the called number
+   * @param {string} voip_carrier_sids - Comma-separated string of carrier SIDs, formatted for SQL IN clause
+   *                                     (e.g., "'carrier1','carrier2'")
+   * @returns {Promise<Object|null>} Returns either:
+   *   - The matching phone_numbers record containing application_sid, voip_carrier_sid, and account_sid
+   *   - null if no matching pattern is found
+   * @throws {Error} Database errors or other unexpected errors
+   */
+  const getApplicationForDidAndCarriers = async(req, voip_carrier_sids) => {
+    const did = normalizeDID(req.calledNumber) || 'anonymous';
+    const sql = `SELECT * FROM phone_numbers WHERE voip_carrier_sid IN (${voip_carrier_sids})`;
+
+    try {
+      /* wildcard / regex match */
+      const [r2] = await pp.query(sql);
+      const patterns = r2
+        .filter((o) => o.number.match(/\D/))                  // look at anything with non-digit characters
+        .sort((a, b) => b.number.length - a.number.length);
+      for (const pattern of patterns) {
+        try {
+          const regexPattern = pattern.number.endsWith('*') ?
+            `${pattern.number.slice(0, -1)}\\d*` :
+            pattern.number;
+          if (did.match(new RegExp(regexPattern))) {
+            logger.debug({'pattern':pattern.number, 'did':did}, 'Found a matching pattern');
+            return pattern;
+          }
+        } catch (err) {
+          logger.warn({err, pattern: pattern.number}, 'Invalid regex pattern encountered - skipping');
+          continue;
+        }
+      }
+      logger.debug('No matching pattern found');
+      return null;
+    } catch (err) {
+      logger.error({err}, 'getApplicationForDidAndCarriers');
+    }
+  };
+
+  /**
+   * Queries ephemeral gateways in Redis for the given source IP address.
+   * Returns an array of active voip_carrier_sid values.
+   *
+   * @param {string} source_address - The source IP address to query
+   * @returns {Promise<Array<string>>} Array of voip_carrier_sid values, or empty array on error
+   */
+  const lookupEphemeralGatewayCarriers = async(source_address) => {
+    try {
+      logger.debug({source_address}, 'querying ephemeral gateways');
+      const carriers = await queryEphemeralGateways(source_address);
+      if (carriers.length > 0) {
+        logger.info({source_address, count: carriers.length, carriers},
+          'found ephemeral gateway carriers');
+      }
+      return carriers;
+    } catch (err) {
+      logger.error({err, source_address}, 'Error querying ephemeral gateways');
+      return [];
+    }
+  };
+
+  /**
+   * Retrieves full gateway details (with carrier info) for the given voip_carrier_sid array.
+   * Returns gateway records (joined with carrier data) matching the structure of other gateway queries.
+   *
+   * @param {Array<string>} voipCarrierSids - Array of voip_carrier_sid values
+   * @returns {Promise<Array<Object>>} Array of gateway objects (with carrier fields included)
+   */
+  const lookupGatewaysByCarrierSids = async(voipCarrierSids) => {
+    if (!voipCarrierSids || voipCarrierSids.length === 0) return [];
+
+    try {
+      const [r] = await pp.query(sqlSelectGatewaysByVoipCarrierSids, [voipCarrierSids]);
+      logger.debug({count: r.length, voipCarrierSids}, 'retrieved gateway details for ephemeral gateways');
+      return r;
+    } catch (err) {
+      logger.error({err, voipCarrierSids}, 'Error retrieving gateway details by carrier IDs');
+      return [];
+    }
+  };
+
   const wasOriginatedFromCarrier = async(req) => {
     const failure = {fromCarrier: false};
     const uri = parseUri(req.uri);
@@ -177,6 +302,32 @@ module.exports = (srf, logger) => {
         if (voip_carriers.length > 1) {
           voip_carriers = [...new Set(voip_carriers.map(JSON.stringify))].map(JSON.parse);
         }
+
+        /* if no static gateway matches, check ephemeral gateways in Redis */
+        if (voip_carriers.length === 0 && gateways.length === 0) {
+          const ephemeralCarrierSids = await lookupEphemeralGatewayCarriers(req.source_address);
+          if (ephemeralCarrierSids.length > 0) {
+            const ephemeralGateways = await lookupGatewaysByCarrierSids(ephemeralCarrierSids);
+            gateways.push(...ephemeralGateways);
+            voip_carriers = ephemeralGateways.map((gw) => {
+              return {
+                voip_carrier_sid: gw.voip_carrier_sid,
+                name: gw.name,
+                service_provider_sid: gw.service_provider_sid,
+                account_sid: gw.account_sid,
+                application_sid: gw.application_sid,
+                pad_crypto: gw.pad_crypto
+              };
+            });
+            /* remove duplicates */
+            if (voip_carriers.length > 1) {
+              voip_carriers = [...new Set(voip_carriers.map(JSON.stringify))].map(JSON.parse);
+            }
+            logger.info({source_address: req.source_address, count: voip_carriers.length},
+              'matched call to ephemeral gateway(s) from registration trunk');
+          }
+        }
+
         if (voip_carriers.length) {
           /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
           const vc_sids = voip_carriers.map((m) => `'${m.voip_carrier_sid}'`).join(',');
@@ -184,9 +335,31 @@ module.exports = (srf, logger) => {
             `SELECT * FROM phone_numbers WHERE number = '${did}'
             AND voip_carrier_sid IN (${vc_sids})
             AND account_sid = '${a[0].account_sid}'`;
-          logger.debug({voip_carriers, sql, did}, 'looking up DID');
+          //logger.debug({voip_carriers, sql, did}, 'looking up DID');
 
           const [r] = await pp.query(sql);
+          if (r.length === 0) {
+            // if no matching phone number is found, find whether there are any applications having phone numbers
+            // matching the regex pattern or wild card
+            logger.debug({isDotDecimal},
+              'Did not find a matching phone number, checking for applications with Regex or wildcard');
+            const vc_sids = voip_carriers.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+            const application = await getApplicationForDidAndCarriers(req, vc_sids);
+            if (application) {
+              logger.debug({application}, 'sip_realm looking up DID: found application with Regex or wildcard ');
+              const gateway = gateways.find((m) => m.voip_carrier_sid === application.voip_carrier_sid);
+              // the gateway may belong to "all accounts", so we need to use the account_sid of the application
+              gateway.account_sid = gateway.account_sid ? gateway.account_sid : application.account_sid;
+              return {
+                fromCarrier: true,
+                gateway: gateway,
+                service_provider_sid: a[0].service_provider_sid,
+                account_sid: gateway.account_sid,
+                application_sid: application.application_sid,
+                account: a[0]
+              };
+            }
+          }
           if (r.length > 1) {
             logger.info({r},
               'multiple carriers with the same gateway have the same number provisioned for the same account'
@@ -238,7 +411,7 @@ module.exports = (srf, logger) => {
             `SELECT application_sid FROM phone_numbers WHERE number = '${did}'
             AND voip_carrier_sid = '${matches[0].voip_carrier_sid}'
             AND account_sid = '${matches[0].account_sid}'`;
-          logger.debug({matches: matches[0], sql, did}, 'looking up DID');
+          //logger.debug({matches: matches[0], sql, did}, 'looking up DID');
 
           const [r] = await pp.query(sql);
           return {
@@ -265,7 +438,7 @@ module.exports = (srf, logger) => {
 
     /* find all carrier entries that have an inbound gateway matching the source IP */
     const [gw] = await pp.query(sqlSelectAllGatewaysForSP);
-    logger.debug({gw}, `checking gateways for source address ${req.source_address}`);
+    //logger.debug({gw}, `checking gateways for source address ${req.source_address}`);
     let matches = gw
       .sort((a, b) => b.netmask - a.netmask)
       .filter(gatewayMatchesSourceAddress.bind(null, logger, req.source_address))
@@ -283,15 +456,60 @@ module.exports = (srf, logger) => {
     if (matches.length > 1) {
       matches = [...new Set(matches.map(JSON.stringify))].map(JSON.parse);
     }
-    logger.debug({matches}, `matches for source address ${req.source_address}`);
+
+    /* if no static gateway matches, check ephemeral gateways in Redis */
+    if (matches.length === 0) {
+      const ephemeralCarrierSids = await lookupEphemeralGatewayCarriers(req.source_address);
+      if (ephemeralCarrierSids.length > 0) {
+        const ephemeralGateways = await lookupGatewaysByCarrierSids(ephemeralCarrierSids);
+        matches = ephemeralGateways.map((gw) => {
+          return {
+            voip_carrier_sid: gw.voip_carrier_sid,
+            name: gw.name,
+            service_provider_sid: gw.service_provider_sid,
+            account_sid: gw.account_sid,
+            application_sid: gw.application_sid,
+            pad_crypto: gw.pad_crypto
+          };
+        });
+        /* remove duplicates */
+        if (matches.length > 1) {
+          matches = [...new Set(matches.map(JSON.stringify))].map(JSON.parse);
+        }
+        logger.info({source_address: req.source_address, count: matches.length},
+          'matched call to ephemeral gateway(s) from registration trunk');
+      }
+    }
+
+    //logger.debug({matches}, `matches for source address ${req.source_address}`);
     if (matches.length) {
       /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
       const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
       const sql =  `SELECT * FROM phone_numbers WHERE number = '${did}' AND voip_carrier_sid IN (${vc_sids})`;
       logger.debug({matches, sql, did, vc_sids}, 'looking up DID');
-
       const [r] = await pp.query(sql);
       if (0 === r.length) {
+        // if no matching phone number is found, find whether there are any applications having phone numbers
+        // matching the regex pattern or wild card
+        logger.debug({isDotDecimal},
+          'Did not find a matching phone number, checking for applications with Regex or wildcard');
+        const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+        const application = await getApplicationForDidAndCarriers(req, vc_sids);
+        if (application) {
+          logger.debug({application}, 'looking up DID: found application with Regex or wildcard');
+          const gateway = matches.find((m) => m.voip_carrier_sid === application.voip_carrier_sid);
+          // the gateway may belong to "all accounts", so we need to use the account_sid of the application
+          const [a] = await pp.query(sqlAccountBySid, [application.account_sid]);
+          return {
+            fromCarrier: true,
+            gateway: gateway,
+            service_provider_sid: gateway.service_provider_sid,
+            account_sid: application.account_sid,
+            application_sid: application.application_sid,
+            account: a[0],
+          };
+        }
+
         /* came from a provisioned carrier, but the dialed number is not provisioned.
             check if we have an account with default routing of that carrier to an application
         */
@@ -364,6 +582,7 @@ module.exports = (srf, logger) => {
   return {
     wasOriginatedFromCarrier,
     getApplicationForDidAndCarrier,
+    getApplicationForDidAndCarriers,
     getOutboundGatewayForRefer,
     getSPForAccount,
     getApplicationBySid

lib/middleware.js

@@ -35,6 +35,7 @@ module.exports = function(srf, logger) {
   const initLocals = (req, res, next) => {
     const callId = req.get('Call-ID');
     req.locals = req.locals || {callId};
+    req.locals.nudge = 0;
 
     /* 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')) {
@@ -130,7 +131,11 @@ module.exports = function(srf, logger) {
           return res.send(404, 'Number Not Provisioned');
         }
         logger.info({gateway}, 'identifyAccount: incoming call from gateway');
-
+        const appSidHeader = req.get('x-application-sid');
+        if (appSidHeader && appSidHeader == application_sid) {
+          logger.info({callId}, 'Loop Detected, x-application-sid header on incoming call matches applicationSid');
+          return res.send(482, 'Loop Detected on x-application-sid');
+        }
         let sid;
         if (siprec) {
           if (!account.siprec_hook_sid) {
@@ -259,15 +264,20 @@ module.exports = function(srf, logger) {
     assert(account_sid);
     assert(service_provider_sid);
 
+    /* if quick cancel then we are done */
+    if (req.canceled) {
+      logger.info('checkLimits: call was immediately canceled, no need to increment call count as we are done');
+      return;
+    }
+
     /* decrement count if INVITE is later rejected */
     res.once('end', async({status}) => {
-      if (status > 200 && !req.locals.callCountNudged) {
-        req.locals.callCountNudged = true;
-        logger.debug('decrementing call count due to call rejection');
-        nudgeCallCounts(logger, {
+      if (status > 200) {
+        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'));
       }
@@ -275,10 +285,11 @@ module.exports = function(srf, logger) {
 
     try {
       /* 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 */
@@ -288,24 +299,22 @@ module.exports = function(srf, logger) {
       logger.debug(`checkLimits: call count is now ${calls}, limit is ${minLimit}`);
       if (calls <= minLimit) return next();
 
-      if (process.env.JAMBONES_HOSTING) {
-        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);
-          }
+      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);
         }
       }
       else if (trackingOn) {
@@ -326,6 +335,11 @@ module.exports = function(srf, logger) {
           });
           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({

lib/utils.js

@@ -30,6 +30,13 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
     dstOpts.flags.push('inject DTMF');
     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 acceptCodecs = process.env.JAMBONES_ACCEPT_AND_TRANSCODE ?
     process.env.JAMBONES_ACCEPT_AND_TRANSCODE :
     process.env.JAMBONES_ACCEPT_G729 ? 'g729' : '';
@@ -117,12 +124,97 @@ const createHealthCheckApp = (port, logger) => {
   });
 };
 
-const nudgeCallCounts = async(logger, sids, nudgeOperator, writers) => {
-  const { service_provider_sid, account_sid, application_sid } = sids;
-  const { writeCallCount, writeCallCountSP, writeCallCountApp } = writers;
+/**
+ * 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 = [];
 
+  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:incalls:${account_sid}:${callId}`, new Date().toISOString(), 259200);
+    }
+    else {
+      await deleteKey(`debug:incalls:${account_sid}:${callId}`);
+    }
+  }
+
   if (process.env.JAMBONES_TRACK_SP_CALLS) {
     const key = makeSPCallCountKey(service_provider_sid);
     nudges.push(nudgeOperator(key));
@@ -151,33 +243,28 @@ const nudgeCallCounts = async(logger, sids, nudgeOperator, writers) => {
     const [callsSP, calls, callsApp] = await Promise.all(nudges);
     logger.debug({
       calls, callsSP, callsApp,
-      service_provider_sid, account_sid, application_sid
-    }, 'call counts after adjustment');
+      service_provider_sid, account_sid, application_sid}, 'call counts after adjustment');
     if (process.env.JAMBONES_TRACK_SP_CALLS) {
-      writes.push(writeCallCountSP({ service_provider_sid, calls_in_progress: callsSP }));
+      writes.push(writeCallCountSP({service_provider_sid, calls_in_progress: callsSP}));
     }
 
     if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS || process.env.JAMBONES_HOSTING) {
-      writes.push(writeCallCount({ service_provider_sid, account_sid, calls_in_progress: calls }));
+      writes.push(writeCallCount({service_provider_sid, account_sid, calls_in_progress: calls}));
     }
 
     if (process.env.JAMBONES_TRACK_APP_CALLS && application_sid) {
-      writes.push(writeCallCountApp({
-        service_provider_sid,
-        account_sid, application_sid,
-        calls_in_progress: callsApp
-      }));
+      writes.push(writeCallCountApp({service_provider_sid, account_sid, application_sid, calls_in_progress: callsApp}));
     }
 
     /* write the call counts to the database */
-    Promise.all(writes).catch((err) => logger.error({ err }, 'Error writing call counts'));
+    Promise.all(writes).catch((err) => logger.error({err}, 'Error writing call counts'));
 
-    return { callsSP, calls, callsApp };
+    return {callsSP, calls, callsApp};
   } catch (err) {
     logger.error(err, 'error incrementing call counts');
   }
 
-  return { callsSP: null, calls: null, callsApp: null };
+  return {callsSP: null, calls: null, callsApp: null};
 };
 
 const roundTripTime = (startAt) => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sbc-inbound",
-  "version": "0.9.2",
+  "version": "0.9.5",
   "main": "app.js",
   "engines": {
     "node": ">= 18.0.0"
@@ -26,29 +26,30 @@
     "jslint:fix": "npm run jslint --fix"
   },
   "dependencies": {
-    "@jambonz/db-helpers": "^0.9.7",
+    "@aws-sdk/client-auto-scaling": "^3.549.0",
+    "@aws-sdk/client-sns": "^3.549.0",
+    "@babel/helpers": "^7.26.10",
+    "@jambonz/db-helpers": "^0.9.18",
+    "@jambonz/digest-utils": "^0.0.8",
     "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.8.8",
+    "@jambonz/realtimedb-helpers": "^0.8.18",
     "@jambonz/rtpengine-utils": "^0.4.4",
-    "@jambonz/siprec-client-utils": "^0.2.9",
+    "@jambonz/siprec-client-utils": "^0.2.10",
     "@jambonz/stats-collector": "^0.1.10",
     "@jambonz/time-series": "^0.2.10",
-    "@jambonz/digest-utils": "^0.0.5",
-    "@aws-sdk/client-sns": "^3.549.0",
-    "@aws-sdk/client-auto-scaling": "^3.549.0",
     "bent": "^7.3.12",
     "cidr-matcher": "^2.1.1",
     "debug": "^4.3.4",
-    "drachtio-fn-b2b-sugar": "0.1.0",
-    "drachtio-srf": "^4.5.38",
+    "drachtio-fn-b2b-sugar": "0.2.1",
+    "drachtio-srf": "^5.0.5",
     "express": "^4.19.2",
-    "pino": "^8.20.0",
+    "pino": "^10.1.0",
     "verify-aws-sns-signature": "^0.1.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "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/db/jambones-sql.sql

@@ -14,8 +14,6 @@ DROP TABLE IF EXISTS beta_invite_codes;
 
 DROP TABLE IF EXISTS call_routes;
 
-DROP TABLE IF EXISTS clients;
-
 DROP TABLE IF EXISTS dns_records;
 
 DROP TABLE IF EXISTS lcr;
@@ -68,6 +66,8 @@ DROP TABLE IF EXISTS phone_numbers;
 
 DROP TABLE IF EXISTS sip_gateways;
 
+DROP TABLE IF EXISTS clients;
+
 DROP TABLE IF EXISTS voip_carriers;
 
 DROP TABLE IF EXISTS accounts;
@@ -132,19 +132,6 @@ application_sid CHAR(36) NOT NULL,
 PRIMARY KEY (call_route_sid)
 ) COMMENT='a regex-based pattern match for call routing';
 
-CREATE TABLE clients
-(
-client_sid CHAR(36) NOT NULL UNIQUE ,
-account_sid CHAR(36) NOT NULL,
-is_active BOOLEAN NOT NULL DEFAULT 1,
-username VARCHAR(64),
-password VARCHAR(1024),
-allow_direct_app_calling BOOLEAN NOT NULL DEFAULT 1,
-allow_direct_queue_calling BOOLEAN NOT NULL DEFAULT 1,
-allow_direct_user_calling BOOLEAN NOT NULL DEFAULT 1,
-PRIMARY KEY (client_sid)
-);
-
 CREATE TABLE dns_records
 (
 dns_record_sid CHAR(36) NOT NULL UNIQUE ,
@@ -162,7 +149,7 @@ regex VARCHAR(32) NOT NULL COMMENT 'regex-based pattern match against dialed num
 description VARCHAR(1024),
 priority INTEGER NOT NULL COMMENT 'lower priority routes are attempted first',
 PRIMARY KEY (lcr_route_sid)
-) COMMENT='An ordered list of  digit patterns in an LCR table.  The patterns are tested in sequence until one matches';
+) COMMENT='An ordered list of  digit patterns in an LCR table.  The pat';
 
 CREATE TABLE lcr
 (
@@ -173,7 +160,7 @@ default_carrier_set_entry_sid CHAR(36) COMMENT 'default carrier/route to use whe
 service_provider_sid CHAR(36),
 account_sid CHAR(36),
 PRIMARY KEY (lcr_sid)
-) COMMENT='An LCR (least cost routing) table that is used by a service provider or account to make decisions about routing outbound calls when multiple carriers are available.';
+) COMMENT='An LCR (least cost routing) table that is used by a service ';
 
 CREATE TABLE password_settings
 (
@@ -351,6 +338,8 @@ speech_credential_sid CHAR(36) NOT NULL,
 model VARCHAR(512) NOT NULL,
 reported_usage ENUM('REPORTED_USAGE_UNSPECIFIED','REALTIME','OFFLINE') DEFAULT 'REALTIME',
 name VARCHAR(64) NOT NULL,
+voice_cloning_key MEDIUMTEXT,
+use_voice_cloning_key BOOLEAN DEFAULT false,
 PRIMARY KEY (google_custom_voice_sid)
 );
 
@@ -414,6 +403,9 @@ register_from_user VARCHAR(128),
 register_from_domain VARCHAR(255),
 register_public_ip_in_contact BOOLEAN NOT NULL DEFAULT false,
 register_status VARCHAR(4096),
+dtmf_type ENUM('rfc2833','tones','info') NOT NULL DEFAULT 'rfc2833',
+outbound_sip_proxy VARCHAR(255),
+trunk_type ENUM('static-ip','auth','registration') NOT NULL DEFAULT 'static-ip',
 PRIMARY KEY (voip_carrier_sid)
 ) COMMENT='A Carrier or customer PBX that can send or receive calls';
 
@@ -487,6 +479,20 @@ password VARCHAR(255),
 PRIMARY KEY (webhook_sid)
 ) COMMENT='An HTTP callback';
 
+CREATE TABLE clients
+(
+client_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+is_active BOOLEAN NOT NULL DEFAULT 1,
+username VARCHAR(64),
+password VARCHAR(1024),
+allow_direct_app_calling BOOLEAN NOT NULL DEFAULT 1,
+allow_direct_queue_calling BOOLEAN NOT NULL DEFAULT 1,
+allow_direct_user_calling BOOLEAN NOT NULL DEFAULT 1,
+voip_carrier_sid CHAR(36),
+PRIMARY KEY (client_sid)
+);
+
 CREATE TABLE applications
 (
 application_sid CHAR(36) NOT NULL UNIQUE ,
@@ -512,6 +518,7 @@ fallback_speech_synthesis_label VARCHAR(64),
 fallback_speech_recognizer_vendor VARCHAR(64),
 fallback_speech_recognizer_language VARCHAR(64),
 fallback_speech_recognizer_label VARCHAR(64),
+env_vars TEXT,
 created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
 record_all_calls BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (application_sid)
@@ -575,9 +582,6 @@ ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERE
 
 ALTER TABLE call_routes ADD FOREIGN KEY application_sid_idxfk (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX client_sid_idx ON clients (client_sid);
-ALTER TABLE clients ADD CONSTRAINT account_sid_idxfk_13 FOREIGN KEY account_sid_idxfk_13 (account_sid) REFERENCES accounts (account_sid);
-
 CREATE INDEX dns_record_sid_idx ON dns_records (dns_record_sid);
 ALTER TABLE dns_records ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
 
@@ -706,6 +710,11 @@ ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY lcr_route_sid_idxfk (lcr_route
 ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_3 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
 CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
+CREATE INDEX client_sid_idx ON clients (client_sid);
+ALTER TABLE clients ADD CONSTRAINT account_sid_idxfk_13 FOREIGN KEY account_sid_idxfk_13 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE clients ADD FOREIGN KEY voip_carrier_sid_idxfk_4 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
 CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);
 
 CREATE INDEX application_sid_idx ON applications (application_sid);
@@ -739,4 +748,4 @@ ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (devic
 
 ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);
 
-SET FOREIGN_KEY_CHECKS=1;
+SET FOREIGN_KEY_CHECKS=0;

test/db/populate-test-data.sql

@@ -72,6 +72,9 @@ values ('d458bf7a-bcea-47b2-ac96-66dfc9c5c220', '150822233*', '287c1452-620d-419
 insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
 values ('f7ad205d-b92f-4363-8160-f8b5216b40d3', '15083871234', '287c1452-620d-4195-9f19-c9814ef90d78', 'd7cc37cb-d152-49ef-a51b-485f6e917089');
 
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('c17d5a7d-9328-4663-92c0-f65aa8381264', '12125551212', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803', '3b43e39f-4346-4218-8434-a53130e8be49');
+
 -- two accounts that both have the same carrier with default routing (ambiguity test)
 insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
 values ('239d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account B1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'echo2.sip.jambonz.org');
@@ -92,3 +95,48 @@ insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outb
 values ('664a5339-c62c-4075-9e19-f4de70a96597', '731abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.40', true, false);
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('554a5339-c62c-4075-9e19-f4de70a96597', '987abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.40', true, false);
+
+-- voip carrier belonging to all accounts
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) 
+values ('voip100', 'test-voip-carrier', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip100', 'voip100', '172.38.0.50', true, false);
+
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) 
+values ('voip101', 'test-voip-carrier-101', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip101', 'voip101', '172.38.0.50', true, false);
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip102', 'voip101', '172.38.0.51', true, false);
+
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('app100', 'app100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('app101', 'app101', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone100', '^100', 'voip101', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app100');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone101', '^10012', 'voip100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app101');
+-- insert an invalid regex pattern, the below pattern should be ignored during pattern
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone102', '\\dkjfhmdf\\', 'voip100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app101');
+
+-- account with a sip realm that is not associated with any voip carriers
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('acct-100', 'Account 100', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'ram.sip.jambonz.org');
+
+-- registration trunk carrier for ephemeral gateway testing
+insert into voip_carriers (voip_carrier_sid, name, account_sid, service_provider_sid, trunk_type,
+    requires_register, register_username, register_sip_realm, register_password, is_active)
+values ('4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 'test-registration-trunk', 'ed649e33-e771-403a-8c99-1780eabbc803',
+    '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'registration', true, 'testuser',
+    'sip.carrier.example.com', 'testpass', true);
+
+-- sip_gateway for outbound only (inbound will use ephemeral gateway from Redis)
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound)
+values ('8b3e5f9a-2c1d-4e7b-9a6c-3d8f1e5a7b2c', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', '3.3.3.3', false, true);
+
+-- phone number for ephemeral gateway test
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('7c2d4e6f-8a1b-4c9d-7e5f-2a8b3c6d9e1f', '16175551000', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 'ed649e33-e771-403a-8c99-1780eabbc803',
+    '3b43e39f-4346-4218-8434-a53130e8be49');

test/scenarios/uac-did-applicationsid-loop.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+<scenario name="UAC with x-application-sid header">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+12125551212@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:12125551212@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+      X-Application-Sid: 3b43e39f-4346-4218-8434-a53130e8be49
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+                
+  <recv response="482" rtd="true" >
+  </recv>
+
+</scenario>

test/scenarios/uac-did-regex-match-vc-all-accts-nosiprealm.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- 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 response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-did-regex-match-vc-all-accts.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- 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 response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-pcap-ephemeral-gateway-success.xml

@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- 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 response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

test/sip-tests.js

@@ -37,9 +37,18 @@ test('incoming call tests', async(t) => {
     await sippUac('uac-late-media.xml', '172.38.0.20');
     t.pass('incoming call with no SDP packet is rejected with a 488');
 
+    await sippUac('uac-did-applicationsid-loop.xml', '172.38.0.20');
+    t.pass('incoming call with x-application-sid header is rejected with 482');
+
     await sippUac('uac-pcap-carrier-success.xml', '172.38.0.20');
     t.pass('incoming call from carrier completed successfully');
 
+    // Test ephemeral gateway (registration trunk)
+    const { createEphemeralGateway } = srf.locals.realtimeDbHelpers;
+    await createEphemeralGateway('172.38.0.60', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 3600);
+    await sippUac('uac-pcap-ephemeral-gateway-success.xml', '172.38.0.60');
+    t.pass('incoming call from ephemeral gateway (registration trunk) completed successfully');
+
     await sippUac('uac-pcap-pbx-success.xml', '172.38.0.21');
     t.pass('incoming call from account-level carrier completed successfully');
   
@@ -64,6 +73,15 @@ test('incoming call tests', async(t) => {
     await sippUac('uac-pcap-carrier-max-call-limit.xml', '172.38.0.20');
     t.pass('rejects incoming call with 503 when max calls per account reached');
 
+    await sippUac('uac-did-regex-match-vc-all-accts.xml', '172.38.0.50');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, with sip realm');
+
+    await sippUac('uac-did-regex-match-vc-all-accts-nosiprealm.xml', '172.38.0.51');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, without sip realm');
+
+    await sippUac('uac-did-regex-match-vc-all-accts-nosiprealm.xml', '172.38.0.50');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, without sip realm');
+
     /* switch off this env for remaining tests (JAMBONES_HOSTING is for Saas sts) */
     delete process.env.JAMBONES_HOSTING;
     await sippUac('uac-pcap-carrier-fail-ambiguous.xml', '172.38.0.40');
@@ -71,8 +89,9 @@ test('incoming call tests', async(t) => {
   
     await waitFor(12);
     const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});
+    console.log(`cdrs res.total: ${res.total}`);
     //console.log(`cdrs: ${JSON.stringify(res)}`);
-    t.ok(7 === res.total, 'successfully wrote 8 cdrs for calls');
+    t.ok(8 === res.total, 'successfully wrote 8 cdrs for calls (including ephemeral gateway)');
 
     srf.disconnect();
     t.end();